From 432134d451eaceea4daa8b60686271d14a89c466 Mon Sep 17 00:00:00 2001 From: Sukanya Pandey Date: Fri, 13 Nov 2020 16:05:35 +0530 Subject: Add status icon documentation Signed-off-by: Sukanya Pandey Change-Id: I7fa990794533c80bc73bbcd15a0d7191ee70cd11 --- .../status-icon/appHeaderWithStatusIcon.png | Bin 0 -> 34062 bytes docs/guide/components/status-icon/danger.png | Bin 0 -> 1653 bytes .../status-icon/eventLogsWithSatusIcon.png | Bin 0 -> 47095 bytes docs/guide/components/status-icon/info.png | Bin 0 -> 1455 bytes docs/guide/components/status-icon/readme.md | 74 +++++++++++++++++++++ docs/guide/components/status-icon/secondary.png | Bin 0 -> 1311 bytes docs/guide/components/status-icon/success.png | Bin 0 -> 1677 bytes docs/guide/components/status-icon/warning.png | Bin 0 -> 1146 bytes 8 files changed, 74 insertions(+) create mode 100644 docs/guide/components/status-icon/appHeaderWithStatusIcon.png create mode 100644 docs/guide/components/status-icon/danger.png create mode 100644 docs/guide/components/status-icon/eventLogsWithSatusIcon.png create mode 100644 docs/guide/components/status-icon/info.png create mode 100644 docs/guide/components/status-icon/readme.md create mode 100644 docs/guide/components/status-icon/secondary.png create mode 100644 docs/guide/components/status-icon/success.png create mode 100644 docs/guide/components/status-icon/warning.png (limited to 'docs/guide/components/status-icon') diff --git a/docs/guide/components/status-icon/appHeaderWithStatusIcon.png b/docs/guide/components/status-icon/appHeaderWithStatusIcon.png new file mode 100644 index 00000000..bb557f3c Binary files /dev/null and b/docs/guide/components/status-icon/appHeaderWithStatusIcon.png differ diff --git a/docs/guide/components/status-icon/danger.png b/docs/guide/components/status-icon/danger.png new file mode 100644 index 00000000..fb1ecd0a Binary files /dev/null and b/docs/guide/components/status-icon/danger.png differ diff --git a/docs/guide/components/status-icon/eventLogsWithSatusIcon.png b/docs/guide/components/status-icon/eventLogsWithSatusIcon.png new file mode 100644 index 00000000..dc276ac1 Binary files /dev/null and b/docs/guide/components/status-icon/eventLogsWithSatusIcon.png differ diff --git a/docs/guide/components/status-icon/info.png b/docs/guide/components/status-icon/info.png new file mode 100644 index 00000000..672def46 Binary files /dev/null and b/docs/guide/components/status-icon/info.png differ diff --git a/docs/guide/components/status-icon/readme.md b/docs/guide/components/status-icon/readme.md new file mode 100644 index 00000000..0c9cc394 --- /dev/null +++ b/docs/guide/components/status-icon/readme.md @@ -0,0 +1,74 @@ +# StatusIcon + +The StatusIcon component is used to add an icon that represents one of the following statuses: + +- success +- info +- warning +- danger + +To use this component: +1. Import it into the single file component (SFC) +2. Add the `` tag +3. Add the optional status prop and set the value to one of the statuses +4. Add the translated text to associate with the icon + +```vue +import StatusIcon from '@/components/Global/StatusIcon' +``` + +## Status icon with default status + +```vue + +``` + +![StatusIcon default icon example](./secondary.png) + +## Status icon with success status + +```vue + +``` + +![StatusIcon success icon example](./success.png) + +## Status icon with info status + +```vue + +``` + +![StatusIcon info icon example](./info.png) + +## Status icon with warning status + +```vue + +``` + +![StatusIcon warning icon example](./warning.png) + +## Status icon with danger status + +```vue + +``` + +![StatusIcon danger icon example](./danger.png) + +### Example of AppHeader with status icon + +![AppHeader with status icon example](./appHeaderWithStatusIcon.png) + +### Example of Event logs with status icon + +![EventLogs with status icon example](./eventLogsWithSatusIcon.png) diff --git a/docs/guide/components/status-icon/secondary.png b/docs/guide/components/status-icon/secondary.png new file mode 100644 index 00000000..bda5f63b Binary files /dev/null and b/docs/guide/components/status-icon/secondary.png differ diff --git a/docs/guide/components/status-icon/success.png b/docs/guide/components/status-icon/success.png new file mode 100644 index 00000000..5ff670cb Binary files /dev/null and b/docs/guide/components/status-icon/success.png differ diff --git a/docs/guide/components/status-icon/warning.png b/docs/guide/components/status-icon/warning.png new file mode 100644 index 00000000..42f92476 Binary files /dev/null and b/docs/guide/components/status-icon/warning.png differ -- cgit v1.2.3