@bmsuisse/datagrid 0.35.3 → 0.37.0

package/dist/index.d.ts

@@ -258,6 +258,16 @@ type BooleanColumn<TRow> = BaseColumn<TRow> & {
 interface EnumOption {
     value: string;
     label: string;
+    /**
+     * Groups this option under a sticky header in `EnumFilter`'s dropdown,
+     * with a tri-state checkbox that selects/deselects the whole group at
+     * once — mirrors `@bmsuisse/ui`'s `ComboboxOption.group`/
+     * `TagComboboxOption.group`. Options sharing a `group` must be adjacent in
+     * `options`: a header renders the first time a group key is seen, so
+     * interleaved groups would render more than one header for the same key.
+     * Options with no `group` render individually, with no header.
+     */
+    group?: string;
 }
 type EnumColumn<TRow> = BaseColumn<TRow> & {
     type: "enum";
@@ -318,9 +328,22 @@ declare function DateRangeFilter<TRow>({ column, value, onChange, today, bare, }
  * - a tri-state "Select all" checkbox acts on whatever subset is currently
  *   visible after that search, not the full option set — matching Excel's
  *   own column-filter behavior ("select all of what's shown").
+ * - options sharing an `EnumOption.group` render under a sticky group
+ *   header with its own tri-state checkbox, letting a whole group be
+ *   selected/deselected in one click — mirrors `@bmsuisse/ui`'s
+ *   `Combobox`/`TagCombobox` grouped-dropdown treatment (sticky `bg-muted`
+ *   header, same contiguous-group chunking), kept as a local mirror rather
+ *   than a shared dependency since `datagrid` and `ui` are sibling packages
+ *   with no cross-dependency (see that package's `Combobox` doc, which
+ *   mirrors this component's own plain-substring search for the same
+ *   reason). The header's tri-state and toggle are scoped to that group's
+ *   currently-*visible* options, same as "Select all" — unlike `Combobox`,
+ *   which scopes its group toggle to the full option set regardless of
+ *   search.
  * - every visible option gets its own plain checkbox + label row (a real
- *   shadcn `Checkbox`, not a menu item), inside a scrollable list so long
- *   option lists don't blow up the popover's height.
+ *   shadcn `Checkbox`, not a menu item — unlike `Combobox`'s button/`role=
+ *   "option"` rows), inside a scrollable list so long option lists don't
+ *   blow up the popover's height.
  * - every toggle emits the updated `FilterDescriptor` immediately — there's
  *   no OK/Cancel step, matching every other filter widget in this package.
  *