Badge Props — Vortex Design System

Badge

Badge is a compact label that marks an item with a status or count, such as a shipped order or unread messages.

Import

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

Allied components

Other links

Badge props
Prop	Type	Default
`size`	`union`	`md`
`rounded`	`boolean`	`false`
`hidden`	`boolean`	No default value
`className`	`union`	No default value
`tone`	`union`	`neutral`
`variant`	`union`	`solid`
`attributes`	`object`	No default value
`onClick`	`callback`	No default value
`href`	`string`	No default value
`as`	`union`	No default value
`children`	`React.ReactNode`	No default value
`startIcon`	`union`	No default value
`onlyIcon`	`union`	No default value
`endIcon`	`union`	No default value
`ariaLabel`	`string`	No default value
`onClose`	`callback`	No default value
`closeAriaLabel`	`string`	No default value

Badge.Frame props
Prop	Type	Default
`position`	`union`	`top-end`
`overlap`	`boolean`	`false`
`children`	`React.ReactNode`	No default value
`className`	`union`	No default value
`attributes`	`object`	No default value