2
0
mirror of https://github.com/iconify/iconify.git synced 2024-10-24 17:41:58 +00:00
iconify/packages/utils/src/icon/index.ts

31 lines
659 B
TypeScript
Raw Normal View History

import type { IconifyOptional, IconifyIcon } from '@iconify/types';
// Export icon and full icon types
export { IconifyIcon };
export type FullIconifyIcon = Required<IconifyIcon>;
/**
* Expression to test part of icon name.
*/
export const matchName = /^[a-z0-9]+(-[a-z0-9]+)*$/;
/**
* Default values for all optional IconifyIcon properties
*/
export const iconDefaults: Required<IconifyOptional> = Object.freeze({
left: 0,
top: 0,
width: 16,
height: 16,
rotate: 0,
vFlip: false,
hFlip: false,
});
/**
* Add optional properties to icon
*/
export function fullIcon(data: IconifyIcon): FullIconifyIcon {
return { ...iconDefaults, ...data };
}