@engie-group/fluid-design-system-react/lib/components/status-indicator/NJStatusIndicator.d.ts

Fluid Design System React

import React from 'react';
import { TSizeVariants } from '../../global';
export type TStatusIndicatorStatus = 'offline' | 'online' | 'away' | 'do-not-disturb' | 'busy' | 'unknown' | 'error' | 'success' | 'warning' | 'in-progress' | 'information' | 'discovery' | 'planet';
export declare const NJStatusIndicator: React.ForwardRefExoticComponent<IStatusIndicatorProps & React.RefAttributes<HTMLDivElement>>;
export interface IStatusIndicatorProps {
    /**
     * Status indicator size
     */
    size?: Extract<TSizeVariants, 'sm' | 'md' | 'lg'>;
    /**
     * Status variant
     */
    status?: TStatusIndicatorStatus;
    /**
     * Label content displayed on the right of the status indicator.
     * It must be either a string or a valid descendant of `<p>` tag
     */
    children?: React.ReactNode;
    /**
     * Title attribute
     */
    title?: string;
    /**
     * Optional additional className
     */
    className?: string;
    /**
     * Visually hide the label. It will still be accessible to assistive technologies
     */
    hideLabel?: boolean;
}