overscroll-behavior-x

The overscroll-behavior-x CSS property sets the browser's behavior when the horizontal boundary of a scrolling area is reached.

See overscroll-behavior for a full explanation.

/* Keyword values */
overscroll-behavior-x: auto; /* default */
overscroll-behavior-x: contain;
overscroll-behavior-x: none;

/* Global values */
overscroll-behavior-x: inherit;
overscroll-behavior-x: initial;
overscroll-behavior-x: unset;

Syntax

The overscroll-behavior-x property is specified as a keyword chosen from the list of values below.

Values

auto

The default scroll overflow behavior occurs as normal.

contain

Default scroll overflow behavior is observed inside the element this value is set on (e.g. "bounce" effects or refreshes), but no scroll chaining occurs to neighbouring scrolling areas, e.g. underlying elements will not scroll.

none

No scroll chaining occurs to neighbouring scrolling areas, and default scroll overflow behavior is prevented.

Formal definition

Formal syntax

contain | none | auto

Examples

Preventing an underlying element from scrolling horizontally

In our simple overscroll-behavior-x example (see source code also), we have two block-level boxes, one inside the other. The outer box has a large width set on it so the page will scroll horizontally. The inner box has a small width (and height) set on it so it sits comforably inside the viewport, but its content is given a large width so it will scroll horizontally.

By default, when the inner box is scrolled and a scroll boundary is reached, the whole page will begin to scroll, which is probably not what we want. To avoid this, you can set overscroll-behavior-x: contain on the inner box:

main > div {
  height: 300px;
  width: 500px;
  overflow: auto;
  position: relative;
  top: 100px;
  left: 100px;
  overscroll-behavior-x: contain;
}

Specifications

Browser compatibility

See also

• Take control of your scroll: customizing pull-to-refresh and overflow effects
• The mapped logical properties: overscroll-behavior-inline, overscroll-behavior-block