<pre class=metadata>
Title: CSS Scroll Anchoring Module Level 1
Shortname: css-scroll-anchoring
Level: 1
Group: csswg
Status: ED
Work Status: Revising
ED: https://drafts.csswg.org/css-scroll-anchoring/
TR: https://www.w3.org/TR/css-scroll-anchoring-1/
Previous Version: https://www.w3.org/TR/2020/WD-css-scroll-anchoring-1-20200211/
Editor: Steve Kobes, Google
Editor: Tab Atkins-Bittner, Google, http://xanthir.com/contact/, w3cid 42199
Abstract: Changes in DOM elements above the visible region of a <a>scrolling box</a> can result in the page moving
Abstract: while the user is in the middle of consuming the content.
Abstract:
Abstract: This spec proposes a mechanism to mitigate this jarring user experience
Abstract: by keeping track of the position of an anchor node and adjusting the scroll offset accordingly.
Abstract:
Abstract: This spec also proposes an API for web developers to opt-out of this behavior.
</pre>

<pre class=link-defaults>
spec:css-box; type:dfn; text:content area
spec:cssom-view-1; type:dfn; text:scrolling area
spec:css2;
	type:dfn; text:line box
spec:css-sizing-3;
	type:property;
		text:max-height
		text:min-height
		text:height
		text:max-width
		text:min-width
		text:width
</pre>
<pre class="anchors">
spec: html; urlPrefix: https://html.spec.whatwg.org/multipage/;
	urlPrefix: interaction.html
		type: dfn;
			text:DOM anchor
			text:focused area of the document
			text:active match; url: fip-active-match
	urlPrefix: form-control-infrastructure.html
		type: dfn;
			text:mutable; url: concept-fe-mutable
spec: html; urlPrefix: https://w3c.github.io/editing/docs/execCommand/;
	urlPrefix: index.html
		type: dfn;
			text:editable
</pre>

<h2 id=intro>
Introduction</h2>

Today, users of the web are often distracted by content moving around
due to changes that occur outside the viewport.
Examples include script inserting an iframe containing an ad,
or non-sized images loading on a slow network.

Historically the browser's default behavior has been
to preserve the absolute scroll position when such changes occur.
This means that to avoid shifting content,
the webpage can attempt to reserve space on the page
for anything that will load later.
In practice, few websites do this consistently.

Scroll anchoring aims to minimize surprising content shifts.
It does this by adjusting the scroll position
to compensate for the changes outside the viewport.

The <a href="https://github.com/WICG/ScrollAnchoring/blob/master/explainer.md">explainer document</a>
gives an informal overview of scroll anchoring.

<h3 id="values">
Value Definitions</h3>

This specification follows the <a href="https://www.w3.org/TR/CSS2/about.html#property-defs">CSS property definition conventions</a> from [[!CSS2]]
using the <a href="https://www.w3.org/TR/css-values-3/#value-defs">value definition syntax</a> from [[!CSS-VALUES-3]].
Value types not defined in this specification are defined in CSS Values &amp; 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 <a>CSS-wide keywords</a> as their property value.
For readability they have not been repeated explicitly.

<h2 id='description'>
Description</h2>

Scroll anchoring attempts to keep the user's view of the document stable across layout changes.
It works by selecting a DOM node (the <dfn export for=scroll-anchoring>anchor node</dfn>)
whose movement is used to determine adjustments to the scroll position.

However, if the scroll container is currently [=scroll snap|snapped=] to an element,
(see [[!CSS-SCROLL-SNAP-1]])
scroll anchoring is limited to adjustments that would be allowed by [=re-snapping=].


<h3 id='anchor-node-selection'>
Anchor Node Selection</h3>

Each <a>scrolling box</a> aims to select an <a>anchor node</a>
that is deep in the DOM
and either should be prioritized as an important DOM node or is close to the
block start edge of its <a>optimal viewing region</a>.

Note: If the user agent does not support the 'scroll-padding' property,
the optimal viewing region of the scrolling box is equivalent to its <a>content area</a>.

An anchor node can be any <a>box</a> except one for a non-<a>atomic inline</a>.
The anchor node is always a <a>descendant</a> of the <a>scrolling box</a>.
In some cases, a scrolling box may not select any anchor node.

An element |C| is a <dfn id="anchor-viable-candidate">viable candidate</dfn>
for becoming a scroll anchor for a scrolling box |S| if it meets all of the
following criteria:

* |C| is an element that is not a non-<a>atomic inline</a>.
* |C| is <a>partially visible</a> or <a>fully visible</a> in |S|
* |C| is a descendant of |S|
* |C| is not in an <a>excluded subtree</a>
* None of the ancestors of |C| up to |S| are in an <a>excluded subtree</a>

Some elements are considered to be 
<dfn id="anchor-priority-candidates" export lt="anchor priority candidate" local-lt="priority candidate">anchor priority candidates</dfn> 
for anchor selection:

