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.

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

[css-view-transitions-1] Should view transition names be tree scoped? #10145

Closed
khushalsagar opened this issue Mar 26, 2024 · 38 comments · Fixed by #10528
Closed

[css-view-transitions-1] Should view transition names be tree scoped? #10145

khushalsagar opened this issue Mar 26, 2024 · 38 comments · Fixed by #10528

Comments

@khushalsagar
Copy link
Member

The spec currently traverses all DOM elements to look for view transition names, see text here. This should probably be tree scoped similar to other CSS naming conventions like scroll timeline and I'm guessing anchor positioning (@tabatkins ?).

@nt1m fyi.

@khushalsagar khushalsagar added Agenda+ css-view-transitions-1 View Transitions; Bugs only labels Mar 26, 2024
@noamr
Copy link
Collaborator

noamr commented Mar 26, 2024

+1 to view transition names being tree-scoped. The implication of the current spec/implementation is that custom elements that are supposed to be encapsulated can animate each other's internals if they know the internal vt-names.

@nt1m
Copy link
Member

nt1m commented Mar 26, 2024

More work in the implementation but makes sense to me.

@css-meeting-bot
Copy link
Member

The CSS Working Group just discussed [css-view-transitions-1] Should view transition names be tree scoped?, and agreed to the following:

  • RESOLVED: view-transition-name lookup is tree-scoped
The full IRC log of that discussion <fantasai> khush: Spec currently traverses all DOM elements, including those in shadow DOM
<fantasai> khush: Suggestion is to limit to tree-scoped
<TabAtkins> +1 to this
<fantasai> khush: so this would exclude things in shadow DOM
<fantasai> astearns: I've written some tests for tree-scoping, btw, and interop is terrible
<fantasai> khush: Are you talking about other features that are similar?
<fantasai> astearns: Yeah, I did @Property rules and @xxx rules, which are supposed to be tree-scoped, and they're not handled correctly
<astearns> zakim, open queue
<Zakim> ok, astearns, the speaker queue is open
<fantasai> astearns: so probably some other things are also broken
<emilio> fantasai: two things, khush does this mean that for v-t that you'll never be doing transitions on anything in the shadow dom?
<emilio> khush: yeah this means that you couldn't use something inside the shadow dom as an independent thing
<kizu> q+
<emilio> ... scoped transitions would allow you to do that
<emilio> ... but only as a unit inside the DOM
<emilio> fantasai: to alan, there's two different kinds of scoping, at-rules and name defining
<emilio> ... those are quite different mechanism
<astearns> ack kizu
<fantasai> s/defining/defining on elements/
<emilio> ... I'd expect less issues with things like timeline scopes and so on
<fantasai> kizu: Wrt other scoping things, we also have timeline-scope and anchor-name
<fantasai> kizu: Might want to have a way to expose these names, since might have cases where you want to expose
<khush> q+
<fantasai> kizu: maybe this is a more general issue that we need to handle in CSS, and have it work consistently
<astearns> ack khush
<TabAtkins> +1, we need a general mechanic for weakening shadow encapsulation
<TabAtkins> But we should be consistent for now
<fantasai> khush: kizu's point reminds me of ::part(), could use CSS to expose names from within shadow DOM outside it
<fantasai> khush: maybe if you expose the element could allow it to match
<fantasai> khush: could make it more complicated to implement
<fantasai> khush: we already have things in the platform that allow such information, in those cases do you want naming in CSS to also be exposed?
<fantasai> astearns: That would be a separate feature, though. This is for default behavior for view transitions
<fantasai> khush: Does it make sense to make this resolution cover other cases also? Have a general principle
<fantasai> astearns: I think a separate issue on general mechanism, because we do want to consider them all
<fantasai> astearns: don't want to have a specific escape route just for VT
<TabAtkins> Agree, separate issues
<fantasai> RESOLVED: view-transition-name lookup is tree-scoped

webkit-commit-queue pushed a commit to nt1m/WebKit that referenced this issue May 13, 2024
https://bugs.webkit.org/show_bug.cgi?id=273883
rdar://127995859

Reviewed by Antti Koivisto.

Corresponding spec issue: w3c/csswg-drafts#10145
Corresponding spec PR: w3c/csswg-drafts#10306

