Interface FilteringProps

Hierarchy

  • FilteringProps

Properties

disableInputIcon fetchFilters? filterInputProps? getColumnFilterValue isRangeInput multiple? prefetchedFilters? progressReporters render? renderCustomInput? type? updateFilterValue

Properties

disableInputIcon

disableInputIcon: boolean

Optional fetchFilters

fetchFilters?: ((key: string) => Promise<void>)

Type declaration

    • (key: string): Promise<void>

    • Parameters

      • key: string

      Returns Promise<void>

Optional filterInputProps

filterInputProps?: ((key: string) => InputHTMLAttributes<HTMLInputElement>)

Type declaration

    • (key: string): InputHTMLAttributes<HTMLInputElement>

    • Parameters

      • key: string

      Returns InputHTMLAttributes<HTMLInputElement>

getColumnFilterValue

getColumnFilterValue: ((key: string) => string | string[])

Type declaration

    • (key: string): string | string[]

    • Parameters

      • key: string

      Returns string | string[]

isRangeInput

isRangeInput: boolean

Optional multiple

multiple?: boolean

Optional prefetchedFilters

prefetchedFilters?: Record<string, string[]>

progressReporters

progressReporters: Set<DataFetchingDefinition>

Optional render

render?: ((text: string) => ReactNode)

Type declaration

    • (text: string): ReactNode

    • Parameters

      • text: string

      Returns ReactNode

Optional renderCustomInput

renderCustomInput?: ((handleChange: ((key: string, value: any) => void), value: any, rangeIndex: undefined | number) => ReactNode)

Type declaration

    • (handleChange: ((key: string, value: any) => void), value: any, rangeIndex: undefined | number): ReactNode

    • Render custom input element instead of default one.

      Parameters

      • handleChange: ((key: string, value: any) => void)

        Event to handle input change, mainly to update internal filter values.

          • (key: string, value: any): void

          • Event to handle input change, mainly to update internal filter values.

            Parameters

            • key: string
            • value: any

            Returns void

      • value: any

        Filter value to either pass or display in custom input.

      • rangeIndex: undefined | number

        Provides filter value indexes as 0 and 1 to index value array, in case range filter function is selected. Required only if filter functions are enabled.

      Returns ReactNode

Optional type

type?: "number" | "select" | "text" | "date"

updateFilterValue

updateFilterValue: ((key: string, value: string | string[]) => void)

Type declaration

    • (key: string, value: string | string[]): void

    • Parameters

      • key: string
      • value: string | string[]

      Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc