Skip to main content

An official website of the United States government

Here's how you know

An official website of the United States government

Here's how you know

Theme:

Design system switcher

Version:

Design system switcher

Theme:

Design system switcher

Version:

Design system switcher

Filter Chip

Filter Chips are used to display dismissible filter chips.

Examples

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

The filter chip component has been tested against, and meets, WCAG 2.0 standards for size, color contrast, and screen reader usage.

  • The filter chip itself does not need a label, as the text content within it is sufficient. However, actions that the filter can take (like remove) do need to be labeled. You should take advantage of the ariaClearLabel prop to provide additional text for screen reader support.
  • The chip should receive focus.
  • Enter, Backspace, and Delete will remove the tag when it is in focus.

Accessibility testing

Screen reader testing

  • When navigating to a filter chip, screen readers should announce the label text and any actions (like remove) separately.
  • Screen readers should identify filter chips as buttons.

Keyboard testing

  • Users should be able to navigate to the chip with their keyboard.
  • Filter chips should receive focus.
  • Enter, Backspace, and Delete should remove the tag or otherwise trigger the filter action when it is in focus.

Code

React

Review Storybook for React guidance of this component.

Web Component

Go to Storybook for Web Component guidance of this component.

Style customization

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

CSS variables for filter-chip
VariableDefault Core Theme Value
--filter-chip__background-colorhex value: #e6f1f8--color-primary-lightest
--filter-chip__background-color--activehex value: #0071bc--color-primary
--filter-chip__border-colorhex value: #0071bc--color-primary
--filter-chip__border-color--activehex value: #0071bc--color-primary
--filter-chip__border-radius--radius-pill
--filter-chip__colorhex value: #262626--color-base
--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

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 Figma.
    Incomplete