Components
Filter
Code

Filter

Filter component

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

Parameters

props

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

Props

children

  • Type: @types/react.React.ReactNode

className (optional)

  • Type: string

defaultSearchValue (optional)

  • Type: string

defaultValue (optional)

  • Type: string | string[]

label

  • Type: string

messages (optional)

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

searchValue (optional)

  • Type: string

setSearchValue (optional)

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

setValue (optional)

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

value (optional)

  • Type: string | string[]

View source (opens in a new tab)

CodeCode