Skip to content
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

Restore event init options tables (bubbles, cancelable, composed) #32832

Closed
Kaiido opened this issue Mar 26, 2024 · 4 comments
Closed

Restore event init options tables (bubbles, cancelable, composed) #32832

Kaiido opened this issue Mar 26, 2024 · 4 comments
Labels
Content:WebAPI Web API docs needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened.

Comments

@Kaiido
Copy link
Contributor

Kaiido commented Mar 26, 2024

MDN URL

https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event

What specific section or headline is this issue about?

The event init flags table

What information was incorrect, unhelpful, or incomplete?

In this particular case, there is no mention that this event does not bubble, or when it's cancelable (when toggling from closed to open, but not the other way around).

But the problem is more general than just this one case, for instance the toggle event is not cancelable and doesn't bubble, or the invalid event which doesn't bubble either, or the animationstart event isn't cancelable, and that's only the few I looked at. I'm afraid the vast majority is now wrong.

What did you expect to see?

For every event, there used to be a table which listed the various event-init flags that a particular event would be created with, i.e. bubbles, cancelable, or, composed. This was

  • easy to read,
  • easy to review,
  • hard to forget when documenting a new event (which I guess is what happened for the popover case).

Do you have any supporting links, references, or citations?

In this duplicate but locked issue, @queengooborg explained

during the migration to a new page layout for event pages, we removed those tables as we merged the information into the writing itself. If an event is cancellable or does not bubble, you will now see a line near the top that says "This event is not cancellable" or "This event does not bubble". In other words, the information has not been removed, it's just represented in a different form.

Do you have anything more you want to share?

One issue here is that as the linked beforetoggle case demonstrates, it's not always obvious which flags are set for a particular event since it can differ based on where it's actually fired, so the table data can't really be automated.
Still, I believe MDN is the place to document this and asking web-devs to do the hunting in the specs isn't appropriate, and I hope the old data is still available somewhere, which should help for the majority of events.


Ps: Sorry for opening a new issue when there was already #22198 but as I said, it's been locked and I can't comment on that one anymore.

@Kaiido Kaiido added the needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. label Mar 26, 2024
@github-actions github-actions bot added the Content:WebAPI Web API docs label Mar 26, 2024
@wbamberg
Copy link
Collaborator

See also #19590 .

@Kaiido
Copy link
Contributor Author

Kaiido commented Mar 27, 2024

Oh thanks, I missed that one. I guess I can move it as a comment there, or should I try to start the discussion that @teoli2003 was talking about directly?

@wbamberg
Copy link
Collaborator

should I try to start the discussion that @teoli2003 was talking about directly?

I think that's a good idea! But let's also close this as a duplicate of the other one.

@wbamberg wbamberg closed this as not planned Won't fix, can't repro, duplicate, stale Mar 27, 2024
@wbamberg
Copy link
Collaborator

wbamberg commented Apr 1, 2024

I started the discussion->https://github.com/orgs/mdn/discussions/665.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:WebAPI Web API docs needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened.
Projects
None yet
Development

No branches or pull requests

2 participants