Badge

A small, distinct component that displays the status or classification of an item.

Import

import { Badge } from '@vortex-kit/vortex';
import type { BadgeProps } from '@vortex-kit/vortex';

Display

<Badge color="neutral" type="outline">Badge</Badge>

Allied components

Badge

Prop	Type	Default
`type`	`union`	`fill`
`children`	`React.ReactNode`	No default value
`color`	`union`	`neutral`
`onlyIcon`	`SVGIcon`	No default value
`ariaLabel`	`string`	No default value
`leftIcon`	`SVGIcon`	No default value
`rightIcon`	`SVGIcon`	No default value
`size`	`union`	`md`
`hidden`	`boolean`	No default value
`href`	`string`	No default value
`onClick`	`function`	No default value
`onDismiss`	`function`	No default value
`dismissAriaLabel`	`string`	No default value
`rounded`	`boolean`	No default value
`className`	`union`	No default value
`attributes`	`object`	No default value

Badge.Frame

Prop	Type	Default
`position`	`union`	`top-end`
`children`	`React.ReactNode`	No default value
`className`	`union`	No default value
`attributes`	`object`	No default value

Badge Component Props — Vortex Design System