Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

inverted-colors

Get a user's contrast preference using CSS @media inverted-colors

readme

🌑 Inverted colors

Travis CI Coverage Status GitHub Vulnerabilities NPM type definitions NPM Minzipped size

NPM

Inverted colors is a package that tells you whether a user prefers inverted colors. It's based on the CSS @media (inverted-colors), 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 inverted-colors

Import the package:

import invertedColors from "inverted-colors";

Then call the function:

const colorPreference = invertedColors();
// Returns "none" or "inverted"

💡 Browser support

This package only works in browsers that natively support @media (inverted-colors), so it just returns "none" in unsupported browsers. Current browser support

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

const colorPreference = invertedColors(false);
// Returns "inverted", "none", or "unsupported"

🛠️ Development

Install dependencies:

yarn

Compile Typescript to ES6 before publishing to NPM:

yarn build

📀 Media Queries Level 5

📝 License

MIT