Skip to content

Commit

Permalink
update bikeshed build to support multiple bikeshed files
Browse files Browse the repository at this point in the history
  • Loading branch information
patrickkettner committed Dec 27, 2023
1 parent 9804ded commit 9a0badd
Show file tree
Hide file tree
Showing 3 changed files with 88 additions and 1 deletion.
9 changes: 8 additions & 1 deletion .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,12 @@ jobs:
# The type of runner that the job will run on
runs-on: ubuntu-20.04

strategy:
matrix:
include:
- source: ./specification/index.bs
- source: ./specification/window.browser.bs

# Steps represent a sequence of tasks that will be executed as part of the job
steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
Expand All @@ -37,4 +43,5 @@ jobs:
with:
GH_PAGES_BRANCH: gh-pages
# Deployment will be available at: https://w3c.github.io/webextensions/specification
DESTINATION: specification/index.html
SOURCE: ${{ matrix.source }}
TOOLCHAIN: 'bikeshed'
File renamed without changes.
80 changes: 80 additions & 0 deletions specification/window.browser.bs
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
<pre class="metadata">
Title: window.browser
Shortname: wecg-browser
Level: 1
Group: wecg
Status: UD
URL: https://w3c.github.io/webextensions/specification/window.browser.html
Editor: Patrick Kettner, Google, [email protected]
Abstract: This specification reserves the <code>window.browser</code> namespace for use by WebExtensions.
Repository: w3c/webextensions
Complain About: accidental-2119 on, missing-example-ids on
</pre>

<pre class=link-defaults>
spec:html; type:attribute; text:window
</pre>

<pre class="anchors">
spec: html; urlPrefix: https://html.spec.whatwg.org/multipage/
type: dfn; text: valid non-empty URL; url: valid-non-empty-url-potentially-surrounded-by-spaces
</pre>

<section class="non-normative">
## Introduction {#introduction}
<em>This section is non-normative.</em>

Browser extensions are programs to extend the capabilities of web browsers.
Although not standardized at first, web browsers have independently implemented a common interoperable set of extension APIs, called WebExtensions.

Modern WebExtensions are an evolution of a system originally introduced in
Chrome version 3. In that system, any API that was added was put under the
<code>chrome</code> namespace. When WebExtensions were adopted outside of
Chromium, other vendors used the more neutral <code>browser</code> namespace.
That <code>browser</code> is now considered to canonically correct namespace
for all WebExtension APIs. Some interactions with WebExtensions (such as
external messaging from content scripts to background processes) necessitate
the exposure of this namespace to the web.

Given that, this document defines <code>window.browser</code> as reserved for
the use of APIs designed to interact with WebExtensions. The specifics of what
APIs within <code>window.browser</code> are at present intentionally undefined,
and are left up to User Agent implementation.
</section>


<section>
<h3 id="window-interface">
<a attribute lt="browser"><code>window.browser</code></a> API
</h3>

{{browser}} is UA defined attribute exposed on {{window}}. When implemented,
it MUST be used only for WebExtension related functionality.
</section>


<pre class="idl">
partial interface Window {
attribute object browser;
};

</pre>

<section>
<h3 id="worker-interface">
Worker API
</h3>

When {{browser}} is defined on {{window}}, it SHOULD also be implemented on {{ServiceWorkerGlobalScope}} and {{DedicatedWorkerGlobalScope}}.
It MUST be used exclusivly for WebExtension purposes, however the contents of each instance of {{browser}} is UA defined.
</section>

<pre class="idl">
partial interface DedicatedWorkerGlobalScope {
attribute object browser;
};

partial interface ServiceWorkerGlobalScope {
attribute object browser;
};
</pre>

0 comments on commit 9a0badd

Please sign in to comment.