Label

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

install	yarn add @clayui/label
version	3.88.0

Stable 3.88.0 View in Lexicon CHANGELOG

Colors
- Sass API
Sizes
- Sass API
Variations
- Simple
- Dismissible
- Link
- Interactive
- Anchor Tag

Colors

Primary Secondary Info Warning Danger Success Light Dark

Code Sample (expand to see it)

<span class="label label-primary">
	<span class="label-item label-item-expand">Primary</span>
</span>
<span class="label label-secondary">
	<span class="label-item label-item-expand">Secondary</span>
</span>
<span class="label label-info">
	<span class="label-item label-item-expand">Info</span>
</span>
<span class="label label-warning">
	<span class="label-item label-item-expand">Warning</span>
</span>
<span class="label label-danger">
	<span class="label-item label-item-expand">Danger</span>
</span>
<span class="label label-success">
	<span class="label-item label-item-expand">Success</span>
</span>
<span class="label label-light">
	<span class="label-item label-item-expand">Light</span>
</span>
<span class="label label-dark">
	<span class="label-item label-item-expand">Dark</span>
</span>

Primary Secondary Info Warning Danger Success Light Dark

Code Sample (expand to see it)

<span class="label label-inverse-primary">
	<span class="label-item label-item-expand">Primary</span>
</span>
<span class="label label-inverse-secondary">
	<span class="label-item label-item-expand">Secondary</span>
</span>
<span class="label label-inverse-info">
	<span class="label-item label-item-expand">Info</span>
</span>
<span class="label label-inverse-warning">
	<span class="label-item label-item-expand">Warning</span>
</span>
<span class="label label-inverse-danger">
	<span class="label-item label-item-expand">Danger</span>
</span>
<span class="label label-inverse-success">
	<span class="label-item label-item-expand">Success</span>
</span>
<span class="label label-inverse-light">
	<span class="label-item label-item-expand">Light</span>
</span>
<span class="label label-inverse-dark">
	<span class="label-item label-item-expand">Dark</span>
</span>

Label Variant Sass API

The map $label-palette allows generating any number of label variants. If a key starts with ., #, or % Clay will output it as is, otherwise we will prepend .label- to the key (e.g., .label-primary). It will also generate a Sass placeholder prefixed by %label- (e.g., %label-primary).

$label-palette: (
    primary: (
        background-color: $primary,
    ),
    '.label-primary-2': (
        extend: '%label-primary',
    ),
    '%label-tertiary': (
        background-color: green,
    ),
    '.label-tertiary': (
        extend: '%label-tertiary',
    ),
    '.label-quaternary': (
        extend: '%label-tertiary',
    ),
);

Outputs:

.label-primary, .label-primary-2 {
    background-color: #0b5fff;
}

.label-tertiary, .label-quaternary {
    background-color: green;
}

Sizes

Use label-lg to make the label larger, or use the mixin label-size($sassMap) to create a custom sized label:

Normal Label Large Label

Code Sample (expand to see it)

<span class="label label-secondary">
	<span class="label-item label-item-expand"> Normal Label </span>
</span>
<span class="label label-lg label-success">
	<span class="label-item label-item-expand"> Large Label </span>
</span>

Label Size Sass API

The map $label-sizes allows generating any number of label size variants. If a key starts with ., #, or % Clay will output it as is, otherwise it will prepend . to the key (e.g., .label-lg). It will also generate a Sass placeholder prefixed by % (e.g., %label-lg).

$label-sizes: (
    label-lg: (
        font-size: 16px,
    ),
    '.label-xl': (
        extend: '%label-lg',
    ),
    '%label-sm': (
        font-size: 12px,
    ),
    '.label-sm': (
        extend: '%label-sm',
    ),
);

Outputs:

.label-lg, .label-xl {
    font-size: 16px;
}

.label-sm {
    font-size: 12px;
}

Variations

Simple

Simple Label

Code Sample (expand to see it)

