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

Why MDN says Beacon API is experimental? #2622

Closed
fcmatteo opened this issue Feb 23, 2021 · 5 comments
Closed

Why MDN says Beacon API is experimental? #2622

fcmatteo opened this issue Feb 23, 2021 · 5 comments
Labels
Content:WebAPI Web API docs

Comments

@fcmatteo
Copy link

fcmatteo commented Feb 23, 2021

Hi there, I had a discussion with my team arguing whether we should or should not use sendBeacon, and one of my teammates sent this link that says that the API is experimental https://developer.mozilla.org/en-us/docs/Web/API/Beacon_API/Using_the_Beacon_API

But it doesn't say that in the repo https://github.com/mdn/content/blob/main/files/en-us/web/api/beacon_api/using_the_beacon_api/index.html

What's the problem here?

@wbamberg
Copy link
Collaborator

It's because the page includes the {{SeeCompatTable}} macro. I think we should just remove that macro call.

For experimental-ness, it's usually better to check the compat table, which will give you more detail and be more likely to be up to date: https://developer.mozilla.org/en-US/docs/Web/API/Navigator/sendBeacon#browser_compatibility.

@Ryuno-Ki
Copy link
Collaborator

Perhaps related to #1521

@Ryuno-Ki Ryuno-Ki added the Content:WebAPI Web API docs label Feb 23, 2021
@wbamberg
Copy link
Collaborator

Thanks, that's a really interesting thread. But I don't think it's connected to this issue.

{{SeeCompatTable}} asks people to look at the compat for the item: although the link the macro adds is broken (because that page doesn't contain a table) the compat for the API looks pretty good.

#1521 argues that the concrete guidance given in the documentation (most specifically, about using onunload) is wrong. @sideshowbarker made some improvements to the Navigator.sendBeacon() article, but Using the Beacon API and the Beacon API overview page both still reference onunload.

So we should IMO remove {{SeeCompatTable}}, but also update these docs in #1521. @sideshowbarker , I'm happy to have a go at distilling the comments in that thread, if you like.

@sideshowbarker
Copy link
Member

@sideshowbarker , I'm happy to have a go at distilling the comments in that thread, if you like.

Yes please — that’d be great

@wbamberg
Copy link
Collaborator

wbamberg commented Mar 5, 2021

I just merged #2866 which removes the {{SeeCompatTable}}, as well as addressing #1521, so I think we can close this.

@wbamberg wbamberg closed this as completed Mar 5, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 9, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Content:WebAPI Web API docs
Projects
None yet
Development

No branches or pull requests

4 participants