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

Beforeinstallprompt #9

Closed
wants to merge 10 commits into from
Closed

Beforeinstallprompt #9

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
a521cb5
First draft at adding display_override to incubations spec
dmurph Jan 30, 2021
97ca97e
Comments & reformat
dmurph Feb 3, 2021
7220785
Update index.html
dmurph Feb 18, 2021
fdeeb2c
Cleanup & fixing links
dmurph Mar 15, 2021
c132d0b
Merge branch 'gh-pages' of https://github.com/WICG/manifest-incubatio…
dmurph Mar 15, 2021
4183a65
Merge branch 'gh-pages' of https://github.com/WICG/manifest-incubatio…
dmurph Mar 15, 2021
03bd79b
Added share_target member, and some editing cleanup of the document
dmurph Mar 17, 2021
6830410
Merge branch 'gh-pages' of https://github.com/WICG/manifest-incubatio…
dmurph Mar 17, 2021
c4728a7
Mostly copy-paste from old before-install-prompt spec
dmurph Mar 17, 2021
9983aa1
added Window extensions and links
dmurph Mar 19, 2021
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
378 changes: 378 additions & 0 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,5 +129,383 @@ <h2 data-dft-for="">
"https://wicg.io">WICG</a>.
</p>
</section>
<section data-cite="DOM">
<h2>
Installable web applications
</h2>
<section>
<h2>
Installation prompts
</h2>
<p>
There are multiple ways that the installation process can be
triggered:
</p>
<ul>
<li>An end-user can <dfn data-lt="manual installation">manually</dfn>
trigger the installation process through the user agent's
<abbr title="User Interface">UI</abbr>, directly invoking the steps
to <a>present an install prompt</a>.
</li>
<li>The installation process can occur through an <dfn>automated
install prompt</dfn>: that is, a UI that the user agent presents to
the user when, for instance, there are sufficient <a data-cite=
"appmanifest#installability-signals">installability signals</a> to
Comment on lines +152 to +153
Copy link
Contributor

Choose a reason for hiding this comment

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

I removed the "installability signals" from the other spec, as they turned out to be somewhat Chrome specific. So it might be good to just say:

Suggested change
the user when, for instance, there are sufficient <a data-cite=
"appmanifest#installability-signals">installability signals</a> to
the user when, for instance, there are sufficient signals to

warrant <a data-cite="appmanifest#dfn-installed">installation</a> of
Copy link
Contributor

Choose a reason for hiding this comment

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

General note: you should never need to use data-cite= for any W3C spec. If a term is not available via xref, it needs to be data-export=""ed from the other spec.

the web application.
</li>
<li>The installation process can occur through a <dfn>site-triggered
install prompt</dfn>: the site can programmatically request that the
user agent present an install prompt to the user. The user agent MAY
restrict the availability of this feature to cases where, for
instance, there are sufficient <a data-cite=
"appmanifest#installability-signals">installability signals</a> to
warrant <a data-cite="appmanifest#dfn-installed">installation</a> of
the web application.
</li>
</ul>
<p>
In any case, the user agent MUST NOT <a>present an install prompt</a>
if the document is not <a data-cite=
"appmanifest#dfn-is-installable">installable</a>.
</p>
<p>
Prior to presenting an <a>automated install prompt</a>, a user agent
MUST run the <a>steps to notify that an install prompt is
available</a>, to give the site the opportunity to prevent the
default action (which is to install the application). Alternatively,
the user agent MAY, at any time (only if the document is
<a data-cite="appmanifest#dfn-is-installable">installable</a>), run
the <a>steps to notify that an install prompt is available</a> at any
time, giving the site the opportunity to show a <a>site-triggered
install prompt</a> without automatically showing the prompt.
</p>
<p>
To <dfn data-lt=
"presenting an install prompt|presentation of the install prompt">present
an install prompt</dfn>:
</p>
<ol>
<li>Show some user-agent-specific UI, asking the user whether to
proceed with installing the app. See <a href=
"#installation-sec">privacy and security considerations</a> for
recommendations relating to this UI. The <var>result</var> of this
choice is either <a data-link-for=
"AppBannerPromptOutcome">accepted</a> or <a data-link-for=
"AppBannerPromptOutcome">dismissed</a>.
</li>
<li>Return <var>result</var>, and <a>in parallel</a>:
<ol>
<li>If <var>result</var> is <a data-link-for=
"AppBannerPromptOutcome">accepted</a>, run the <a>steps to
install the web application</a>.
</li>
</ol>
</li>
</ol>
<p>
The <dfn>steps to notify that an install prompt is available</dfn>
are given by the following algorithm:
</p>
<ol>
<li>Wait until the {{Document}} of the <a>top-level browsing
context</a> is <a>completely loaded</a>.
</li>
<li>If there is already an <a data-lt=
"present an install prompt">install prompt being presented</a> or if
the <a>steps to install the web application</a> are currently being
executed, then abort this step.
</li>
<li>
<a>Queue a task</a> on the <a>application life-cycle task
source</a> to do the following:
<ol>
<li>Let <var>event</var> be a newly constructed
<a>BeforeInstallPromptEvent</a> named
<code>beforeinstallprompt</code>, with its
<code>cancelable</code> attribute initialized to true.
</li>
<li>Let <var>mayShowPrompt</var> be the result of <a>firing</a>
<var>event</var> at the {{Window}} object of the <a>top-level
browsing context</a>.
</li>
<li>If <var>mayShowPrompt</var> is true, then the user agent MAY,
<a>in parallel</a>, <a>request to present an install prompt</a>
with <var>event</var>.
</li>
</ol>
</li>
</ol>
</section>
<section>
<h2>
Installation Events
</h2>
<p>
Installation events and supporting the {{BeforeInstallPrompt}} is
OPTIONAL.
</p>
<p>
DOM events <a>fired</a> by this specification use the
<dfn>application life-cycle task source</dfn>.
</p>
<section data-dfn-for="BeforeInstallPromptEvent" data-link-for=
"BeforeInstallPromptEvent">
Comment on lines +252 to +253
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
<section data-dfn-for="BeforeInstallPromptEvent" data-link-for=
"BeforeInstallPromptEvent">
<section data-dfn-for="BeforeInstallPromptEvent">

<h3>
<dfn>BeforeInstallPromptEvent</dfn> Interface
</h3>
<div class="note">
The <a>beforeinstallprompt</a> event is somewhat misnamed, as it
does not necessarily signal that an <a>automated install prompt</a>
will follow (depending on the user agent, it might just be giving
the site the ability to trigger an install prompt). It is so named
for historical reasons.
</div>
<pre class="idl" data-cite="DOM">
[Exposed=Window]
interface BeforeInstallPromptEvent : Event {
constructor(DOMString type, optional EventInit eventInitDict = {});
Promise&lt;PromptResponseObject&gt; prompt();
};

dictionary PromptResponseObject {
AppBannerPromptOutcome userChoice;
};

enum AppBannerPromptOutcome {
"accepted",
"dismissed"
};
</pre>
<p>
The <a>BeforeInstallPromptEvent</a> is dispatched when the site is
allowed to present a <a>site-triggered install prompt</a>, or prior
to the user agent presenting an <a>automated install prompt</a>. It
allows the site to cancel the <a>automated install prompt</a>, as
well as manually present the <a>site-triggered install prompt</a>.
</p>
<div class="note">
If the <a>BeforeInstallPromptEvent</a> is <em>not</em> cancelled,
the user agent is allowed to <a>present an install prompt</a>
(specifically, an <a>automated install prompt</a>) to the end-user.
Canceling the default action (via <a data-cite=
"DOM#dom-event-preventdefault">preventDefault</a>) prevents the
user agent from <a>presenting an install prompt</a>. The user agent
is free to run <a>steps to notify that an install prompt is
available</a> again at a later time.
</div>
<p data-dfn-for="PromptResponseObject">
The <dfn>PromptResponseObject</dfn> contains the result of calling
<a data-lt="BeforeInstallPromptEvent.prompt()">prompt()</a>. It
contains one member, <dfn data-link-for=
"PromptResponseObject">userChoice</dfn>, which states the user's
chosen outcome.
</p>
<p>
An instance of a <a>BeforeInstallPromptEvent</a> has the following
internal slots:
</p>
<dl>
<dt>
<dfn>[[\didPrompt]]</dfn>
</dt>
<dd>
A boolean, initially <code>false</code>. Represents whether this
event was used to <a>present an install prompt</a> to the
end-user.
</dd>
<dt>
<dfn>[[\userResponsePromise]]</dfn>
</dt>
<dd>
A promise that represents the outcome of <a>presenting an install
prompt</a>.
</dd>
</dl>
<section>
<h4>
<code>prompt()</code> method
</h4>
<p>
The <dfn>prompt</dfn> method, when called, runs the following
steps:
</p>
<ol>
<li>If <var>this</var>.<a>[[\userResponsePromise]]</a> is
pending:
<ol>
<li>If this event's <a data-cite=
"DOM#dom-event-istrusted"><code>isTrusted</code></a>
attribute is <code>false</code>, reject
<var>this</var>.<a>[[\userResponsePromise]]</a> with
{{"NotAllowedError"}}, optionally informing the developer
that untrusted events can't call <code>prompt()</code>.
</li>
<li>Else if <var>this</var>.<a>[[\didPrompt]]</a> is
<code>false</code>, set <var>this</var>.<a>[[\didPrompt]]</a>
to <code>true</code>, then <a>in parallel</a>, <a>request to
present an install prompt</a> with this event. Wait, possibly
indefinitely, for the end-user to make a choice.
</li>
</ol>
</li>
<li>Return <var>this</var>.<a>[[\userResponsePromise]]</a>.
</li>
</ol>
<p>
To <dfn data-noexport="">request to present an install
prompt</dfn> with <a>BeforeInstallPromptEvent</a>
<var>event</var>:
</p>
<ol>
<li>
<a>Present an install prompt</a> and let <var>outcome</var> be
the result.
</li>
<li>Resolve <var>event</var>.<a>[[\userResponsePromise]]</a> with
a newly created <a>PromptResponseObject</a> whose
<a data-link-for="PromptResponseObject">userChoice</a> member is
the value of <var>outcome</var>.
</li>
</ol>
</section>
<section class="informative">
<h4>
Usage example
</h4>
<p>
This example shows how one might prevent an automated install
prompt from showing until the user clicks a button to show a
<a>site-triggered install prompt</a>. In this way, the site can
leave installation at the user's discretion (rather than
prompting at an arbitrary time), whilst still providing a
prominent UI to do so.
</p>
<pre class="example" title=
"Using beforeinstallprompt to present an install button">
window.addEventListener("beforeinstallprompt", event =&gt; {
// Suppress automatic prompting.
event.preventDefault();

// Show the (disabled-by-default) install button. This button
// resolves the installButtonClicked promise when clicked.
installButton.disabled = false;

// Wait for the user to click the button.
installButton.addEventListener("click", async e =&gt; {
// The prompt() method can only be used once.
installButton.disabled = true;

// Show the prompt.
const { userChoice } = await event.prompt();
console.info(`user choice was: ${userChoice}`);
});
});
</pre>
</section>
<section data-dfn-for="AppBannerPromptOutcome">
<h4>
<code>AppBannerPromptOutcome</code> enum
</h4>
<p>
The <dfn>AppBannerPromptOutcome</dfn> enum's values represent the
outcomes from <a>presenting an install prompt</a>.
</p>
<dl data-dfn-for="AppBannerPromptOutcome">
<dt>
<dfn>accepted</dfn>:
</dt>
<dd>
The end-user indicated that they would like the user agent to
<a>install</a> the web application.
</dd>
<dt>
<dfn>dismissed</dfn>:
</dt>
<dd>
The end-user dismissed the install prompt.
</dd>
</dl>
</section>
</section>
</section>
<section>
<h2>
Installation process
</h2>
<p>
The <dfn>steps to install the web application</dfn> are given by the
following algorithm:
</p>
<ol>
<li>Let <var>manifest</var> be the manifest of an <a data-cite=
"appmanifest#dfn-is-installable">installable</a> document.
</li>
<li>Perform an unspecified sequence of actions to attempt to register
the web application in the user's operating system (e.g., create
shortcuts that launch the web application, register the application
in the system uninstall menu, etc.). If the installation fails (which
can be for any reason, for example, the OS denying permission to the
user agent to add an icon to the home screen of the device), abort
these steps.
</li>
</ol>
</section>
<section>
<h3>
Extensions to the <code>Window</code> object
</h3>
<p>
The following extensions to the <code><dfn data-cite=
"HTML/window-object.html#window">Window</dfn></code> object specify
the <a>event handler idl attribute</a> on which events relating to
the <a>installation</a> of a web application are <a>fired</a>.
</p>
<pre class="idl" data-cite="HTML">
partial interface Window {
attribute EventHandler onappinstalled;
attribute EventHandler onbeforeinstallprompt;
};
</pre>
<pre class="example js" title=
"Two ways of handling the 'appinstalled' event">
function handleInstalled(ev) {
const date = new Date(ev.timeStamp / 1000);
console.log(`Yay! Our app got installed at ${date.toTimeString()}.`);
}

// Using the event handler IDL attribute
window.onappinstalled = handleInstalled;

// Using .addEventListener()
window.addEventListener("appinstalled", handleInstalled);
</pre>
<section data-dfn-for="Window">
<h4>
<code>onappinstalled</code> attribute
</h4>
<p>
The <dfn>onappinstalled</dfn> is an <a>event handler IDL
attribute</a> for the "<dfn>appinstalled</dfn>" event type. The
interface used for these events is the <a><code>Event</code>
interface</a> [[DOM]]. This event is dispatched as a result of a
successful installation (see the <a>steps to install the web
application</a>).
</p>
</section>
<section data-dfn-for="Window">
<h4>
<code>onbeforeinstallprompt</code> attribute
</h4>
<p>
The <dfn>onbeforeinstallprompt</dfn> is an <a>event handler IDL
attribute</a> for the "<dfn>beforeinstallprompt</dfn>" event type.
The interface used for these events is the
<a>BeforeInstallPromptEvent</a> interface (see the <a>steps to
notify that an install prompt is available</a>).
</p>
</section>
</section>
</section>
</body>
</html>