DataViewFilters API
API reference docs for the Stash DataViewFilters component. Learn about the props, CSS, and other APIs of this exported module.
Import
ts
import DataViewFilters from '@leaflink/stash/DataViewFilters.vue';Props
| Name | Type | Default | Description |
|---|---|---|---|
| activeGroup | string | undefined | The name of the active filter group. The active filter group is determined by which instance of FilterDropdown or FilterDrawerItem is open. **Note:** This prop is required when using a "nested" `drawerStyle`, but has no effect when using a "cascade" `drawerStyle`. |
| drawerProps | ModalProps | undefined | |
| drawerStyle | DrawerStyles | cascade | 'cascade' displays all fields within every filter group; 'nested' displays only the group names and requires clicking a group to view its fields. |
| filtersLabelText | string | 't(ll.filterBy)' | |
| isLoading | false | ||
| onApply | OnApplyFilters | undefined | |
| searchBarProps | SearchBarProps | undefined | Props to pass to the `SearchBar` component. |
| showDrawerPreviousButton | boolean | false | |
| showSearch | boolean | true | |
| useFiltersInstance | UseFiltersReturnType | undefined | Required when using filters. This prop should contain the return value of the `useFilters()` composable. |
Slots
| Name | Description |
|---|---|
| filters-label | |
| default | |
| drawer |
Events
| Name | Description |
|---|---|
| open-drawer | When the drawer is opened |
| dismiss | When the drawer is dismissed |
| previous | When the "Previous" button in the header is clicked |
| reset-group | When the "Reset" button is clicked while viewing a filter group |
| reset-all | When one of the "Reset All" buttons is clicked |