Label

Label is deprecated. Use Badge with the color prop instead — every Label color is supported by Badge and renders identically (color="outline" becomes color="neutral-outline"). Label rendered a <span> while Badge renders a <div> by default — add as="span" to migrated Badges that sit in text flow (paragraphs, headings, links, buttons). Never use Label in new code. Label will be removed in a future major version.

Usage

• Use Labels to indicate status or categorize items with short descriptive text (e.g., "Active", "Draft").
• Use Badges, not Labels, to display numeric quantities (e.g., notification counts).
• Use Tags, not Labels, for user-generated, interactive categorization that users can create, edit, or remove. Labels are read-only system indicators.

Variants

• Base (default) — no status indicator dot. Use for categorical attributes that describe what something is: types, tiers, roles, tags.
• Status (showStatusIndicator) — includes a colored dot. Use for operational status that describes where something is in its lifecycle: online/offline, running/stopped, active/draft.

Appearance

• color — available values: red, raspberry, clementine, yellow, green, teal, blue, plum, purple, grey, outline. Default is grey.
• Use color consistently across the application for the same or similar statuses. Never use color purely for decoration.
• Status indicator colors — only red, yellow, green, blue, purple, and grey support the status indicator dot.
• Semantic color mapping: red = critical/destructive, yellow = warning, green = success/functional, blue = info, grey = neutral.
• bold — defaults to true. Set bold={false} for less visually prominent Labels. Light text is not compatible with status indicators.

Content

• Limit text to one or two words.
• Use sentence case.
• Accurately describe the category or status.
• Never use long phrases or full sentences.

Implementation Notes

• showStatusIndicator restricts color to red, yellow, green, blue, purple, or grey. Other colors throw a runtime error.
• showStatusIndicator requires bold to remain true (the default). Setting bold={false} with showStatusIndicator throws a runtime error.
• Content — React uses children for label text. Ember uses {{yield}} (default block) via <PlumaLabel>Text</PlumaLabel>.
• Label extends Text — it renders as a <span> by default and can be changed via the as prop.