Filter

API reference

calcite-filter
v1.0.0-beta.83

Properties

PropertyAttributeDescriptionTypeValues
disableddisabled

When true, disabled prevents interaction. This state shows items with lower opacity/grayed.

booleanA boolean property should be present, or not
truefalse
filteredItems

The resulting items after filtering.

read-only
typedChoose from a set of typed values
object[]
intlClearintl-clear

A text label that will appear on the clear button.

optional
stringA custom string
undefined
intlLabelintl-label

A text label that will appear next to the input field.

optional
stringA custom string
undefined
items

The items to filter through. The filter uses this as the starting point, and returns items that contain the string entered in the input, using a partial match and recursive search. This property is required.

typedChoose from a set of typed values
object[]
placeholderplaceholder

Placeholder text for the input element's placeholder attribute

optional
stringA custom string
undefined
scalescale

specify the scale of filter, defaults to m

typedChoose from a set of typed values
lm (default)s
valuevalue

Filter value.

stringA custom string
"" (default)

Events

NameDescriptionDetail
calciteFilterChange

This event fires when the filter text changes.

bubblescomposedcancelable
void

Methods

NameDescriptionSignatureReturns
setFocus

Sets focus on the component.

setFocus() => Promise<void>Promise<void>

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.