Badge
⟦Šhórt lábél fór á štáté, çátégórý, ór çóúñt.~~~~~~~~~~~~~~~~⟧
- ⟦Brówšérš~~~⟧
- Chrome 123+Firefox 121+Safari 17.5+
- ⟦Tíér~~⟧
- 0
- ⟦Búñdlé çómpréššéd~~~~~~⟧
- 201 B
- ⟦Fórçéd láýóút búdgét~~~~~~~⟧
- 0 ms
- ⟦Áxé búdgét~~~~⟧
- 0
- ⟦ŠŠR çómpátíblé~~~~~⟧
- ⟦Ýéš~~⟧
- ⟦Públíšhéd çóñtráçt~~~~~~~⟧
- ⟦Téšt hárñéšš~~~~~⟧
⟦Pláýgróúñd~~~~⟧
Badge
Ready⟦Éxámpléš~~~⟧
Status labels
Use visible words to convey state; color is a supporting cue.
DraftReadyReviewBlocked
import { Badge } from "@gunkin/uiify";
export default function Example() {
return (
<>
<Badge variant="secondary">Draft</Badge>
<Badge variant="success">Ready</Badge>
<Badge variant="warning">Review</Badge>
<Badge variant="destructive">Blocked</Badge>
</>
);
}⟦ÁPÍ~~⟧
Badge
| ⟦Próp~~⟧ | ⟦Týpé~~⟧ | ⟦Défáúlt~~~⟧ | ⟦Déšçríptíóñ~~~~⟧ |
|---|---|---|---|
children | ReactNode | — | ⟦Téxt šhówñ íñšídé thé bádgé.~~~~~~~~~~⟧ |
variant | "secondary" | "success" | "warning" | "destructive" | — | ⟦Víšúál méáñíñg wríttéñ tó dátá-váríáñt; kéép štátúš úñdérštáñdáblé íñ téxt.~~~~~~~~~~~~~~~~~~~~~~~~~~~⟧ |
size | "sm" | "md" | "lg" | — | ⟦Víšúál šçálé wríttéñ tó dátá-šížé; ómíttéd whéñ úñšét.~~~~~~~~~~~~~~~~~~~⟧ |
as | ElementType | "span" | ⟦Ñátívé éléméñt ór çómpóñéñt úšéd fór thé róót.~~~~~~~~~~~~~~~~~⟧ |
className | string | — | ⟦Çlášš ápplíéd tó thé róót éléméñt.~~~~~~~~~~~~⟧ |
style | CSSProperties | — | ⟦Ñátívé róót štýléš.~~~~~~~⟧ |
ref | Ref<HTMLElement> | — | ⟦Réf fórwárdéd tó thé réñdéréd róót éléméñt.~~~~~~~~~~~~~~~~⟧ |
render | ReactElement | ((props, state) => ReactElement) | — | ⟦Répláçé thé réñdéréd éléméñt whílé kéépíñg béhávíór áñd áççéššíbílítý wíríñg.~~~~~~~~~~~~~~~~~~~~~~~~~~~⟧ |
⟦Kéýbóárd~~~⟧
| ⟦Kéý~~⟧ | ⟦Áçtíóñ~~~⟧ |
|---|
⟦Áççéššíbílítý~~~~~⟧
⟦Štátíç téxt márkér wíth ñó rólé ór kéýbóárd béhávíór. Kéép ítš méáñíñg íñ víšíblé wórdš áñd dó ñót úšé ít áš á çóñtról.~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~⟧
⟦Štýlíñg hóókš~~~~~⟧
data-uiify-badgedata-variantdata-size