Skip to content

[css-view-transitions-2] Update the algorithm to check opt-in on outbound transition #10078

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

Merged
merged 2 commits into from
Mar 15, 2024
Merged

[css-view-transitions-2] Update the algorithm to check opt-in on outbound transition #10078

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a50cc3c
[css-view-transitions-2] Update the algorithm to check opt-in on outb…
noamr Mar 14, 2024
714c049
Refactor outbound algo into vt
noamr Mar 15, 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
47 changes: 37 additions & 10 deletions css-view-transitions-2/Overview.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -450,6 +450,11 @@ Note: as per default behavior, the ''@view-transition'' rule can be nested insid
Note: the [=@view-transition/type=] descriptor only applies to the {{Document}} in which it is defined.
The author is responsible for using their chosen set of types in both documents.

## Responding to changes in the ''@view-transition'' rule ## {#respond-to-rule-changes}

When the ''@view-transition'' rule changes for {{Document}} |document|, [=update the opt-in state for outbound transitions=] given |document|.
Copy link
Member

Choose a reason for hiding this comment

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

Should we leave a note here to the effect of, "The UA is responsible for deciding when style resolution is executed to keep the opt-in state in sync with style mutations".

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 don't think that's necessary.



# API # {#api}

## Additions to {{Document}} ## {#additions-to-document-api}
Expand Down Expand Up @@ -527,6 +532,12 @@ The {{CSSViewTransitionRule}} represents a ''@view-transition'' rule.
: <dfn>inbound view transition params</dfn>
:: a [=view transition params=], or null.
Initially null.

: <dfn>can initiate outbound view transition</dfn>
:: a boolean.
Initially false.

Note: this value can be read [=in parallel=] while navigating.
</dl>

### The View transition params struct ### {#view-transition-params-struct}
Expand Down Expand Up @@ -660,20 +671,24 @@ Prepend this to the [=Perform pending transition operations=] algorithm given a

<div algorithm>
To check if a <dfn export>navigation can trigger a cross-document view-transition?</dfn> given
an [=/origin=] |oldOrigin|, an [=/origin=] |newOrigin|, a boolean |navigationHasCrossOriginRedirects|, a {{NavigationType}} |navigationType|, and a boolean |isBrowserUINavigation|:
a {{Document}} |oldDocument|, a {{Document}} |newDocument|, a {{NavigationType}} |navigationType|, and a boolean |isBrowserUINavigation|:

Note: this is called during navigation, potentially [=in parallel=], for documents that have opted-in to view-transitions using the ''@view-transition'' rule.
Note: this is called during navigation, potentially [=in parallel=].

1. If the user agent decides to display an [=implementation-defined=] navigation experience, e.g. a gesture-based transition for a back navigation,
the user agent may ignore the author-defined view transition. If that is the case, return false.

1. If |oldDocument|'s [=can initiate outbound view transition=] is false, then return false.

1. If |navigationType| is {{NavigationType/reload}}, then return false.

1. If |isBrowserUINavigation| is true, and |navigationType| is {{NavigationType/push}} or {{NavigationType/replace}}, then return false.
1. If |oldDocument|'s [=Document/origin=] is not [=same origin=] as |newDocument|'s [=Document/origin=], then return false.

1. If |oldOrigin| is not [=same origin=] as |newOrigin| then return false.
1. If |navigationType| is {{NavigationType/traverse}}, then return true.

1. If |navigationHasCrossOriginRedirects| is true, then return false.
1. If |isBrowserUINavigation| is true, then return false.

1. If |newDocument| [=was created via cross-origin redirects=], then return false.

1. Return true.
</div>
Expand All @@ -683,11 +698,11 @@ Prepend this to the [=Perform pending transition operations=] algorithm given a

1. [=Assert=]: These steps are running as part of a [=task=] queued on |oldDocument|.

1. If |oldDocument|'s [=has been revealed=] is false, then return null.
1. If |oldDocument|'s [=can initiate outbound view transition=] is false, then return null.

1. Let |resolvedRule| be the result of [=Resolve @view-transition rule|resolving the @view-transition rule=] for |oldDocument|.
1. Let |transitionTypesFromRule| be the result of [=Resolve @view-transition rule|resolving the @view-transition rule=] for |oldDocument|.

1. If |resolvedRule| is "<code>skip transition</code>", then return null.
1. [=Assert=]: |transitionTypesFromRule| is not "<code>skip transition</code>".

Note: We don't know yet if |newDocument| has opted in, as it might not be parsed yet.
We check the opt-in for |newDocument| when we fire the {{Window/pagereveal}} event.
Expand All @@ -701,7 +716,7 @@ Prepend this to the [=Perform pending transition operations=] algorithm given a

1. Let |outboundTransition| be a new {{ViewTransition}} object in |oldDocument|'s [=relevant Realm=].

1. Set |outboundTransition|'s [=ViewTransition/active types=]'s [=DOMTokenList/token set=] to |resolvedRule|.
1. Set |outboundTransition|'s [=ViewTransition/active types=]'s [=DOMTokenList/token set=] to |transitionTypesFromRule|.

Note: the [=ViewTransition/active types=] are not shared between documents.
Manipulating the {{ViewTransition/typeList}} in the new document does not affect the types in the new document,
Expand Down Expand Up @@ -732,10 +747,14 @@ Prepend this to the [=Perform pending transition operations=] algorithm given a
### Accessing the view-transition in the new {{Document}} ### {#access-view-transition-in-new-doc}

<div algorithm>
To <dfn export>resolve cross-document view-transition</dfn> for {{Document}} |document|:
To <dfn export>resolve inbound cross-document view-transition</dfn> for {{Document}} |document|:

1. [=Assert=]: |document| is [=fully active=].

1. [=Assert=]: |document| [=has been revealed=] is true.
Copy link
Member

Choose a reason for hiding this comment

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

Do we still need to export this algorithm? It looks like for the new Document we're calling it within this spec in "resolve cross-document view-transition" and html should now use the can initiate outbound view transition bit.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Export which algorithm?

Copy link
Member

Choose a reason for hiding this comment

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

"resolve cross-document view-transition" shouldn't need to be visible outside this spec now. Can fix after the html rewrite lands.

Copy link
Collaborator Author

@noamr noamr Mar 14, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

It's still called from page reveal, that's not changed here

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

What we don't need is "Resolve @view-transition rule", it's already not exported.

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 renamed it, I think it's clearer now


1. [=Update the opt-in state for outbound transitions=] for |document|.

1. Let |inboundViewTransitionParams| be |document|'s [=inbound view transition params=].

1. If |inboundViewTransitionParams| is null, then return null.
Expand Down Expand Up @@ -769,6 +788,14 @@ Prepend this to the [=Perform pending transition operations=] algorithm given a
1. Return |transition|.
</div>

### Updating the opt-in state for outbound view transitions ### {#update-opt-in-state-for-outbound}

<div algorithm="update-opt-in-for-outbound">
To <dfn>update the opt-in state for outbound transitions</dfn> for a {{Document}} |document|:
1. If |document| [=has been revealed=], and the result of [=resolve @view-transition rule|resolving the @view-transition rule=] is not "<code>skip transition</code>",
then set |document|'s [=can initiate outbound view transition=] to true.
1. Otherwise, set |document|'s [=can initiate outbound view transition=] to false.


<h2 id="priv" class="no-num">Privacy Considerations</h2>

Expand Down