content: document alternative to dismissOnPageChange (ionNavWillChange, ionNavDidChange)
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- angular
- Domain
- documentation
Research direction
Start with BREAKING_ARCHIVE/v4.md at the overlays section and review the existing dismissOnPageChange workaround. Check the Angular router-events usage shown in the issue, especially NavigationEnd, and document a usable alternative with enough context for readers to apply it. Done means the page no longer points to an undocumented event without explaining how to use the recommended approach.
Written by the indexing model from the issue text.
Description
URL
https://github.com/ionic-team/ionic-framework/blob/main/BREAKING_ARCHIVE/v4.md#overlays
What is missing or inaccurate about the content on this page?
The doc says that as a workaround for the removed dismissOnPageChange, there are global events (ionNavWillChange, ionNavDidChange) that you can listen to in order to detect when navigation occurs.
I can't find any documentation anywhere on how to actually use ionNavDidChange, so this is not a great proposed alternative.
I managed to get it working using this code in app.component.ts to subscribe to Angular router events:
router.events.subscribe(event => {
if (event instanceof NavigationEnd) {
// Do something
}
});
Perhaps this should be documented as an alternative to dismissOnPageChange.
- 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
-
Area: Excel support
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
orbeon/orbeon-forms#7893 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
docToolchain/docToolchain#1705 ·
-
kb-infra-drift
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
OCHA-DAP/ds-knowledge-base#653 · 1 comment ·
-
area/dev-productivity area/disaster-recovery area/ipcei kind/enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
namespace operations
Difficulty 1/5 Under an hour Newbie friendliness 90/100
EclipseFdn/open-vsx.org#13419 ·