1. The [=DOM anchor=] of the [=focused area of the document=], if such an anchor
	is text editable ([=editable=], [=editing host=], [=mutable=] <{textarea}>, or
	[=mutable=] <{input}> with a type that allows text entry).
2. An element containing the current [=active match=] of the
	find-in-page user-agent algorithm. If the match spans multiple elements, then
	consider only the first such element.

Note that if the <a>priority candidate</a> is a non-<a>atomic inline</a>
element, then instead consider its nearest ancestor element that is not a
non-atomic inline element as the priority candidate.

<div algorithm>
	The <dfn id="anchoring-algorithm">anchor node selection algorithm</dfn>
	for a scrolling box |S| is as follows:

	1. If |S| is generated by an element
		whose computed value of the 'overflow-anchor' property is ''overflow-anchor/none'',
		then do not select an anchor node for |S|.
	2. If |S| is not scrolled away from the origin of its <a>scrolling area</a> in its
		<a>block flow direction</a>, then do not select an anchor node for |S|.
	3. Otherwise, for each <a>priority candidate</a> |PC| in order specified,
		check if |PC| is a <a>viable candidate</a> in |S|.
		If so, perform the <a>candidate examination algorithm</a> for |PC| in |S| and terminate.

		Note: Since the priority candidate itself is checked to be viable, the <a>candidate examination algorithm</a>
		is guaranteed to select at least the candidate node itself.

	4. Otherwise, for each DOM child |N| of the element or document associated with |S|,
		perform the <a>candidate examination algorithm</a> for |N| in |S|,
		and terminate if it selects an anchor node.

</div>

<div algorithm>
	The <dfn id="candidate-examination">candidate examination algorithm</dfn>
	for a candidate DOM node |N| in a scrolling box |S| is as follows:

	1. If |N| is an <a>excluded subtree</a>,
		or if |N| is <a>fully clipped</a> in |S|,
		then do nothing (|N| and its descendants are skipped).
	2. If |N| is <a>fully visible</a> in |S|,
		select |N| as the anchor node.
	3. If N is <a>partially visible</a>:
		1. For each DOM child |C| of |N|,
			perform the <a>candidate examination algorithm</a> for |C| in |S|,
			and terminate if it selects an anchor node.
		2. For each absolutely-positioned element |A|
			whose <a>containing block</a> is |N|,
			but whose DOM parent is not |N|,
			perform the <a>candidate examination algorithm</a> for |A| in |S|,
			and terminate if it selects an anchor node.
		3. Select |N| as the anchor node.
			(If this step is reached,
			no suitable anchor node was found among |N|’s descendants.)

		Note: Deeper nodes are preferred to minimize the possibility of content changing
		inside the anchor node but outside the viewport, which would cause visible
		content to shift without triggering any scroll anchoring adjustment.
</div>

<div algorithm>
	A DOM node |N| is an <dfn>excluded subtree</dfn>
	if it is an element and any of the following conditions holds:

	* |N|’s computed value of the 'display' property is ''display/none''.
	* |N|’s computed value of the 'position' property is ''position/fixed''.
	* |N|’s computed value of the 'position' property is ''position/sticky''.
	* |N|’s computed value of the 'position' property is ''position/absolute''
		and |N|’s <a>containing block</a> is an ancestor of the scrolling box.
	* |N|’s computed value of the 'overflow-anchor' property is ''overflow-anchor/none''.
</div>

<div algorithm>
	A DOM node |N| is <dfn>fully visible</dfn> in a scrolling box |S|
	if |N|’s <a>scroll anchoring bounding rect</a> is entirely within the <a>optimal viewing region</a> of |S|.
</div>

<div algorithm>
	A DOM node |N| is <dfn>fully clipped</dfn> in a scrolling box |S|
	if |N|’s <a>scroll anchoring bounding rect</a> is entirely outside the <a>optimal viewing region</a> of |S|.
</div>

<div algorithm>
	A DOM node |N| is <dfn>partially visible</dfn> in a scrolling box |S|
	if |N| is neither <a>fully visible</a> in |S| nor <a>fully clipped</a> in |S|.
</div>

<div algorithm>
	The <dfn>scroll anchoring bounding rect</dfn> of a DOM node |N|
	is |N|’s <a>scrollable overflow rectangle</a>.
</div>

<h4 id='anchor-node-invalidation'>
Invalidation</h3>

An anchor node is considered valid for a <a>scrolling box</a> until any of the following occur:
	* The scroll position of the <a>scrolling box</a> changes (excluding adjustments originating from scroll anchoring).
	* A <a>suppression trigger</a> suppresses a scroll adjustment.
	* The <a>anchor node</a> is removed from the DOM.

Once an anchor node has become invalid, the <a>anchor node selection algorithm</a> must be run again to compute the anchor node

As a performance optimization, implementations may wait until the <a>anchor node</a> is needed before computing it.

<h3 id="scroll-adjustment">
Scroll Adjustment</h3>

