CSS Scoping Module Level 1

Level: 1
Shortname: css-scoping
Group: CSSWG
Status: ED
Work Status: Exploring
TR: http://www.w3.org/TR/css-scoping-1/
ED: http://dev.w3.org/csswg/css-scoping/
Previous Version: http://www.w3.org/TR/2014/WD-css-scoping-1-20140403/
Editor: Tab Atkins Jr., Google, http://xanthir.com/contact/
Editor: Elika J Etemad / fantasai, Invited Expert, http://fantasai.inkedblade.net/contact
Abstract: This specification defines various scoping/encapsulation mechanisms for CSS, including scoped styles and the ''@scope'' rule, Shadow DOM selectors, and page/region-based styling.
Ignored Terms: slot, shadowroot, scoped
Link Defaults: selectors (dfn) child combinator, html (element) style
Issue Tracking: Bugzilla https://www.w3.org/Bugs/Public/buglist.cgi?component=Scoping&list_id=47685&product=CSS&resolution=---

Introduction

...

Scoped Styles

Scoped style rules apply only within a subtree of a document, rather than matching against the entire document. Scoping has two primary effects: * The selector of the scoped style rule is restricted to match only elements within scope. See Scoped Selectors in [[SELECTORS4]]. * The cascade prioritizes scoped rules over unscoped ones, regardless of specificity. See Cascading by Scope in [[CSS3CASCADE]].

Scoping Mechanisms

Style rules can be scoped using constructs defined in the document language or using the ''@scope'' rule in CSS. “Scoping” consists of three somewhat independent concepts, which are in practice generally used together: * A declaration can be scoped to a scoping root, which affects its cascading behavior. [[!CSS3CASCADE]] (Alternately, a style rule can be scoped to a scoping root, which scopes all of the declarations it contains to that scoping root.) * A selector can be either scope-contained or scope-filtered to a scoping root, which limits what elements it is allowed to match. [[!SELECTORS4]] * The '':scope'' pseudo-class matches whatever the context sets as the :scope elements, and is used by several features, such as relative selectors. In the absence of any anything explicitly setting the :scope elements to something, the '':scope'' pseudo-class matches the selector's scoping root.

Document Markup for Scoping

Document languages may define a mechanism for a stylesheet to be scoped to some element in the document. For example, in HTML, a style element with a scoped attribute defines a stylesheet that is scoped to the style element’s parent element. [[HTML]] The element that the stylesheet is scoped to is the scoping root for all the style rules in the stylesheet, and selectors of style rules in the stylesheet are scope-contained to the scoping root.

CSS Syntax for Scoping: the ''@scope'' rule

The @scope at-rule allows authors to create scoped style rules using CSS syntax. The syntax of the ''@scope'' rule is:
	@scope <> {
		<>
	}
	
where the elements matched by the <> are scoping roots for the style rules in <>, and selectors of style rules scoped by ''@scope'' are scope-contained to their scoping root.

This rule makes it very easy for authors to create scoped style sheets, which could affect the optimization strategies for implementing scoped styles. If multiple elements match the <>, the <> is effectively duplicated and scoped independently to each one. Authors should avoid using overly-generic selectors as it can have confusing interactions with the cascade.

A scoped stylesheet is attached not only to the outermost scoping element, but to all matching elements. For example, given the style sheet below
		@scope div {
			span {
				color: blue;
			}
		}
		@scope section {
			span {
				color: orange;
			}
		}
		
and the following document fragment
		<div>
			<section>
				<div>
					<span>text</span>
				</div>
			</section>
		</div>
		
the text will be blue.
''@scope'' rules can be nested. In this case, just as with the nested style rules, the selector of an outer ''@scope'' scope-contains the selector of the inner one. The specificity of selectors inside the ''@scope'' rule is calculated locally: the selector specifying the scoping element is ignored. However, because scoped styles override non-scoped styles, style rules inside the ''@scope'' will override rules outside of it.
In the following example, the text would be green:
			@scope aside {
				p { color: green; }
			}
			aside#sidebar p { color: red; }
		
Issue: If multiple ''@scope'' rules apply to an element, should they be cascaded by specificity?

Querying the Scoping Context

Selecting the Scoping Root: '':scope'' pseudo-class

In a scoped stylesheet, the '':scope'' pseudo-class, defined in [[SELECTORS4]], matches the scoping root.

Selecting Outside the Scope: '':scope-context()'' pseudo-class

This would be defined similarly to '':host-context()'', but matching the ancestors of the scoping root instead. However, since for scoped stylesheets you may want the ability to match complex selectors against the outside tree, rather than a single compound selector, we may want to instead use a more general mechanism that doesn't syntactically invert the order of tree elements. Possible ideas:
		:scope-context(<>) div {...}
		scope(<>) div {...}
		\scope <>\ div {...}
		<> \scope\ div {...}
		
