Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/duskload/react-device-detect

Detect device, and render view according to detected device type.
https://github.com/duskload/react-device-detect

detect device javascript mobile user-agent useragent

Last synced: about 2 months ago
JSON representation

Detect device, and render view according to detected device type.

Lists

README 

        
## react-device-detect



![npm](https://img.shields.io/npm/dm/react-device-detect?label=npm%20downloads)



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](https://developer.mozilla.org/en-US/docs/Web/HTTP/Browser_detection_using_the_user_agent) to detect device information. That means it works by examining the [User Agent string](https://en.wikipedia.org/wiki/User_agent) given by a browser and comparing it to a list of browser and device names it knows about. This technique works, but [has drawbacks](https://css-tricks.com/browser-detection-is-bad/) 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](https://developer.mozilla.org/en-US/docs/Web/CSS/@media) and [`matchMedia`](https://developer.mozilla.org/en-US/docs/Web/API/Window/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](https://www.npmjs.com/package/react-responsive) and [@react-hook/media-query](https://www.npmjs.com/package/@react-hook/media-query).



## API



- [Hooks, SSR and utilities](docs/api.md)

- [Selectors](docs/selectors.md)

- [Views](docs/views.md)



## Usage



Example:



```javascript

import { BrowserView, MobileView, isBrowser, isMobile } from 'react-device-detect';

```



```html



  
This is rendered only in browser



  
This is rendered only on mobile



```



if you don't need a view, you can use `isMobile` for conditional rendering



```javascript

import {isMobile} from 'react-device-detect';



function App() {

  renderContent = () => {

    if (isMobile) {

      return 
 This content is available only on mobile


    }

    return 
 ...content 


  }



  render() {

    return this.renderContent();

  }

}

```



If you want to leave a message to a specific browser (e.g IE), you can use `isIE` selector



```javascript

import { isIE } from 'react-device-detect';



function App() {

  render() {

    if (isIE) return 
 IE is not supported. Download Chrome/Opera/Firefox 


    return (

      
...content


    )

  }

}

```



If you want to render a view on a specific device and with a specific condition:



```javascript

import { browserName, CustomView } from 'react-device-detect';



function App() {

  render() {

    return (

      

        
...content


      

    )

  }

}

```



## Style the view



You can style a view component by passing class to the `className` prop



```html



  
View content



```



or you can pass inline styles to `style` prop



```javascript

const styles = {

  background: 'red',

  fontSize: '24px',

  lineHeight: '2',

};

```



```html



  
View content



```



### Testing



```js

import * as rdd from 'react-device-detect';



rdd.isMobile = true;



// use in tests

```



## License



MIT