@csstools/postcss-logical-overscroll-behavior
TypeScript icon, indicating that this package has built-in type declarations

2.0.0 • Public • Published

PostCSS Logical Overscroll Behavior PostCSS Logo

npm install @csstools/postcss-logical-overscroll-behavior --save-dev

PostCSS Logical Overscroll Behavior lets you use overscroll-behavior-inline and overscroll-behavior-block properties following the CSS Overscroll Specification.

.inline {
	overscroll-behavior-inline: auto;
}

.block {
	overscroll-behavior-block: contain;
}

/* becomes */

.inline {
	overscroll-behavior-x: auto;
}

.block {
	overscroll-behavior-y: contain;
}

Usage

Add PostCSS Logical Overscroll Behavior to your project:

npm install postcss @csstools/postcss-logical-overscroll-behavior --save-dev

Use it as a PostCSS plugin:

const postcss = require('postcss');
const postcssLogicalOverscrollBehavior = require('@csstools/postcss-logical-overscroll-behavior');

postcss([
	postcssLogicalOverscrollBehavior(/* pluginOptions */)
]).process(YOUR_CSS /*, processOptions */);

Options

inlineDirection

The inlineDirection option allows you to specify the direction of the inline axe. The default value is left-to-right, which would match any latin language.

You should tweak this value so that it is specific to your language and writing mode.

postcssLogicalOverscrollBehavior({
	inlineDirection: 'top-to-bottom'
})
.inline {
	overscroll-behavior-inline: auto;
}

.block {
	overscroll-behavior-block: contain;
}

/* becomes */

.inline {
	overscroll-behavior-y: auto;
}

.block {
	overscroll-behavior-x: contain;
}

Each direction must be one of the following:

  • top-to-bottom
  • bottom-to-top
  • left-to-right
  • right-to-left

Versions

Current Tags

  • Version
    Downloads (Last 7 Days)
    • Tag
  • 2.0.0
    175,395
    • latest

Version History

  • Version
    Downloads (Last 7 Days)
    • Published
  • 2.0.0
    175,395
  • 1.0.1
    495,174
  • 1.0.0
    59,569

Package Sidebar

Install

npm i @csstools/postcss-logical-overscroll-behavior

Weekly Downloads

730,138

Version

2.0.0

License

MIT-0

Unpacked Size

7.45 kB

Total Files

7

Last publish

Collaborators

  • romainmenke
  • alaguna
  • jonathantneal