prefers-reduced-motion v1.0.1

🙅 Prefers reduced motion

Prefers reduced motion is a package that tells you whether a user prefers reduced motion. It's based on the CSS @media (prefers-reduced-motion), which is part of Media Queries Level 5. It's around 700 bytes minified, 300 bytes gzipped.

⭐ Usage

Add the dependency from NPM:

npm install prefers-reduced-motion

Import the package:

import prefersReducedMotion from "prefers-reduced-motion";

Then call the function:

const motionPreference = prefersReducedMotion();
// Returns "reduce" or "no-preference"

💡 Browser support

This package only works in browsers that natively support @media (prefers-reduced-motion), so it just returns "no-preference" in unsupported browsers. Current browser support

By passing false as the argument, you can get "unsupported" as the value for unsupported browsers:

const motionPreference = prefersReducedMotion(false);
// Returns "reduce", "no-preference", or "unsupported"

🛠️ Development

Install dependencies:

yarn

Compile Typescript to ES6 before publishing to NPM:

yarn build

📀 Media Queries Level 5

• 🙅 prefers-reduced-motion · GitHub · NPM
• 🎨 prefers-color-scheme · GitHub · NPM
• 🕶️ prefers-contrast · GitHub · NPM
• 🎞️ prefers-reduced-transparency · GitHub · NPM
• 🌑 inverted-colors · GitHub · NPM
• 🧖 environment-blending · GitHub · NPM
• 💡 light-level · GitHub · NPM

📝 License

MIT