Skip to content

Commit d9a33f0

Browse files
thetaPCliamdebeasi
andauthored
docs(toast): remove hardware back button dismissal (#2854)
Co-authored-by: liamdebeasi <[email protected]>
1 parent 2f64893 commit d9a33f0

File tree

4 files changed

+10
-2
lines changed

4 files changed

+10
-2
lines changed

docs/api/toast.md

+4
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,12 @@ import ControllerExample from '@site/static/usage/v7/toast/presenting/controller
4848

4949
## Dismissing
5050

51+
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.
52+
5153
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.
5254

55+
Pressing the hardware back button does not dismiss toasts since they are not supposed to interrupt the user.
56+
5357
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.
5458

5559
import ButtonsPlayground from '@site/static/usage/v7/toast/buttons/index.md';

docs/developing/hardware-back-button.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -340,6 +340,6 @@ The table below lists all of the internal hardware back button event handlers th
340340

341341
| Handler | Priority | Propagates | Description |
342342
| ---------- | -------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
343-
| Overlays | 100 | No | Applies to overlay components `ion-action-sheet`, `ion-alert`, `ion-loading`, `ion-modal`, `ion-popover`, `ion-picker`, and `ion-toast`. |
343+
| Overlays | 100 | No | Applies to overlay components `ion-action-sheet`, `ion-alert`, `ion-loading`, `ion-modal`, `ion-popover`, and `ion-picker`. |
344344
| Menu | 99 | No | Applies to `ion-menu`. |
345345
| Navigation | 0 | Yes | Applies to routing navigation (i.e. Angular Routing). |

versioned_docs/version-v6/api/toast.md

+4
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,12 @@ function Example() {
9191

9292
## Dismissing
9393

94+
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.
95+
9496
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.
9597

98+
Pressing the hardware back button does not dismiss toasts since they are not supposed to interrupt the user.
99+
96100
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.
97101

98102
import ButtonsPlayground from '@site/static/usage/v6/toast/buttons/index.md';

versioned_docs/version-v6/developing/hardware-back-button.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -340,6 +340,6 @@ The table below lists all of the internal hardware back button event handlers th
340340

341341
| Handler | Priority | Propagates | Description |
342342
| ---------- | -------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
343-
| Overlays | 100 | No | Applies to overlay components `ion-action-sheet`, `ion-alert`, `ion-loading`, `ion-modal`, `ion-popover`, `ion-picker`, and `ion-toast`. |
343+
| Overlays | 100 | No | Applies to overlay components `ion-action-sheet`, `ion-alert`, `ion-loading`, `ion-modal`, `ion-popover`, and `ion-picker`. |
344344
| Menu | 99 | No | Applies to `ion-menu`. |
345345
| Navigation | 0 | Yes | Applies to routing navigation (i.e. Angular Routing). |

0 commit comments

Comments
 (0)