This functionality would replace ''@global'', which is a poor excuse for a selector.

Shadow Encapsulation

The Shadow DOM spec augments the DOM with several new concepts, several of which are relevant to CSS. A shadow tree is a document fragment that can be attached to any element in the DOM. The root of the shadow tree is a shadow root, a non-element node which is associated with a shadow host. An element can have any number of shadow trees, which are ordered by creation time. The most recently-created shadow tree on an element is the youngest shadow tree for that element. An element with a shadow tree is a shadow host. It is the host element for its shadow trees. The descendants of a shadow host must not generate boxes in the formatting tree. Instead, the contents of the youngest shadow tree generate boxes as if they were the contents of the element instead. In several instances in shadow DOM, elements don't have element parents (instead, they may have a shadow root as parent, or something else). An element without a parent, or whose parent is not an element, is called a top-level element. While the children of a shadow host do not generate boxes normally, they can be explicitly pulled into a shadow tree and forced to render normally. This is done by marking the elements as distributed nodes for an insertion point element. This specification does not define how to mark elements as distributed nodes, instead leaving that to the Shadow DOM spec. At the time this spec is written, however, only slot elements in a shadow tree can be insertion points. An insertion point must not generate any boxes. Instead, its distributed nodes generate boxes as normal, as if they all replaced the insertion point in-place. (Akin to the behavior of 'display-outside: contents'.)

Shadow DOM Selection Model

Elements in the DOM have zero or more shadow trees and zero or more distributed nodes. Note: The "descendants" of an element are based on the children of the element, which does not include the shadow trees or distributed nodes of the element. When a selector is matched against a shadow tree, the selector match list is initially the shadow host, followed by all the top-level elements of the shadow tree and their descendants, ordered by a pre-order traversal. A selector is in the context of a shadow tree if it is in a stylesheet attached to the shadow tree (that is, present in the ShadowRoot.styleSheets list), or it is used in an API that is rooted in a shadow tree.
Need to get DOM to hook this term. querySelector()/etc are rooted in a shadow tree if they're called on a ShadowRoot or an element in a shadow tree.

Host Elements in a Shadow Tree

A shadow host is outside of the shadow trees it hosts, but it is sometimes useful to be able to style it from inside the shadow tree context. For the purpose of Selectors, a host element also appears in each of its shadow trees, with the contents of the shadow tree treated as its children. If an element has multiple shadow trees, it appears in each shadow tree's context independently; each shadow tree sees itself as the contents of the host element, not the other shadow trees. When considered within its own shadow trees, the host element is featureless. Only the '':host'', '':host()'', and '':host-context()'' pseudo-classes are allowed to match it.
Why is the shadow host so weird? The shadow host lives outside the shadow tree, and its markup is in control of the page author, not the component author. It would not be very good if a component used a particular class name internally in a shadow tree, and the page author using the component accidentally also used the the same class name and put it on the host element. Such a situation would result in accidental styling that is impossible for the component author to predict, and confusing for the page author to debug. However, there are still some reasonable use-cases for letting a stylesheet in a shadow tree style its host element. So, to allow this situation but prevent accidental styling, the host element appears but is completely featureless and unselectable except through '':host''.

Shadow DOM Selectors

Shadow DOM defines a few new selectors to help select elements in useful way related to Shadow DOM. Issue: This section is still under discussion. Feedback and advice on intuitive syntax for the following functionality would be appreciated.

Selecting Into the Light: the '':host'', '':host()'', and '':host-context()'' pseudo-classes

The :host pseudo-class, when evaluated in the context of a shadow tree, matches the shadow tree's host element. In any other context, it matches nothing. The :host() function pseudo-class has the syntax:
:host( <> )
When evaluated in the context of a shadow tree, it matches the shadow tree's host element if the host element, in its normal context, matches the selector argument. In any other context, it matches nothing.
For example, say you had a component with a shadow tree like the following:
			<x-foo class="foo">
				<"shadow tree">
					<div class="foo">...</div>
				</>
			</x-foo>
		
For a stylesheet within the shadow tree: * '':host'' matches the <x-foo> element. * ''x-foo'' matches nothing. * ''.foo'' matches only the <div> element. * ''.foo:host'' matches nothing * '':host(.foo)'' matches the <x-foo> element.
Ordinary, selectors within a shadow tree can't see elements outside the shadow tree at all. Sometimes, however, it's useful to select an ancestor that lies somewhere outside the shadow tree, above it in the document.
For example, a group of components can define a handful of color themes they they know how to respond to. Page authors could opt into a particular theme by adding a specific class to the components, or higher up in the document.
The :host-context() functional pseudo-class tests whether there is an ancestor, outside the shadow tree, which matches a particular selector. Its syntax is:
:host-context( <> )
When evaluated in the context of a shadow tree, the '':host-context()'' pseudo-class matches the host element, if the host element or one of its ancestors matches the provided <>. For the purpose of this pseudo-class, the "ancestor" of an element is: : if the element is a distributed node :: the slot element it is ultimately distributed to. : if the element is a top-most element in a shadow tree :: the host element : otherwise :: the element's parent, if it has one. Note: This means that the selector pierces through shadow boundaries on the way up, looking for elements that match its argument, until it reaches the document root.

