diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/.vuepress/components/BmcAlerts.vue | 14 | ||||
-rw-r--r-- | docs/.vuepress/config.js | 1 | ||||
-rw-r--r-- | docs/.vuepress/enhanceApp.js | 5 | ||||
-rw-r--r-- | docs/guide/components/alert.md | 12 |
4 files changed, 31 insertions, 1 deletions
diff --git a/docs/.vuepress/components/BmcAlerts.vue b/docs/.vuepress/components/BmcAlerts.vue new file mode 100644 index 00000000..60440644 --- /dev/null +++ b/docs/.vuepress/components/BmcAlerts.vue @@ -0,0 +1,14 @@ +<template> + <div> + <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> + </div> +</template> + +<script> + +export default { + name: 'BmcAlerts', +} +</script>
\ No newline at end of file diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 680c98ef..a07000e8 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -44,6 +44,7 @@ module.exports = { title: "Components", children: [ "/guide/components/", + "/guide/components/alert", "/guide/components/button", "/guide/components/toast", ] diff --git a/docs/.vuepress/enhanceApp.js b/docs/.vuepress/enhanceApp.js index 799cf208..72fd24d7 100644 --- a/docs/.vuepress/enhanceApp.js +++ b/docs/.vuepress/enhanceApp.js @@ -1,19 +1,22 @@ -// OpenBMC Imports import "../../src/assets/styles/_obmc-custom.scss"; +import Alert from "../../src/components/Global/Alert"; import BVToastMixin from "../../src/components/Mixins/BVToastMixin"; // Bootstrap-vue Plugin imports import { + AlertPlugin, ButtonPlugin, ToastPlugin } from 'bootstrap-vue'; export default ({ Vue }) => { + Vue.use(AlertPlugin); Vue.use(ButtonPlugin); Vue.use(ToastPlugin); // BMC Components and Mixins + Vue.component('Alert', Alert); Vue.mixin('BVToastMixin', BVToastMixin); }
\ No newline at end of file diff --git a/docs/guide/components/alert.md b/docs/guide/components/alert.md new file mode 100644 index 00000000..768aa873 --- /dev/null +++ b/docs/guide/components/alert.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) + +<BmcAlerts /> + +```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 |