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

media-screen

v1.0.0

Published

Control media query with JavaScript

Downloads

2

Readme

Control media query with JavaScript.

Usage

var MediaScreen = require('media-screen');

MediaScreen()
  .width()
  .gt(640)
  .then(function () {
    // pass
  }, function () {
    // else
  });

MediaScreen:

Media screen is the main function that accepts a single argument, which is an element to watch.

Pararmeters:

element optional: default window

Accepts:

  • Dom Object.

  • CSS Selector.

Also accepts list of elements. not recommended

MediaScreen();   // defaults to window
// or
MediaScreen(docuemnt.getElementById('main'));
// or
MediaScreen('.container.fluid');

Options, Conditions:

MediaScreen returns a list of options and conditions methods:

width(): option

Tell the MediaScreen to watch only the width of the element.

MediaScreen()
  .width()    
  ...

width() option returns a list of conditions.

height(): option

Tell the MediaScreen to watch only the height of the element.

MediaScreen()
  .height()
  ...

height() option returns a list of conditions.

always(): condition

Tells MediaScreen to call the handler whenever the width of the element or its height or both are changed.

MediaScreen()
  .width()
  .always()
  .then(function (dimensions) {
    // passed
  });
  ...

always condition returns only the then handler.

note: when always is called without an option 'dimension', MediaScreen will watch both dimensions.

gt(): condition

Tells MediaScreen to dispatch an event when width or height is greater than the limit.

Parameters:

  • limit: {Number}.

  • always: {Boolean}. optional default false runs the callback function each time the element is resized instead of only once when its width or height is greater than the limit.

  • elseAlways: {Boolean}. optional default false runs the else callback function each time the element is resized instead of only once when its width or height is less than the limit.

MediaScreen()
  .width()
  .gt(1024, true)
  .then(...)

gt() condition returns only the then handler.

lt(): condition

Tells MediaScreen to dispatch an event when width or height is less than the limit.

Parameters:

  • limit: {Number}.

  • always: {Boolean}. optional default false runs the callback function each time the element is resized instead of only once when its width or height is less than the limit.

  • elseAlways: {Boolean}. optional default false runs the else callback function each time the element is resized instead of only once when its width or height is greater than the limit.

MediaScreen()
  .height()
  .lt(1024, false, true)
  .then(...)

lt() option returns only the then() handler.

in(): condition

Tells MediaScreen to dispatch an event when width or height is between min and max arguments range.

Parameters:

  • min: {Number}.

  • max: {Number}.

  • always: {Boolean}. optional default false runs the callback function each time the element is resized instead of only once when its width or height is between min and max arguments range.

  • elseAlways: {Boolean}. optional default false runs the else callback function each time the element is resized instead of only once when its width or height is out of min and max arguments range.

MediaScreen()
  .height()
  .in(640, 1024, false, true)
  .then(...)

in() option returns only the then() handler.

out(): condition

Tells MediaScreen to dispatch an event when width or height is out of min and max arguments range.

Parameters:

  • min: {Number}.

  • max: {Number}.

  • always: {Boolean}. optional default false runs the callback function each time the element is resized instead of only once when its width or height is out of min and max arguments range.

  • elseAlways: {Boolean}. optional default false runs the else callback function each time the element is resized instead of only once when its width or height is between min and max arguments range.

MediaScreen()
  .height()
  .in(640, 1024, false, true)
  .then(...)

out() option returns only the then() handler.

landscape(): condition

Tells MediaScreen to dispatch an event when the width of the element is greater than its height.

Parameters:

  • always: {Boolean}. optional default false runs the callback function each time the element is resized instead of only once when its width is greater than its height.

  • elseAlways: {Boolean}. optional default false runs the else callback function each time the element is resized instead of only once when its height is greater than its width.

MediaScreen()
  .landscape(false, true)
  .then(...)

landscape() option returns only the then() handler.

portrait(): condition

Tells MediaScreen to dispatch an event when the height of the element is greater than its width.

Parameters:

  • always: {Boolean}. optional default false runs the callback function each time the element is resized instead of only once when its height is greater than its width.

  • elseAlways: {Boolean}. optional default false runs the else callback function each time the element is resized instead of only once when its width is greater than its height.

MediaScreen()
  .portrait(false, true)
  .then(...)

portrait() option returns only the then() handler.

Handler:

then():

then has two callback handlers called whenever a condition is passed unless you set the always paramter to true, then it will be called whenever the element is resized and it still passes the condition.

Parameters:

  • callback: {Function}.

  • elseCalback: {Function}. optional

The callbacks will have the context of the element and a single argument object describing the current dimensions of the element.

MediaScreen()
  .portrait(false, true)
  .then(function (dimensions) {
    console.log(dimensions);  // { width: 465, height: 759 }
  }, function (dimensions) {

  })
  .MediaScreen(...)
  ...

then handler returns a MediaScreen wrapper for new query.

Thank you...