Set Filter

Prop enableSetFilter — engine behaviour, default false.

Guide

When to use it

Filtering categorical columns (status, type, owner) — a spreadsheet-style checklist of the distinct values instead of typing a condition.

How it works

Adds a checklist to the column's filter row: search, select-all / clear, per-value counts, and a (Blanks) option. Categorical columns (select / multiSelect / radio / boolean) are auto-eligible; force or opt out with meta.filter: 'set' / 'condition'.

Gotchas

• Requires enableColumnFilters + enableColumnFilterRow (it lives in that row).
• Distinct values come from the loaded data — in server mode, provide the facet list yourself.

Live example

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' },
]
const cols: BstTableColumn<Row>[] = columns.map((c) =>
  c.id === 'team' || c.id === 'role' ? { ...c, meta: { type: 'text', filter: 'set' } } : c)
export default function App() {
  return (
    <BstTableMui data={seed} columns={cols} getRowId={(r) => r.id}
      enableColumnFilters enableColumnFilterRow enableSetFilter showSearch={false} />
  )
}

Loading live example…

Overview

Layer	enable* (engine, resolved in useBstTable)
Type	boolean
Default	false
Maps to	custom — Excel-style checklist of distinct values per column in the filter row (BstSetFilter: search · select-all/clear · counts · (Blanks)). Writes an {op:'set'} condition through the bstCondition filterFn. Faceted — options come from v9's columnFacetingFeature (rows passing every OTHER column's filter), so the list narrows as you filter elsewhere; the column's own selection is excluded so a selection can always be widened again. Categorical columns (select/multiSelect/radio/boolean) auto-eligible; meta.filter: 'set'/'condition' forces/opts out. Needs enableColumnFilters + enableColumnFilterRow. In settings ("Data operations", always shown)
Status	✅ done
Since	v0.35.0
Settings sheet	Data operations

Set Filter — an Excel-style checklist of distinct values per column, rendered in the per-column filter row. When on, categorical columns (singleSelect / multiSelect / radio / boolean) use the checklist; any column can force it via meta.filter: 'set' or opt out via meta.filter: 'condition'. Needs enableColumnFilters + the filter row (enableColumnFilterRow) to be visible. Default: false.

Enable it

<BstTableMui
  data={rows}
  columns={columns}
  enableSetFilter
/>

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.
• Excel-style checklist of distinct values per column, rendered in the per-column filter row — so also turn on enableColumnFilterRow. Categorical columns (singleSelect / multiSelect / radio / boolean) are auto-eligible; force or skip per column via meta.filter: "set" | "condition".