Skip to components
DEVELOPER REFERENCE · v4.0.0

FilterBadge API

Props, callbacks and methods. Select an underlined type to explore its fields, allowed values and callback arguments.

FilterBadge9 props1 callbacks0 methods

Props9

FilterBadge props
NameTypeDescription
classNameOptionalstring | undefinedAdditional CSS classes applied to the component root.
roleOptional"listitem" | undefinedAccessibility role used by the rendered element.
removeLabelOptionalstring | undefinedAccessible text or formatter for the remove-item action.
removeClassNameOptionalstring | undefinedAdditional CSS classes for the remove part of the component.
labelRequired
ComponentChildrenInspect type
Label content or accessible name for the component, as rendered by this control.
colorOptionalstring | undefinedCSS color used for this item or its visual accent.
detailsOptionalstring | undefinedSupplementary detail content associated with this item or message.
detailsLabelOptionalstring | undefinedAccessible label for the filter-details information action.
descriptionIdOptionalstring | undefinedID used to associate the explanatory content with its trigger.

Events and callbacks1

FilterBadge events and callbacks
NameTypeDescription
onRemoveOptional
(() => void) | undefinedInspect type
Requests removal of the indicated item; the application owns updating its data.

Methods0

No component-specific imperative methods. Use props and callbacks to control this component.