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

Jump to bottom

Replace appmanifest's launch algorithm with one that has launch_handler behaviors #79

Merged
merged 5 commits into from
Nov 8, 2022
Merged

Replace appmanifest's launch algorithm with one that has launch_handler behaviors #79

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1ad172a
git squash commit for replace-launch-algorithm.
alancutter Nov 7, 2022
ae60cda
Rebased
alancutter Nov 8, 2022
2b3a3b9
given
alancutter Nov 8, 2022
106384d
Remove section
alancutter Nov 8, 2022
c01483b
application
alancutter Nov 8, 2022
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
153 changes: 58 additions & 95 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,145 +283,108 @@ <h2>
</h2>
<section>
<h2>
Launching a Web App
Launching a Web App with Handling
</h2>
<p>
When launching a web app via any means the trigger of the launch
should run the steps to [=launch a web app=] with a {{LaunchParams}}
containing relevant launch information (e.g. share data in the event
of a share target launch).
This specification replaces the existing algorithm to [=launch a web
application=] to include the behavior of [=manifest/launch_handler=]
by replacing it with the steps to [=launch a web application with
handling=].
</p>
<p class="note">
Examples of different web app launch triggers:
</p>
<ul class="note">
<!--
This should be part of the <p> above but class="note"s don't agree
with nested <ul>s and will kick them out of the note box.
-->
<li>OS application launch surfaces
</li>
<li><a href="https://wicg.github.io/manifest-incubations/index.html#protocol_handlers-member">Protocol handling</a>
</li>
<li><a href="https://wicg.github.io/manifest-incubations/index.html#file_handlers-member">File handling</a>
</li>
<li><a href="https://wicg.github.io/manifest-incubations/index.html#share_target-member">Share target</a>
</li>
<li>Link capturing
</li>
</ul>
<p>
The steps to <dfn>launch a web app</dfn> are given by the following
algorithm and takes an optional {{LaunchParams}}
|params:LaunchParams|.
The steps to <dfn data-export="" data-lt="launching a web application with handling">
launch a web application with handling</dfn> are given by the
following algorithm. The algorithm takes a [=Document/processed
manifest=] |manifest:processed manifest|, an optional [=URL=] or
{{LaunchParams}} |params|, an optional [=POST resource=] |POST
resource| and returns an [=application context=].
</p>
<ol class="algorithm">
<li>If |params| is null, set |params| to a new {{LaunchParams}} with
{{LaunchParams/targetURL}} set to [=manifest/start_url=].
<li>If |params| is not given, set |params| to
|manifest|.[=manifest/start_url=].
</li>
<li>Set |client| to the result of running the steps to
[=prepare a web app launch client=] passing the web app's
<a data-cite="appmanifest#dfn-processed-manifest">processed
manifest</a> and |params|.{{LaunchParams/targetURL}}.
<li>If |params| is a [=URL=], set |params| to a new {{LaunchParams}}
with {{LaunchParams/targetURL}} set to |params|.
</li>
<li>Assert: |params|.{{LaunchParams/targetURL}} is [=manifest/within
scope=] of |manifest|.
</li>
<li>Set |application context| to the result of running the steps to
[=prepare an application context=] passing |manifest|, |params|
and |POST resource|.
</li>
<li>Append |params| to the [=unconsumed launch params=] of the
|client|'s document's {{Window/launchQueue}}.
|application context|'s document's {{Window/launchQueue}}.
</li>
<li>Run the steps to [=process unconsumed launch params=] on the
|client|'s document's {{Window/launchQueue}}.
|application context|'s [=navigable/active document=]'s
{{Window/launchQueue}}.
<p class="note">
|client| may be an existing window client with an
|application context| may be an existing instance with an
[=assigned launch consumer=] hence it is necessary to process
the newly appended |params|.
the newly appended {{LaunchParams}}.
</p>
</li>
</ol>
</section>
<section>
<h2>
Preparing a [=Web App Launch Client=]
</h2>
<p>
A <dfn>web app launch client</dfn> is a
[=top-level browsing context=] associated with the web app.
</p>
<p class="note">
The exact form of this association is up to the user agent e.g. a
dedicated app window separate UI presentation from general hyperlink
browsing.
</p>
<p>
To <dfn>prepare a web app launch client</dfn> given a
<a data-cite="appmanifest#dfn-processed-manifest"> processed
manifest</a> |manifest| and |target URL: URL|, run the following
steps:
The steps to <dfn>prepare an application context</dfn> are given by
the following algorithm. The algorithm takes a
[=Document/processed manifest=] |manifest:processed manifest|, a
{{LaunchParams}} |launch params|, an optional [=POST
resource=] |POST resource| and returns an [=application context=].
</p>
<ol class="algorithm">
<li>Let [=client mode target=] |client_mode| be
|manifest|["launch_handler"]["client_mode"].
|manifest|.[=manifest/launch_handler=].[=manifest/client_mode=].
</li>
<li>If |client_mode| is [=client mode/auto=], set |client_mode| to either
[=client mode/navigate-new=] or [=client mode/navigate-existing=]
according to the user agent's decision for which is most
appropriate.
<li>If |client_mode| is [=client mode/auto=], set |client_mode| to
either [=client mode/navigate-new=] or
[=client mode/navigate-existing=] according to the user agent's
decision for which is most appropriate.
</li>
<li>
<p>Switching on |client mode|, run the following substeps:</p>
<dl class="switch">
<dt>[=client mode/navigate-new=]</code>
<dd>
<ol class="algorithm">
<li>Return the result of running the steps to [=prepare a new
web app launch client=] passing |manifest| and
|target URL|.
<li>Return the result of running the steps to [=create a new
application context=] passing |manifest|, |launch
params|.{{LaunchParams/targetURL}} and |POST resource|.
</li>
</ol>
<dt>[=client mode/navigate-existing=] or
[=client mode/focus-existing=]</code>
<dd>
<ol class="algorithm">
<li>If there is no [=top-level browsing context=] for
the web app, return the result of the result of
[=prepare a new web app launch client=] passing |manifest|
and |target URL|.
<li>If there is no [=application context=] that has |manifest|
[=applied=], return the result of running the steps to
[=create a new application context=] passing |manifest|,
|launch params|.{{LaunchParams/targetURL}} and |POST
resource|.
</li>
<li>Let |client| be a [=top-level browsing context=]
for the web app, the exact selection algorithm is decided
by the user agent.
<li>Let |application context| be an [=application context=]
that has |manifest| [=applied=], the user agent selects
the most appropriate one if there are multiple.
<p class="note">
An appropriate selection strategy would be to pick the
one that was most recently in focus.
</p>
</li>
<li>Bring |application context|'s viewport into focus.
</li>
<li>If |client mode| is [=client mode/navigate-existing=],
run the steps to [=navigate=] |client| to |target URL|.
[=navigate=] |application context| to |launch
params|.{{LaunchParams/targetURL}} passing |POST
resource|.
</li>
<li>Return |client|.
<li>Return |application context|.
</li>
</ol>
</dl>
</li>
</ol>
</section>
<section>
<h2>
Preparing a new [=Web App Launch Client=]
</h2>
<p>
To <dfn>prepare a new web app launch client</dfn> given a
<a data-cite="appmanifest#dfn-processed-manifest">processed
manifest</a> |manifest| and |target URL:URL|, run the following steps:
</p>
<ol class="algorithm">
<li>Let |client| be the result of
<a href="https://html.spec.whatwg.org/multipage/browsers.html#creating-a-new-top-level-browsing-context">
creating a new top-level browsing context</a>.
</li>
<li><a data-cite="appmanifest#dfn-applied">Apply</a> |manifest| to
|client|.
</li>
<li>Run the steps to [=navigate=] |client| passing |target URL|.
</li>
<li>Return |client|.
</li>
</ol>
</section>
<section>
<h2>
Processing [=unconsumed launch params=]
Expand Down