@devopness/ui-react
Version:
Devopness Design System React Components - Painless essential DevOps to everyone
45 lines (44 loc) • 1.35 kB
TypeScript
import { HTMLAttributes } from 'react';
import { Color } from '../../../colors';
import { Icon as IconName } from '../../../icons';
type IconProps = {
/**
* Defines which icon to render from Devopness UI Icons
*
* @see iconLoader
*/
name: IconName | undefined;
/** Defines element height and width */
size?: number;
/**
* Defines element foreground/fill color
*
* https://developer.mozilla.org/en-US/docs/Web/CSS/color
* https://developer.mozilla.org/en-US/docs/Web/CSS/fill
*
* @see {getColor}
*/
color?: Color;
/**
* Defines the degree to which content behind an element is hidden; is a number in the range 0.0 to 1.0
*
* @see {@link https://developer.mozilla.org/en-US/docs/Web/CSS/opacity}
*/
opacity?: number;
/**
* Defines a string value that labels the current element
*
* Uses name as fallback, if prop is undefined
*
* @see {@link https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-label}
*/
ariaLabel?: HTMLAttributes<HTMLOrSVGImageElement>['aria-label'];
};
/**
* Loads icon from iconLoader
*
* @see {@link src/icons/iconLoader.tsx:iconLoader}
*/
declare const Icon: (props: IconProps) => import("react").JSX.Element;
export type { IconProps };
export { Icon };