-
Notifications
You must be signed in to change notification settings - Fork 22.5k
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 optional_host_permissions docs #33819
Closed
Ashish-CodeJourney
wants to merge
3
commits into
mdn:main
from
Ashish-CodeJourney:feature/bug_1766026
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
54 changes: 54 additions & 0 deletions
54
.../mozilla/add-ons/webextensions/manifest.json/optional_host_permissions/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
--- | ||
title: optional_host_permissions | ||
slug: Mozilla/Add-ons/WebExtensions/manifest.json/optional_host_permissions | ||
page-type: webextension-manifest-key | ||
browser-compat: webextensions.manifest.optional_host_permissions | ||
--- | ||
|
||
{{AddonSidebar}} | ||
|
||
<table class="fullwidth-table standard-table"> | ||
<tbody> | ||
<tr> | ||
<th scope="row">Type</th> | ||
<td><code>Array</code></td> | ||
</tr> | ||
<tr> | ||
<th scope="row">Mandatory</th> | ||
<td>No</td> | ||
</tr> | ||
<tr> | ||
<th scope="row">Manifest version</th> | ||
<td>3 or higher</td> | ||
</tr> | ||
<tr> | ||
<th scope="row">Example</th> | ||
<td> | ||
<pre class="brush: json;"> | ||
"optional_host_permissions": [ | ||
"*://developer.mozilla.org/*", | ||
"*://*.example.org/*" | ||
]</pre | ||
> | ||
</td> | ||
</tr> | ||
</tbody> | ||
</table> | ||
|
||
Use the `optional_host_permissions` key to enable runtime requests for access (access granted by the user after your extension has been installed) for the APIs in your extension that read or modify host data, such as {{WebExtAPIRef("cookies")}}, {{WebExtAPIRef("webRequest")}}, and {{WebExtAPIRef("tabs")}}. This key is an array of strings. | ||
|
||
See [`host_permissions`](/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/host_permissions) for more information on defining hosts. | ||
|
||
Use the {{webextapiref("permissions")}} API to ask for a permission. Asking for a permission may present the user with a dialog requesting they grant the host permission to your extension. | ||
|
||
## Example | ||
|
||
```json | ||
"optional_host_permissions": ["*://developer.mozilla.org/*"] | ||
``` | ||
|
||
Enables your extension to make a runtime request for privileged access to pages under `developer.mozilla.org`. | ||
|
||
## Browser compatibility | ||
|
||
{{Compat}} | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[mdn-linter] reported by reviewdog 🐶