CSS Shadow Parts

Unofficial Proposal Draft,

This version:
http://tabatkins.github.io/specs/css-shadow-parts/
Issue Tracking:
Inline In Spec
GitHub Issues
Editor:
Tab Atkins-Bittner (Google)
Not Ready For Implementation

This spec is not yet ready for implementation. It exists in this repository to record the ideas and promote discussion.

Before attempting to implement this spec, please contact the CSSWG at www-style@w3.org.


Abstract

This specification defines the ::part() and ::theme() pseudo-elements on shadow hosts, allowing shadow hosts to selectively expose chosen elements from their shadow tree to the outside page for styling purposes.

CSS is a language for describing the rendering of structured documents (such as HTML and XML) on screen, on paper, in speech, etc.

Status of this document

1. Introduction

This spec is intentionally a rough sketch at the moment. It should contain all the details necessary to evaluate the proposal, but is intentionally avoiding precise algorithms at the moment, to aid in easy comprehension and to, hopefully, discourage implementation from this sketch.

Shadow DOM allows authors to separate their page into "components", subtrees of markup whose details are only relevant to the component itself, not the outside page. This reduces the chance of a style meant for one part of the page accidentally over-applying and making a different part of the page look wrong. However, this styling barrier also makes it harder for a page to interact with its components when it actually wants to do so.

This specification defines the ::part() and ::theme() pseudo-elements, which allow an author to style specific, purposely exposed elements in a shadow tree from the outside page’s context. In combination with custom properties, which let the outside page pass particular values (such as theme colors) into the component for it to do with as it will, these pseudo-elements allow components and the outside page to interact in safe, powerful ways, maintaining encapsulation without surrending all control.

1.1. Motivation

For obvious reasons, it’s valuable to let the outside page style the internals of a shadow tree, at least in some limited ways. (The ubiquity of UA-specific pseudo-elements for the various input elements shows this.)

The previous proposed method for doing so, the >>> combinator, turned out to be too powerful for its own good; it exposed too much of a component’s internal structure to scrutiny, defeating some of the encapsulation benefits that using Shadow DOM brings. For this, and other performance-related reasons, the >>> combinator was eventually removed from the dynamic profile.

This left us with using custom properties as the only way to style into a shadow tree: the component would advertise that it uses certain custom properties to style its internals, and the outer page could then set those properties as it wished on the shadow host, letting inheritance push the values down to where they were needed. This works very well for many simple theming use-cases.

However, there are some cases where this falls down. If a component wishes to allow arbitrary styling of something in its shadow tree, the only way to do so is to define hundreds of custom properties (one per CSS property they wish to allow control of), which is obviously ridiculous for both usability and performance reasons. The situation is compounded if authors wish to style the component differently based on pseudo-classes like :hover; the component needs to duplicate the custom properties used for each pseudo-class (and each combination, like :hover:focus, resulting in a combinatorial explosion). This makes the usability and performance problems even worse.

We introduce ::part() to handle this case much more elegantly and performantly. Rather than bundling everything into custom property names, the functionality lives in selectors and style rule syntax, like it’s meant to. This is far more usable for both component authors and component users, should have much better performance, and allows for better encapsulation/API surface.

Another interesting facet of using custom properties, however, is that inheritance doesn’t stop at the first shadow tree. Unless explicitly blocked, a custom property inherits down thru nested trees, allowing authors to style deeply nested components as easily as they style directly-visible ones. The same considerations apply to this case, so we introduce ::theme() to handle this.

