react-device-breakpoints
v2.0.3
Published
Component for managing matchMedia queries in react.
Downloads
21
Maintainers
Readme
React Device Breakpoints
Installation
npm i react-device-breakpoints --save
or with yarn:
yarn add react-device-breakpoints
Usage
App.js
import React from 'react'
import { Breakpoints } from 'react-device-breakpoints'
const breakpoints = {
isDesktop: '(min-width: 1024px)',
isTablet: '(max-width: 1023px) and (min-width: 768px)',
isMobile: '(max-width: 767px)'
}
const App = () => (
<Breakpoints {...breakpoints}>
<MyComponent/>
</Breakpoints>
)
export default App
With Hooks
MyComponent.js
import React, { useContext } from 'react'
import { useBreakpoints } from 'react-device-breakpoints'
const MyComponent = () => {
const device = useBreakpoints()
return (
<div>
{device.isDesktop &&
<h1>Desktop</h1>
}
{device.isTablet &&
<h1>Tablet</h1>
}
{device.isMobile &&
<h1>Mobile</h1>
}
{device.isTouchDevice &&
<h2>Touch Device</h2>
}
</div>
)
}
export default MyComponent
With Consumer
MyComponent.js
import React, { useContext } from 'react'
import { Media } from 'react-device-breakpoints'
const MyComponent = () => {
return (
<Media>
{(device, Media) => (
<div>
{device.isDesktop &&
<h1>Desktop</h1>
}
{device.isTablet &&
<h1>Tablet</h1>
}
{device.isMobile &&
<h1>Mobile</h1>
}
{device.isTouchDevice &&
<h2>Touch Device</h2>
}
<Media.isDesktop>
<h1>Desktop</h1>
</Media.isDesktop>
<Media.isTablet>
<h1>Tablet</h1>
</Media.isTablet>
<Media.isMobile>
<h1>Mobile</h1>
</Media.isMobile>
<Media.isTouchDevice>
<h1>Touch Device</h1>
</Media.isTouchDevice>
</div>
)}
</Media>
)
}
export default MyComponent
The Device Object
React Device Breakpoints returns a device object as follows:
{
[breakpointName]: Boolean
}
For example:
{
isDesktop: true,
isTablet: false,
isMobile: false
}
It also includes a pre-built-in option for touch devices base of the following user agent test /Mobi|Tablet|iPad|iPhone|Android/.test(window.navigator.userAgent)
{
isTouchDevice: false
}