1. Introduction
Efficiently rendering a website relies on the user agent being able to detect what parts of the page are being displayed, which parts might affect the currently-displayed section, and what can be ignored.
There are various heuristics that can be used to guess when a given sub-tree is independent of the rest of the page in some manner, but they’re fragile, so innocuous changes to a page may inadvertently make it fail such heuristic tests, causing rendering to fall into a slow code path. There are also many things that would be good to isolate which are difficult or impossible to detect in a heuristic manner.
To alleviate these problems and allow strong, predictable isolation of a subtree from the rest of the page, this specification defines a contain property.
1.1. Value Definitions
This specification follows the CSS property definition conventions from [CSS2] using the value definition syntax from [CSS-VALUES-3]. Value types not defined in this specification are defined in CSS Values & Units [CSS-VALUES-3]. Combination with other CSS modules may expand the definitions of these value types.
In addition to the property-specific values listed in their definitions, all properties defined in this specification also accept the CSS-wide keywords as their property value. For readability they have not been repeated explicitly.
2. Strong Containment: the contain property
This change has tests
A test for this change has been added to WPT. The results can be viewed at wpt.fyi. Note that a few subtests of this test (those involving thestyle
or inline-size
values)
only relate to later levels of this specification.
Name: | contain |
---|---|
Value: | none | strict | content | [ size || layout || paint ] |
Initial: | none |
Applies to: | See below |
Inherited: | no |
Percentages: | n/a |
Computed value: |
|
Canonical order: | per grammar |
Animation type: | not animatable |
User agents are expected to support this property on all media, including non-visual ones.
The contain property allows an author to indicate that an element and its contents are, as much as possible, independent of the rest of the document tree. This allows user agents to utilize much stronger optimizations when rendering a page using contain properly, and allows authors to be confident that their page won’t accidentally fall into a slow code path due to an innocuous change.
- none
- This value indicates that the property has no effect. The element renders as normal, with no containment effects applied.
- strict
-
This value
computes to size layout paint,
and thus
turns on all forms of containment for the element.
In other words, it behaves the same as contain: size layout paint;.. - content
-
This value
computes to layout paint,
and thus
turns on all forms of containment except size containment for the element.
In other words, it behaves the same as contain: layout paint;..Note: contain: content is reasonably "safe" to apply widely; its effects are fairly minor in practice, and most content won’t run afoul of its restrictions. However, because it doesn’t apply size containment, the element can still respond to the size of its contents, which can cause layout-invalidation to percolate further up the tree than desired. Use contain: strict when possible, to gain as much containment as you can.
- size
- The value turns on size containment for the element. This ensures that the containment box can be laid out without needing to examine its descendants.
- layout
- This value turns on layout containment for the element. This ensures that the containment box is totally opaque for layout purposes; nothing outside can affect its internal layout, and vice versa.
- paint
- This value turns on paint containment for the element. This ensures that the descendants of the containment box don’t display outside its bounds, so if an element is off-screen or otherwise not visible, its descendants are also guaranteed to be not visible.
This property generally applies to all elements (including CSS Pseudo-Elements 4 § 4.1 Generated Content Pseudo-elements: ::before and ::after),
although some types of containment have no effect on some elements,
as detailed in § 3 Types of Containment.
In addition, in the case of [SVG2],
the contain property only applies to svg
elements that have an associated CSS layout box.
For example, assume a micropost social network had markup something like this:
< body >
< aside > ...</ aside >
< section >
< h2 > Messages</ h2 >
< article >
Lol, check out this dog: images.example.com/jsK3jkl
</ article >
< article >
I had a ham sandwich today. #goodtimes
</ article >
< article >
I have political opinions that you need to hear!
</ article >
…
</ section >
</ body >
There are probably a lot of messages displayed on the site, but each is independent and won’t affect anything else on the site. As such, each can be marked with contain: content to communicate this to the user agent, so it can optimize the page and skip a lot of computation for messages that are off-screen. If the size of each message is known ahead of time, contain: strict can be applied to communicate further restrictions.
html
and body
elements,
particularly in consideration of the fact that
for legacy reasons,
some properties can propagate outwards from the body
element.
This proposed text addresses this oversight.
Additionally, when the used value of the contain property on either the HTMLhtml
orbody
elements is anything other than none, propagation of properties from thebody
element to the initial containing block, the viewport, or the canvas background, is disabled. Notably, this affects:
writing-mode, direction, and text-orientation (see CSS Writing Modes 3 § 8 The Principal Writing Mode)
overflow and its longhands (see CSS Overflow 3 § 3.5 Overflow Viewport Propagation)
background and its longhands (see CSS Backgrounds 3 § 2.11.2 The Canvas Background and the HTML <body> Element)
Note: Propagation to the initial containing block, the viewport, or the canvas background, of properties set on the
html
element itself is unaffected.
This change has tests
Tests to cover these new requirements have been added to WPT. The results of these tests can be seen at the Web-Platform-Tests dashboard:- contain-body-bg-001.html
- contain-body-bg-002.html
- contain-body-bg-003.html
- contain-body-bg-004.html
- contain-body-dir-001.html
- contain-body-dir-002.html
- contain-body-dir-003.html
- contain-body-dir-004.html
- contain-body-overflow-001.html
- contain-body-overflow-002.html
- contain-body-overflow-003.html
- contain-body-overflow-004.html
- contain-body-t-o-001.html
- contain-body-t-o-002.html
- contain-body-t-o-003.html
- contain-body-t-o-004.html
- contain-body-w-m-001.html
- contain-body-w-m-002.html
- contain-body-w-m-003.html
- contain-body-w-m-004.html
- contain-html-bg-001.html
- contain-html-bg-002.html
- contain-html-bg-003.html
- contain-html-bg-004.html
- contain-html-dir-001.html
- contain-html-dir-002.html
- contain-html-dir-003.html
- contain-html-dir-004.html
- contain-html-overflow-001.html
- contain-html-overflow-002.html
- contain-html-overflow-003.html
- contain-html-overflow-004.html
- contain-html-t-o-001.html
- contain-html-t-o-002.html
- contain-html-t-o-003.html
- contain-html-t-o-004.html
- contain-html-w-m-001.html
- contain-html-w-m-002.html
- contain-html-w-m-003.html
- contain-html-w-m-004.html
3. Types of Containment
There are several varieties of containment that an element can be subject to, restricting the effects that its descendants can have on the rest of the page in various ways. Containment enables much more powerful optimizations by user agents, and helps authors compose their page out of functional units, as it limits how widely a given change can affect a document.
Specification authors introducing new properties or mechanisms need to consider whether and how the various types of containment affect what they are introducing, and include in their specification any effect not described here.
3.1. Size Containment
Giving an element size containment makes its principal box a size containment box and has the following effects:
-
When calculating the size of size containment box,
it must be treated as having no contents.
Note: Even when the element’s sizing properties specify an intrinsic size, this does not necessarily make the element zero-sized: properties set on the element itself continue to be taken into account, which can cause it to be larger.
Then, its contents must then be laid out into the containment box's resolved size.
Note: Size containment does not suppress baseline alignment. See layout containment for that.
Proposed Correction 2: The way the two normative sentences above are written was somewhat ambiguous, causing implementers to have some doubts about the precise intended effects in certain cases. In order to clarify what is meant without changing the intended behavior, The CSSWG suggest replacing this first item in the list with the following two (the existing notes remain the same):-
The intrinsic sizes of the size containment box are determined as if the element had no content,
following the same logic as when sizing as if empty.
Note: This affects explicit invocations of the min-content or max-content keywords, as well as any calculation that depends on these measurement, such as sizing grid tracks into which a size contained item is placed, or if fit-content sizing the containment box’s parent.
-
Laying out a size containment box and its content is conceptually done in two phases:
- Sizing as if empty
-
The used width and height of the containment box are determined as if performing a normal layout of the box,
except that it is treated as having no content—
not even through pseudo elements such as ::before, ::after, or ::marker. Replaced elements must be treated as having a natural width and height of 0 and no natural aspect ratio.
Note: Size containment only suppresses the natural aspect ratio, so properties like aspect-ratio which affect that preferred aspect ratio directly are honored.
All CSS properties of the size containment box are taken into account as they would be when performing layout normally. Other specifications may make specific exemptions.
Note: Even when the element’s sizing properties specify an intrinsic size, this does not necessarily make the element zero-sized: properties set on the element itself continue to be taken into account, which can cause it to be larger.
- Laying out in-place
- The containment box's content (including any pseudo-elements) must then be laid out into the now fixed-size containment box normally.
Note: Size containment does not suppress baseline alignment. See layout containment for that.
This change has tests
All statements in this more detailed write-up have tests in WPT. The results of these tests can be seen at the Web-Platform-Tests dashboard:- contain-size-013.html
- contain-size-021.html
- contain-size-023.html
- contain-size-025.html
- contain-size-027.html
- contain-size-041.html
- contain-size-042.html
- contain-size-061.html
- contain-size-062.html
- contain-size-063.html
- contain-size-064.html
- contain-size-borders.html
- contain-size-button-001.html
- contain-size-fieldset-001.html
- contain-size-fieldset-002.html
- contain-size-flexbox-001.html
- contain-size-flexbox-002.html
- contain-size-grid-001.html
- contain-size-grid-002.html
- contain-size-grid-003.html
- contain-size-multicol-001.html
- contain-size-multicol-as-flex-item.html
- contain-size-replaced-001.html
- contain-size-replaced-002.html
- contain-size-replaced-003a.html
- contain-size-replaced-003b.html
- contain-size-replaced-003c.html
- contain-size-replaced-004.html
- contain-size-replaced-005.html
- contain-size-replaced-006.html
- contain-size-scrollbars-001.html
- contain-size-scrollbars-002.html
- contain-size-scrollbars-003.html
- contain-size-scrollbars-004.html
- contain-size-select-001.html
- contain-size-select-002.html
- replaced-element-023.html
- replaced-element-025.html
- replaced-element-027.html
- contain-size-block-001.html
- contain-size-block-002.html
- contain-size-block-003.html
- contain-size-block-004.html
- contain-size-button-002.html
- contain-size-fieldset-003.html
- contain-size-flex-001.html
- contain-size-grid-005.html
- contain-size-inline-block-001.html
- contain-size-inline-block-002.html
- contain-size-inline-block-003.html
- contain-size-inline-block-004.html
- contain-size-inline-flex-001.html
- contain-size-multicol-002.html
- contain-size-multicol-003.html
- contain-size-select-elem-001.html
- contain-size-select-elem-002.html
- contain-size-select-elem-003.html
- contain-size-select-elem-004.html
- contain-size-select-elem-005.html
- contain-size-fieldset-004.html
- contain-size-inline-block-001.html
- contain-size-inline-block-002.html
- contain-size-inline-block-003.html
- contain-size-inline-block-004.html
- contain-size-inline-flex-001.html
Also, note the insertion of a parenthetical at the very end of § 3.1.1 Possible Size-Containment Optimizations, referencing part of this clarified text.
-
The intrinsic sizes of the size containment box are determined as if the element had no content,
following the same logic as when sizing as if empty.
- Size containment boxes are monolithic (See CSS Fragmentation 3 § 4.1 Possible Break Points).
img
{ width : 100 px ; aspect-ratio : 1 /1 ; contain : size; }
< img src = "https://www.example.com/300x100.jpg" >
If the aspect-ratio property had not been declared, the image would have been 100px by 0px, as its natural aspect ratio is suppressed, and its natural height is treated as 0.
However, giving an element size containment has no effect if any of the following are true:
-
if the element does not generate a principal box (as is the case with display: contents or display: none)
-
if its inner display type is table
-
if its principal box is an internal table box
-
if its principal box is an internal ruby box or a non-atomic inline-level box
Note: Internal table boxes, which do not include table captions, are excluded, because the table layout algorithm does not allow boxes to become smaller than their inflow content. Sizing a table cell as if it was empty and then laying out its content inside without changing the size is effectively an undefined operation. Manually setting the width or height properties to 0 cannot make it smaller than its content. This concern does not apply to table captions, which are perfectly capable of having a fixed size that is independent of their content.
3.1.1. Possible Size-Containment Optimizations
This section is non-normative.
By itself, size containment does not offer much optimization opportunity. Its primary benefit on its own is that tools which want to lay out the containment box's contents based on the containment box's size (such as a JS library implementing the "container query" concept) can do so without fear of "infinite loops", where having a child’s size respond to the size of the containment box causes the containment box's size to change as well, possibly triggering further changes in how the child sizes itself and possibly thus more changes to the containment box's size, ad infinitum.
When paired with layout containment, though, possible optimizations that can be enabled include (but are not limited to):
-
When the style or contents of a descendant of the containment box is changed, calculating what part of the DOM tree is "dirtied" and might need to be re-laid out can stop at the containment box.
-
When laying out the page, if the containment box is off-screen or obscured, the layout of its contents (i.e. "laying out in-place") can be delayed or done at a lower priority.
3.2. Layout Containment
Giving an element layout containment makes its principal box a layout containment box and has the following effects:
-
The layout containment box establishes an independent formatting context.
-
If at least one fragmentation container of a fragmentation context has layout containment, or if at least one fragmentation container of a fragmentation context is a descendant of layout containment box and at least one subsequent fragmentation container of the same fragmentation context is not a descendant of that same element with layout containment, then the first layout containment box which is either a fragmentation container itself or is an ancestor of a fragmentation container must “trap” the remainder of the fragmented flow: fragmentation must not continue past the layout containment boundary, and the last fragmentation container within the first layout containment boundary is treated as if it is the last fragmentation container in its fragmentation context.
If subsequent fragmentation containers in the fragmentation context are only generated when more content remains in the fragmented flow, then they are not generated. If they would exist regardless, they remain part of the fragmentation context, but do not receive any content from the fragmented flow.
Note: At the time of writing, no stable specification is affected by this point. Only specifications that would enable some (but not all) fragmentation containers of a fragmentation context to be layout-contained (or descendants of a layout contained element) are concerned. This is not the case of [CSS-PAGE-3] nor of [CSS-MULTICOL-1]. This requirement is nonetheless included because several mechanisms that would make this a possibility have been considered (e.g.: [CSS-REGIONS-1], ::nth-fragment(), a hypothetical selector for individual columns of a multicol…), and the guarantees that layout containment is intended to offer would not be realized if such mechanisms did not abide by this rule. [CSS-REGIONS-1] has details over how layout containment affects regions.
< article > Lorem ipsum…</ article > < div id = a ></ div > < aside > < div id = b ></ div > < div id = c ></ div > </ aside > < aside > < div id = d ></ div > < div id = e ></ div > </ aside > < div id = f ></ div > article
{ flow-into : foo;} #a, #b, #c, #d, #e, #f{ flow-from : foo;} aside{ contain : layout} In this [CSS-REGIONS-1] example, content can flow from
#a
to#b
, from#b
to#c
. However as#c
is the last fragment container in the first layout containment box it traps all the remaining content, and nothing gets flowed into#d
,#e
, or#f
. -
If the computed value of the overflow property is either visible or clip or a combination thereof, any overflow must be treated as ink overflow.
-
The layout containment box establishes an absolute positioning containing block and a fixed positioning containing block.
-
The layout containment box creates a stacking context.
-
Forced breaks are allowed within layout containment boxes but do not propagate to the parent as otherwise described in CSS Fragmentation 3 § 3.1 Breaks Between Boxes: the break-before and break-after properties.
Note: This introduces the previously non-existent possibility that forced breaks may occur between a box and its container (See CSS Fragmentation 3 § 4.1 Possible Break Points).
-
For the purpose of the vertical-align property, or any other property whose effects need to relate the position of the layout containment box's baseline to something other than its descendants, the containment box is treated as having no baseline.
However, giving an element layout containment has no effect if any of the following are true:
-
if the element does not generate a principal box (as is the case with display: contents or display: none)
-
if its principal box is an internal table box other than table-cell
-
if its principal box is an internal ruby box or a non-atomic inline-level box
3.2.1. Possible Layout-Containment Optimizations
This section is non-normative.
Possible optimizations that can be enabled by layout containment include (but are not limited to):
-
When laying out the page, the contents of separate containment boxes can be laid out in parallel, as they’re guaranteed not to affect each other.
-
When laying out the page, if the containment box is off-screen or obscured and the layout of the visible parts of the screen do not depend on the size of the containment box (for example, if the containment box is near the end of a block container, and you’re viewing the beginning of the block container), the layout of the containment box' contents can be delayed or done at a lower priority.
(When paired with size containment, this optimization can be applied more liberally.)
3.3. Paint Containment
Giving an element paint containment makes its principal box a paint containment box and has the following effects:
-
The contents of the element including any ink or scrollable overflow must be clipped to the padding edge of the paint containment box, taking corner clipping into account. This does not include the creation of any mechanism to access or indicate the presence of the clipped content; nor does it inhibit the creation of any such mechanism through other properties, such as overflow, resize, or text-overflow.
Note: The next level of this specification [CSS-CONTAIN-2] refines this effect to apply to the overflow clip edge rather than the padding edge, in order to take the new overflow-clip-margin property into account. For implementations that do not support overflow-clip-margin, the effect is identical.
Note: The behavior is described in this paragraph is equivalent to changing overflow-x: visible into overflow-x: clip and overflow-y: visible into overflow-y: clip at used value time, while leaving other values of overflow-x and overflow-y unchanged.
-
The paint containment box establishes an absolute positioning containing block and a fixed positioning containing block.
-
The paint containment box creates a stacking context.
-
The paint containment box establishes an independent formatting context.
However, giving an element paint containment has no effect if any of the following are true:
-
if the element does not generate a principal box (as is the case with display: contents or display: none)
-
if its principal box is an internal table box other than table-cell
-
if its principal box is an internal ruby box or a non-atomic inline-level box
3.3.1. Possible Paint-Containment Optimizations
This section is non-normative.
Possible optimizations that can be enabled by paint containment include (but are not limited to):
-
If the containment box is off-screen or obscured, the UA can usually skip trying to paint its contents, as they’re guaranteed to be off-screen/obscured as well.
Note: Some paint effects such as the blur() filter from [FILTER-EFFECTS-1] have non local effects. The user agent needs to keep track of these, as it may need to repaint parts of an element with such a filter when its descendents change, even if they have paint containment and could otherwise be skipped.
-
Unless the clipped content is made accessible via a separate mechanism such as the overflow, resize, or text-overflow properties, the UA can reserve "canvas" space for the box exactly the box’s size. (In similar, scrollable, situations, like overflow: hidden, it’s possible to scroll to the currently-clipped content, so UAs often predictively overpaint somewhat so there’s something to see as soon as the scroll happens, rather than a frame later.)
-
Because they are guaranteed to be stacking contexts, scrolling elements can be painted into a single GPU layer.
4. Privacy Considerations
There are no known privacy impacts of the features in this specification.
5. Security Considerations
There are no known security impacts of the features in this specification.
Like any other CSS specification, it affects the rendering of the document, but does not introduce any special ability to present content in a misleading way that was not previously available through other CSS modules and that isn’t inherent to the act of formatting the document.
Appendix A. Changes
This appendix is informative.
Changes from the Recommendation of 22 December 2020
A full Disposition of Comments is available.
- Candidate Correction 1 is now marked as Proposed Correction 1.
- Candidate Correction 2 is now marked as Proposed Correction 2.
- Marked as Proposed Correction 3:
Define the effects of containment on outwards propagation of properties
from the HTML
body
element. -
Editorial tweaks:
- Note that paint effects with non-local effects can limit certain optimization opportunities.
- Add subsection headings for the possible optimisations
- List cases where various types of containment do not apply at the end rather than the start of of each section, to start with the general behavior and go into exceptions later.
Changes from the Recommendation of 21 November 2019
A full Disposition of Comments is available.
- Marked as Candidate Correction 1: Changed how the computed values of the contain property are determined for the shortcut values.
- Marked as Candidate Correction 2: Rewrote much of the § 3.1 Size Containment section in more detail to clarify ambiguities about how it is meant to work, and improve the general legibility. The intended behavior is unaltered.
-
Editorial tweaks:
- Added an example and clarified a note in the § 3.1 Size Containment section
- phrasing improvement in § 3.3 Paint Containment to use established terminology rather than ad-hoc wording with the same intended meaning
- phrasing improvement in note in § 3.3 Paint Containment
- terminology change: replace "containing box" with "containment box"
Changes from the Candidate Recommendation of 30 April 2019
Full Dispositions of Comments since CR and since PR is available.
- Editorial tweaks
- Drop the at-risk “style containment” feature from this specification, move it Level 2
Changes from the Candidate Recommendation of 08 November 2018
A full Disposition of Comments is available.
-
Exclude style containment from contain: strict and contain: content, and mark it at risk.
Changes from the Candidate Recommendation of 24 May 2018
A full Disposition of Comments is available.
-
Clarify that layout containment causes overflow to be treated as ink overflow only when visible (or clip)
-
Layout containment suppresses baseline alignment, but size containment does not
-
Layout containment causes the element to establish a new stacking context
-
Size containment does not apply to tables
-
Clarify that the columns and grid properties affect the size of size-contained elements
-
Change the animation type of the contain property from discrete to not animatable
-
Define the effect of containment on SVG elements
-
Editorial improvements
-
A comprehensive test suite for the full specification was developed, see http://test.csswg.org/harness/review/css-contain-1_dev
Changes from the Candidate Recommendation of 8 August 2017
A full Disposition of Comments is available.
- Clarify to which box paint containment clips (see tests).
- Move the interaction between containment and the
bookmark-*
andstring-set
properties to [CSS-CONTENT-3] (additional tests not needed, no change in behavior). - Remove the effects of style containment on the "break-*" properties (see tests).
- Move the description of the effects of containment on regions from this specification to [CSS-REGIONS-1] (additional tests not needed, no change in behavior).
- Clarify the effects of style scoping on counter-set and counter-increment (see tests)
- Size layout and paint containment don’t apply to internal ruby elements (see tests)
- Layout, Paint, and size containments do not apply to non-atomic inlines (see tests here and one more test here)
- Align paint containment’s behavior with overflow:clip (see test)
- Elements with size containment are monolithic (see test)
- Forced breaks area allowed in elements with layout containments, but do not propagate (see tests)
- Clarify the effects of scoping to a subtree (see test)
- Clarify the effects of scoping on open/close quotes (see tests)
- Editorial clarification: replace "Becoming a formatting context" (aka "Becoming a formatting context root") with "Establish a FC" (additional tests not needed, no change in behavior)
Changes from the Working Draft of 19 April 2017
A Disposition of Comments covering this draft and the previous one together is available.
- Clarify the interaction with display: contents
- Clarify how containment works on table parts
- Move the interaction between containment and fragmentation of overflow from this specification to CSS-OVERFLOW-4
Changes from the First Public Working Draft of 21 February 2017
- Specify handling of replaced elements for size containment
- Layout containment makes element act as a containing block for absolutely positioned and fixed positioned descendants.