It’s important to note that ::part() and ::theme() offer absolutely zero new theoretical power. They are not a rehash of the >>> combinator, they’re simply a more convenient and consistent syntax for something authors can already do with custom properties. By separating out the explicitly "published" parts of an element (the shadow part map from the sub-parts that it merely happens to contain (the shadow theme map, it also helps with encapsulation, as authors can use ::part() without fear of accidental over-styling.

2. Exposing a Shadow Element: the part attribute

Any element in a shadow tree can have a part attribute. This is used to expose the element outside the shadow tree, and to "forward" sub-parts of the element (if it has its own shadow tree) to outside the shadow tree.

The part attribute is parsed as a comma-separated list of part mappings. Each part mapping is one of:

ident

Adds «[ ident → el ]» to the shadow root’s shadow part map.

ident1 => ident2

If el is a shadow host, and it’s shadow root’s shadow part map partMap contains ident1, then this adds «[ ident2 → partMap[ident1] ]» to the shadow root’s shadow part map.

* => prefix*

If el is a shadow host, then for each identsubEl in el’s shadow root’s shadow part map, «[ prefix + identsubEl ]» is added to the shadow root’s shadow part map.

anything else

Ignored for error-recovery / future compat.

Note: It’s okay to give a part multiple names, or map a sub-part to several names. The "part name" should be considered similar to a class, not an id or tagname.

Each shadow root has a shadow part map and a shadow theme map, both of which are ordered maps.

The shadow part map contains all the entries described by the elements in its shadow tree, as described above.

If the shadow root’s mode is "closed", the shadow theme map is identical to the shadow part map. Otherwise, it’s the concatenation of the shadow part map with the shadow theme maps of every shadow host’s shadow root in its shadow tree.

TODO: Define a syntax or new attribute to prevent an element from adding things to its shadow root’s shadow theme map.

3. Selecting a Shadow Element: the ::part() and ::theme() pseudo-elements

The ::part() and ::theme() pseudo-elements (collectively, the shadow-part pseudo-elements) allow you to select elements that have been exposed via a part attribute. The syntaxes of them are:

::part() = ::part( <ident> )
::theme() = ::theme( <ident> )

The ::part() pseudo-element only matches anything when the originating element is a shadow host. If the originating element’s shadow root’s shadow part map contains the specified <ident>, ::part() matches the element or elements keyed to that <ident>. Otherwise, it matches nothing.

For example, if you have a custom button that contains a "label" element that is exposed for styling (via part="label"), you can select it with #the-button::part(label).

The ::theme() pseudo-element is similar, except it can match regardless of whether the originating element is a shadow host or not. It matches the elements keyed to the specified <ident> in the shadow theme map of the shadow trees of the originating element or any descendants.

For example, :root::theme(label) matches any element with part="label" anywhere in the entire document, no matter how deeply nested into shadow trees they are.

The shadow-part pseudo-elements can take additional pseudo-classes after them, such as x-button::part(label):hover, but never match the structural pseudo-classes or any other pseudo-classes that match based on tree information rather than local element information.

The shadow-part pseudo-elements also can take additional pseudo-elements after them, such as x-button::part(label)::before, but never match additional shadow-part pseudo-elements.

For example, x-panel::part(confirm-button)::part(label) never matches anything. This is because doing so would expose more structural information than is intended.

One can still target the nested label with a selector like x-panel::theme(label). However, this will also select the labels of any other buttons in the panel.

If the <x-panel>’s internal confirm button had used something like part="confirm-button, * => confirm-*" to forward the button’s internal parts up into the panel’s own shadow part map, then a selector like x-panel::part(confirm-label) would select just the one button’s label, ignoring any other labels.

Conformance

Document conventions

Conformance requirements are expressed with a combination of descriptive assertions and RFC 2119 terminology. The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in the normative parts of this document are to be interpreted as described in RFC 2119. However, for readability, these words do not appear in all uppercase letters in this specification.

All of the text of this specification is normative except sections explicitly marked as non-normative, examples, and notes. [RFC2119]

Examples in this specification are introduced with the words “for example” or are set apart from the normative text with class="example", like this:

This is an example of an informative example.

Informative notes begin with the word “Note” and are set apart from the normative text with class="note", like this:

Note, this is an informative note.

Advisements are normative sections styled to evoke special attention and are set apart from other normative text with <strong class="advisement">, like this: UAs MUST provide an accessible alternative.

Conformance classes

Conformance to this specification is defined for three conformance classes:

style sheet
A CSS style sheet.
renderer
A UA that interprets the semantics of a style sheet and renders documents that use them.
authoring tool
A UA that writes a style sheet.

A style sheet is conformant to this specification if all of its statements that use syntax defined in this module are valid according to the generic CSS grammar and the individual grammars of each feature defined in this module.

A renderer is conformant to this specification if, in addition to interpreting the style sheet as defined by the appropriate specifications, it supports all the features defined by this specification by parsing them correctly and rendering the document accordingly. However, the inability of a UA to correctly render a document due to limitations of the device does not make the UA non-conformant. (For example, a UA is not required to render color on a monochrome monitor.)

An authoring tool is conformant to this specification if it writes style sheets that are syntactically correct according to the generic CSS grammar and the individual grammars of each feature in this module, and meet all other conformance requirements of style sheets as described in this module.

Requirements for Responsible Implementation of CSS

The following sections define several conformance requirements for implementing CSS responsibly, in a way that promotes interoperability in the present and future.

Partial Implementations

So that authors can exploit the forward-compatible parsing rules to assign fallback values, CSS renderers must treat as invalid (and ignore as appropriate) any at-rules, properties, property values, keywords, and other syntactic constructs for which they have no usable level of support. In particular, user agents must not selectively ignore unsupported property values and honor supported values in a single multi-value property declaration: if any value is considered invalid (as unsupported values must be), CSS requires that the entire declaration be ignored.

Implementations of Unstable and Proprietary Features

To avoid clashes with future stable CSS features, the CSSWG recommends following best practices for the implementation of unstable features and proprietary extensions to CSS.

Implementations of CR-level Features

Once a specification reaches the Candidate Recommendation stage, implementers should release an unprefixed implementation of any CR-level feature they can demonstrate to be correctly implemented according to spec, and should avoid exposing a prefixed variant of that feature.

To establish and maintain the interoperability of CSS across implementations, the CSS Working Group requests that non-experimental CSS renderers submit an implementation report (and, if necessary, the testcases used for that implementation report) to the W3C before releasing an unprefixed implementation of any CSS features. Testcases submitted to W3C are subject to review and correction by the CSS Working Group.

Further information on submitting testcases and implementation reports can be found from on the CSS Working Group’s website at http://www.w3.org/Style/CSS/Test/. Questions should be directed to the public-css-testsuite@w3.org mailing list.

Index

Terms defined by this specification

Terms defined by reference

References

Normative References

[CSS-SCOPING-1]
Tab Atkins Jr.; Elika Etemad. CSS Scoping Module Level 1. URL: http://dev.w3.org/csswg/css-scoping/
[CSS-VALUES-3]
Tab Atkins Jr.; Elika Etemad. CSS Values and Units Module Level 3. URL: https://drafts.csswg.org/css-values/
[CSS-VARIABLES-1]
Tab Atkins Jr.. CSS Custom Properties for Cascading Variables Module Level 1. URL: http://dev.w3.org/csswg/css-variables/
[INFRA]
Anne van Kesteren; Domenic Denicola. Infra Standard. Living Standard. URL: https://infra.spec.whatwg.org/
[RFC2119]
S. Bradner. Key words for use in RFCs to Indicate Requirement Levels. March 1997. Best Current Practice. URL: https://tools.ietf.org/html/rfc2119
[SELECTORS-4]
Selectors Level 4 URL: https://drafts.csswg.org/selectors-4/
[WHATWG-DOM]
Anne van Kesteren. DOM Standard. Living Standard. URL: https://dom.spec.whatwg.org/

Issues Index

This spec is intentionally a rough sketch at the moment. It should contain all the details necessary to evaluate the proposal, but is intentionally avoiding precise algorithms at the moment, to aid in easy comprehension and to, hopefully, discourage implementation from this sketch.
TODO: Define a syntax or new attribute to prevent an element from adding things to its shadow root’s shadow theme map.