diff options
author | Sukanya Pandey <sukapan1@in.ibm.com> | 2020-11-03 17:08:47 +0300 |
---|---|---|
committer | Derick Montague <derick.montague@ibm.com> | 2020-12-03 00:08:42 +0300 |
commit | 96d9a6aad7f3f0d41f73905af245f3c688647f5d (patch) | |
tree | 4611d9b057ced174dfb2819a5fdba7b6ec744732 /docs | |
parent | e6693048f6e2d069ac27a73c93fc7faf51eae5de (diff) | |
download | webui-vue-96d9a6aad7f3f0d41f73905af245f3c688647f5d.tar.xz |
Add info tooltip documentation
Signed-off-by: Sukanya Pandey <sukapan1@in.ibm.com>
Change-Id: Id19854ed326eb55f6443a7015579ea6375193d1f
Diffstat (limited to 'docs')
-rw-r--r-- | docs/.vuepress/config.js | 1 | ||||
-rw-r--r-- | docs/.vuepress/public/tooltip.png | bin | 0 -> 4234 bytes | |||
-rw-r--r-- | docs/guide/components/tooltip.md | 15 |
3 files changed, 16 insertions, 0 deletions
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 9f052773..e86a9d25 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -53,6 +53,7 @@ module.exports = { "/guide/components/status-icon/", "/guide/components/table/", "/guide/components/toast", + "/guide/components/tooltip" ] }, { diff --git a/docs/.vuepress/public/tooltip.png b/docs/.vuepress/public/tooltip.png Binary files differnew file mode 100644 index 00000000..7af1b7ae --- /dev/null +++ b/docs/.vuepress/public/tooltip.png diff --git a/docs/guide/components/tooltip.md b/docs/guide/components/tooltip.md new file mode 100644 index 00000000..ebc1a16d --- /dev/null +++ b/docs/guide/components/tooltip.md @@ -0,0 +1,15 @@ +# InfoTooltip + +The `InfoTooltip` is a custom component that uses a Bootstrap-vue tooltip with an info icon. This custom component requires a title property containing the tooltip text to display to the user. + +[Read more about the Bootstrap-vue tooltip component](https://bootstrap-vue.org/docs/components/tooltip) + +## Example + +```vue +<info-tooltip + :title="Title" //should be translated +/> +``` + +![Tooltip example](/tooltip.png) |