Filter menu allows user to filter the data in a table or a list.
The filter menu button (and icon button) can be disabled.
You can also disable individual filter menu options instead of the entire button.
Root-level component for adding a menu.
All menu-related components must be children of FilterMenu
.
Name | Default | Description |
---|---|---|
children | — | ReactNode Menu button and list. |
Button for opening a menu.
Name | Default | Description |
---|
Icon-only button for opening a menu.
Name | Default | Description |
---|
Wrapper for groups.
Name | Default | Description |
---|---|---|
children | — | ReactNode Groups. |
Grouping of options.
Type: ReactNode
Options.
Type: string
Group title displayed above options.
Type: "radio" | "checkbox"
Selection type.
Use radio
to allow a single option to be selected.
Use checkbox
to allow multiple options to be selected.
Type: string | string[]
Selection.
When type
is "radio"
, value is always a string.
When type
is "checkbox"
, value is always an array of strings.
Type: ((value: string) => void) | (value: string[]) => void)
Callback for when user selects a single or multiple options, depending on the type
prop.
When type
is "radio"
, value
is always a string.
When type
is "checkbox"
, value
is always an array of strings.
Name | Default | Description |
---|---|---|
isDisabled | — | boolean Determines if option is disabled. |
children | — | ReactNode Option text. |
value | — | string Option value. Used to identify this option in a selection. |