CONSOLE-3204: Add missing api docs for *Icon and *Status components

Updates to the API docs for dynamic plugin sdk.
openshift · Jul 8, 2022 · 2b0411c · 2b0411c
1 parent 49f045d
commit 2b0411c
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 8 deletions.
diff --git a/frontend/packages/console-dynamic-plugin-sdk/docs/api.md b/frontend/packages/console-dynamic-plugin-sdk/docs/api.md
@@ -149,7 +149,7 @@ Component for displaying a green check mark circle icon
 | -------------- | ----------- |
 | `className` | (optional) class name for styling |
 | `title` | (optional) icon title |
-| `size` | (optional) icon size |
+| `size` | (optional) icon size: 'sm' | 'md' | 'lg' | 'xl' |
 
 
 
@@ -180,7 +180,7 @@ Component for displaying a red exclamation mark circle icon
 | -------------- | ----------- |
 | `className` | (optional) class name for styling |
 | `title` | (optional) icon title |
-| `size` | (optional) icon size |
+| `size` | (optional) icon size: 'sm' | 'md' | 'lg' | 'xl' |
 
 
 
@@ -211,7 +211,7 @@ Component for displaying a yellow triangle exclamation icon
 | -------------- | ----------- |
 | `className` | (optional) class name for styling |
 | `title` | (optional) icon title |
-| `size` | (optional) icon size |
+| `size` | (optional) icon size: 'sm' | 'md' | 'lg' | 'xl' |
 
 
 
@@ -242,7 +242,7 @@ Component for displaying a blue info circle icon
 | -------------- | ----------- |
 | `className` | (optional) class name for styling |
 | `title` | (optional) icon title |
-| `size` | (optional) icon size |
+| `size` | (optional) icon size: 'sm' | 'md' | 'lg' | 'xl' |
 
 
 

diff --git a/frontend/packages/console-dynamic-plugin-sdk/src/app/components/status/icons.tsx b/frontend/packages/console-dynamic-plugin-sdk/src/app/components/status/icons.tsx
@@ -19,7 +19,7 @@ export type ColoredIconProps = {
  * Component for displaying a green check mark circle icon
  * @param {string} [className] - (optional) class name for styling
  * @param {string} [title] - (optional) icon title
- * @param {string} [size] - (optional) icon size
+ * @param {string} [size] - (optional) icon size: 'sm' | 'md' | 'lg' | 'xl'
  * @example
  * ```tsx
  * <GreenCheckCircleIcon />
@@ -38,7 +38,7 @@ export const GreenCheckCircleIcon: React.FC<ColoredIconProps> = ({ className, ti
  * Component for displaying a red exclamation mark circle icon
  * @param {string} [className] - (optional) class name for styling
  * @param {string} [title] - (optional) icon title
- * @param {string} [size] - (optional) icon size
+ * @param {string} [size] - (optional) icon size: 'sm' | 'md' | 'lg' | 'xl'
  * @example
  * ```tsx
  * <RedExclamationCircleIcon />
@@ -60,7 +60,7 @@ export const RedExclamationCircleIcon: React.FC<ColoredIconProps> = ({
  * Component for displaying a yellow triangle exclamation icon
  * @param {string} [className] - (optional) class name for styling
  * @param {string} [title] - (optional) icon title
- * @param {string} [size] - (optional) icon size
+ * @param {string} [size] - (optional) icon size: 'sm' | 'md' | 'lg' | 'xl'
  * @example
  * ```tsx
  * <YellowExclamationTriangleIcon />
@@ -82,7 +82,7 @@ export const YellowExclamationTriangleIcon: React.FC<ColoredIconProps> = ({
  * Component for displaying a blue info circle icon
  * @param {string} [className] - (optional) class name for styling
  * @param {string} [title] - (optional) icon title
- * @param {string} [size] - (optional) icon size
+ * @param {string} [size] - (optional) icon size: 'sm' | 'md' | 'lg' | 'xl'
  * @example
  * ```tsx
  * <BlueInfoCircleIcon />