Document best practices for handling modal life cycle events with frameworks
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- angular
- Domain
- documentation, frontend
Research direction
Start with the modal API page at https://ionicframework.com/docs/api/modal and read the linked reference issue #25250. Identify the lifecycle events and framework guidance currently missing, especially the Angular case involving presentation outside a component. Done means the page documents clear best practices for listening and responding after an ion-modal is presented.
Written by the indexing model from the issue text.
Description
URL
The URL at which the content is missing or inaccurate: https://ionicframework.com/docs/api/modal
What is missing or inaccurate about the content on this page?
We should document best practices with life cycle events for ion-modal and frameworks. Since it is a common pattern to present the modal from code external to a component, for example in Angular within a service; developers will need to be instructed on how to best listen and respond for when the modal is presented from their component.
For Angular, it makes the most sense to use rxjs subjects to emit changes after the modal is presented.
Reference issue: https://github.com/ionic-team/ionic-framework/issues/25250
- 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
-
documentation help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
infinispan/infinispan#18150 ·