Skip to main content

Filter Bar

Filter Bar is a widget that lets people narrow a list by several criteria, such as a member table or transaction history.

Import

import { FilterBar } from '@vortexlabs/vortex';
import type { FilterBarProps } from '@vortexlabs/vortex';

Allied components

Other links

FilterBar

FilterBar props
PropTypeDefaultAttributes
filters
array
No default value
value
indexed
No default value
defaultValue
indexed
No default value
onChange
callback
No default value
getResultCount
callback
No default value
labels
object
No default value
className
union
No default value
attributes
object
No default value

FilterBarFilter

FilterBarFilter options
PropTypeDefaultAttributes
id
string
No default value
label
string
No default value
options
array
No default value
selection
union
multiple
addable
boolean
No default value

FilterBarLabels

FilterBarLabels options
PropTypeDefaultAttributes
region
string
Filters
add
string
Add filter
clearAll
string
Clear all
close
string
Close
filters
string
Filters
formatApplied
callback
{count} applied
formatCount
callback
{count} selected
formatClear
callback
Clear {label} filter
formatShowResults
callback
Show {count} results

FilterTrigger

FilterTrigger props
PropTypeDefaultAttributes
options
array
No default value
label
string
No default value
value
array
No default value
onChange
callback
No default value
selection
union
multiple
onClear
callback
No default value
clearLabel
string
Clear {label} filter
formatCount
callback
{count} selected
iconOnly
boolean
No default value
icon
component
Plus icon
ariaLabel
string
No default value
open
boolean
No default value
defaultOpen
boolean
No default value
onOpen
callback
No default value
onClose
callback
No default value
className
union
No default value
attributes
object
No default value