react-responsive

Information

Package	react-responsive
Description	Media queries in react for responsive design
Browser Version	>= IE6*
Demo

The best supported, easiest to use react media query module.

Install

$ npm install react-responsive --save

Example Usage

With Hooks

This feature is available on the 8.0.0-beta branch, and will go stable very soon!

importReactfrom'react'import{useMediaQuery}from'react-responsive'constExample=()=>{constisDesktopOrLaptop=useMediaQuery({query: '(min-device-width: 1224px)'})constisBigScreen=useMediaQuery({query: '(min-device-width: 1824px)'})constisTabletOrMobile=useMediaQuery({query: '(max-width: 1224px)'})constisTabletOrMobileDevice=useMediaQuery({query: '(max-device-width: 1224px)'})constisPortrait=useMediaQuery({query: '(orientation: portrait)'})constisRetina=useMediaQuery({query: '(min-resolution: 2dppx)'})return(<div><h1>Device Test!</h1>{isDesktopOrLaptop&&<><p>You are a desktop or laptop</p>{isBigScreen&&<p>You also have a huge screen</p>}{isTabletOrMobile&&<p>You are sized like a tablet or mobile phone though</p>}</>}{isTabletOrMobileDevice&&<p>You are a tablet or mobile phone</p>}<p>Your are in {isPortrait ? 'portrait' : 'landscape'} orientation</p>{isRetina&&<p>You are retina</p>}</div>)}

With Components

importMediaQueryfrom'react-responsive'constExample=()=>(<div><h1>Device Test!</h1><MediaQueryminDeviceWidth={1224}device={{deviceWidth: 1600}}><p>You are a desktop or laptop</p><MediaQueryminDeviceWidth={1824}><p>You also have a huge screen</p></MediaQuery></MediaQuery><MediaQueryminResolution='2dppx'>{/* You can also use a function (render prop) as a child */}{(matches)=>matches
? <p>You are retina</p>
: <p>You are not retina</p>}</MediaQuery></div>)

API

Using Properties

To make things more idiomatic to react, you can use camel-cased shorthands to construct media queries.

For a list of all possible shorthands and value types see https://github.com/contra/react-responsive/blob/master/src/mediaQuery.js#L9.

Any numbers given as shorthand will be expanded to px (1234 will become '1234px').

The CSS media queries in the example above could be constructed like this:

importReactfrom'react'import{useMediaQuery}from'react-responsive'constExample=()=>{constisDesktopOrLaptop=useMediaQuery({minDeviceWidth: 1224})constisBigScreen=useMediaQuery({minDeviceWidth: 1824})constisTabletOrMobile=useMediaQuery({maxWidth: 1224})constisTabletOrMobileDevice=useMediaQuery({maxDeviceWidth: 1224})constisPortrait=useMediaQuery({orientation: 'portrait'})constisRetina=useMediaQuery({minResolution: '2dppx'})return(<div>
...
</div>)}

Forcing a device with the device prop

At times you may need to render components with different device settings than what gets automatically detected. This is especially useful in a Node environment where these settings can't be detected (SSR) or for testing.

Possible Keys

orientation, scan, aspectRatio, deviceAspectRatio, height, deviceHeight, width, deviceWidth, color, colorIndex, monochrome, resolution and type

Possible Types

type can be one of: all, grid, aural, braille, handheld, print, projection, screen, tty, tv or embossed

Note: The device property always applies, even when it can be detected (where window.matchMedia exists).

import{useMediaQuery}from'react-responsive'constExample=()=>{constisDesktopOrLaptop=useMediaQuery({minDeviceWidth: 1224},{deviceWidth: 1600}// `device` prop)return(<div>{isDesktopOrLaptop&&<p>
this will always get rendered even if device is shorter than 1224px,
that's because we overrode device settings with 'deviceWidth: 1600'.
</p>}</div>)}

Supplying through Context

You can also pass device to every useMediaQuery hook in the components tree through a React Context. This should ease up server-side-rendering and testing in a Node environment, e.g:

Server-Side Rendering

import{ContextasResponsiveContext}from'react-responsive'import{renderToString}from'react-dom/server'importAppfrom'./App'
...
// Context is just a regular React Context component, it accepts a `value` prop to be passed to consuming componentsconstmobileApp=renderToString(<ResponsiveContext.Providervalue={{width: 500}}><App/></ResponsiveContext.Provider>)...

Testing

import{ContextasResponsiveContext}from'react-responsive'import{render}from'@testing-library/react'importProductsListingfrom'./ProductsListing'describe('ProductsListing',()=>{test('matches the snapshot',()=>{const{container: mobile}=render(<ResponsiveContext.Providervalue={{width: 300}}><ProductsListing/></ResponsiveContext.Provider>)expect(mobile).toMatchSnapshot()const{container: desktop}=render(<ResponsiveContext.Providervalue={{width: 1000}}><ProductsListing/></ResponsiveContext.Provider>)expect(desktop).toMatchSnapshot()})})

Note that if anything has a device prop passed in it will take precedence over the one from context.

Easy Mode

That's it! Now you can create your application specific breakpoints and reuse them easily. Here is an example:

import{useMediaQuery}from'react-responsive'constDesktop=({ children })=>{constisDesktop=useMediaQuery({minWidth: 992})returnisDesktop ? children : null}constTablet=({ children })=>{constisTablet=useMediaQuery({minWidth: 768,maxWidth: 991})returnisTablet ? children : null}constMobile=({ children })=>{constisMobile=useMediaQuery({maxWidth: 767})returnisMobile ? children : null}constDefault=({ children })=>{constisNotMobile=useMediaQuery({minWidth: 768})returnisNotMobile ? children : null}constExample=()=>(<div><Desktop>Desktop or laptop</Desktop><Tablet>Tablet</Tablet><Mobile>Mobile</Mobile><Default>Not mobile (desktop or laptop or tablet)</Default></div>)exportdefaultExample

Browser Support

Out of the box

Chrome	9
Firefox (Gecko)	6
MS Edge	All
Internet Explorer	10
Opera	12.1
Safari	5.1

With Polyfills

Pretty much everything. Check out these polyfills:

• matchMedia.js by Paul Irish
• media-match (faster, but larger and lacking some features)