@kupibilet/react-media

A CSS media query component for React

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
2,3686Jul 15, 2020Aug 3, 2016Minified + gzip package size for @kupibilet/react-media in KB

Readme

react-media Travis npm package

react-media is a CSS media query component for React.

A <Media> component listens for matches to a CSS media query and renders stuff based on whether the query matches or not.

Installation

Using npm:

$ npm install --save react-media

Then with a module bundler like webpack, use as you would anything else:

// using ES modules
import Media from 'react-media'

// using CommonJS modules
var Media = require('react-media')

The UMD build is also available on unpkg:

<script src="https://unpkg.com/react-media/umd/react-media.min.js"></script>

You can find the library on window.ReactMedia.

Usage

Render a <Media> component with a query prop whose value is a valid CSS media query or a queries prop whose value is an object with keys as the name of your query and values as a vali CSS media queries. The children prop should be a function whose only argument will be a boolean flag that indicates whether the media query matches or not.

with query:

import React from 'react'
import Media from 'react-media'

class App extends React.Component {
  render() {
    return (
      <div>
        <Media query="(max-width: 599px)">
          {matches => matches ? (
            <p>The document is less than 600px wide.</p>
          ) : (
            <p>The document is at least 600px wide.</p>
          )}
        </Media>
      </div>
    )
  }
}

with queries:

import React from 'react'
import Media from 'react-media'

class App extends React.Component {
  render() {
    return (
      <div>
        <Media
          queries={{
            small: "(min-width: 300px)"
            medium: "(min-width: 600px)"
          }}
        >
          {({ small, medium }) => (
            <div
              className={[
                (small ? 'hello' : ''),
                (medium ? 'goodbye' : ''),
              ].join(' ')}
            >
              At 300px wide, I have a `className` of `hello`. At 600px wide,
              I have a `className` of `hello goodbye`.
            </div>
          )}
        </Media>
      </div>
    )
  }
}

If you render a <Media> component on the server, it always matches.

If you use a regular React element as children (i.e. <Media><SomethingHere/></Media>) it will be rendered if the query matches. However, you may end up creating a bunch of elements that won't ever actually be rendered to the page (i.e. you'll do a lot of unnecessary createElements on each render). Thus, a children function (i.e. <Media>{matches => ...}</Media>) is the preferred API. Then you can decide in the callback which elements to create based on the result of the query.

For the common case of "only render something when the media query matches", you can use a render prop that is only called if the query matches.

import React from 'react'
import Media from 'react-media'

class App extends React.Component {
  render() {
    return (
      <div>
        <Media query="(max-width: 599px)" render={() => (
          <p>The document is less than 600px wide.</p>
        )}/>
      </div>
    )
  }
}

The render prop is never called if the query does not match.

<Media query> and <Media queries> also accepts an object, similar to React's built-in support for inline style objects in e.g. <div style>. These objects are converted to CSS media queries via json2mq.

import React from 'react'
import Media from 'react-media'

class App extends React.Component {
  render() {
    return (
      <div>
        <Media query={{ maxWidth: 599 }}>
          {matches => matches ? (
            <p>The document is less than 600px wide.</p>
          ) : (
            <p>The document is at least 600px wide.</p>
          )}
        </Media>
      </div>
    )
  }
}

Keys of media query objects are camel-cased and numeric values automatically get the px suffix. See the json2mq docs for more examples of queries you can construct using objects.

That's it :) Enjoy!

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.