This ignores view-transition names from shadow DOM, given the pseudo-elements are linked to the document element,
exposing shadow DOM names to the view transition pseudo-elements would be a violation of shadow DOM principles.

We don't check for the tree scope directly in `forEachRendererInPaintOrder` because a shadow DOM element might have
flat tree descendants that have an outer tree scope.

We also use the `Styleable`'s element instead of `RenderElement`'s element because for pseudo-elements we want to consider
the associated element's tree scope.

* LayoutTests/TestExpectations:
* LayoutTests/platform/glib/TestExpectations:
* Source/WebCore/dom/ViewTransition.cpp:
(WebCore::ViewTransition::captureOldState):
(WebCore::ViewTransition::captureNewState):

Canonical link: https://commits.webkit.org/278704@main
@shonya3
Copy link

shonya3 commented Jun 16, 2024

View-transition names have been working seamlessly inside shadow trees until now. After updating Chrome to version 126, view-transition-name no longer pierces the shadow tree.
My entire project is built with custom elements (CE), including individual elements, pages, and the root.
This change has significantly degraded the user experience of my website, and I am currently at a loss for how to address this issue.

@vmpstr vmpstr reopened this Jun 17, 2024
@vmpstr
Copy link
Member

vmpstr commented Jun 17, 2024

Perhaps we should follow Scroll Timeline example here which treats everything as a flat tree:

Like most operations in CSS besides selector matching, features in this specification operate over the flattened element tree.

In ViewTransitions, we limit view-transition-name in this algorithm, but in the same algorithm use flat tree ancestors, which seems contradictory.

@vmpstr vmpstr added the Agenda+ label Jun 17, 2024
@nt1m
Copy link
Member

nt1m commented Jun 17, 2024

I do not think we should violate shadow DOM principles by exposing shadow DOM names to the root element (in the light DOM). Having a way to run transitions outside of the root element seems like a better solution to the problem @shonya3 is facing.

@vmpstr
Copy link
Member

vmpstr commented Jun 17, 2024

I'm not sure I understand the distinction. Transitions can run outside of the root element, but they can't reference things within the shadow DOM. Running a transition within the shadow DOM would only solve some cases, but not all of them. For example, icon to detailed view morph wouldn't be possible if the icon is a part of a custom web component.

@nt1m
Copy link
Member

nt1m commented Jun 17, 2024

If view-transition-name: shadow is applied to a shadow DOM element, having it exposed to the root element through ::view-transition-group(shadow) and friends, is a violation of shadow DOM should work. The shadow DOM element and the root element are in different tree scopes.

@bramus
Copy link
Contributor

bramus commented Jun 17, 2024

I think this discussion transcends View Transitions and touches all CSS properties that define a name: view-transition-name, scroll-timeline-name, anchor-name, container-name (and any others I can’t think of right now).

In general I think we should respect the aspect that these names don’t leak out of shadow roots. However, in some cases authors would explicitly want this, e.g. websites where they have a big tree of Web Components.

(For context: the re-opening of this issue was sparked by this report from an author in which they let us know that the View Transitions from the overview to the detail page on their site are no longer working in Chrome 126. Culprit is the view-transition-name being set on an element that is contained in a Web Component)

In #8915 (comment) there was talk of breaking style containment into two parts: containing names and all the rest. I would love to see a solution where names are contained by default – to not break one of the premises of using shadow DOM – but that there is a way to make the names visible only after the author opts-in (and only for open shadowroots).

This “contain by default” could be part of the UA stylesheet – e.g. :host { contain: names; } – which authors could then choose to unset/reset/adjust.

@vmpstr
Copy link
Member

vmpstr commented Jun 17, 2024

My understanding from @bramus is also that timeline-scope is able to lift a scroll-timeline-name from within a shadow tree to outside of the shadow root. This seems inconsistent with the treating we've resolved on for view-transition-name.

To support cases that were broken by this change, we'd like to have some way of loosening this restriction, whether it's with contain: names or something else. I suspect having bespoke language in the VT spec that prevents cross-shadow-dom interactions isn't the right approach

@nt1m
Copy link
Member

nt1m commented Jun 17, 2024

I'm not sure I understand the distinction. Transitions can run outside of the root element, but they can't reference things within the shadow DOM. Running a transition within the shadow DOM would only solve some cases, but not all of them. For example, icon to detailed view morph wouldn't be possible if the icon is a part of a custom web component.