<span class="label label-secondary">
	<span class="label-item label-item-expand"> Simple Label </span>
</span>

Dismissible

Label Dismissible

Code Sample (expand to see it)

<span class="label label-dismissible label-secondary">
	<span class="label-item label-item-before">
		<span class="sticker"> ... </span>
	</span>
	<span class="label-item label-item-before"> ... </span>
	<span class="label-item label-item-before"> ... </span>
	<span class="label-item label-item-expand">
		<a href="#1">Label Dismissible</a>
	</span>
	<span class="label-item label-item-after">
		<button aria-label="Close" class="close" type="button">...</button>
	</span>
</span>

Link

Label with Link

Code Sample (expand to see it)

<span class="label label-dismissible label-lg label-success">
	<span class="label-item label-item-before">
		<span class="sticker"> ... </span>
	</span>
	<span class="label-item label-item-before"> ... </span>
	<span class="label-item label-item-before"> ... </span>
	<span class="label-item label-item-expand">
		<a href="#1">Label with Link</a>
	</span>
	<span class="label-item label-item-after">
		<button aria-label="Close" class="close" type="button">...</button>
	</span>
</span>

Interactive

Add the tabindex="0" attribute to the .label element to create an interactive label with multiple controls inside. The inner controls should have the attribute tabindex="-1" to remove them from the tab order. The inner controls can be placed back in the tab order by changing back to tabindex="0" with javascript.

Implementing Interactive Labels require custom javascript.

Interactive Label

Code Sample (expand to see it)

<span class="label label-dismissible label-secondary" tabindex="0">
	<span class="label-item label-item-before">
		<span class="sticker">
			<span class="sticker-overlay">
				<img
					alt="thumbnail"
					class="sticker-img"
					src="/images/thumbnail_dock.jpg"
				/>
			</span>
		</span>
	</span>
	<span class="label-item label-item-before">
		<button class="btn btn-unstyled" type="button" tabindex="-1">
			<svg
				class="lexicon-icon lexicon-icon-times-circle"
				focusable="false"
				role="presentation"
			>
				<use xlink:href="/images/icons/icons.svg#times-circle"></use>
			</svg>
		</button>
	</span>
	<span class="label-item label-item-before">
		<a href="#1" role="button" tabindex="-1">
			<svg
				class="lexicon-icon lexicon-icon-add-cell"
				focusable="false"
				role="presentation"
			>
				<use xlink:href="/images/icons/icons.svg#add-cell"></use>
			</svg>
		</a>
	</span>
	<span class="label-item label-item-expand">
		<a href="#1" tabindex="-1">Interactive Label</a>
	</span>
	<span class="label-item label-item-after">
		<button aria-label="Close" class="close" tabindex="-1" type="button">
			<svg
				class="lexicon-icon lexicon-icon-times"
				focusable="false"
				role="presentation"
			>
				<use xlink:href="/images/icons/icons.svg#times"></use>
			</svg>
		</button>
	</span>
</span>

Anchor Tag

Primary Secondary Success Info Warning Danger Light Dark

Code Sample (expand to see it)

<a class="label label-primary" href="#1">
	<span class="label-item label-item-expand">Primary</span>
</a>
<a class="label label-secondary" href="#1">
	<span class="label-item label-item-expand">Secondary</span>
</a>
<a class="label label-success" href="#1">
	<span class="label-item label-item-expand">Success</span>
</a>
<a class="label label-info" href="#1">
	<span class="label-item label-item-expand">Info</span>
</a>
<a class="label label-warning" href="#1">
	<span class="label-item label-item-expand">Warning</span>
</a>
<a class="label label-danger" href="#1">
	<span class="label-item label-item-expand">Danger</span>
</a>
<a class="label label-light" href="#1">
	<span class="label-item label-item-expand">Light</span>
</a>
<a class="label label-dark" href="#1">
	<span class="label-item label-item-expand">Dark</span>
</a>