Skip to content

Home > @liquidrazor/list-display > FiltersPanelProps

FiltersPanelProps interface

Props for the filters panel slot. This component is expected to surface controls for adjusting the active filter set.

Signature:

typescript
export interface FiltersPanelProps

Properties

Property

Modifiers

Type

Description

fields

Array<FieldSchema<any>>

Definitions for the fields that support filtering.

onChangeFilters?

(next: unknown) => void

(Optional) Handler to update the filter bag. The consumer should pass the next value that will be merged into the list state.

state

ListState<any>

Current list state including the active filters.