Skip to main content

Filter builder UI

Prop showFilterBuilder — adapter chrome, default false.

Guide

When to use it

Give users a panel to build column filters with explicit operator rows — richer than the inline filter row for complex, multi-column filtering.

How it works

Adds a "Filters (n)" toolbar button that opens a panel of per-column, operator-aware condition rows. Combine it with enableColumnFilterRow for a second, inline per-column row.

Gotchas

  • Backed by enableColumnFilters (the engine behaviour it drives).
  • Chrome — it needs showToolbar to surface the button.

Live example

Filter builder — a per-column condition panel

Example source
import React from 'react'
import { BstTableMui } from '@bloomskill/table-mui'
import type { BstTableColumn } from '@bloomskill/table-engine'
import '@bloomskill/table-engine/styles.css'
type Row = { id: string; name: string; team: string; role: string; score: number }
const seed: Row[] = [
{ id: '1', name: 'Ada Lovelace', team: 'Platform', role: 'Engineer', score: 92 },
{ id: '2', name: 'Alan Turing', team: 'Research', role: 'Scientist', score: 88 },
{ id: '3', name: 'Grace Hopper', team: 'Platform', role: 'Engineer', score: 95 },
{ id: '4', name: 'Katherine J.', team: 'Research', role: 'Analyst', score: 90 },
{ id: '5', name: 'Edsger Dijkstra', team: 'Platform', role: 'Architect', score: 84 },
]
const columns: BstTableColumn<Row>[] = [
{ id: 'name', accessorKey: 'name', header: 'Name' },
{ id: 'team', accessorKey: 'team', header: 'Team' },
{ id: 'role', accessorKey: 'role', header: 'Role' },
{ id: 'score', accessorKey: 'score', header: 'Score', sortFn: 'basic' },
]
export default function App() {
return (
<BstTableMui data={seed} columns={columns} getRowId={(r) => r.id}
showFilterBuilder enableColumnFilterRow />
)
}
Loading live example…

Overview

Layershow* (chrome, resolved in the adapter)
Typeboolean
Defaultfalse
Maps toadapter panel hosting BstFilterBuilder
Status✅ done (Phase 3)
Sincev0.9.0
Settings sheetDisplay

Enable it

<BstTableMui
data={rows}
columns={columns}
enableColumnFilters // chrome is a no-op without its behaviour flag
showFilterBuilder
/>

Swap BstTableMui for BstTableShadcn (and the CSS import) for the shadcn skin — same props.

Behavior & interactions

  • Requires enableColumnFilters to be on — this flag is a no-op otherwise.

Spec coverage

Spec codes (A1, C2, X8, …) are Bst-Table's internal requirement IDs from the capability matrix; P0P2 mark the delivery phase. They are traceability tags, not part of the public API.

  • E3 · Advanced filtering — ✅ built. P3 — filter builder + bstCondition