Skip to main content
U.S. Flag

An official website of the United States government

Filter Chip

Filter Chips are used to display dismissible filter chips.

Examples

Loading

Code

React

React Properties Documentation
NameTypeDefaultDescription
idstringId for filter chip button. If not provided, a unique id will be automatically generated and used.
classNamestringClass to be applied to the outer <div> that contains filter chip button.
labelrequiredstringText for the filter chip.
ariaClearLabelstringLabels filter action, i.e., "Remove." For screenreader support.
onDeleterequired() => voidFunction to call when filter chip is dismissed.
useAlternateIconbooleanUse alternate thinner close icon in place of standard.
size"big"Sets the size of the chip to larger version.

Styles

The following CSS variables can be overridden to customize FilterChip components:

CSS variables for filter-chip
VariableDefault Core Theme Value
--filter-chip__border-radius9999px
--filter-chip__background-colorhex value: #e6f9fd--color-primary-alt-lightest
--filter-chip__border-colorhex value: #0071bc--color-primary
--filter-chip__colorhex value: #262626--color-base
--filter-chip__background-color--activehex value: #0071bc--color-primary
--filter-chip__border-color--activehex value: #0071bc--color-primary
--filter-chip__color--activehex value: #ffffff--color-white
--filter-chip-icon__colorhex value: #262626--color-base
--filter-chip-icon__color-activehex value: #ffffff--color-white
--filter-chip-icon__container-size18px

Guidance

When to use

  • Use to clearly indicate to the user what filters have been applied to a set of results and provide a quick and easy way to remove a selected filter

When to consider alternatives

  • When many filter chips would be displayed and available screen real estate is limited
  • When a badge is sufficient in place of a filter chip

Usage

  • Do not mix badges and filter chip as it can be confusing to the user
  • Do not use filter chip when a badge is sufficient, i.e., when none of the tags are removable
  • Filter chips should be short and not wrap to the second line
  • Allow adequate spacing (at least 8px) between each filter chip, as much as the design will allow.
  • The colors of the Filter Chip can be overriden using the CSS variables listed below, but should not be overriden with colors outside of the color palette.

Accessibility

  • Enter, Backspace, Delete, and Spacebar will remove the tag when it is in focus

Component maturity

For more information about how we tested and validated our work for each checklist item, read our component maturity documentation.

Accessibility

  • Color

    Meets AA color contrast standards for accessibility and color blindness.
    Complete
  • Forced Colors Mode (FCM)

    While using FCM the components text is legible and improves readability.
    Complete
  • WCAG 2.1 Level AA Conformance

    All Axe checks for WCAG AA compliance have passed.
    Complete
  • Screen readers

    VoiceOver, NVDA, and JAWS screen readers provide concise communication and interaction.
    Complete
  • Keyboard navigation

    Component is fully navigable with a keyboard.
    Complete

Code

  • Storybook

    Component has stories to cover all defined props.
    Complete
  • Responsive

    Component designed to work in all responsive breakpoints.
    Complete
  • Spanish translations

    Includes Spanish translations for default text content.
    Complete

Tokens

  • Code

    Tokens implemented in code.
    Complete
  • Design

    Tokens implemented in the Sketch.
    Complete