Socket
Socket
Sign inDemoInstall

media-query-parser

Package Overview
Dependencies
Maintainers
1
Versions
14
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

media-query-parser

Parse CSS media queries and merge


Version published
Maintainers
1
Created
Source

media-query-parser

npm version npm bundle size test coverage GitHub Workflow Status

  • Parses correct CSS media queries
  • Fails on invalid CSS media queries
  • Spec-compliant - https://www.w3.org/TR/mediaqueries-4/
  • Zero-dependencies
  • TypeScript friendly
  • All valid queries parsed, even newer ones like
    @media (100px < width < 200px)

Quickfire examples

import { toAST } from 'media-query-parser'

// Simple responsive media query
console.log(toAST('(max-width: 768px)'))
/* [
  {
    "mediaPrefix":null,
    "mediaType":"all",
    "mediaCondition":{
      "operator":null,
      "children":[
        {"context":"value",
         "prefix":"max",
         "feature":"width",
         "value":{"type":"<dimension-token>","value":768,"unit":"px","flag":"number"}
        }
      ]
    }
  }
] */

// Supports comma separated media-query lists
console.log(toAST('print, (not (color))'))
// Trims the `@media` if it starts with it, the `{` and anything that follows
console.log(toAST('@media screen { body { background: #000 } }'))
// Full support for new range syntax
console.log(toAST('(100px < width < 200px)'))
// ...which was no mean feat...
console.log(toAST('(4/3 <= aspect-ratio <= 16/9)'))
// Throws an Error with invalid media query syntax
console.log(toAST('clearly this is not a valid media query')) // => Error
// ...even the normal looking but invalid ones:
{
  console.log(toAST('(max-width: 768px) and screen')) // => Error
  // explanation: screen must be on left hand side
  console.log(toAST('screen and (max-width: 768px) or (hover)')) // => Error
  // explanation: spec disallows `and` and `or` on same level as ambiguous
}

Considerations & Caveats

This library does:

  • remove extra layers from unnecessary parentheses (((((max-width: 768px)))))
  • parses units, numbers and other values to the spec
  • handle unusual whitespace anywhere that the spec allows it
  • contain many a unit test

This library does not:

  • sanity check the actual media features or their types (max-power: infinite) is as valid as (hover: none)
  • normalize the media query features (e.g. (max-width: -100px) is always false)

Note that:

  • Handling individual media features is being developed in a separate project: media-query-fns

Installation

npm install media-query-parser --save
# yarn add media-query-parser

Alternatively, there are also client web builds available:

<!-- window.MediaQueryParser -->
<script src="https://unpkg.com/media-query-parser/dist/media-query-parser.umd.js"></script>

API

License

MIT

Keywords

FAQs

Package last updated on 27 Mar 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc