Add documentation for BVToastMixin enhancements
Includes documentation for multi-lined toast body, refresh app link,
and timestamp.
Signed-off-by: Yoshie Muranaka <yoshiemuranaka@gmail.com>
Change-Id: Id95e1858a703cc0be44f1f6de51fd6daab24876d
diff --git a/docs/guide/components/toasts/index.md b/docs/guide/components/toasts/index.md
index 271155a..2e695f6 100644
--- a/docs/guide/components/toasts/index.md
+++ b/docs/guide/components/toasts/index.md
@@ -29,4 +29,28 @@
this.infoToast('This is an info toast and must be dismissed by the user.');
},
}
+```
+
+## 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 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">
+
+```js
+
+methods: {
+ makeInfoToast() {
+ this.infoToast([
+ 'This is a toast with multi-lined body content.',
+ 'Just pass an array of strings!'
+ ], {
+ title: 'This is an example',
+ refreshAction: true,
+ timestamp: true
+ })
+ }
+}
```
\ No newline at end of file
diff --git a/docs/guide/components/toasts/toast-options.png b/docs/guide/components/toasts/toast-options.png
new file mode 100644
index 0000000..f4d725d
--- /dev/null
+++ b/docs/guide/components/toasts/toast-options.png
Binary files differ
