@clubmed/trident-ui
Version:
Shared ClubMed React UI components
45 lines (44 loc) • 1.12 kB
TypeScript
import { IconicNames, IconProps } from '@clubmed/trident-icons';
import { ComponentPropsWithoutRef, FunctionComponent } from 'react';
import { BgColor, BorderColor, TextColor } from './helpers/colors/colors';
import { LiteralUnion } from './types/LiteralUnion';
export interface TagProps extends Omit<ComponentPropsWithoutRef<'span'>, 'color'> {
/**
* Additional class names
*/
className?: string;
/**
* Background color
*/
backgroundColor?: LiteralUnion<BgColor>;
/**
* Text color
*/
color?: LiteralUnion<TextColor>;
/**
* Border color
*/
border?: LiteralUnion<BorderColor>;
/**
* Optional icon name
*/
icon?: IconicNames;
/**
* Tag label
*/
label?: string;
/**
* theme mode
*/
theme?: 'icon' | 'label' | 'both' | 'swap' | 'unfold' | 'monogram' | 'pill' | 'none';
/**
* Icon class name
*/
iconClassName?: string;
iconWidth?: IconProps['width'];
/**
* Label class name
*/
labelClassName?: string;
}
export declare const Tag: FunctionComponent<TagProps>;