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

Allow notifications and actions to specify a navigable URL #213

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Allow notifications and actions to specify a navigable URL #213

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
84723c1
Allow notifications and actions to specify a navigable URL
annevk Jul 10, 2024
f4c9633
Update notifications.bs
annevk Nov 7, 2024
2960674
Update notifications.bs
annevk Nov 7, 2024
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
74 changes: 70 additions & 4 deletions notifications.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,9 @@ or "<code>rtl</code>").
<p>A <a for=/>notification</a> has an associated <dfn for=notification id=body>body</dfn> (a
string).

<p>A <a for=/>notification</a> has an associated <dfn export for=notification>navigation URL</dfn>
(null or a <a for=/>URL</a>). It is initially null.

<p>A <a for=/>notification</a> has an associated <dfn for=notification id=tag>tag</dfn> (a string).

<p>A <a for=/>notification</a> has an associated <dfn for=notification id=data>data</dfn> (a
Expand Down Expand Up @@ -137,6 +140,9 @@ support these features might ignore them.
<dt><dfn for="notification action" id=action-title>title</dfn>
<dd>A string.

<dt><dfn export for="notification action">navigation URL</dfn>
<dd>Null or a <a for=/>URL</a>. It is initially null.

<dt><dfn for="notification action" id=action-icon-url>icon URL</dfn>
<dd>Null or a <a for=/>URL</a>. It is initially null.

Expand Down Expand Up @@ -220,6 +226,11 @@ important information through, e.g., loss of color or clipped corners.
<li><p>Set <var>notification</var>'s <a for=notification>body</a> to
<var>options</var>["{{NotificationOptions/body}}"].

<li><p>If <var>options</var>["{{NotificationOptions/navigate}}"] <a for=map>exists</a>, then
<a lt="URL parser">parse</a> it using <var>baseURL</var>, and if that does not return failure, set
annevk marked this conversation as resolved.
Show resolved Hide resolved
<var>notification</var>'s <a for=notification>navigation URL</a> to the return value. (Otherwise
<var>notification</var>'s <a for=notification>navigation URL</a> remains null.)

<li><p>Set <var>notification</var>'s <a for=notification>tag</a> to
<var>options</var>["{{NotificationOptions/tag}}"].

Expand Down Expand Up @@ -270,6 +281,11 @@ important information through, e.g., loss of color or clipped corners.
<li><p>Set <var>action</var>'s <a for="notification action">title</a> to
<var>entry</var>["{{NotificationAction/title}}"].

<li><p>If <var>entry</var>["{{NotificationAction/navigate}}"] <a for=map>exists</a>, then
<a lt="URL parser">parse</a> it using <var>baseURL</var>, and if that does not return failure,
set <var>action</var>'s <a for="notification action">navigation URL</a> to the return value.
(Otherwise <var>action</var>'s <a for="notification action">navigation URL</a> remains null.)

<li><p>If <var>entry</var>["{{NotificationAction/icon}}"] <a for=map>exists</a>, then
<a lt="URL parser">parse</a> it using <var>baseURL</var>, and if that does not return failure,
set <var>action</var>'s <a for="notification action">icon URL</a> to the return value. (Otherwise
Expand Down Expand Up @@ -541,18 +557,51 @@ interpreted as a language tag. Validity or well-formedness are not enforced. [[!
platform supports activation, the user agent must (unless otherwise specified) run these steps:

<ol>
<li><p>Let <var>action</var> be null.

<li><p>If one of <var>notification</var>'s <a for=notification>actions</a> was activated by the end
user, then set <var>action</var> to that <a for=/>notification action</a>.

<li><p>Let <var>navigationURL</var> be <var>notification</var>'s
<a for=notification>navigation URL</a>.

<li>
<p>If <var>action</var> is non-null, then set <var>navigationURL</var> to <var>action</var>'s
<a for="notification action">navigation URL</a>.

<p class=note>This intentionally makes it so that when a <a for=/>notification action</a>'s
<a for="notification action">navigation URL</a> is null, it falls through to the
<code>click</code> event, providing more flexibility to the web developer.

<li>
<p>If <var>navigationURL</var> is non-null:

<ol>
<li><p>If there is an existing <a for=/>top-level traversable</a> <var>traversable</var> within
the user agent's <a for="user agent">top-level traversable set</a> whose
<a for="navigable">active document</a>'s <a for=Document>URL</a> <a for=url>equals</a>
<var>navigationURL</var> with <a for=url/equals><i>exclude fragments</i></a> set to true, then
annevk marked this conversation as resolved.
Show resolved Hide resolved
<a for=/>navigate</a> <var>traversable</var> to <var>navigationURL</var> and return. If there are
multiple <a for=/>top-level traversables</a> that satisfy the condition the user agent has to
pick one in an <a>implementation-defined</a> manner.
annevk marked this conversation as resolved.
Show resolved Hide resolved
<!-- Should maybe set userInvolvement correctly here and below. -->

<li><p><a>Create a fresh top-level traversable</a> given <var>navigationURL</var>.

<li><p>Return.
</ol>

<li>
<p>If <var>notification</var> is a <a>persistent notification</a>, then:

<ol>
<li><p>Let <var>action</var> be the empty string.
<li><p>Let <var>actionName</var> be the empty string.

<li><p>If one of <var>notification</var>'s <a for=notification>actions</a> was activated by the
user, then set <var>action</var> to that <a for=/>notification action</a>'s
<li><p>If <var>action</var> is non-null, then set <var>actionName</var> to <var>action</var>'s
<a for="notification action">name</a>.

<li><a>Fire a service worker notification event</a> named "<code>notificationclick</code>" given
<var>notification</var> and <var>action</var>.
<var>notification</var> and <var>actionName</var>.
</ol>

<li>
Expand Down Expand Up @@ -643,6 +692,7 @@ interface Notification : EventTarget {
readonly attribute NotificationDirection dir;
readonly attribute DOMString lang;
readonly attribute DOMString body;
readonly attribute USVString navigate;
annevk marked this conversation as resolved.
Show resolved Hide resolved
readonly attribute DOMString tag;
readonly attribute USVString image;
readonly attribute USVString icon;
Expand All @@ -662,6 +712,7 @@ dictionary NotificationOptions {
NotificationDirection dir = "auto";
DOMString lang = "";
DOMString body = "";
USVString navigate;
DOMString tag = "";
USVString image;
USVString icon;
Expand Down Expand Up @@ -690,6 +741,7 @@ enum NotificationDirection {
dictionary NotificationAction {
required DOMString action;
required DOMString title;
USVString navigate;
USVString icon;
};

Expand Down Expand Up @@ -853,6 +905,16 @@ return the <a>maximum number of actions</a> supported.
<p>The <dfn attribute for=Notification><code>body</code></dfn> getter steps are to return
<a>this</a>'s <a for=/>notification</a>'s <a for=notification>body</a>.

<p>The <dfn attribute for=Notification><code>navigate</code></dfn> getter steps are:

<ol>
<li><p>If <a>this</a>'s <a>notification</a>'s <a for=notification>navigation URL</a> is null, then
return the empty string.

<li><p>Return <a>this</a>'s <a>notification</a>'s <a for=notification>navigation URL</a>,
<a lt="URL serializer">serialized</a>.
</ol>

<p>The <dfn attribute for=Notification><code>tag</code></dfn> getter steps are to return
<a>this</a>'s <a for=/>notification</a>'s <a for=notification>tag</a>.

Expand Down Expand Up @@ -925,6 +987,10 @@ then return null.
<li><p>Set <var>action</var>["{{NotificationAction/title}}"] to <var>entry</var>'s
<a for="notification action">title</a>.

<li><p>If <var>entry</var>'s <a for="notification action">navigation URL</a> is non-null, then
set <var>action</var>["{{NotificationAction/navigate}}"] to <var>entry</var>'s
<a for="notification action">navigation URL</a>, <a lt="URL serializer">serialized</a>.

<li><p>If <var>entry</var>'s <a for="notification action">icon URL</a> is non-null, then set
<var>action</var>["{{NotificationAction/icon}}"] to <var>entry</var>'s
<a for="notification action">icon URL</a>, <a lt="URL serializer">serialized</a>.
Expand Down