Officina UI
Components

FiltersProvider

Context provider that shares one useFilters store with FilterBar, FilterChips, and SavedViews.

FiltersProvider is the context that ties the filter components together. You build a filter store with the useFilters hook (passing your fields and mode) and hand its return value to the provider's value prop; everything rendered inside — FilterBar, FilterChips, SavedViews — then reads and mutates that same shared state without prop drilling. Wrap your filtering UI in it once near the top of the feature.

Example

Preview
import { FiltersProvider, FilterBar, useFilters } from '@officina/ui';

function PeopleFilters() {
  const filters = useFilters({
    mode: 'client',
    fields: [{ id: 'role', label: 'Role', type: 'enum' }],
  });
  return (
    <FiltersProvider value={filters}>
      <FilterBar />
    </FiltersProvider>
  );
}

API

PropTypeDefaultDescription
value*UseFiltersReturn<TRow>—

On this page