@furystack/shades-common-components
Version:
Common UI components for FuryStack Shades
35 lines • 1.39 kB
TypeScript
import type { PartialElement } from '@furystack/shades';
import type { Palette } from '../services/theme-provider-service.js';
export type BadgeProps = PartialElement<HTMLElement> & {
/** The count to display in the badge */
count?: number;
/** If true, renders a small dot instead of a count */
dot?: boolean;
/** Palette color for the badge */
color?: keyof Palette;
/** Maximum count to display. Counts above this show `{max}+` */
max?: number;
/** If true, shows the badge when count is zero */
showZero?: boolean;
/** Controls badge visibility. Defaults to true */
visible?: boolean;
};
export declare const Badge: (props: Omit<Partial<HTMLElement>, "style"> & {
style?: Partial<CSSStyleDeclaration>;
} & {
ref?: import("@furystack/shades").RefObject<Element>;
} & {
/** The count to display in the badge */
count?: number;
/** If true, renders a small dot instead of a count */
dot?: boolean;
/** Palette color for the badge */
color?: keyof Palette;
/** Maximum count to display. Counts above this show `{max}+` */
max?: number;
/** If true, shows the badge when count is zero */
showZero?: boolean;
/** Controls badge visibility. Defaults to true */
visible?: boolean;
}, children?: import("@furystack/shades").ChildrenList) => JSX.Element;
//# sourceMappingURL=badge.d.ts.map