Better explanations of the use cases for AfterNavigationListener and AfterNavigationObserver
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 72/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- java
- Domain
- documentation
Research direction
Start with the AfterNavigationEvent documentation linked in the issue and locate the section explaining AfterNavigationObserver and AfterNavigationListener. Clarify at the beginning that observers are component-scoped while listeners are UI-scoped and run before observers; done means readers can choose the appropriate interface for a component or for navigation generally.
Written by the indexing model from the issue text.
Description
Tell us about your request
AfterNavigationEvent documentation leaves a confusion for readers between AfterNavigationObserver and AfterNavigationListener.
Despite this article has a technically correct explanation for how to add them and what's their order, it should highlight the essential difference between them:
- observers are implemented by component class and being active only when this component is attached to
UI; - listeners are added to
UIinstance without a need to implement any interface or override a method.
Observers are "per component" and Listeners are "per UI", i.e. invoked before any found observer.
Hopefully these key point, if placed in the very beginning of this chapter, would help readers which interface to use for particular component Java class and which to use for any navigation.
If you think this issue is important, add a 👍 reaction to help the community and maintainers prioritize this issue.
- Dominant language
- AsciiDoc
- Stars
- 38
- Forks
- 225
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 170
Contributor guide
No contributing guide indexed for this repository
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 vaadin/docs
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
design system
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
design system
Difficulty 1/5 1-3 hours Newbie friendliness 72/100
-
a11y design system
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
a11y design system
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Similar issues
-
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 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
infinispan/infinispan#18150 ·
-
bug triage:deciding
Difficulty 1/5 Under an hour Newbie friendliness 88/100
open-telemetry/otel-arrow#4132 ·
-
Ecosystem: ClawMetry — the Qwen Code reader is now free and open source (follow-up to #9294 / #9338) Opencategory/integration priority/P3 scope/documentation status/ready-for-human type/feature-request
Difficulty 1/5 Under an hour Newbie friendliness 84/100