Closed Bug 1278180 Opened 8 years ago Closed 8 years ago

Remove browser.browserAction.openPopup documentation

Categories

(WebExtensions :: Untriaged, defect)

49 Branch
defect
Not set
normal

Tracking

(Not tracked)

RESOLVED FIXED

People

(Reporter: naber, Assigned: wbamberg)

References

(Blocks 1 open bug)

Details

(Whiteboard: [browserAction] triaged)

User Agent: Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:46.0) Gecko/20100101 Firefox/46.0
Build ID: 20160511224433

Steps to reproduce:

browser.browserAction.openPopup is documented at https://developer.mozilla.org/en-US/Add-ons/WebExtensions/API/browserAction/openPopup to exist since FF 45, but in my web extension it's undefined (tried in popup.js and background.js). I tried with today's FF nightly (49.0a1). Same for chrome.browserAction.openPopup.


Actual results:

browser.browserAction.openPopup is undefined


Expected results:

browser.browserAction.openPopup should exist and open the extension's popup
I'm moving the issue to Toolkit - WebExtensions component. Activity Streams is an add-on and has nothing to do with your issue.
Component: Activity Streams: General → WebExtensions
Product: Firefox → Toolkit
There's a documentation bug, this isn't yet implemented.  We'll get the MDN compat data fixed and use this bug to track doing the implementation.
(you can also look at http://arewewebextensionsyet.com/ for current compatibility info, then any inconsistencies between that page and MDN are bugs...)
Status: UNCONFIRMED → NEW
Ever confirmed: true
Summary: browser.browserAction.openPopup is documented but doesn't seem to exist → Implement browser.browserAction.openPopup
Whiteboard: [browserAction] triaged
This isn't something we're going to implement. Chrome only supports this method for internal add-ons. It's not public.
Summary: Implement browser.browserAction.openPopup → Remove browser.browserAction.openPopup documentation
I updated the docs on MDN, but the method needs to be removed from the compat tables as well.
Assignee: nobody → wbamberg
It's gone: https://github.com/mdn/browser-compat-data/commit/049e357a66df4866329a578b0cead78c640250cc

and I've refreshed the relevant pages.
Status: NEW → RESOLVED
Closed: 8 years ago
Resolution: --- → FIXED
Thanks for fixing the documentation. For reference, this issue (whether this should be a private API or not) is discussed for Chrome at https://bugs.chromium.org/p/chromium/issues/detail?id=436489
openPopup is still listed at https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Chrome_incompatibilities#browserAction
If there are no other incompatibilities, then we can move "browserAction" to the "Fully supported APIs" section.
Looks like it, so I've done that!
(I'd like to start generating this page from our compat data, but I'm not quite there yet.)
(In reply to Daniel Naber from comment #6)
> Thanks for fixing the documentation. For reference, this issue (whether this
> should be a private API or not) is discussed for Chrome at
> https://bugs.chromium.org/p/chromium/issues/detail?id=436489

I read this, and it is convincing - there is not a single good reason mentioned why it should not work.

In addition exactly the same worked with SDK/pannel for many years - did anyone notice problems with that?

Instead we are pushing addon developpers into using unsafe practices like 
  https://bugzilla.mozilla.org/show_bug.cgi?id=1287590
and similar.
openPopup will be in the next Firefox Nightly build and ultimately in Firefox 57 - see bug 1341126.
Product: Toolkit → WebExtensions
You need to log in before you can comment on or make changes to this bug.