Skip to content
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

Jump to bottom

docs(toast): clarify toasts from overlays #3432

Merged
merged 3 commits into from
Feb 7, 2024
Merged

docs(toast): clarify toasts from overlays #3432

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ceb9083
docs(toast): clarify toasts from overlays
liamdebeasi Feb 6, 2024
56738fc
Update docs/api/toast.md
liamdebeasi Feb 7, 2024
d83214d
Update toast.md
liamdebeasi Feb 7, 2024
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
4 changes: 4 additions & 0 deletions docs/api/toast.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,10 @@ While this is not a complete list, here are some guidelines to follow when using

* For toasts with long messages, consider adjusting the `duration` property to allow users enough time to read the content of the toast.

* If adding buttons to a toast, always provide alternative ways of completing the actions associated with each button. This ensures that even if the toast dismisses before a user can read it, they can still complete the actions shown in the toast.

* Avoid showing a toast with buttons from inside another overlay such as a [modal](./modal). Modals and other overlays implement [focus trapping](./modal#focus-trapping) that will prevent screen readers from moving focus to the toast to complete the actions. This may be confusing for users since the toast will still be announced by screen readers. This is true even if alternative ways of completing the actions associated with each button are implemented. Consider creating a [live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Live_Regions) within the focus-trapped modal instead of using a toast.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Am I losing it here or do these links to modal not work? I swear it worked yesterday but now it brings me to "file not found".

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Weird! It's working for me on https://ionic-docs-git-5273-docs-ionic1.vercel.app/docs/api/toast#tips

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ignore me. For some reason I was doing it from the preview in GitHub. 😂


## Interfaces

### ToastButton
Expand Down