Selecting Into the Dark: the ''::shadow'' pseudo-element

Issue: It's been suggested to remove this feature. If an element has at least one shadow tree, the ::shadow pseudo-element matches the shadow roots themselves. In HTML, the shadow root is represented by {{ShadowRoot}} objects. The ''::shadow'' pseudo-element must not generate boxes, unless specified otherwise in another specification. However, for the purpose of Selectors, the ''::shadow'' pseudo-element is considered to be the root of the shadow tree, with the top-level elements in the shadow tree the direct children of the ''::shadow'' pseudo-element.
For example, say you had a component with a shadow tree like the following:
			<x-foo>
				<"shadow tree">
					<div>
						<span id="not-top">...</span>
					</div>
					<span id="top">...</span>
				</>
			</x-foo>
		
For a stylesheet in the outer document, ''x-foo::shadow > span'' matches ''#top'', but not ''#not-top'', because it's not a top-level element in the shadow tree. If one wanted to target ''#not-top'', one way to do it would be with ''x-foo::shadow > div > span''. However, this introduces a strong dependency on the internal structure of the component; in most cases, it's better to use the descendant combinator, like ''x-foo::shadow span'', to select all the elements of some type in the shadow tree.
If an element has multiple shadow trees, a ''::shadow'' pseudo-element selects all of the corresponding shadow roots. Similarly, inside of a shadow tree, a selector like '':host::shadow div'' selects the div elements in all the shadow trees on the element, not just the one containing that selector.

Selecting Shadow-Projected Content: the ''::slotted'' pseudo-element

Issue: It's been proposed to restrict this to child elements only. The ::slotted pseudo-element matches the list of distributed nodes itself, on elements that have them. The ''::slotted'' pseudo-element must not generate boxes, unless specified otherwise in another specification. However, for the purpose of Selectors, the ''::slotted'' pseudo-element is considered to be a parent of the distributed nodes.
For example, say you had a component with both children and a shadow tree, like the following:
			<x-foo>
				<div id="one" class="foo">...</div>
				<div id="two">...</div>
				<div id="three" class="foo">
					<div id="four">...</div>
				</div>
				<"shadow tree">
					<div id="five">...</div>
					<div id="six">...</div>
					<content select=".foo"></content>
				</"shadow tree">
			</x-foo>
		
For a stylesheet within the shadow tree, a selector like ''::slotted div'' selects ''#one'', ''#three'', and ''#four'', as they're the elements distributed by the sole slot element, but not ''#two''. If only the top-level elements distributed the slot element are desired, a child combinator can be used, like ''::slotted > div'', which will exclude ''#four'' as it's not treated as a child of the ''::slotted'' pseudo-element. Note: Note that a selector like ''::slotted div'' is equivalent to ''*::slotted div'', where the ''*'' selects many more elements that just the slot element. However, since only the slot element has distributed nodes, it's the only element that has a ''::slotted'' pseudo-element as well.

Selecting Through Shadows: the ''>>>'' combinator

Issue: It's currently disputed whether this combinator should exist. When a >>> combinator (or shadow-piercing descendant combinator) is encountered in a selector, replace every element in the selector match list with every element reachable from the original element by traversing any number of child lists or shadow trees.
For example, say you had a component with a shadow tree like the following:
			<x-foo>
				<"shadow tree">
					<div>
						<span id="not-top">...</span>
					</div>
					<span id="top">...</span>
					<x-bar>
						<"shadow tree">
							<span id="nested">...</span>
						</>
					</x-bar>
				</>
			</x-foo>
		
For a stylesheet in the outer document, the selector ''x-foo >>> span'' selects all three of <span> elements: ''#top'', ''#not-top'', and ''#nested''.

Shadow Cascading & Inheritance

Cascading

To address the desired cascading behavior of rules targetting elements in shadow roots, this specification extends the cascade order defined in the Cascade specification. [[!CSS3CASCADE]] An additional cascade criteria must be added, between Origin and Scope, called Shadow Tree. * When comparing two declarations, if one of them is in a shadow tree and the other is in a document that contains that shadow tree, then for normal rules the declaration from the outer document wins, and for important rules the declaration from the shadow tree wins. Note: This is the opposite of how scoped styles work. * When comparing two declarations, if both are in shadow trees with the same host element, then for normal rules the declaration from the shadow tree that was created most recently wins, and for important rules the declaration from the shadow tree that was created less recently wins. When calculating Order of Appearance, the tree of trees, defined by the Shadow DOM specification, is used to calculate ordering.

