Components
Filter
API Reference

API Reference

Filter component

<Filter label="Label">
  <FilterItem value="option">Option</FilterItem>
</Filter>

Parameters

props

  • Type: @vtex/shoreline-components.FilterProps & @types/react.React.RefAttributes<typescript.HTMLDivElement>

Props

children

Filter children

  • Type: @types/react.React.ReactNode

className (optional)

Additional className

  • Type: string

defaultSearchValue (optional)

Whether the filter is searchable by default

  • Type: string

defaultValue (optional)

Filter default value

  • Type: string | string[]

label

Filter label

  • Type: string

messages (optional)

Filter messages

  • Type: { apply: string; clear: string; }

searchValue (optional)

Whether the filter is searchable

  • Type: string

setSearchValue (optional)

Callback to set the filter search value

  • Type: @types/react.React.Dispatch<@types/react.React.SetStateAction<string>>

setValue (optional)

Callback to set the filter value

  • Type: @types/react.React.Dispatch<@types/react.React.SetStateAction<string>> | @types/react.React.Dispatch<@types/react.React.SetStateAction<string[]>>

value (optional)

Filter value

  • Type: string | string[]

View source (opens in a new tab)

FilterFilterApply