Title: CSS Overscroll Behavior Module Level 1
Shortname: css-overscroll
Level: 1
Status: ED
Work Status: Exploring
Group: CSSWG
URL: https://drafts.csswg.org/css-overscroll-1/
TR: https://www.w3.org/TR/css-overscroll-1/
Editor: Benoit Girard, Facebook, bgirard@fb.com
Editor: Majid Valipour, Google, majidvp@google.com, w3cid 81464

Abstract: This module defines 'overscroll-behavior' to control the behavior when the scroll position
Abstract: of a scroll container reaches the edge of the scrollport.
Abstract: This allows content authors to hint that the boundary default actions,
Abstract: such as scroll chaining and overscroll, should not be triggered.

urlPrefix: https://www.w3.org/TR/css-display-3/
    type: dfn; text: containing block chain
url: https://drafts.csswg.org/css-overflow-3/#scroll-container
    type: dfn; text: scroll container
    type: dfn; text: scroll containers
url: https://drafts.csswg.org/cssom-view/#viewport
    type: dfn; text: viewport
url: https://drafts.csswg.org/cssom-view/#dom-document-scrollingelement
    type: dfn; text: scrollingElement
url: https://www.w3.org/TR/uievents/#default-action
    type: dfn; text: default action
    type: dfn; text: default actions
url: https://dom.spec.whatwg.org/#dom-event-preventdefault
    type: dfn; text: preventDefault
url: https://dom.spec.whatwg.org/#dom-eventtarget-addeventlistener
    type: dfn; text: passive flag

Introduction {#intro} ===================== This section is not normative. A content author does not necessarily want scroll chaining to occur for all scroll containers. Some scroll containers may be part of a containing block chain but may serve a different logical purpose in the document and may want to prevent scrolling from continuing up the scroll chain. To achieve this, a content author will install event listeners without the passive flag set and will use preventDefault when there is a risk that scroll chaining will occur. This is detrimental for the following reasons: * The user agent may in the future introduce new input methods for scrolling that are not supported by the content author's event listeners. * A non passive event listener will delay scrolling because the user agent will have to wait for the result of the event listener to determine if preventDefault was called causing increased scroll latency. * When scrolling is performed near the edge of the scroll boundary, the default action may cause both scrolling to the edge of the scroll container and a boundary default action. Calling preventDefault will not only cancel the boundary default action but also the scroll to the edge of the scrollport. * The default action for the event may also provide additional behavior that the author does not want to cancel such as an overscroll affordance. preventDefault doesn't allow the content author to cancel only some of the default actions such as scroll chaining. Thus, it is not possible for a content author to control scroll chaining and overscroll in a robust, performant and forward compatible way. The 'overscroll-behavior' property fixes this shortcoming. Motivating Examples {#motivating-examples} ==========================================

A position fixed left navigation bar does not want to hand off scrolling to the document because a scroll gesture performed on the navigation bar is almost never meant to scroll the document. Note that using the native overscroll affordances are still desirable while scroll chaining is to be prevented.

  #sidebar {
    overscroll-behavior: contain;
  }

In this case, the author can use contain on the sidebar to prevent scrolling from being chained to the parent document element.

A page wants to implement their own pull-to-refresh effect and thus needs to disable browser native overscroll action.

  html {
    /* only disable pull-to-refresh but allow swipe navigations */
    overscroll-behavior-y: contain;
  }

In this case, the author can use contain on the viewport defining element to prevent overscroll from triggering navigation actions.

A infinite scrollers loads more content as user reaches the boundary and thus wants to disable the potentially confusing rubber banding effect in addition to scroll chaining.

  #infinite_scroller {
    overscroll-behavior-y: none;
  }

In this case the the author can use none on the infinite scroller to prevent both scroll chaining and overscroll affordance.

