Tag
<sc-tag> | ScTag
Tags are used as labels to organize things or to indicate a selection.
<sc-tag variant="primary">Primary</sc-tag> <sc-tag variant="success">Success</sc-tag> <sc-tag variant="neutral">Neutral</sc-tag> <sc-tag variant="warning">Warning</sc-tag> <sc-tag variant="danger">Danger</sc-tag>
import ScTag from '@styledc-dev/styledc/dist/react/tag'; const App = () => ( <> <ScTag variant="primary">Primary</ScTag> <ScTag variant="success">Success</ScTag> <ScTag variant="neutral">Neutral</ScTag> <ScTag variant="warning">Warning</ScTag> <ScTag variant="danger">Danger</ScTag> </> );
Examples
Sizes
Use the size
attribute to change a tab’s size.
<sc-tag size="small">Small</sc-tag> <sc-tag size="medium">Medium</sc-tag> <sc-tag size="large">Large</sc-tag>
import ScTag from '@styledc-dev/styledc/dist/react/tag'; const App = () => ( <> <ScTag size="small">Small</ScTag> <ScTag size="medium">Medium</ScTag> <ScTag size="large">Large</ScTag> </> );
Pill
Use the pill
attribute to give tabs rounded edges.
<sc-tag size="small" pill>Small</sc-tag> <sc-tag size="medium" pill>Medium</sc-tag> <sc-tag size="large" pill>Large</sc-tag>
import ScTag from '@styledc-dev/styledc/dist/react/tag'; const App = () => ( <> <ScTag size="small" pill> Small </ScTag> <ScTag size="medium" pill> Medium </ScTag> <ScTag size="large" pill> Large </ScTag> </> );
Removable
Use the removable
attribute to add a remove button to the tag.
<div class="tags-removable"> <sc-tag size="small" removable>Small</sc-tag> <sc-tag size="medium" removable>Medium</sc-tag> <sc-tag size="large" removable>Large</sc-tag> </div> <script> const div = document.querySelector('.tags-removable'); div.addEventListener('sc-remove', event => { const tag = event.target; tag.style.opacity = '0'; setTimeout(() => (tag.style.opacity = '1'), 2000); }); </script> <style> .tags-removable sc-tag { transition: var(--sc-transition-medium) opacity; } </style>
import ScTag from '@styledc-dev/styledc/dist/react/tag'; const css = ` .tags-removable sc-tag { transition: var(--sc-transition-medium) opacity; } `; const App = () => { function handleRemove(event) { const tag = event.target; tag.style.opacity = '0'; setTimeout(() => (tag.style.opacity = '1'), 2000); } return ( <> <div className="tags-removable"> <ScTag size="small" removable onScRemove={handleRemove}> Small </ScTag> <ScTag size="medium" removable onScRemove={handleRemove}> Medium </ScTag> <ScTag size="large" removable onScRemove={handleRemove}> Large </ScTag> </div> <style>{css}</style> </> ); };
Importing
If you’re using the autoloader or the traditional loader, you can ignore this section. Otherwise, feel free to use any of the following snippets to cherry pick this component.
To import this component from the CDN using a script tag:
<script type="module" src="https://cdn.jsdelivr.net/npm/@styledc-dev/styledc@1.0.0/cdn/components/tag/tag.js"></script>
To import this component from the CDN using a JavaScript import:
import 'https://cdn.jsdelivr.net/npm/@styledc-dev/styledc@1.0.0/cdn/components/tag/tag.js';
To import this component using a bundler:
import '@styledc-dev/styledc/dist/components/tag/tag.js';
To import this component as a React component:
import ScTag from '@styledc-dev/styledc/dist/react/tag';
Slots
Name | Description |
---|---|
(default) | The tag’s content. |
Learn more about using slots.
Properties
Name | Description | Reflects | Type | Default |
---|---|---|---|---|
variant
|
The tag’s theme variant. |
|
'primary' | 'success' | 'neutral' | 'warning' | 'danger' | 'text'
|
'neutral'
|
size
|
The tag’s size. |
|
'small' | 'medium' | 'large'
|
'medium'
|
pill
|
Draws a pill-style tag with rounded edges. |
|
boolean
|
false
|
removable
|
Makes the tag removable and shows a remove button. |
boolean
|
false
|
|
updateComplete |
A read-only promise that resolves when the component has finished updating. |
Learn more about attributes and properties.
Events
Name | React Event | Description | Event Detail |
---|---|---|---|
sc-remove |
onScRemove |
Emitted when the remove button is activated. | - |
Learn more about events.
Parts
Name | Description |
---|---|
base |
The component’s base wrapper. |
content |
The tag’s content. |
remove-button |
The tag’s remove button, an <sc-icon-button> . |
remove-button__base |
The remove button’s exported base part. |
Learn more about customizing CSS parts.
Dependencies
This component automatically imports the following dependencies.
<sc-icon>
<sc-icon-button>