@openshift-console/dynamic-plugin-sdk
Version:
Provides core APIs, types and utilities used by dynamic plugins at runtime.
55 lines (54 loc) • 2.12 kB
TypeScript
import * as React from 'react';
import { IconSize } from '@patternfly/react-core';
import './icons.scss';
export type ColoredIconProps = {
className?: string;
title?: string;
size?: IconSize;
dataTest?: string;
};
/**
* Component for displaying a green check mark circle icon.
* @param {string} [className] - (optional) additional class name for the component
* @param {string} [title] - (optional) icon title
* @param {string} [size] - (optional) icon size: ('sm', 'md', 'lg', 'xl', '2xl', '3xl', 'headingSm', 'headingMd', 'headingLg', 'headingXl', 'heading_2xl', 'heading_3xl', 'bodySm', 'bodyDefault', 'bodyLg')
* @example
* ```tsx
* <GreenCheckCircleIcon title="Healthy" />
* ```
*/
export declare const GreenCheckCircleIcon: React.FC<ColoredIconProps>;
/**
* Component for displaying a red exclamation mark circle icon.
* @param {string} [className] - (optional) additional class name for the component
* @param {string} [title] - (optional) icon title
* @param {string} [size] - (optional) icon size: ('sm', 'md', 'lg', 'xl')
* @example
* ```tsx
* <RedExclamationCircleIcon title="Failed" />
* ```
*/
export declare const RedExclamationCircleIcon: React.FC<ColoredIconProps>;
/**
* Component for displaying a yellow triangle exclamation icon.
* @param {string} [className] - (optional) additional class name for the component
* @param {string} [title] - (optional) icon title
* @param {string} [size] - (optional) icon size: ('sm', 'md', 'lg', 'xl')
* @param {string} [dataTest] - (optional) icon test id
* @example
* ```tsx
* <YellowExclamationTriangleIcon title="Warning" />
* ```
*/
export declare const YellowExclamationTriangleIcon: React.FC<ColoredIconProps>;
/**
* Component for displaying a blue info circle icon.
* @param {string} [className] - (optional) additional class name for the component
* @param {string} [title] - (optional) icon title
* @param {string} [size] - (optional) icon size: ('sm', 'md', 'lg', 'xl')
* @example
* ```tsx
* <BlueInfoCircleIcon title="Info" />
* ```
*/
export declare const BlueInfoCircleIcon: React.FC<ColoredIconProps>;