diff --git a/docs/api/toast.md b/docs/api/toast.md index bf74e97cdd6..f99a9bfe92e 100644 --- a/docs/api/toast.md +++ b/docs/api/toast.md @@ -48,8 +48,12 @@ import ControllerExample from '@site/static/usage/v7/toast/presenting/controller ## Dismissing +Toasts are intended to be subtle notifications and should not interrupt the user. As a result, user interaction should not be required to dismiss the toast. + The toast can be dismissed automatically after a specific amount of time by passing the number of milliseconds to display it in the `duration` of the toast options. If a button with a role of `"cancel"` is added, then that button will dismiss the toast. To dismiss the toast after creation, call the `dismiss()` method on the instance. +Pressing the hardware back button does not dismiss toasts since they are not supposed to interrupt the user. + The following example demonstrates how to use the `buttons` property to add a button that automatically dismisses the toast when clicked, as well as how to collect the `role` of the dismiss event. import ButtonsPlayground from '@site/static/usage/v7/toast/buttons/index.md'; diff --git a/docs/developing/hardware-back-button.md b/docs/developing/hardware-back-button.md index ff50b2f7f1b..2f3271613dc 100644 --- a/docs/developing/hardware-back-button.md +++ b/docs/developing/hardware-back-button.md @@ -340,6 +340,6 @@ The table below lists all of the internal hardware back button event handlers th | Handler | Priority | Propagates | Description | | ---------- | -------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| Overlays | 100 | No | Applies to overlay components `ion-action-sheet`, `ion-alert`, `ion-loading`, `ion-modal`, `ion-popover`, `ion-picker`, and `ion-toast`. | +| Overlays | 100 | No | Applies to overlay components `ion-action-sheet`, `ion-alert`, `ion-loading`, `ion-modal`, `ion-popover`, and `ion-picker`. | | Menu | 99 | No | Applies to `ion-menu`. | | Navigation | 0 | Yes | Applies to routing navigation (i.e. Angular Routing). | diff --git a/versioned_docs/version-v6/api/toast.md b/versioned_docs/version-v6/api/toast.md index b0915d8cf8c..f5fb5184c58 100644 --- a/versioned_docs/version-v6/api/toast.md +++ b/versioned_docs/version-v6/api/toast.md @@ -91,8 +91,12 @@ function Example() { ## Dismissing +Toasts are intended to be subtle notifications and should not interrupt the user. As a result, user interaction should not be required to dismiss the toast. + The toast can be dismissed automatically after a specific amount of time by passing the number of milliseconds to display it in the `duration` of the toast options. If a button with a role of `"cancel"` is added, then that button will dismiss the toast. To dismiss the toast after creation, call the `dismiss()` method on the instance. +Pressing the hardware back button does not dismiss toasts since they are not supposed to interrupt the user. + The following example demonstrates how to use the `buttons` property to add a button that automatically dismisses the toast when clicked, as well as how to collect the `role` of the dismiss event. import ButtonsPlayground from '@site/static/usage/v6/toast/buttons/index.md'; diff --git a/versioned_docs/version-v6/developing/hardware-back-button.md b/versioned_docs/version-v6/developing/hardware-back-button.md index ff50b2f7f1b..2f3271613dc 100644 --- a/versioned_docs/version-v6/developing/hardware-back-button.md +++ b/versioned_docs/version-v6/developing/hardware-back-button.md @@ -340,6 +340,6 @@ The table below lists all of the internal hardware back button event handlers th | Handler | Priority | Propagates | Description | | ---------- | -------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| Overlays | 100 | No | Applies to overlay components `ion-action-sheet`, `ion-alert`, `ion-loading`, `ion-modal`, `ion-popover`, `ion-picker`, and `ion-toast`. | +| Overlays | 100 | No | Applies to overlay components `ion-action-sheet`, `ion-alert`, `ion-loading`, `ion-modal`, `ion-popover`, and `ion-picker`. | | Menu | 99 | No | Applies to `ion-menu`. | | Navigation | 0 | Yes | Applies to routing navigation (i.e. Angular Routing). |