feature: provide an API to make router ignore an anchor #17745
Conversation
mcollovati
added
the
Contribution
| assignHrefAttribute(); | ||
| } | ||
|
|
||
| /** | ||
| * The routing mechanism in Vaadin by default intercepts all anchor elements | ||
| * with relative URL. This method can be used make the router ignore this |
There was a problem hiding this comment.
I'm wondering if it would be worth to add e.g. a info-level logging in development mode on attach (like done in Label) to inform the user about this behavior when setRouterIgnore(false) and setHref(relative path)?
I feel like most of the "pitfalls" (when they can't be changed easily, cause "senior" users are used to it by now and would unnessary result in breaking changes) can be improved for new user by providing such information in the logs to notify them about the problem and possible better practice?
Edit: Totally out of scope, just thinking out loud: Instead of bloating all components.. the devserver could contain hooks that are always called when components are added to the layout and could implement such checks based on a "ruleset", allowing to improve UX, DX and probably even the whole application overall by providing helpfull tipps like:
- "Anchor with relatives paths and no router-link attribute are handled by Vaadin. Is this intended?"
- "Found foo in bar. It would be better to use baz instead to improve accessibility."
- ...
Sell it as pro-code 😉
There was a problem hiding this comment.
More than the added phase (which might be handy as well), would be more/as handy if could intercept the phase when the state is about to be synced with the client. That I have missed a dozen of times. There is this related UI.beforeClientResponse, but that is also component specific (and the method is in weird place and not that well documented in our reference docs).
There was a problem hiding this comment.
And yeah, something derived of that could be used for some actual logic as well, not just complaining that our users have not figured out that we have bad defaults ;-)
There was a problem hiding this comment.
Yeah "beforeClientResponse".. I remember that method, everytime I see it in the flow components it feels like some hack-ish way to workaround limitations 😬
use given boolean in set method
|
Kudos, SonarCloud Quality Gate passed!
|
|
Not planning to add that. It would only help a tiny bit in the big picture. As discussed in the ticket a better solution would be to the change the default in Anchor component. But still, most broken links probably come via other links than those created with Anchor (like richtextarea editing html coming to be displayed within same app) and the true fix would be to admit that we have had this wrong default since V15 in the client side router itself. That should be changed and the only thing that would break are some rare Vaadin-Hilla integrations - otherwise changing the default would only fix current apps (hunch, haven't checked if people (mis)use Anchor for in-app navigation). |
|
I agree with Matti (it was just a thought experiment), but I trust people to missuse the anchor, like any other component 🙈 |
|
This ticket/PR has been released with Vaadin 24.3.0.alpha1 and is also targeting the upcoming stable 24.3.0 version. |
Description
Anchors in Vaadin are simply broken if the url happens to be relative. With this API that can be fixed.
Fixes #17617
Type of change
Checklist
Additional for
Featuretype of change