diff options
| author | Derick Montague <derick.montague@ibm.com> | 2021-03-17 03:52:33 +0300 |
|---|---|---|
| committer | Derick Montague <derick.montague@ibm.com> | 2021-03-22 16:27:10 +0300 |
| commit | 492875622b39cb2cf04bbb9248b6ed0c52ced2df (patch) | |
| tree | 665449e11841591a8aae5f4f347a3a88936a2d7a /docs/guide/components/toasts | |
| parent | b0fadef1f96df99ff5eb0637527f04bc793c8d6e (diff) | |
| download | webui-vue-492875622b39cb2cf04bbb9248b6ed0c52ced2df.tar.xz | |
Update text wrapping in documentation
To meet best practices and standards for markdown, this commit updates
all markdown files used for the VuePress documentation so that each
line is limited to 80 characters.
Signed-off-by: Derick Montague <derick.montague@ibm.com>
Change-Id: I0cadb33343ce1bc331dfefd096d8137a04c33604
Diffstat (limited to 'docs/guide/components/toasts')
| -rw-r--r-- | docs/guide/components/toasts/index.md | 24 |
1 files changed, 19 insertions, 5 deletions
diff --git a/docs/guide/components/toasts/index.md b/docs/guide/components/toasts/index.md index 2e695f6a..3f0c815d 100644 --- a/docs/guide/components/toasts/index.md +++ b/docs/guide/components/toasts/index.md @@ -1,7 +1,14 @@ # Toasts -Use a toast message to indicate the status of a user action. For example, a user saves a form successfully, a toast message with the `success` variant is displayed. If the user action was not successful, a toast message with the `danger` variant is displayed. +Use a toast message to indicate the status of a user action. For example, a user +saves a form successfully, a toast message with the `success` variant is +displayed. If the user action was not successful, a toast message with the +`danger` variant is displayed. -There are different transitions for the toast messages. The `success` toast message will auto-hide after 10 seconds. The user must manually dismiss the `informational`, `warning`, and `error` toast messages. The `BVToastMixin` provides a simple API that generates a toast message that meets the transition guidelines. +There are different transitions for the toast messages. The `success` toast +message will auto-hide after 10 seconds. The user must manually dismiss the +`informational`, `warning`, and `error` toast messages. The `BVToastMixin` +provides a simple API that generates a toast message that meets the transition +guidelines. <img src="./toast.png" alt="Toast message examples" style="max-width:350px"> @@ -33,11 +40,18 @@ methods: { ## Additional options -The first argument for each method will be the toast body content. It accepts a string value or an array of strings for toasts needing to display multiple lines of content. +The first argument for each method will be the toast body content. It accepts a +string value or an array of strings for toasts needing to display multiple lines +of content. -The BVToastMixin also accepts additional options as a second argument. Pass an object with a `title` property to change the default toast title. Include a `refreshAction` property, set to true, to include a link that refreshes the application. Include a `timestamp` property, set to true, to include a timestamp in the toast. +The BVToastMixin also accepts additional options as a second argument. Pass an +object with a `title` property to change the default toast title. Include a +`refreshAction` property, set to true, to include a link that refreshes the +application. Include a `timestamp` property, set to true, to include a timestamp +in the toast. -<img src="./toast-options.png" alt="Toast message options example" style="max-width:350px"> +<img src="./toast-options.png" alt="Toast message options example" +style="max-width:350px"> ```js |