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

Change interface to property on devtool page #21004

Merged

Conversation

rebloor
Copy link
Contributor

@rebloor rebloor commented Sep 23, 2022

Description

Changes the heading for the list of devtools properties to properties. Change missed from #20969.

@rebloor rebloor added the Content:WebExt WebExtensions docs label Sep 23, 2022
@rebloor rebloor requested a review from rpl September 23, 2022 00:11
@rebloor rebloor self-assigned this Sep 23, 2022
@rebloor rebloor requested a review from a team as a code owner September 23, 2022 00:11
@github-actions github-actions bot added the Content:Other Any docs not covered by another "Content:" label label Sep 23, 2022
@github-actions
Copy link
Contributor

Copy link
Member

@rpl rpl left a comment

Choose a reason for hiding this comment

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

@rebloor ty!

(The inline comment below is not related to this fix, it is a separate issue I noticed while reading the diff).

@@ -19,7 +19,7 @@ Enables extensions to interact with the browser's {{Glossary("Developer Tools")}

To use this API you need to have the `"devtools"` [API permission](/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/permissions#api_permissions) specified in your [manifest.json](/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json) file. This permission can not be optional.
Copy link
Member

Choose a reason for hiding this comment

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

@rebloor Unrelated to what this pull request is meant to fix, it seems worth filing it as a separate issue, but I did notice it while I was looking to this diff and so I thought to mention it to you here in the meantime:

  • "devtools" API doesn't technically exist in Chromium, and in Firefox isn't mandatory, it is implicitly prompted (and granted) at install time if the extension has a "devtools_page" property in the manifest.json file (unless listed as an optional permission in Firefox >= 77)

  • in Firefox >= 77 "devtools" permission can also be listed as an optional permission, if listed as an optional permission in the manifest.json file it will not be prompted and granted at install time and the extensions is going to be responsible of requesting it using the permissions WebExtensions API

  • It may be worth to mention that the "devtools" API namespace is only available in the DevTools Extension Pages (the devtools_page and the extension devtools panels created from the devtools_page using the devtools.panels.create and devtools.panels.elements.createSidebarPane), no other extension pages (e.g. background page or action popup panels pages) can access this API namespace

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks @rpl, I have created #21059 and will look into this shortly

@rebloor rebloor merged commit 58c6fc5 into mdn:main Sep 25, 2022
himanshugarg pushed a commit to himanshugarg/content that referenced this pull request Sep 27, 2022
@rebloor rebloor deleted the change-interface-to-property-on-devtool-pages branch October 25, 2022 16:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:Other Any docs not covered by another "Content:" label Content:WebExt WebExtensions docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants