@carbon/ibm-products/lib/components/StatusIcon/StatusIcon.d.ts

Carbon for IBM Products

/**
 * Copyright IBM Corp. 2021, 2022
 *
 * This source code is licensed under the Apache-2.0 license found in the
 * LICENSE file in the root directory of this source tree.
 */
import React, { PropsWithChildren } from 'react';
/**
The `StatusIcon` component follows the Carbon guidelines for status icons with
some added specifications around illustration usage. For additional usage
guidelines and documentation please refer to the links above.

_Status icons_ are an important method of communicating severity level
information to users. The shapes and colors, communicate severity that enable
users to quickly assess and identify status and respond accordingly.
 */
type Size = 'sm' | 'md' | 'lg' | 'xl';
type Theme = 'light' | 'dark';
type Kind = 'fatal' | 'critical' | 'major-warning' | 'minor-warning' | 'undefined' | 'unknown' | 'normal' | 'info' | 'in-progress' | 'running' | 'pending';
export interface StatusIconProps extends PropsWithChildren {
    /**
     * Provide an optional class to be applied to the modal root node.
     */
    className?: string;
    /**
     * A required prop that provides a title element and tooltip for the icon for accessibility purposes
     */
    iconDescription: string;
    /**
     * A required prop that displays the respective icon associated with the status
     */
    kind: Kind;
    /**
     * A required prop that displays the size of the icon associate with the status
     */
    size: Size;
    /**
     * A required prop that displays the theme of the icon associated with the status
     */
    theme: Theme;
}
export declare let StatusIcon: React.ForwardRefExoticComponent<StatusIconProps & React.RefAttributes<React.ReactSVGElement | null>>;
export {};