Pill - React

Pill is a type of button that is often used as a filter, but can also be used as a rounded button for overlays, etc.

AndroidreleasedElementsreleasediOSreleasedReactreleasedVuereleased

React

AndroidElementsiOSReactVue

Import

You can import the component like so:

import { Pill } from '@warp-ds/react';

or import it individually to optimize your JS bundle size by adding only the components you need:

import { Pill } from '@warp-ds/react/components/pill';

Syntax

Filter Pill

<Pill label="Filter Pill" />

Filter Pill with changed pill screen reader label

<Pill label="Filter Pill" openSRLabel="Activate Filter" />

Closable Filter Pill

<Pill canClose label="Closable Filter Pill" />

Closable Filter Pill with changed close button screen reader label

<Pill canClose label="Closable Filter Pill" closeSRLabel="Deactivate Filter" />

Suggestion Pill

<Pill suggestion label="Suggestion Pill" />

Closable Suggestion Pill

<Pill suggestion canClose label="Closable Suggestion Pill" />

Props

Optional Props

Name	Type	Default	Description
label	string	undefined	The text content of the pill.
icon	ReactNode	undefined	Used to render an icon inside the pill. You can pass any valid HTML. This will override the label property. @deprecated Do not use.
canClose	boolean	false	Whether the pill should be removable via a close button.
openSRLabel	string	"Open filter"	Label read by screen readers when targeting the pill.
closeSRLabel	string	"Remove filter {label}"	Label read by screen readers when targeting the close button.
suggestion	boolean	false	Whether the pill should be rendered as a suggestion.
className	string	undefined	Additional classes applied to the button element of the pill as long as canClose is set to false.

Events

Name	Description
onClick	Action to be called when the pill is clicked.
onClose	Action to be called when the close button is clicked.

Questions?

Feel free to ask any questions on usage in the Warp DS Slack channel: #warp-design-system