ClayClay
  • Get Started
    • How to Use Clay
    • Composition Philosophy
    • How to Read This Documentation
    • Migrating From v2.x
    • Using Clay in JSPs
  • Components
    • Alert
    • Application Bar
    • Autocomplete
    • Badge
    • Breadcrumb
    • Button Group
    • Buttons
    • Card
    • Chart
    • Color Picker
    • Data Provider
    • Date Picker
    • Drop Down
    • Empty State
    • Form
      • Checkbox
      • Dual List Box
      • Input
      • Radio Group
      • Select
      • Select Box
      • Toggle Switch
    • Forms Hierarchy
    • Icon
    • Label
    • Layout
    • Link
    • List
    • Loading Indicator
    • Localized Input
    • Management Toolbar
    • Modal
    • Multi Select
    • Multi Step Nav
    • Nav
    • Navigation Bar
    • Pagination
    • Pagination Bar
    • Panel
    • Popover
    • Progress Bar
    • Sidebar
    • Slider
    • Sticker
    • Table
    • Tabs
    • Timelines
    • Time Picker
    • Toolbar
    • Tooltip
    • Upper Toolbar
  • Contributing
  • CSS Framework
    • Paver
    • SCSS
    • Color
    • Grid
    • Content
      • Typography
      • C Kbd
    • Utilities
      • Autofit
      • C Focus Inset
      • C Inner
      • C Spacing Utilities
      • Inline Item
    • Playground
  • Examples
  • Docs
  • Blog
  • Storybook
  • Codesandbox
  • Github
  • Use this menu to toggle between Atlas and Base Themes.

Label

yarn add @clayui/label

Labels are a visual pattern used to categorize information providing quick and easy recognition.

  • Examples
  • Markup
  • API

Stable3.4.1View in LexiconCHANGELOGstorybook demos

PropertyTypeRequiredDefaultDescription
dismissible
booleanfalseFlag to indicate if `label-dismissible` class should be applied.
displayType
'secondary' | 'info' | 'warning' | 'danger' | 'success' | 'unstyled'falseDetermines the style of the label.
large
booleanfalseFlag to indicate if the label should be of the `large` variant.
closeButtonProps
React.ButtonHTMLAttributes<HTMLButtonElement> & { ref?: (instance: HTMLButtonElement | null) => void; }falseHTML properties that are applied to the 'x' button.
innerElementProps
React.ComponentProps<typeof ClayLabelItemExpand>false{}Pros to add to the inner label item
spritemap
stringfalsePath to the location of the spritemap resource used for Icon.
withClose
booleanfalsetrueFlag to indicate if component should include the close button

How can this be improved? Create an issue!