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.

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

Update Toast/Dialog/Drawer docs with specific use case warnings #618

Closed
endigo9740 opened this issue Dec 1, 2022 · 1 comment · Fixed by #620
Closed

Update Toast/Dialog/Drawer docs with specific use case warnings #618

endigo9740 opened this issue Dec 1, 2022 · 1 comment · Fixed by #620
Labels
documentation Improvements or additions to documentation

Comments

@endigo9740
Copy link
Contributor

Link to the Page

No response

Describe the Issue

See this PR for the full context and discussion:
#580

I think we've settled on a change in messaging for the Toast/Dialog/Drawer documentation rather than any codebase related modifications. Generally idea is we should warn users against the follow scenarios:

  1. Don't use a global store in a SvelteKit app within a Load function
  2. If you need a overlay feature triggered on init, put it inside a Browser context if (browser) ...

Then linking back to the PR discussion or SvelteKit threads for additional reference.

Are you able to create a Pull Request with the fix?

Yes

@endigo9740 endigo9740 added the documentation Improvements or additions to documentation label Dec 1, 2022
@endigo9740 endigo9740 changed the title <title> Update Toast/Dialog/Drawer docs with specific use case warnings Dec 1, 2022
@endigo9740
Copy link
Contributor Author

I've implemented the following warning tailored for all three sections.

Screen Shot 2022-12-01 at 2 06 22 PM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant