@withjoy/joykit
Version:
UI Component Library for Joy web
31 lines (30 loc) • 1.17 kB
TypeScript
export declare type IconViewBox = 16 | 24 | 40 | 48;
export declare type ComposeableIcon = 'iconBase';
/**
* JoyKit provided icons
*/
export declare type BundledIcon = 'add' | 'backArrow' | 'buy' | 'check' | 'chevronLeft' | 'chevronRight' | 'close' | 'config' | 'creditCard' | 'dropdown' | 'edit' | 'email' | 'eye' | 'forwardIcon' | 'friends' | 'globe' | 'label' | 'lock' | 'more' | 'notification' | 'optionSelect' | 'question' | 'refund' | 'search' | 'star' | 'toggle' | 'toggles' | 'trash' | 'vendorSearch' | ComposeableIcon;
export interface IconConfig {
name: BundledIcon;
/**
* Descriptive text to be read to screenreaders
*/
a11yLabel: string;
/**
* Base fill - to be applied to the SVG directly
*/
fill: string;
/**
* Size of the icon.
*
* JoyKit contains 24px and 40px icons.
*/
viewBox: IconViewBox;
/**
* The sub-paths to be drawn
*/
body: string;
}
import { JOYKIT_ICONS } from './iconDefinitions';
declare const generateViewBoxStringFromValue: (viewBox: IconViewBox) => string;
export { JOYKIT_ICONS, generateViewBoxStringFromValue };