# postcss-help-media-queries

> lets you see some informations about the active breakpoint (media query), screen density and orientation directly inside the page

Latest version **1.0.0** (published 2020-08-31) · CC0-1.0 license · 0 weekly downloads

## Install

```sh
npm install postcss-help-media-queries
pnpm add postcss-help-media-queries
yarn add postcss-help-media-queries
bun add postcss-help-media-queries
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2020-08-31 |
| First published | 2020-08-29 |
| Weekly downloads | 0 |
| License | CC0-1.0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=8.0.0 |
| Dependencies | 1 |
| Unpacked size | 31.2 KB |
| Known vulnerabilities | 0 (+7 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 26 |
| Author | limitlessloop |
| Maintainers | limitlessloop |
| Keywords | postcss, css, postcss-plugin, media queries |

## Links

- npm: https://www.npmjs.com/package/postcss-help-media-queries
- Repository: https://github.com/limitlessloop/postcss-help-media-queries
- Homepage: https://github.com/limitlessloop/postcss-help-media-queries#readme
- Issues: https://github.com/limitlessloop/postcss-help-media-queries/issues
- npm.io page: https://npm.io/package/postcss-help-media-queries

## Dependencies (1)

- [postcss](https://npm.io/package/postcss.md) 7.0.21

## Alternatives

- [style-dictionary](https://npm.io/package/style-dictionary.md) — 2.0M weekly downloads
- [postcss-merge-idents](https://npm.io/package/postcss-merge-idents.md) — 1.7M weekly downloads
- [@fontsource/noto-sans](https://npm.io/package/@fontsource/noto-sans.md) — 93.0K weekly downloads
- [uglifycss](https://npm.io/package/uglifycss.md) — 71.6K weekly downloads
- [mat4-interpolate](https://npm.io/package/mat4-interpolate.md) — 23.3K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2020-08-31
- 1.0.0-alpha.2 — 2020-08-30
- 1.0.0-alpha.1 — 2020-08-29
- 1.0.0-alpha.0 — 2020-08-29

## README

# PostCSS Help Media Queries [<img src="https://postcss.github.io/postcss/logo.svg" alt="PostCSS" width="90" height="90" align="right">][postcss]

[![NPM Version][npm-img]][npm-url]
[![Build Status][cli-img]][cli-url]
[![Support Chat][git-img]][git-url]

[PostCSS Help Media Queries] lets you see information about the active breakpoint (media query), screen density and orientation displayed in a tooltip. All generated by CSS.

![postcss-help-media-queries](https://user-images.githubusercontent.com/10454741/91659106-ffdb9f80-eacd-11ea-8628-83676d837305.png)

Add the following at-rule at the top of your CSS to include the help-media-queries tooltip.

```pcss
@help-media-queries;
```

## Usage

Add [PostCSS Help Media Queries] to your project:

```bash
npm install postcss-help-media-queries --save-dev
```

Use **PostCSS Help Media Queries** to process your CSS:

```js
const postcssHelpMediaQueries = require('postcss-help-media-queries');

postcssHelpMediaQueries.process(YOUR_CSS /*, processOptions, pluginOptions */);
```

Or use it as a [PostCSS] plugin:

```js
const postcss = require('postcss');
const postcssHelpMediaQueries = require('postcss-help-media-queries');

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

**PostCSS Help Media Queries** runs in all Node environments, with special instructions for:

| [Node](INSTALL.md#node) | [PostCSS CLI](INSTALL.md#postcss-cli) | [Webpack](INSTALL.md#webpack) | [Create React App](INSTALL.md#create-react-app) | [Gulp](INSTALL.md#gulp) | [Grunt](INSTALL.md#grunt) |
| --- | --- | --- | --- | --- | --- |

## Options

<details open>
<summary><b>breakpoints</b> <code>object</code></summary>
<small>Define the custom <b>min-width</b> breakpoints to watch and show inside the tooltip.

```js
postcssHelpMediaQueries({
  breakpoints: {
    extraSmall: '30em',
    small: '48em',
    medium: '60em',
    large: '80em',
    extraLarge: '100em'
  }
})
```
</small>
</details>

[cli-img]: https://img.shields.io/travis/limitlessloop/postcss-help-media-queries/master.svg?style=for-the-badge
[cli-url]: https://travis-ci.org/limitlessloop/postcss-help-media-queries
[git-img]: https://img.shields.io/badge/support-chat-blue.svg?style=for-the-badge
[git-url]: https://gitter.im/postcss/postcss
[npm-img]: https://img.shields.io/npm/v/postcss-help-media-queries.svg?style=for-the-badge&colorA=CD4A4A&colorB=B03737
[npm-url]: https://www.npmjs.com/package/postcss-help-media-queries

[PostCSS]: https://github.com/postcss/postcss
[PostCSS Help Media Queries]: https://github.com/limitlessloop/postcss-help-media-queries

---
_Source: https://npm.io/package/postcss-help-media-queries · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._