Interface FilterControlProps

interface FilterControlProps {
    filterButtonHref?: string;
    filterButtonLabel?: string;
    filterDisplay: "singleLine" | "multiLine";
    filterPlaceholder?: string;
    filters: Filter[];
    isDisabled?: boolean;
    onFiltersChange: ((newFilters) => void);
    onNavigate?: ((url) => void);
    onSearchChange?: ((newSearch) => void);
    searchDefaultValue?: string;
    searchPlaceholder?: string;
}

Properties

filterButtonHref? filterButtonLabel? filterDisplay filterPlaceholder? filters isDisabled? onFiltersChange onNavigate? onSearchChange? searchDefaultValue? searchPlaceholder?

Properties

Optional filterButtonHref

filterButtonHref?: string

Href for the apply filter button

Optional filterButtonLabel

filterButtonLabel?: string

Label for the apply filter button

filterDisplay

filterDisplay: "singleLine" | "multiLine"

Whether to display filter items on a single line (with left-right scroll) or multiple lines

Optional filterPlaceholder

filterPlaceholder?: string

Placeholder to display in the filter component when no filters selected

filters

filters: Filter[]

Current state of filters

Optional isDisabled

isDisabled?: boolean

Disables changes while loading or similar

onFiltersChange

onFiltersChange: ((newFilters) => void)

Callback when a filter is removed (x button clicked)

Type declaration

    • (newFilters): void

    • Callback when a filter is removed (x button clicked)

      Parameters

      Returns void

Optional onNavigate

onNavigate?: ((url) => void)

Standard onNavigate callback

Type declaration

    • (url): void

    • Standard onNavigate callback

      Parameters

      • url: string

      Returns void

Optional onSearchChange

onSearchChange?: ((newSearch) => void)

Callback when search text is changed and then enter pressed

Type declaration

    • (newSearch): void

    • Callback when search text is changed and then enter pressed

      Parameters

      • newSearch: string

      Returns void

Optional searchDefaultValue

searchDefaultValue?: string

Default value for the search (on first load)

Optional searchPlaceholder

searchPlaceholder?: string

Placeholder to display in the search component when no text entered

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc