ComponentsFilterFilterProvider

FilterProvider

Provides context to Filter

<FilterProvider>
  <FilterTrigger>...</FilterTrigger>
  <FilterPopover>...</FilterPopover>
</FilterProvider>

Required props

children

Children of FilterProvider

type
React.ReactNode
default
null

Optional props

open

Whether the filter is open

type
boolean
default
null

setOpen

Callback to set the filter open state

type
React.Dispatch<React.SetStateAction<boolean>>
default
null

defaultOpen

Whether the filter is open by default

type
boolean
default
null

searchValue

Whether the filter is searchable

type
string
default
null

setSearchValue

Callback to set the filter search value

type
React.Dispatch<React.SetStateAction<string>>
default
null

defaultSearchValue

Whether the filter is searchable by default

type
string
default
null

value

Filter value

type
string
string[]
default
null

setValue

Callback to set the filter value

type
React.Dispatch<React.SetStateAction<string>>
React.Dispatch<React.SetStateAction<string[]>>
default
null

defaultValue

Filter default value

type
string
string[]
default
null