FilterMenu API
API reference docs for theFilterMenucomponent. For examples and details on the usage of this component, visit the component demo page.
Props
| Props | Type | Description | Default |
|---|---|---|---|
children | ((menuState: { isMenuOpen: boolean; triggerProps: TriggerProps }) => ReactNode) | ReactNode | Accepts either a React node or a render function. The render function provides the menu's state (isMenuOpen) and accessibility/interaction props (triggerProps) for the trigger. | _ |
closeButtonPropsForMobile? | { label: string, onClick: () => void, size?: IconButtonProps['size'] } | Props for the close button that appears on mobile. | _ |
mobileFriendly? | boolean | Indicates whether the filter menu should be displayed as a sheet on mobile devices. | true |
popoverMatchReferenceWidth? | boolean | Match the width of the popover with the reference element. | false |
popoverMaxHeight? | number | The max height of the filter menu popover. | 356 |
popoverMaxWidth? | number | The max width of the filter menu popover. | 400 |
popoverOffset? | number | The offset of the filter menu popover. | 4 |
popoverPlacement? | 'bottom' | 'bottom-start' | 'bottom-end' | The placement of the filter menu popover in relation to the trigger. | 'bottom-start' |
strategy? | 'absolute' | 'fixed' | The strategy used to position the floating element. | 'absolute' |
titleForMobile? | string | If titleForMobile is provided then the mobile sheet view will have a header with title rendered | _ |