Interface IFilterBoxProps

The class name added to the filebrowser crumbs node.

interface IFilterBoxProps {
    caseSensitive?: boolean;
    disabled?: boolean;
    filterSettingsChanged?: ISignal<unknown, {
        caseSensitive?: boolean;
        disabled?: boolean;
        filterSettingsChanged?: ISignal<unknown, { caseSensitive?: boolean | undefined; disabled?: boolean | undefined; forceRefresh?: boolean | undefined; initialQuery?: string | undefined; inputRef?: RefObject<HTMLInputElement> | undefined; ... 4 more ...; filterSettingsChanged?: ISignal<...> | undefined; }> | undefined;
        forceRefresh?: boolean;
        initialQuery?: string;
        inputRef?: RefObject<HTMLInputElement>;
        placeholder?: string;
        showIcon?: boolean;
        updateFilter?: ((filterFn, query?) => void);
        useFuzzyFilter?: boolean;
    }>;
    forceRefresh?: boolean;
    initialQuery?: string;
    inputRef?: RefObject<HTMLInputElement>;
    placeholder?: string;
    showIcon?: boolean;
    updateFilter: ((filterFn, query?) => void);
    useFuzzyFilter?: boolean;
}

Properties

caseSensitive? disabled? filterSettingsChanged? forceRefresh? initialQuery? inputRef? placeholder? showIcon? updateFilter useFuzzyFilter?

Properties

Optional caseSensitive

caseSensitive?: boolean

Whether to use case-sensitive search

Optional disabled

disabled?: boolean

Whether the search box is disabled or not.

Optional filterSettingsChanged

filterSettingsChanged?: ISignal<unknown, {
    caseSensitive?: boolean;
    disabled?: boolean;
    filterSettingsChanged?: ISignal<unknown, { caseSensitive?: boolean | undefined; disabled?: boolean | undefined; forceRefresh?: boolean | undefined; initialQuery?: string | undefined; inputRef?: RefObject<HTMLInputElement> | undefined; ... 4 more ...; filterSettingsChanged?: ISignal<...> | undefined; }> | undefined;
    forceRefresh?: boolean;
    initialQuery?: string;
    inputRef?: RefObject<HTMLInputElement>;
    placeholder?: string;
    showIcon?: boolean;
    updateFilter?: ((filterFn, query?) => void);
    useFuzzyFilter?: boolean;
}>

Signal emitted when filter settings change

Type declaration

  • Optional caseSensitive?: boolean

    Whether to use case-sensitive search

  • Optional disabled?: boolean

    Whether the search box is disabled or not.

  • Optional filterSettingsChanged?: ISignal<unknown, { caseSensitive?: boolean | undefined; disabled?: boolean | undefined; forceRefresh?: boolean | undefined; initialQuery?: string | undefined; inputRef?: RefObject<HTMLInputElement> | undefined; ... 4 more ...; filterSettingsChanged?: ISignal<...> | undefined; }> | undefined

    Signal emitted when filter settings change

  • Optional forceRefresh?: boolean

    Whether to force a refresh.

  • Optional initialQuery?: string

    An optional initial search value.

  • Optional inputRef?: RefObject<HTMLInputElement>

    Pass a ref to the input element

  • Optional placeholder?: string

    Optional placeholder for the search box.

  • Optional showIcon?: boolean

    Whether to show a search icon in the box.

  • Optional updateFilter?: ((filterFn, query?) => void)

    A function to callback when filter is updated.

  • Optional useFuzzyFilter?: boolean

    Whether to use the fuzzy filter.

Optional forceRefresh

forceRefresh?: boolean

Whether to force a refresh.

Optional initialQuery

initialQuery?: string

An optional initial search value.

Optional inputRef

inputRef?: RefObject<HTMLInputElement>

Pass a ref to the input element

Optional placeholder

placeholder?: string

Optional placeholder for the search box.

Optional showIcon

showIcon?: boolean

Whether to show a search icon in the box.

updateFilter

updateFilter: ((filterFn, query?) => void)

A function to callback when filter is updated.

Type declaration

Optional useFuzzyFilter

useFuzzyFilter?: boolean

Whether to use the fuzzy filter.

Settings

Member Visibility

Theme

On This Page

caseSensitivedisabledfilterSettingsChangedforceRefreshinitialQueryinputRefplaceholdershowIconupdateFilteruseFuzzyFilter