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.

Sign up for GitHub

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

Spec cleanup #34

Merged
merged 4 commits into from
Jun 25, 2019
Merged

Spec cleanup #34

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3224844
Begins cleaning up the spec for release
fallaciousreasoning Jun 19, 2019
c914089
Merge remote-tracking branch 'origin/master' into spec-cleanup
fallaciousreasoning Jun 20, 2019
bc22c5e
Cleans up references
fallaciousreasoning Jun 20, 2019
226b14a
Adds SotD
fallaciousreasoning Jun 20, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 10 additions & 20 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,18 +42,17 @@
<section id="abstract" class="informative">
<p>
This specification defines an API allowing <a data-cite=
"appmanifest">web applications</a> to set an application-wide badge,
"appmanifest#installable-web-applications">web applications</a> to set an application-wide badge,
shown in an operating-system-specific place associated with the
application (such as the shelf or home screen), for the purpose of
notifying the user when the state of the application has changed (e.g.,
when new messages have arrived), without showing a more heavyweight
<a data-cite="NOTIFICATIONS">notification</a>.
<a data-cite="notifications#concept-notification">notification</a>.
</p>
</section>
<section id="sotd">
<p>
This specification is currently a work in progress. Implementors should
not expose the API surface to the open web.
This is an early draft of the Badging API spec.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Not really sure what to put here? It’s not in the w3c so it’s not a spec yet, but it’s not really a draft either.

(I’ve copied this from the WebShareTarget spec, mostly I just wanted it to show up as changed in the diff).

</p>
</section>
<section class="informative">
Expand Down Expand Up @@ -93,7 +92,7 @@ <h2>
</h2>
<p>
There is a single global badge associated with each <a data-cite=
"appmanifest">web application</a>. At any time, the application's badge
"appmanifest#installable-web-applications">web application</a>. At any time, the application's badge
is set to one of the following values:
</p>
<ul>
Expand Down Expand Up @@ -121,12 +120,10 @@ <h2>
Badge display
</h2>
<p>
When the application is <a data-cite=
"appmanifest#dfn-installing">installed</a> and the application's flag
is <a>set</a>, the user agent SHOULD display the application's badge
alongside the symbolic representation of the application in the user's
operating system (for example, as a small overlay on top of the
application's icon).
When the application's flag is <a>set</a>, the user agent SHOULD display
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I think this fixes #12

Copy link

Choose a reason for hiding this comment

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

Hmm I think #12 was about completely removing the notion of this being related to an installed app. e.g. if it worked in a tab, it could potentially be used without the app being installed

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Hmm, okay. I don't know how I feel about that. The one Badge per application example gets kind of hazy.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

How would we treat this in per tab land? I think there has to be some kind of guideline about what gets badged, and I wouldn't like it to work differently based on whether or not the app is installed.

Copy link

Choose a reason for hiding this comment

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

That's true. Application scope is the simplest thing to use. Let's keep it and comment on the bug.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This has come up again in #35

the application's badge alongside the symbolic representation of the
application in the user's operating system (for example, as a small
overlay on top of the application's icon).
</p>
<p>
The special value <b>flag</b> indicates that the badge is set, but
Expand All @@ -153,7 +150,7 @@ <h2>
<code>Badge</code> interface
</h2>
<pre class="idl">
[Exposed=(Window, Worker)]
fallaciousreasoning marked this conversation as resolved.
Show resolved Hide resolved
[Exposed=(Window)]
interface Badge {
static void set(optional [EnforceRange] unsigned long long contents);
static void clear();
Expand All @@ -163,13 +160,6 @@ <h2>
The <dfn>Badge</dfn> interface provides methods for setting and
clearing the application badge indicator.
</p>
<div class="issue">
fallaciousreasoning marked this conversation as resolved.
Show resolved Hide resolved
This section is not clear about which web application is associated
with a particular context. In particular, when called from a
<a data-cite="service-workers-1">service worker</a> whose scope is
outside of the <a data-cite="appmanifest">app manifest</a> scope, the
web application may be ambiguous.
</div>
<section>
<h3>
<dfn>set()</dfn> method
Expand Down Expand Up @@ -213,7 +203,7 @@ <h2>
<p>
<code><dfn data-cite=
"!ECMASCRIPT#sec-native-error-types-used-in-this-standard-typeerror">TypeError</dfn></code>
is defined by [[!ECMASCRIPT]].
is defined by [[ECMASCRIPT]].
</p>
</section>
</body>
Expand Down