Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/anandchowdhary/prefers-contrast

🕶️ Check a user's preference using CSS @media(prefers-contrast)
https://github.com/anandchowdhary/prefers-contrast

css media-queries prefers-contrast typescript

Last synced: 3 months ago
JSON representation

🕶️ Check a user's preference using CSS @media(prefers-contrast)

Host: GitHub
URL: https://github.com/anandchowdhary/prefers-contrast
Owner: AnandChowdhary
License: mit
Created: 2019-05-24T13:44:08.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-06-18T01:59:29.000Z (7 months ago)
Last Synced: 2024-10-03T18:22:32.224Z (4 months ago)
Topics: css, media-queries, prefers-contrast, typescript
Language: TypeScript
Homepage: https://anandchowdhary.github.io/prefers-contrast/
Size: 140 KB
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # 🕶️ Prefers contrast

[![Travis CI](https://img.shields.io/travis/AnandChowdhary/prefers-contrast.svg)](https://travis-ci.org/AnandChowdhary/prefers-contrast)

[![Coverage Status](https://coveralls.io/repos/github/AnandChowdhary/prefers-contrast/badge.svg?branch=master)](https://coveralls.io/github/AnandChowdhary/prefers-contrast?branch=master)

[![GitHub](https://img.shields.io/github/license/anandchowdhary/prefers-contrast.svg)](https://github.com/AnandChowdhary/prefers-contrast/blob/master/LICENSE)

![Vulnerabilities](https://img.shields.io/snyk/vulnerabilities/github/AnandChowdhary/prefers-contrast.svg)

![NPM type definitions](https://img.shields.io/npm/types/prefers-contrast.svg)

[![NPM](https://img.shields.io/npm/v/prefers-contrast.svg)](https://www.npmjs.com/package/prefers-contrast)

[![Minzipped size](https://img.shields.io/bundlephobia/minzip/prefers-contrast.svg)](https://www.npmjs.com/package/prefers-contrast)

[![NPM](https://nodei.co/npm/prefers-contrast.png)](https://www.npmjs.com/package/prefers-contrast)

Prefers contrast is a package that tells you whether a user prefers increased contrast. It's based on the CSS `@media (prefers-contrast)`, which is part of [Media Queries Level 5](https://drafts.csswg.org/mediaqueries-5/). It's around 700 bytes minified, 300 bytes gzipped.

## ⭐ Usage

Add the dependency from NPM:

```bash

npm install prefers-contrast

```

Import the package:

```js

import prefersContrast from "prefers-contrast";

```

Then call the function:

```js

const contrastPreference = prefersContrast();

// Returns "high", "low" or "no-preference"

```

## 💡 Browser support

This package only works in browsers that natively support `@media (prefers-contrast)`, so it just returns `"no-preference"` in unsupported browsers. [Current browser support](https://caniuse.com/#feat=prefers-contrast)

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

```js

const contrastPreference = prefersContrast(false);

// Returns "high", "low", "no-preference", or "unsupported"

```

## 🛠️ Development

Install dependencies:

```bash

yarn

```

Compile Typescript to ES6 before publishing to NPM:

```bash

yarn build

```

## 📀 Media Queries Level 5

- 🙅 `prefers-reduced-motion` · [GitHub](https://github.com/AnandChowdhary/prefers-reduced-motion) · [NPM](https://www.npmjs.com/package/prefers-reduced-motion)

- 🎨 `prefers-color-scheme` · [GitHub](https://github.com/AnandChowdhary/prefers-color-scheme) · [NPM](https://www.npmjs.com/package/prefers-color-scheme)

- 🕶️ `prefers-contrast` · [GitHub](https://github.com/AnandChowdhary/prefers-contrast) · [NPM](https://www.npmjs.com/package/prefers-contrast)

- 🎞️ `prefers-reduced-transparency` · [GitHub](https://github.com/AnandChowdhary/prefers-reduced-transparency) · [NPM](https://www.npmjs.com/package/prefers-reduced-transparency)

- 🌑 `inverted-colors` · [GitHub](https://github.com/AnandChowdhary/inverted-colors) · [NPM](https://www.npmjs.com/package/inverted-colors)

- 🧖 `environment-blending` · [GitHub](https://github.com/AnandChowdhary/environment-blending) · [NPM](https://www.npmjs.com/package/environment-blending)

- 💡 `light-level` · [GitHub](https://github.com/AnandChowdhary/light-level) · [NPM](https://www.npmjs.com/package/light-level-css)

## 📝 License

MIT