If you end up with such a component, the components are probably poorly separated in the first place.

To me, it sounds like scoped element transitions would be the better solution to this problem.

@bramus
Copy link
Contributor

bramus commented Jun 17, 2024

To me, it sounds like scoped element transitions would be the better solution to this problem.

That doesn’t work for websites with a tree of custom elements.

In https://divicards-site.pages.dev/ for example the author has a <e-divination-card> custom element that they want to transition from the overview to the detail page. The value for view-transition-name gets set on the fly on the first div of that component, which seems pretty logical to me.

Even if they did set that view-transition-name on the <e-divination-card> directly it wouldn’t work, because that element itself is a child of another custom element:

<app-root>
  <p-home>
    <e-card-with-sources>
      <e-divination-card></e-divination-card>
    </e-card-with-sources>
  </p-home>
</app-root>

@noamr
Copy link
Collaborator

noamr commented Jun 18, 2024

Before jumping to the solutions, I want to see how far part() can get us there with the current use cases people are trying to build. Seems like it can work for a lot of things like animating an element's internal icon etc?

@khushalsagar
Copy link
Member Author

^ that is the question on this issue: #10303. And reading through the discussion here, I also feel like ::part is the correct way to name elements inside the shadow DOM.

@khushalsagar
Copy link
Member Author

This is worth discussing in the context of all named references for CSS in general, added #10304 to the agenda with more context for it.

@JudahGabriel
Copy link

JudahGabriel commented Jun 27, 2024

One of our public-facing apps at Microsoft was also broken by this change. Our app is built entirely with web components; a tree of web components with shadow roots.

In our case, when the user navigates our SPA, we want to view transition everything except that header and footer. So we assigned those a separate view-transition-name. This worked until Chrome 126.

We'd love a way to say, "this web component has a different view-transition-name" so that it can remain in place during view transitions. I don't feel strongly about any of the proposals so far. So long as we can do what we did before: give elements different view-transition-names so they don't take part in view transition.

@noamr
Copy link
Collaborator

noamr commented Jun 28, 2024

One of our public-facing apps at Microsoft was also broken by this change. Our app is built entirely with web components; a tree of web components with shadow roots.

In our case, when the user navigates our SPA, we want to view transition everything except that header and footer. So we assigned those a separate view-transition-name. This worked until Chrome 126.

We'd love a way to say, "this web component has a different view-transition-name" so that it can remain in place during view transitions. I don't feel strongly about any of the proposals so far. So long as we can do what we did before: give elements different view-transition-names so they don't take part in view transition.

So if I understand correctly, the issue here was not about mixing light-DOM elements with shadow-DOM elements, but rather that all the elements participating were inside the shadow DOM, and now this can't work?

@JudahGabriel
Copy link

Correct, it's not about mixing light DOM with shadow DOM. Our whole app is built with web components, so it's all shadow DOM.

And the issue is that, we don't want our header and footer to take part in view transition. Since header and footer don't change, we want them to stay in place. We accomplished this by setting view-transition-name on header and footer. This worked until Chrome 126. Now with the new behavior, the browser ignores view-transition-name, and thus enlists them in the page transition.

You can see it for yourself in this minimal repo. Or you can see it on our live public-facing site, apps.microsoft.com - just click a link and observe that the header and footer participate in the view transition.

We want a way to say, "This element shouldn't participate in the view transition", even if that element is inside a shadow root.

@bramus
Copy link
Contributor

bramus commented Jul 1, 2024

Correct, it's not about mixing light DOM with shadow DOM.

But you’re calling document.startViewTransition – with the pseudos getting injected onto :root – so it kinda is … no? For this to work the Light DOM needs to see the view-transition-name values declared in the Shadow DOM.

@noamr
Copy link
Collaborator

noamr commented Jul 1, 2024

Correct, it's not about mixing light DOM with shadow DOM.

But you’re calling document.startViewTransition – with the pseudos getting injected onto :root – so it kinda is … no? For this to work the Light DOM needs to see the view-transition-name values declared in the Shadow DOM.

I think we should find a way where the pseudos are also defined in the shadow tree, but we have to deal with edge cases like ::view-transition-group:only-child

