File: Icon.d.ts

package info (click to toggle)
cockpit 354-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 308,956 kB
  • sloc: javascript: 775,606; python: 40,351; ansic: 35,655; cpp: 11,117; sh: 3,511; makefile: 580; xml: 261
file content (30 lines) | stat: -rw-r--r-- 1,685 bytes parent folder | download | duplicates (8)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
/// <reference types="react" />
export type IconSize = 'sm' | 'md' | 'lg' | 'xl' | '2xl' | '3xl' | 'headingSm' | 'headingMd' | 'headingLg' | 'headingXl' | 'heading_2xl' | 'heading_3xl' | 'bodySm' | 'bodyDefault' | 'bodyLg';
export interface IconComponentProps extends Omit<React.HTMLProps<HTMLSpanElement>, 'size'> {
    /** Icon content */
    children?: React.ReactNode;
    /** Icon when isInProgress is set to true. Defaults to a 1em spinner.  */
    progressIcon?: React.ReactNode;
    /** Additional classes applied to the icon container */
    className?: string;
    /** Size of the icon component container and icon. */
    size?: IconSize;
    /** Size of icon. Overrides the icon size set by the size property. */
    iconSize?: IconSize;
    /** Size of progress icon. Overrides the icon size set by the size property. */
    progressIconSize?: IconSize;
    /** Status color of the icon */
    status?: 'custom' | 'info' | 'success' | 'warning' | 'danger';
    /** Indicates the icon is inline and should inherit the text font size and color. Overriden by size and iconSize properties. */
    isInline?: boolean;
    /** Indicates the icon is in progress. Setting this property to true will swap the icon with the progressIcon. */
    isInProgress?: boolean;
    /** Aria-label for the default progress icon */
    defaultProgressArialabel?: string;
    /** Flag indicating whether the icon passed as children should be mirrored for
     * right to left (RTL) languages. This will not mirror the icon passed to progressIcon.
     */
    shouldMirrorRTL?: boolean;
}
export declare const Icon: React.FunctionComponent<IconComponentProps>;
//# sourceMappingURL=Icon.d.ts.map