diff options
| author | Derick Montague <derick.montague@ibm.com> | 2020-12-10 03:37:11 +0300 |
|---|---|---|
| committer | Derick Montague <derick.montague@ibm.com> | 2020-12-16 02:12:41 +0300 |
| commit | f6df801b384118b946bb3b7b3248832ec70cfd0a (patch) | |
| tree | 0866ee9fcb2dce300631bdf82a041bfb3a54068a /docs/guide/components/alerts | |
| parent | 34efde291781c01c78e4363d919cdf4d5c90ae43 (diff) | |
| download | webui-vue-f6df801b384118b946bb3b7b3248832ec70cfd0a.tar.xz | |
Update component documentation
The component structure was not consistent. We determined how we
wanted to save image examples within the component directory, but not
all of the components were updated. The result was that some images
were not displaying on the component pages. This patchset resolves
that issue, along with removing the page component since it is not an
actual component within the application.
- Add directory for each component, move example images to the
directory, and update the image path
- Create a page-title and page-section directory and index.md for each
- Move content for page-title and page-section from the page.md file
into the index.md within the respective component directory
- Delete the page.md from the component directory as it is not a
component
- Update links to page.md in the page-anatomy.md file.
Signed-off-by: Derick Montague <derick.montague@ibm.com>
Change-Id: I1e554adf71abb4c84f423a30d3c3b598f678ade0
Diffstat (limited to 'docs/guide/components/alerts')
| -rw-r--r-- | docs/guide/components/alerts/alert.png | bin | 0 -> 45130 bytes | |||
| -rw-r--r-- | docs/guide/components/alerts/index.md | 12 |
2 files changed, 12 insertions, 0 deletions
diff --git a/docs/guide/components/alerts/alert.png b/docs/guide/components/alerts/alert.png Binary files differnew file mode 100644 index 00000000..7a368f7f --- /dev/null +++ b/docs/guide/components/alerts/alert.png diff --git a/docs/guide/components/alerts/index.md b/docs/guide/components/alerts/index.md new file mode 100644 index 00000000..9273f8e2 --- /dev/null +++ b/docs/guide/components/alerts/index.md @@ -0,0 +1,12 @@ +# Alerts +An alert is an inline message that contains a short description that a user cannot manually dismiss. With exception to the error message on the login page, alerts are not triggered by user action. Success and error notifications based on user actions are created using a toast component. + +[Learn more about Bootstrap-vue alert options](https://bootstrap-vue.js.org/docs/components/alert) + + + +```vue +<alert show variant="warning">This is a warning message</alert> +<alert show variant="danger">This is an error message</alert> +<alert show variant="info">This is an info message</alert> +```
\ No newline at end of file |
