Skip to main content

FilterProps

Props for the Filter component.

Properties

className?

optional className: string

Class name for the filter container


disabled?

optional disabled: boolean

Whether the filter should be disabled


onChange?

optional onChange: VoidFuncNoParam

Event handler called when any filter interaction occurs


onStateChange()

onStateChange: (v) => void

Event handler called when the filter state changes

Parameters

v

BaseODataFilter

Returns

void


orientation?

optional orientation: FilterListOrientation

Position of the filter in the filter list


parentContextName?

optional parentContextName: string

Name of the parent component context, used for generating element Ids


propertyMeta

propertyMeta: PropertyMeta

Metadata of the property to filter


ref?

optional ref: Ref<FilterComponent>

Ref for accessing filter component methods


resetCounter?

optional resetCounter: number

Counter that triggers reset of input visibility


state

state: BaseODataFilter

Current state of the filter


type?

optional type: FilterType

Visual type of the filter