Scroll chaining and boundary default actions {#scroll-chaining-and-boundary-default-actions} ============================================================================================ Operating Systems have rules for scrolling such as scroll chaining and overscroll affordances. This specification does not mandate if and how scroll chaining or overscroll affordances be implemented. This specification only allows the content author to disable them if any are implemented. Scroll chaining is when scrolling is propagated from one scroll container to an ancestor scroll container following the scroll chain. Typically scroll chaining is performed starting at the event target recursing up the containing block chain. When a scroll container in this chain receives a scroll event or gesture it may act on it and/or pass it up the chain. Chaining typically occurs when the scrollport has reached its boundary. A scroll chain is the order in which scrolling is propagated from one scroll container to another. The viewport participates in scroll chaining as the document's scrollingElement, both regarding placement in the scroll chain as well as adhering to the chaining rules applied to it. Scroll boundary refers to when the scroll position of a scroll container reaches the edge of the scrollport. If a scroll container has no potential to scroll, because it does not overflow in the direction of the scroll, the element is always considered to be at the scroll boundary. Boundary default action refers to the user-agent-defined default action performed when scrolling against the edge of the scrollport. A local boundary default action is a boundary default action which is performed on the scroll container without interacting with the page, for example displaying a overscroll UI affordance. Conversely, a non-local boundary default action interacts with the page, for example scroll chaining or a navigation action. Overscroll Behavior Properties {#overscroll-behavior-properties} ================================================================ The overscroll behavior controls the permitted boundary default action for a scroll container element when its scrollport reaches the boundary of its scroll box. The 'overscroll-behavior' property specifies the overscroll behavior for a scroll container element. It allows the content author to specify that a scroll container element must prevent scroll chaining and/or overscroll affordances. An element that is not scroll container must accept but ignore the values of this property. This property must be applied to all scrolling methods supported by the user agent. Note: This property should provide guarantees that are, at least, as strong as preventDefault for preventing both scroll chaining and overscroll. Doing otherwise would cause content authors to use preventDefault instead.

Name: overscroll-behavior
Value: [ contain | none | auto ]{1,2}
Initial: auto auto
Applies to: scroll container elements
Inherited: no
Media: visual
Computed value: see individual properties
Animation type: discrete
Canonical order: per grammar

The 'overscroll-behavior' property is a shorthand property that sets the specified values of 'overscroll-behavior-x' and 'overscroll-behavior-y' in that order. If only one value is specified, the second value defaults to the same value. Values have the following meanings:

contain: This value indicates that the element must not perform non-local boundary default actions such as scroll chaining or navigation. The user agent must not perform scroll chaining to any ancestors along the scroll chain regardless of whether the scroll originated at this element or one of its descendants. This value must not modify the behavior of how local boundary default actions should behave, such as showing any overscroll affordances.
none: This value implies the same behavior as contain and in addition this element must also not perform local boundary default actions such as showing any overscroll affordances.
auto: This value indicates that the user agent should perform the usual boundary default action with respect to scroll chaining, overscroll and navigation gestures.

Note: In the case where a user agent does not implement scroll chaining and overscroll affordances, these values will have no side effects for a compliant implementation. Note: Programmatic scrolling is clamped and can not trigger any boundary default actions. Physical Longhands for 'overscroll-behavior' {#overscroll-behavior-longhands-physical} ---------------------------------------------------------------------------------------

Name: overscroll-behavior-x, overscroll-behavior-y
Value: contain | none | auto
Initial: auto
Applies to: scroll container elements
Inherited: no
Percentages: N/A
Media: visual
Computed value: as specified
Animation type: discrete
Canonical order: per grammar

The 'overscroll-behavior-x' property specifies the overscroll behavior in the horizontal axis and the 'overscroll-behavior-y' property specifies the overscroll behavior in the vertical axis. When scrolling is performed along both the horizontal and vertical axes at the same time, the overscroll behavior of each respective axis should be considered independently. Flow-relative Longhands for 'overscroll-behavior' {#overscroll-behavior-longhands-logical} -------------------------------------------------------------------------------------------

Name: overscroll-behavior-inline, overscroll-behavior-block
Value: contain | none | auto
Initial: auto
Applies to: scroll container elements
Inherited: no
Percentages: N/A
Media: visual
Computed value: as specified
Animation type: discrete
Canonical order: per grammar

These properties correspond to the 'overscroll-behavior-x' and 'overscroll-behavior-y' properties. The mapping depends on the element's 'writing-mode'. Security and Privacy Considerations {#security-and-privacy} =========================================================== There are no known security or privacy impacts of this feature. The feature may be used to prevent certain native UI features such as overscroll affordances and overscroll navigations (e.g., pull- to-refresh, swipe navigations). However, this does not expose any additional abilities beyond what is already possible in the platform e.g., by preventing the default action of the event that would cause a scroll.