Interface FilterPageProps

interface FilterPageProps {
    labels: {
        applyFiltersButton: string;
        resetFiltersButton: string;
    };
    onApplyFiltersClicked: ((filters) => void);
    onFiltersChange: ((filters) => void);
    selectableFilterGroups: FilterGroup[];
    selectableFilters: ReactNode[];
    selectedFilters: string[];
}

Properties

labels onApplyFiltersClicked onFiltersChange selectableFilterGroups selectableFilters selectedFilters

Properties

labels

labels: {
    applyFiltersButton: string;
    resetFiltersButton: string;
}

Labels for standard filter page

Type declaration

  • applyFiltersButton: string
  • resetFiltersButton: string

onApplyFiltersClicked

onApplyFiltersClicked: ((filters) => void)

Callback when the apply filters button is clicked

Type declaration

    • (filters): void

    • Callback when the apply filters button is clicked

      Parameters

      • filters: string[]

      Returns void

onFiltersChange

onFiltersChange: ((filters) => void)

Callback when a filter is added/removed

Type declaration

    • (filters): void

    • Callback when a filter is added/removed

      Parameters

      • filters: string[]

      Returns void

selectableFilterGroups

selectableFilterGroups: FilterGroup[]

Selectable filter groups to display

selectableFilters

selectableFilters: ReactNode[]

Selectable filters to display

selectedFilters

selectedFilters: string[]

Currently selected filters. Keys should be given as groupName.key

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc