-
-
Notifications
You must be signed in to change notification settings - Fork 926
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
m.route.Link doesn't proxy event handler prevention #2767
Comments
As a priority, the docs need fixing to remove the misleading line about event handlers & fix the API signature table's description of |
The router has been completely rewritten since I left, and I'll have to wrap my head around the new code first if we decide something needs fixing |
Do you think it's a release blocker? I was planning to release this weekend 😉 Can anyone fix the docs for now so we can do bugfix release later on? |
@barneycarroll can you do it? I've yet to wrap my head around the issue, and I have the kids this weekend. I may have a look at it this evening otherwise. |
* Simpler m.route.Link documentation. Fixes #2767 * Remove redundant HTML encoding from markdown docs * Warn about m.route.Link immunity to event handler API. * Integrate @JAForbes review corrections * Example code typo in docs/route.md Co-authored-by: Matias Kinnunen <github@mtsknn.fi> Co-authored-by: Matias Kinnunen <github@mtsknn.fi>
* Simpler m.route.Link documentation. Fixes #2767 * Remove redundant HTML encoding from markdown docs * Warn about m.route.Link immunity to event handler API. * Integrate @JAForbes review corrections * Example code typo in docs/route.md Co-authored-by: Matias Kinnunen <github@mtsknn.fi> Co-authored-by: Matias Kinnunen <github@mtsknn.fi>
m.route.Link
documentation misleadingly states thatNeither of those criteria will actually prevent the default behaviour of a
Link
as they do with a simplea
. It's a shame because this is IMO the clearest sentence in this APIs documentation, and it's false. I wrote a little matrix sandbox to try and work out how event handling logic intersected withLink
behaviour here, it may be useful for anyone else trying to reconcile expectations.It took me reading the source & returning to read the docs a few times over to realise they're trying to explain the behaviour of a special-cased magic
disabled
attribute, which is the only way of preventing anLink
from resolving. On that front, they're extremely unclear. Critically, the published docs have a typo stating that thedisabled
attribute is forwarded to them.route.set
API.The text was updated successfully, but these errors were encountered: