Componentsv2.189.1
Iconsv1.19.0
MCPv0.8.62
Tokensv0.34.3

Labels are read-only indicators used to communicate a category, metadata, or process's current state.

Importing

The component can be imported via:

import { Label } from '@customerio/pluma-components/react';

Usage

Loading editor

Colors

The Label component accepts a range of colors via the color prop, the default being grey:

Loading editor

Loading editor

Loading editor

Loading editor

Loading editor

Loading editor

Loading editor

Loading editor

Loading editor

Loading editor

Loading editor

Text style

By default, the text in a label renders in a bold font. By calling the component with the bold set to false, it renders in a lighter weight:

Loading editor

Status indicator

In certain scenarios, a PlumaLabel may be used to indicate the current status of a process or item. By enabling the showStatusIndicator argument, a PlumaLabel will render with a colored dot to communicate the status:

Loading editor

Loading editor

Loading editor

Loading editor

Note: The status indicator is only available for the following colors:

  • red
  • yellow
  • green
  • grey

Attempting to enable the status indicator with a different color will throw an error. Similarly, the light text version of bold={false} is also not allowed.

API

Label extends Text

Default:true

Whether the label should render in a bold font weight

Default:grey

The visual style of the label. Note: When using status indicators, only red, yellow, green, blue, purple, and grey colors are supported.

Default:false

Whether the label should show a status indicator colored dot

On this page