If an anchor node was selected,
then when the anchor node moves,
the browser computes the previous offset <code>y0</code>, and the current offset <code>y1</code>,
of the block start edge of the anchor node's <a>scroll anchoring bounding rect</a>,
relative to the block start edge of the scrolling content in the <a>block flow direction</a> of the scroller.

It then queues an adjustment to the scroll position of <code>y1 - y0</code>,
in the block flow direction,
to be performed at the end of the <a>suppression window</a>.

The scroll adjustment is a type of [[cssom-view-1#scrolling-events|scrolling]] as defined by [[!CSSOM-VIEW]],
and generates <a event lt=scroll>scroll events</a> in the manner described there.

<h4 id="suppression-windows">
Suppression Window</h4>

Every movement of an anchor node occurs within a window of time
called the <dfn>suppression window</dfn>,
defined as follows:

* The suppression window begins at the start of the current iteration of the
	<a href="https://html.spec.whatwg.org/multipage/webappapis.html#processing-model-8">HTML Processing Model</a> event loop,
	or at the end of the most recently completed suppression window,
	whichever is more recent.
* The suppression window ends at the end of the current iteration of the
	<a href="https://html.spec.whatwg.org/multipage/webappapis.html#processing-model-8">HTML Processing Model</a> event loop,
	or immediately before the next operation whose result or side effects
	would differ as a result of a change in the scroll position
	(for example, an invocation of {{Element/getBoundingClientRect()}}),
	whichever comes sooner.

Note: The suppression window boundaries should be incorporated into the HTML standard once the
scroll anchoring API is stabilized.

More than one anchor node movement may occur within the same suppression window.

At the end of a suppression window,
the user agent performs all scroll adjustments that were queued during the window
and not suppressed by any <a>suppression trigger</a> during the window.

<h4 id="suppression-triggers">
Suppression Triggers</h4>

A <dfn>suppression trigger</dfn> is an operation
that suppresses the scroll anchoring adjustment for an anchor node movement,
if it occurs within the suppression window for that movement.
These triggers are:

* Any change to the computed value of any of the following properties,
	on any element in the path from the anchor node to the scrollable element (or document),
	inclusive of both:

	* 'top', 'left', 'right', or 'bottom'
	* 'margin' or its longhands
	* 'padding' or its longhands
	* 'width', 'height', 'min-width', 'max-width', 'min-height', or 'max-height'
	* 'position'
	* 'transform'

* Any change to the computed value of the 'position' property
	on any element within the scrollable element (or document),
	such that the element becomes or stops being absolutely positioned.
	Note that this trigger applies regardless of whether the modified element is
	on the path from the anchor node to the scrollable element.

* The scroll offset of the scrollable element being zero.

Note: Suppression triggers exist for compatibility with existing web content that has negative
interactions with scroll anchoring due to shifting content in scroll event handlers.

<h2 id="exclusion-api">
Exclusion API</h2>

Scroll anchoring aims to be the default mode of behavior when launched,
so that users benefit from it even on legacy content.
'overflow-anchor' can disable scroll anchoring in part or all of a webpage (opt out),
or exclude portions of the DOM from the anchor node selection algorithm.

<pre class=propdef>
Name: overflow-anchor
Value: auto | none
Initial: auto
Inherited: no
Computed value: specified keyword
Animation type: discrete
</pre>

Values are defined as follows:

<dl dfn-type=value dfn-for=overflow-anchor>
	: <dfn>auto</dfn>
	::
		Declares that the element
		is potentially eligible to participate in the <a>anchor node selection algorithm</a>
		for any scrolling box created by the element or an ancestor.

	: <dfn>none</dfn>
	::
		Declares that the element and its descendants
		(that aren't nested inside of another scrolling element)
		are <em>not</em> eligible to participate in the <a>anchor node selection algorithm</a>
		for any scrolling box created by the element or an ancestor.
</dl>

Note: It is not possible to turn scroll anchoring "back on"
for descendants of a ''overflow-anchor: none'' element.
However, descendant <a>scroll containers</a> automatically "turn it back on"
(for their own scrolling box)
unless they explicitly have ''overflow-anchor: none'' set on them as well.

Note: The <code>overflow-anchor</code> property was also proposed (with different values)
for <a href="http://tabatkins.github.io/specs/css-sticky-scrollbars/">CSS Sticky Scrollbars</a>,
which has now been <a href="https://tabatkins.github.io/specs/css-sticky-scrollbars/#intro">superseded</a>.

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

This specification,
as it only adjusts how we compute scroll positions,
introduces no new privacy considerations.

<h2 class=no-num id=security>Security Considerations</h2>

This specification,
as it only adjusts how we compute scroll positions,
introduces no new security considerations.

<h2 id='changes' class="no-num">
Changes</h2>

<h3 id='changes-20200211'>
Changes Since the Feb 11 2020 Working Draft</h3>

	* Added definitions of [=viable candidate=] and [=priority candidate=].
	* Clarified interaction between scroll anchoring and [=scroll snapping=].
	* Added a step to run <a>candidate examination algorithm</a> on viable priority candidates.
