Skip to content

Adapt BroadcastChannel events to the new event structure#12982

Merged
sideshowbarker merged 2 commits intomdn:mainfrom
teoli2003:Events-BroadcastChannel
Feb 14, 2022
Merged

Adapt BroadcastChannel events to the new event structure#12982
sideshowbarker merged 2 commits intomdn:mainfrom
teoli2003:Events-BroadcastChannel

Conversation

@teoli2003
Copy link
Contributor

@teoli2003 teoli2003 commented Feb 14, 2022 •
edited
Loading

This PR updates the BroadcastChannel interface for new-style event pages. (see the template)

The onXYZ event handler pages are redirected to the eventname_event pages. As both the event pages and the onXYZ pages were existing, I used:
yarn content delete Web/API/BroadcastChannel/onmessage --redirect=/en-US/docs/Web/API/BroadcastChannel/message_event
yarn content delete Web/API/BroadcastChannel/onmessageerror --redirect=/en-US/docs/Web/API/BroadcastChannel/messageerror_event

I also corrected a few details:

  • I removed the experimental banners and icons.
  • I removed a gremlin (curly ").
  • I fixed the reported flaws.
  • I made sure to use = event => {} modern JS way of assigning events.
  • I removed the uses of {{event}} macros in these pages.

BCD: mdn/browser-compat-data#14969

@github-actions github-actions bot added the Content:WebAPI Web API docs label Feb 14, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Feb 14, 2022

Preview URLs

Flaws

Note! 7 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Web/API/Broadcast_Channel_API
Title: Broadcast Channel API
on GitHub
Flaw count: 3

  • broken_links:
    • Can't resolve /en-us/docs/Web/API/BroadcastChannel/message_event
  • bad_bcd_links:
    • no explanation!
    • no explanation!

External URLs

URL: /en-US/docs/Web/API/BroadcastChannel
Title: BroadcastChannel
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/BroadcastChannel/name
Title: BroadcastChannel.name
on GitHub

No external URLs

URL: /en-US/docs/Web/API/BroadcastChannel/postMessage
Title: BroadcastChannel.postMessage()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/BroadcastChannel/message_event
Title: BroadcastChannel: message event
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/BroadcastChannel/BroadcastChannel
Title: BroadcastChannel()
on GitHub

No external URLs

URL: /en-US/docs/Web/API/BroadcastChannel/close
Title: BroadcastChannel.close()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/BroadcastChannel/messageerror_event
Title: BroadcastChannel: messageerror event
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Broadcast_Channel_API
Title: Broadcast Channel API
on GitHub

No new external URLs

@teoli2003 teoli2003 requested a review from Elchi3 February 14, 2022 09:08
@teoli2003 teoli2003 marked this pull request as ready for review February 14, 2022 09:08
@teoli2003 teoli2003 requested review from a team as code owners February 14, 2022 09:08
@teoli2003 teoli2003 mentioned this pull request Feb 14, 2022
Merged
@sideshowbarker sideshowbarker merged commit e56ebea into mdn:main Feb 14, 2022
@Elchi3 Elchi3 mentioned this pull request Feb 14, 2022
Merged
Elchi3
Elchi3 reviewed Feb 14, 2022
View reviewed changes
files/en-us/web/api/broadcastchannel/messageerror_event/index.md

A {{domxref("MessageEvent")}}. Inherits from {{domxref("Event")}}.

{{InheritanceDiagram("TrackEvent")}}
Copy link
Member

@Elchi3 Elchi3 Feb 14, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be {{InheritanceDiagram("MessageEvent")}}

Elchi3
Elchi3 reviewed Feb 14, 2022
View reviewed changes
files/en-us/web/api/broadcastchannel/message_event/index.md
A {{domxref("MessageEvent")}}. Inherits from {{domxref("Event")}}.

### Live example
{{InheritanceDiagram("TrackEvent")}}
Copy link
Member

@Elchi3 Elchi3 Feb 14, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

{{InheritanceDiagram("MessageEvent")}}

@teoli2003 teoli2003 mentioned this pull request Feb 14, 2022
Merged
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 14, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@Elchi3 Elchi3 Elchi3 left review comments

@sideshowbarker sideshowbarker sideshowbarker approved these changes

Assignees

No one assigned

Labels

Content:WebAPI Web API docs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@teoli2003 @sideshowbarker @Elchi3