npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

js-custom-media

v1.0.0

Published

Use Custom Media Queries in JS

Downloads

30

Readme

JS Custom Media

NPM Version Build Status Support Chat

JS Custom Media lets you use Custom Media Queries in JS, following the CSS Media Queries specification.

npm install js-custom-media

Usage

import { customMedia, polyfillMatchMedia } from 'js-custom-media';

// define a custom media query
customMedia.set('--md', '(width > 640px)');

// polyfill `window.matchMedia`
const matchMedia = polyfillMatchMedia(window.matchMedia);

// match a custom media query
mq = matchMedia('(--md)');
mq.addListener(update);

// apply the custom media query
function update() {
  // do something with `mq.matches`
}

update();

A typical implementation of this script is about 576 bytes minified and gzipped.

Usage with PostCSS Custom Media

PostCSS Custom Media lets you import Custom Media from external files. These files can be used by this library as well.

import { extensions, polyfillMatchMedia } from 'js-custom-media';

// get variables that include `'custom-media'` (or `customMedia`)
import variables from 'path/to/variables.json';

// add variables’ custom media to `extensions`
Object.assign(extensions, variables['custom-media']);

// get built-in support for variables’ custom media
window.matchMedia = polyfillMatchMedia(window.matchMedia);

Features

polyfillMatchMedia

The polyfillMatchMedia method returns a wrapped version of matchMedia that can parse custom media queries.

import { polyfillMatchMedia } from 'js-custom-media';

const matchMedia = polyfillMatchMedia(window.matchMedia); // works like window.matchMedia

customMedia

The customMedia object includes 2 methods for getting and setting custom media queries.

set

The set method adds a custom media query that is readable by the wrapped version of matchMedia.

import { customMedia } from 'js-custom-media';

customMedia.set('--md', '(min-width: 640px)');

get

The get method returns the value of a custom media query.

import { customMedia } from 'js-custom-media';

CSS.customMedia.get('--md'); // (min-width: 640px)

extensions

The extensions object is the internal map of custom media queries used by customMedia and polyfillMatchMedia.

This can only be used for non-standard behavior, such as Usage with PostCSS Custom Media.

import { extensions } from 'js-custom-media';

extensions['--some-mq'] = '(width >= 960px)'; // add custom media queries in a non-standard way