react-device-detect
v2.2.3
Published
Detect device type and render your component according to it
Downloads
4,121,926
Maintainers
Readme
react-device-detect
Detect device, and render view according to the detected device type.
Installation
To install, you can use npm or yarn:
npm install react-device-detect --save
or
yarn add react-device-detect
When to use this library
This library uses a technique called user agent sniffing to detect device information. That means it works by examining the User Agent string given by a browser and comparing it to a list of browser and device names it knows about. This technique works, but has drawbacks and may or may not be the right approach, depending on what you're trying to achieve. If you need to detect a specific browser type (e.g. Chrome, Safari, Internet Explorer) or specific category of device (e.g. all iPods), this library can do that. If you just want your React app to behave differently or look different on mobiles in general, CSS @media
queries and matchMedia
are probably what you want. There are many libraries that can help with using @media
queries and matchMedia
in React projects, such as react-responsive and @react-hook/media-query.
API
Usage
Example:
import { BrowserView, MobileView, isBrowser, isMobile } from 'react-device-detect';
<BrowserView>
<h1>This is rendered only in browser</h1>
</BrowserView>
<MobileView>
<h1>This is rendered only on mobile</h1>
</MobileView>
if you don't need a view, you can use isMobile
for conditional rendering
import {isMobile} from 'react-device-detect';
function App() {
renderContent = () => {
if (isMobile) {
return <div> This content is available only on mobile</div>
}
return <div> ...content </div>
}
render() {
return this.renderContent();
}
}
If you want to leave a message to a specific browser (e.g IE), you can use isIE
selector
import { isIE } from 'react-device-detect';
function App() {
render() {
if (isIE) return <div> IE is not supported. Download Chrome/Opera/Firefox </div>
return (
<div>...content</div>
)
}
}
If you want to render a view on a specific device and with a specific condition:
import { browserName, CustomView } from 'react-device-detect';
function App() {
render() {
return (
<CustomView condition={browserName === "Chrome"}>
<div>...content</div>
</CustomView>
)
}
}
Style the view
You can style a view component by passing class to the className
prop
<BrowserView className="custom-class">
<p>View content</p>
</BrowserView>
or you can pass inline styles to style
prop
const styles = {
background: 'red',
fontSize: '24px',
lineHeight: '2',
};
<BrowserView style={styles}>
<p>View content</p>
</BrowserView>
Testing
import * as rdd from 'react-device-detect';
rdd.isMobile = true;
// use in tests
License
MIT