Layout

Overscroll Behavior

Utilities for controlling how the browser behaves when reaching the boundary of a scrolling area.

Quick reference

Class
Properties
overscroll-autooverscroll-behavior: auto;
overscroll-containoverscroll-behavior: contain;
overscroll-noneoverscroll-behavior: none;
overscroll-y-autooverscroll-behavior-y: auto;
overscroll-y-containoverscroll-behavior-y: contain;
overscroll-y-noneoverscroll-behavior-y: none;
overscroll-x-autooverscroll-behavior-x: auto;
overscroll-x-containoverscroll-behavior-x: contain;
overscroll-x-noneoverscroll-behavior-x: none;

Basic usage

Preventing parent overscrolling

Use overscroll-contain to prevent scrolling in the target area from triggering scrolling in the parent element, but preserve “bounce” effects when scrolling past the end of the container in operating systems that support it.

Overscroll Behavior - 图1

  1. <div class="overscroll-contain ...">Well, let me tell you something, ...</div>

Preventing overscroll bouncing

Use overscroll-none to prevent scrolling in the target area from triggering scrolling in the parent element, and also prevent “bounce” effects when scrolling past the end of the container.

Overscroll Behavior - 图2

  1. <div class="overscroll-none ...">Well, let me tell you something, ...</div>

Using the default overscroll behavior

Use overscroll-auto to make it possible for the user to continue scrolling a parent scroll area when they reach the boundary of the primary scroll area.

Overscroll Behavior - 图3

  1. <div class="overscroll-auto ...">Well, let me tell you something, ...</div>

Applying conditionally

Hover, focus, and other states

Tailwind lets you conditionally apply utility classes in different states using variant modifiers. For example, use hover:overscroll-contain to only apply the overscroll-contain utility on hover.

  1. <div class="overscroll-auto hover:overscroll-contain">
  2. <!-- ... -->
  3. </div>

For a complete list of all available state modifiers, check out the Hover, Focus, & Other States documentation.

Breakpoints and media queries

You can also use variant modifiers to target media queries like responsive breakpoints, dark mode, prefers-reduced-motion, and more. For example, use md:overscroll-contain to apply the overscroll-contain utility at only medium screen sizes and above.

  1. <div class="overscroll-auto md:overscroll-contain">
  2. <!-- ... -->
  3. </div>

To learn more, check out the documentation on Responsive Design, Dark Mode and other media query modifiers.