Components
Filter menu
A component used to apply category-specific filters for a dataset.
Basic usage
First, import the component.
import {FilterMenu} from '@pleo-io/telescope'
Then use it like so:
See the examples for more guidance.
API reference
FilterMenu
Contains all of the filter menu parts.
| Prop | Type | Default |
|---|---|---|
onClose | function | |
onOpen | function |
Trigger
A wrapper around the toggle component that takes care of opening the filter menu. Exposed in case a custom toggle element is needed.
This component doesn't accept any custom props.
Toggle
The button that toggles the filter menu. Should contain the filter category.
| Prop | Type | Default |
|---|---|---|
hasAppliedFilters | boolean | |
loading | boolean | |
loadingText | string | |
maxWidth | string | |
moreFilters | boolean | |
numAppliedFilters | number | |
skeleton | boolean | false |
Content
Place filtering elements (checboxes, search fields, etc.) within this component.
| Prop | Type | Default |
|---|---|---|
align | enum | start |
Actions
Container for "Clear" and "Apply" actions.
This component doesn't accept any custom props.
Clear
Button that should be used to clear interim filters. Clicking this button should not be used to change which filters are applied and should thus not update the page results.
This component doesn't accept any custom props.