Badge
A badge is a short coloured label that sits inside a sentence, such as a status or a version.
Example
Stable Beta Deprecated
mdx
<Badge color="green">Stable</Badge> <Badge color="amber">Beta</Badge> <Badge color="red">Deprecated</Badge>Props
colorstringThe tint.
| Value | Looks like |
|---|---|
gray | gray |
green | green |
blue | blue |
amber | amber |
red | red |
purple | purple |
childrentextrequiredThe label, between the tags. Keep it to a word or two.
Inside a sentence
A badge is inline, so write it on the same line as the text around it. On a line of its own it still works, but it sits alone.
This endpoint is Beta and may change.
mdx
This endpoint is <Badge color="amber">Beta</Badge> and may change.Not the same as page badges
A badge here is part of the page's text. The badge beside a page's name in the sidebar is a page setting.