DefaultSuccessRemovedNew
import { Badge, Stack } from '@fidely-ui/react'
export const BadgeBasics = () => {
return (
<Stack direction="row">
<Badge>Default</Badge>
<Badge colorPalette="green">Success</Badge>
<Badge colorPalette="red">Removed</Badge>
<Badge colorPalette="purple">New</Badge>
</Stack>
)
}
Usage
import { Badge } from '@fidely-ui/react'<Badge>Badge Text</Badge>Examples
Icon
Render an icon within the badge directly
NewNew
import { Badge, Stack } from '@fidely-ui/react'
import { HiAtSymbol, HiStar } from 'react-icons/hi'
export const BadgeIcon = () => {
return (
<Stack direction="row">
<Badge colorPalette="blue">
<HiStar />
New
</Badge>
<Badge colorPalette="green">
<HiAtSymbol />
New
</Badge>
</Stack>
)
}
Sizes
Badges come in different sizes
NewNewNewNew
import { Badge, HStack } from '@fidely-ui/react'
export const BadgeSizes = () => {
return (
<HStack>
<Badge size="sm">New</Badge>
<Badge size="md">New</Badge>
<Badge size="lg">New</Badge>
<Badge size="xl">New</Badge>
</HStack>
)
}
Variants
Badges come in different variants
NewNewNew
import { Badge, HStack } from '@fidely-ui/react'
export const BadgeVariants = () => {
return (
<HStack>
<Badge variant="solid">New</Badge>
<Badge variant="outline">New</Badge>
<Badge variant="subtle">New</Badge>
</HStack>
)
}
asChild
Use the asChild prop to render or use the child elements component.
Badge
import { Badge } from '@fidely-ui/react/badge'
export const BadgeAsChild = () => {
return (
<Badge asChild colorPalette="orange">
<span>Badge</span>
</Badge>
)
}
Props
Badge
| Prop | Type | Default | Description |
|---|---|---|---|
size | "sm" | "md" | "lg" | "xl" | "md" | Defines the size of the badge. |
colorPalette | - | "gray" | Sets the color palette for the badge. |
variant | "solid" | "subtle" | "outline" | "solid" | Defines the visual style of the badge. |
as | React.ElementType | "-" | The underlying element to render. |
asChild | boolean | false | Passes props to use a custom inline element. |