@noamr
Copy link
Collaborator

noamr commented Jul 1, 2024

Thanks @JudahGabriel! We're taking this breakage very seriously and we'll find a solution.

@shonya3 does your use case involve sharing view-transition-names across shadow boundaries, or it's like this comment, where the captured element is encapsulated within a shadow DOM?

@shonya3
Copy link

shonya3 commented Jul 1, 2024

@noamr Yep, i am sharing across boundaries, something like this or this
Bramus explained my case perfectly.

@noamr
Copy link
Collaborator

noamr commented Jul 1, 2024

@noamr Yep, i am sharing across boundaries, something like this or this Bramus explained my case perfectly.

Gotcha. I see that you're using shadow parts already in the first example? Do you think enabling view-transition-name on ::part like in #10303 work for your use case? Superficially it seems like the right direction.

@Remiscan
Copy link

Remiscan commented Jul 1, 2024

If I may mention my own use case here: my team is working on an app built entirely with web components, so we have nested components with shadow roots. Chrome 126 broke our View Transitions.

Enabling view-transition-name on ::part would be a useful solution if we also had scoped View Transitions. Starting a View Transition on a deeply nested custom element, then giving names to its sub-components with ::part sounds doable. But without scoped View Transitions, we'd have to use the exportparts attribute all the way up to the document element, since that's the only element we can start a View Transition on right now, right?

That sounds very impractical. A solution like a CSS attribute, as mentioned here, looks like it would help us a lot more in that case.

@noamr
Copy link
Collaborator

noamr commented Jul 1, 2024

If I may mention my own use case here: my team is working on an app built entirely with web components, so we have nested components with shadow roots. Chrome 126 broke our View Transitions.

Enabling view-transition-name on ::part would be a useful solution if we also had scoped View Transitions. Starting a View Transition on a deeply nested custom element, then giving names to its sub-components with ::part sounds doable. But without scoped View Transitions, we'd have to use the exportparts attribute all the way up to the document element, since that's the only element we can start a View Transition on right now, right?

That sounds very impractical. A solution like a CSS attribute, as mentioned here, looks like it would help us a lot more in that case.

Thanks for sharing! Do your transitions cross shadow boundaries (an element in a shadow transitions into an element in another shadow/light DOM etc) or it's more like wanting transitions within the same shadow root to work?

@Remiscan
Copy link

Remiscan commented Jul 2, 2024

Thanks for sharing! Do your transitions cross shadow boundaries (an element in a shadow transitions into an element in another shadow/light DOM etc) or it's more like wanting transitions within the same shadow root to work?

The transitions cross shadow boundaries. view-transition-names are set on components nested a few levels deep within a container's shadow root, and the same view-transition-name will be set on different elements, in different shadow roots, between the start and end state of the transition.

However, there is still a "transition container" element that contains every transitioned element within its shadow root (or its children's shadow roots, or their children's, etc). I feel like ::part could still work within the "transition container" here, provided the correct chain of exportparts is used on the nested children. Then we would move all view-transition-names definitions into the CSSStyleSheet that's adopted by the "transition container" element. (It would also be nice to define the transition itself in that same style sheet, but for now all ::view-transition-* selectors have to be in a separate style sheet adopted by the document.)

The main pain point remains that we would also have to modify the whole chain of ancestor elements, from the "transition container" all the way up to the root of the document, to use exportparts on them as well to make things work with document.startViewTransition.

And it would make it harder to move the view-transition-names between the start and end state of the transition: before Chrome 126, some JavaScript could directly set (or remove) the names (or CSS classes) on the appropriate elements during the View Transition update callback. Now, that JS would have to set (or remove) parts instead, and we'd have to make sure they're exported through all ancestors, and set the names from the document.

@noamr
Copy link
Collaborator

noamr commented Jul 2, 2024

@Remiscan gotcha. So sounds like in the long run, something like a combination of ::part and element-scoped transition would be ideal for your use case.

Thanks for sharing in detail, we're discussing a few options internally and want to understand the use cases better.

@noamr
Copy link
Collaborator

noamr commented Jul 3, 2024

Summarizing internal conversation about this:

