Content: Why MDN says Beacon API is experimental?

Created on 23 Feb 2021 · 5Comments · Source: mdn/content

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?

WebAPI

Source

fcmatteo

Most helpful comment

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.

https://github.com/mdn/content/issues/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 https://github.com/mdn/content/issues/1521. @sideshowbarker , I'm happy to have a go at distilling the comments in that thread, if you like.

wbamberg on 24 Feb 2021

👍2

All 5 comments

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.

wbamberg on 23 Feb 2021

Perhaps related to #1521

Ryuno-Ki on 23 Feb 2021

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.