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

Add CloseWatcher reference pages #33910

Merged
merged 6 commits into from
Jul 4, 2024
Merged

Add CloseWatcher reference pages #33910

merged 6 commits into from
Jul 4, 2024

Conversation

Elchi3
Copy link
Member

@Elchi3 Elchi3 commented Jun 4, 2024

Description

Adds references pages for CloseWatcher.

I reckon that my work here is quite minimal. Would be cool to write a bit more about this either in this PR or as a follow-up.

Motivation

This API is new and ships in Chromium based browsers in M126.
Fixes #34184

Additional details

Link to spec: https://html.spec.whatwg.org/multipage/interaction.html#the-closewatcher-interface

Related issues and pull requests

BCD: mdn/browser-compat-data#23207

@Elchi3 Elchi3 requested a review from a team as a code owner June 4, 2024 12:20
@Elchi3 Elchi3 requested review from sideshowbarker and removed request for a team June 4, 2024 12:20
@github-actions github-actions bot added Content:WebAPI Web API docs size/m [PR only] 51-500 LoC changed labels Jun 4, 2024
Elchi3 and others added 2 commits June 4, 2024 14:23
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@wbamberg wbamberg requested review from wbamberg and removed request for sideshowbarker June 5, 2024 15:56
files/en-us/web/api/closewatcher/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/closewatcher/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/closewatcher/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/closewatcher/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/closewatcher/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/closewatcher/closewatcher/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/closewatcher/destroy/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/closewatcher/destroy/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/closewatcher/destroy/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/closewatcher/close/index.md Outdated Show resolved Hide resolved
@lukewarlow
Copy link
Contributor

Anything I can do to help get this across the line? It's shipped in Chrome and I have a webkit implementation so it'll hopefully be merged and released there soon, having these docs will be useful for developers to make use of it.

@wbamberg
Copy link
Collaborator

wbamberg commented Jul 2, 2024

@lukewarlow I'll take a look today.

Co-authored-by: wbamberg <will@bootbonnet.ca>
Co-authored-by: wbamberg <will@bootbonnet.ca>
@Elchi3
Copy link
Member Author

Elchi3 commented Jul 3, 2024

Thank you Will for reviewing this so thoroughly and making these docs so much better than my lazy initial pull request. I've accepted your suggestions.

Copy link
Collaborator

@wbamberg wbamberg left a comment

Choose a reason for hiding this comment

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

I'm happy it's helpful, Florian :).

I will approve this but won't merge in case @lukewarlow has comments, especially whether can do better with #33910 (comment). I don't think this is a blocker for getting the PR merged though.

Copy link
Contributor

@lukewarlow lukewarlow left a comment

Choose a reason for hiding this comment

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

LGTM (the anti abuse mechanism explainer is possibly something that can be expanded upon in a Close Watcher API overview page if one is ever made?).

@wbamberg wbamberg merged commit 600202f into mdn:main Jul 4, 2024
8 checks passed
@Elchi3 Elchi3 deleted the closewatcher branch July 5, 2024 09:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:WebAPI Web API docs size/m [PR only] 51-500 LoC changed
3 participants