We're hitting the same snag that we've hit in anchor positioning and view-timeline, where to support ::part (as in #10303) is problematic because it requires tracking of "where did this style come from", and style doesn't always come from a particular tree scope, e.g. it can come from an inline attribute set by a script that's not from a particular tree. See https://drafts.css-houdini.org/css-properties-values-api/#shadow-dom.

In other specs the current direction is to have these names operate on the flat tree, and scope them using a separate property (e.g. anchor-scope) rather than using the shadow boundary for this scoping. Perhaps we could have a "soft" encapsulation for this by defaulting these scope property to be contained in shadow roots.

In any case, we should be consistent here and in anchor-positining/scroll-driven positioning.

Proposing that if anchor positioning and scroll-driven animations don't change course to use shadow encapsulation, including figuring out the "where did the style come from" issue, then we revert the view-transition change so that view-transition-names are in the flat tree to be consistent, and introduce view-transition-scope which would be as consistent as possible with anchor-scope (will prepare a proposal for that).

@shonya3
Copy link

shonya3 commented Jul 3, 2024

@noamr Yep, i am sharing across boundaries, something like this or this Bramus explained my case perfectly.

Gotcha. I see that you're using shadow parts already in the first example? Do you think enabling view-transition-name on ::part like in #10303 work for your use case? Superficially it seems like the right direction.

Enabling view-transition-name for ::part looks logical and natural to me.

But the main concern for me is whether it will work without much hassle.

@andruud
Copy link
Member

andruud commented Jul 3, 2024

In other specs the current direction is to have these names operate on the flat tree, and scope them using a separate property (e.g. anchor-scope) rather than using the shadow boundary for this scoping.

No, anchor positioning is tree-scoped, and there's no plan to change it. I think the issue and proposal in #10325 was just misunderstood. The anchor-scope property does not replace tree-scoping, it's just an additional mechanism on top of it.

Scroll-driven animations however is more like what you describe. For some reason I never understood, timeline names are not tree-scoped. #8135. But I'm not sure we should draw inspiration from this, we might want to fix SDA instead.

@noamr
Copy link
Collaborator

noamr commented Jul 3, 2024

Thanks @andruud, this makes sense. So to clarify, the resolution here is fine and matches anchor positioning, and should also support things like putting a view-transition-name on a ::part, but the way we interpreted it in the implementation (and perhaps in the spec wording?) is a bug.

noamr added a commit to noamr/csswg-drafts that referenced this issue Jul 4, 2024
… being name-based.

The previous fix for using the tree context made it inconsistent with how shadow DOM styling
works for things like anchor positioning, and made it so that e.g. `::part` cannot set a
`view-transition-name`.

Refactored to make the `view-transition-name` a tree-scoped name, rather than check the
tree context of the element.

Closes w3c#10145
@noamr noamr closed this as completed in eaf34b1 Jul 5, 2024
@noamr
Copy link
Collaborator

noamr commented Jul 8, 2024

@shonya3 @Remiscan @JudahGabriel as of Chrome M127 you should be able to give a view-transition-name to a ::part in the document scope. I know this is not an ideal solution for every use-case given that we don't have element-scoped transitions yet, but it should at least give you a way to work around the regression you've experienced in the short term. WebKit is following through with the same.

@shonya3
Copy link

shonya3 commented Aug 7, 2024

Just implemented my first try with new approach.

index.html

p-card::part(card),
 p-home::part(card) {
 view-transition-name: card;
}

p-home.ts
Somewhere in render method...
Conditionally set part="card" attribute

this.paginated.map(card => {
	return html`<li>
		${card === this.activeCard
			? html`<e-card-with-sources
					.name=${card}
					.divcordTable=${this.divcordTable}
					.cardSize=${this.cardSize}
					.sourceSize=${this.sourceSize}
					@navigate=${() => this.#setActiveCard(card)}
					part="card"
			  ></e-card-with-sources>`
			: html`<e-card-with-sources
					.name=${card}
					.divcordTable=${this.divcordTable}
					.cardSize=${this.cardSize}
					.sourceSize=${this.sourceSize}
					@navigate=${() => this.#setActiveCard(card)}
			  ></e-card-with-sources>`}
	</li>`;
});

And there is activeCard?:string global state to set it on p-home render and update on navigate(emits by divination card element on any inner link element click).
Not too bad, to be honest 🤓
https://divicards-site.pages.dev/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.