@amsterdam/design-system-react
Version:
All React components from the Amsterdam Design System. Use it to compose pages in your website or application.
29 lines (28 loc) • 1.06 kB
TypeScript
/**
* @license EUPL-1.2+
* Copyright Gemeente Amsterdam
*/
import type { HTMLAttributes } from 'react';
import type { IconProps } from '../Icon';
export declare const badgeColors: readonly ["azure", "lime", "magenta", "orange", "purple", "red", "yellow"];
type BadgeColor = (typeof badgeColors)[number];
export type BadgeProps = {
/** The background colour. */
color?: BadgeColor;
/** The icon to show before the badge text. */
icon?: IconProps['svg'];
/** The text content. */
label: string | number;
} & HTMLAttributes<HTMLElement>;
/**
* @see {@link https://designsystem.amsterdam/?path=/docs/components-feedback-badge--docs Badge docs at Amsterdam Design System}
*/
export declare const Badge: import("react").ForwardRefExoticComponent<{
/** The background colour. */
color?: BadgeColor;
/** The icon to show before the badge text. */
icon?: IconProps["svg"];
/** The text content. */
label: string | number;
} & HTMLAttributes<HTMLElement> & import("react").RefAttributes<HTMLElement>>;
export {};