docs(toast): document useToast API, quiet mode, and announcers - #394
Merged
mikewheeleer merged 1 commit intoJul 20, 2026
Merged
Conversation
Contributor
|
good stuff here — merged with thanks 🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
closes #380
This PR introduces comprehensive documentation for the
ToastProvidersystem and strengthens its test coverage to align with the documented behavior. The toast provider is a critical, user-facing component, and this work provides a durable reference for its API and features.Key Changes
docs/components/Toast.md): Created a complete reference document covering:ToastProvideranduseToasthook API.roleattributes and theToastAnnouncerlive regions.src/components/toast/toast-provider.tsx, linking directly to the new documentation and summarizing key behaviors in-code.toast-provider.test.tsxto explicitly verify behaviors mentioned in the documentation, such asaria-atomicattributes and eviction logic.This resolves the issue of scattered or missing documentation for a central UI component, making it easier for developers to use the toast system correctly and safely.