@konstructio/ui
Version:
A set of reusable and customizable React components built for konstruct.io
35 lines (34 loc) • 805 B
TypeScript
import { FC } from 'react';
import { Props } from './Badge.types';
/**
* A badge/tag component for status indicators and labels.
* Supports multiple variants, icons, loading state, and dismissible mode.
*
* @example
* ```tsx
* // Basic badge
* <Badge label="Active" variant="success" />
*
* // Badge with icon
* <Badge label="Settings" leftIcon={<SettingsIcon />} />
*
* // Dismissible badge
* <Badge
* label="Tag"
* dismissible
* onDismiss={() => removeTag()}
* />
*
* // Clickable badge
* <Badge
* label="Filter"
* onClick={() => applyFilter()}
* />
*
* // Loading badge
* <Badge label="Processing" loading />
* ```
*
* @see {@link https://konstructio.github.io/konstruct-ui/?path=/docs/components-badge--docs Storybook}
*/
export declare const Badge: FC<Props>;