Skip to main contentPrimer

Label

readyNot reviewed for a11y
Lookbook|Source
This page may be removed. Primer plans to move all Rails component documentation to Lookbook.

Description

Use Label to add contextual metadata to a design.

Accessibility

Use aria-label if the Label or the context around it don't explain the label.

Arguments

NameRequiredDescription
tag
Symbol

One of :a, :div, :span, or :summary.

scheme
Symbol

One of :accent, :attention, :danger, :default, :done, :info, :orange, :primary, :purple, :secondary, :severe, :sponsors, :success, or :warning.

size
Symbol

One of :large or :medium.

inline
Boolean

Whether or not to render this label inline.

variant
Symbol

One of :inline, :large, or :none.

system_arguments
Hash