Add info on how components are loaded (especially useful for Toast & Alert ones)
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
Research direction
Start with the components documentation and the Toast and Alert API pages linked in the issue. Explain that components are lazy loaded and document how to preload components needed when an app is offline; the linked Ionic Framework discussion provides the background to verify the wording.
Written by the indexing model from the issue text.
Description
URL
The URL at which the content is missing or inaccurate:
- Globally at: https://ionicframework.com/docs/components
- Or in the Toast & Alert component at: https://ionicframework.com/docs/api/toast, https://ionicframework.com/docs/api/alert
What is missing or inaccurate about the content on this page?
I was testing that an app that I'm developing was working correctly when the user's device does not have an internet connection, and for that I'm displaying a toast when a request fails because he does not have an internet connection. But this toast was never displaying and every time I was getting an error in the developer console of my browser. I did some research and figure out that components are lazy loaded and that was the cause of the problem (see the explanation here: https://github.com/ionic-team/ionic-framework/issues/17450#issuecomment-628223724).
Hence, this would be really cool to add this explanation on the Ionic website to inform people that you have to preload components that you want to display when the user's device goes offline.
- Dominant language
- MDX
- Stars
- 621
- Forks
- 3.2k
- Avg merge
- 1d 2h
- Merged PRs (30d)
- 86
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from ionic-team/ionic-docs
-
content
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
ionic-team/ionic-docs#4705 ·
-
content package: angular
Difficulty 2/5 Half a day Newbie friendliness 78/100
ionic-team/ionic-docs#4702 ·
-
triage
Difficulty 1/5 Under an hour Newbie friendliness 80/100
ionic-team/ionic-docs#4546 ·
-
content: broken link Opencontent
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
ionic-team/ionic-docs#4381 · 2 comments ·
-
triage
Difficulty 1/5 Under an hour Newbie friendliness 72/100
ionic-team/ionic-docs#3639 ·
All issues in ionic-team/ionic-docs
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
agilepathway/label-checker#640 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
BasedHardware/omi#15662 · 1 comment ·
-
documentation help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
documentation good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
amponce/archive-movie-browser#167 ·
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·