Skip to content

Latest commit

 

History

History
92 lines (59 loc) · 3.17 KB

README.md

File metadata and controls

92 lines (59 loc) · 3.17 KB
Raw

media-query-listener

NPM version

A module for observing media query breakpoint changes defined in CSS. A common way to accomplish this is to use window.matchMedia(), but if we want to use the same Media Queries in our JavaScript as in our CSS we have to define them in both environments. Since we're good developers and follow the DRY and SSOT principles we don't like doing this, and should use this module instead.

Install

$ npm install --save media-query-listener

Usage

CSS

In your CSS where you probably already have a few Media Queries set up, add a name to your breakpoints by adding the names as content to the body:after pseudo element. The Media Queries can be of any type and the names can be any strings. It should look something like this...

body:after {
    display: none; // this is needed to not display the breakpoint names on the page
    content: "small";
}

@media (min-width: 600px) {
    body:after {
        content: "medium";
    }
}

@media (min-width: 1000px) {
    body:after {
        content: "large";
    }
}

JavaScript

If you want to use this module with Browserify you can require it as usual with var mqListener = require('media-query-listener'). If you want to use it without a build step you can download mq-listener.js or the minified version mq-listener.min.js from this repo and add it to your page with a <script> tag or include it in some other way.

After the module is loaded you can listen to events for when a certain breakpoint is entered like this...

mqListener.on('small', function() {
    // We now entered a breakpoint defined as "small" in the CSS.
});

mqListener.on('medium', function() {
    // We now entered a breakpoint defined as "medium" in the CSS.
});

mqListener.on('change', function(breakpoint) {
    // We now entered a breakpoint and the callback function parameter contains the name of the entered breakpoint as defined in the CSS.
});

Methods

on(name, callback[, context])

Subscribe to a breakpoint change event

  • name - the name of the breakpoint to subscribe to, as defined in the CSS
  • callback - the function to call when the breakpoint is entered
  • context - (OPTIONAL) - the context to bind the event callback to

once(name, callback[, context])

Subscribe to a breakpoint change event only once

  • name - the name of the breakpoint to subscribe to, as defined in the CSS
  • callback - the function to call when the breakpoint is entered
  • context - (OPTIONAL) - the context to bind the event callback to

off(name[, callback])

Unsubscribe from a breakpoint change event or all events. If no callback is provided, it unsubscribes you from all events.

  • name - the name of the breakpoint to unsubscribe from, as defined in the CSS
  • callback - the function used when binding to the event

License

MIT © Jonathan Svenheden