@hxui/angular/lib/filters/filters-config.interface.d.ts

* * *

import { FilterType } from './filters-type.enum';
export interface IFilterOption {
    label: string;
    value: any;
    icon?: string;
    selected: boolean;
}
export interface IFiltersConfig {
    /**
     * Unique identifier for filter
     */
    id: string;
    /**
     * Filter type, can be SingleSelect, MultiSelect or Search
     */
    type: FilterType;
    /**
     * Label that will appear in a button or search field placeholder
     */
    label: string;
    /**
     * Filter options for Single Select and MultiSelect types
     */
    options?: IFilterOption[];
    /**
     * Filter value for Search filter type
     */
    value?: string;
    /**
     * Filter character limit for Search filter type
     * Fire filter event if character >= this value
     *  Defaults to 2
     */
    charLimit?: number;
    /**
     * Index of default filter option.
     * The option to set when filters are cleared.
     */
    defaultIndex?: number;
}