@atlaskit/icon
Version:
An icon is a symbol representing a command, device, directory, or common action.
39 lines (38 loc) • 1.13 kB
TypeScript
/**
* Metadata for the animated icons in `src/animated`, shown in the Icon Explorer on the Animated icon page.
*
* Unlike `metadata-core`, this file is written by hand. Every animated icon must have an entry, keyed by its
* file name in `src/animated`; a unit test enforces this.
*/
export interface AnimatedIconMetadata {
/**
* Default component name for the icon
*/
componentName: string;
/**
* Package path to the icon component
*/
package: string;
/**
* Single purpose icons should only be used for the purposes listed in `usage`.
*/
categorization: 'single-purpose' | 'multi-purpose';
/**
* Usage guidelines for the icon
*/
usage?: string;
/**
* Additional keywords used to assist in search/lookup of an icon
*/
keywords: string[];
/**
* The name of the team owning the icon
*/
team: string;
/**
* The status of the icon
*/
status?: 'draft' | 'ready-to-publish' | 'published' | 'modified' | 'deprecated';
}
declare const metadata: Record<string, AnimatedIconMetadata>;
export default metadata;