Inheritance

The top-level elements of a shadow tree inherit from their host element. Distributed nodes inherit from the parent of the slot element they are ultimately distributed to, rather than from their normal parent.

Fragmented Styling

Fragmented content can be styled differently based on which line, column, page, region, etc. it appears in. This is done by using an appropriate fragment pseudo-element, which allows targetting individual fragments of an element rather than the entire element.
In our example, the designer wants to make text flowing into #region1 dark blue and bold. This design can be expressed as shown below.
		#region1::region p {
			color: #0C3D5F;
			font-weight: bold;
		}
		
The ''::region'' pseudo-element is followed by a ''p'' relative selector in this example. The color and font-weight declarations will apply to any fragments of paragraphs that are displayed in ''#region1''. The following figure shows how the rendering changes if we apply this styling specific to ''#region1''. Note how less text fits into this box now that the 'font-weight!!property' is bold instead of normal.
Illustrate how changing region styling affects the flow of content.
Different rendering with a different region styling
Note: This feature is an extension of ''::first-line'' styling.

Region-based Styling: the ''::region'' pseudo-element

Extend this to specify: * ''<region-element-selector>::region'' * ''<paginated-element-selector>::page(<page-selector>)'' * ''<multicol-element>::column(<AnB>)'' * ''<fragmented-element-selector>::nth-fragment(<AnB>)'' * ''::first-line''
A ::region pseudo-element represents a relationship between a selector that matches a CSS Region, and a relative selector that matches some named flow content. This allows style declarations to be applied to fragments of named flow content flowing into particular regions.
	<region selector>::region <content selector>  {
		... CSS styling declarations ...
	}
	
When the ::region pseudo-element is appended to a selector that matches one or more CSS Regions, this creates a 'flow fragment' selector. The flow fragment selector specifies which range of elements in the flow can be matched by the relative selector. The relative selector can match elements in the range(s) (see [[!DOM]]) of the named flow that are displayed fully or partially in the selected region(s). Elements that are fully or partially in the flow fragment range may match the relative selector. However, the style declarations only apply to the fragment of the element that is displayed in the corresponding region(s). Only a limited list of properties apply to a ::region pseudo-element: Issue: Either this list should be all functionally inheritable properties, or all properties. Why is it a seemingly-arbitrary subset of all properties, including box properties? 1. font properties 2. color property 3. opacity property 4. background property 5. 'word-spacing' 6. 'letter-spacing' 7. 'text-decoration' 8. 'text-transform' 9. 'line-height' 10. alignment and justification properties 11. border properties 12. rounded corner properties 13. border images properties 14. margin properties 15. padding properties 16. 'text-shadow' 17. 'box-shadow' 18. 'box-decoration-break' 19. 'width'
In the following example, the named flow “article-flow” flows into “region-1” and “region-2”.
		<style>
		  #div-1 {
			flow-into: article-flow;
		  }

		  #region-1, #region-2 {
			flow-from: article-flow;
		  }

		  /* region styling */
		  #region-1::region p  {
			margin-right: 5em;
		  }
		</style>

		<body>
		  <div id="div-1">
			  <p id="p-1">...</p>
			  <p id="p-2">...</p>
		  </div>
		  <div id="region-1"></div>
		  <div id="region-2"></div>
		</body>
		
Example showing how a named flow content fits into regions to illustrate region styling.
  •  div div-1
  •  paragraph p-1
  •  paragraph p-2
  •  range of flow that fits into region-1
  •  range of flow that fits into region-2
The region styling applies to flow content that fits in ''region-1''. The relative selector matches ''p-1'' and ''p-2'' because these paragraphs flow into ''region-1''. Only the fragment of ''p-2'' that flows into ''region-1'' is styled with the pseudo-element.
All of the selectors in a ::region pseudo-element contribute to its specificity. So the specificity of the ::region pseudo-element in the example above would combine the id selector's specificity with the specificity of the type selector, resulting in a specificity of 101. Selectors that match a given element or element fragment (as described above), participate in the CSS Cascading order as defined in [[!CSS21]]. Note: Region styling does not apply to nested regions. For example, if a region ''A'' receives content from a flow that contains region ''B'', the content that flows into ''B'' does not receive the region styling specified for region ''A''. Issue: We'll need some way to query the styles of a fragment in a particular region. getComputedStyle() isn't enough, because an element can exist in multiple regions, for example, with each fragment receiving different styles.

Changes

The following significant changes were made since the 3 April 2014 Working Draft. * Renamed ::content to ''::slotted''.