Skip to content

chore(docs): add example for <b-toast> with custom close button (closes #5837) #5864

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 7, 2020
Merged

chore(docs): add example for <b-toast> with custom close button (closes #5837) #5864

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
756f726
chore(docs): add example for `<b-toast>` with custom close button
jacobmllr95 Oct 7, 2020
960f180
Merge branch 'dev' into chore-docs-add-b-toast-cutom-close-button-exa…
jacobmllr95 Oct 7, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 54 additions & 2 deletions src/components/toast/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,6 +272,58 @@ When auto-hide is enabled, hovering over the toast will pause the auto-hide time
the toast, the auto-hide timer will be resumed. You can disable this feature by setting the
`no-hover-pause` prop to `true`.

### Close button

Toasts have a close button to hide them on use click by default. Setting the `no-close-button` prop
to `true` will prevent this and creates a toast without the default close button.

It is still possible to create a custom close button for the toast by providing a unique ID and use
the `this.$bvToast.hide(id)` method to hide the specific toast:

```html
<template>
<div>
<b-button @click="showToast">Show Toast</b-button>
</div>
</template>

<script>
export default {
data() {
return {
count: 0
}
},
methods: {
showToast() {
// Use a shorter name for `this.$createElement`
const h = this.$createElement
// Create a ID with a incremented count
const id = `my-toast-${this.count++}`

// Create the custom close button
const $closeButton = h(
'b-button',
{
on: { click: () => this.$bvToast.hide(id) }
},
'Close'
)

// Create the toast
this.$bvToast.toast([$closeButton], {
id: id,
title: `Toast ${this.count}`,
noCloseButton: true
})
}
}
}
</script>

<!-- toasts-advanced.vue -->
```

### Toast roles

Toasts are rendered with a default `role` attribute of `'alert'` and `aria-live` attribute of
Expand Down Expand Up @@ -428,7 +480,7 @@ for generating more complex toast content:
```html
<template>
<div>
<b-button @click="popToast">Show Toast with custom content</b-button>
<b-button @click="showToast">Show Toast with custom content</b-button>
</div>
</template>

Expand All @@ -440,7 +492,7 @@ for generating more complex toast content:
}
},
methods: {
popToast() {
showToast() {
// Use a shorter name for this.$createElement
const h = this.$createElement
// Increment the toast count
Expand Down