add isMobile and isTouchDevice helpers

Author: burnpiro

README.md

@@ -103,4 +103,29 @@ import { useEngine } from 'use-ua-parser-js';
 const myComponent: FC<Props> = (props) => {
   const engine = useEngine(); //{ name: string, version: string }
 }
+```
+
+## Helpers
+
+### `isMobile(device: UAParser.IResult['device']): boolean`
+
+```javascript
+import { useDevice, isMobile } from 'use-ua-parser-js';
+
+const myComponent: FC<Props> = (props) => {
+  const device = useDevice(); //{ model: string, type: string, vendor: string }
+  const isCurrentDeviceMobile = isMobile(device);
+}
+```
+
+### `isTouchDevice(device: UAParser.IResult['device']): boolean`
+Check if device is either a `mobile`, `tablet` or `wearable` device. Doesn't include "2:1" laptops.
+
+```javascript
+import { useDevice, isTouchDevice } from 'use-ua-parser-js';
+
+const myComponent: FC<Props> = (props) => {
+  const device = useDevice(); //{ model: string, type: string, vendor: string }
+  const hasTouchScreen = isTouchDevice(device);
+}
 ```

src/helpers.ts

@@ -0,0 +1,11 @@
+import * as UAParser from 'ua-parser-js';
+
+function isMobile(details: UAParser.IResult['device']): boolean {
+  return details.type === 'mobile';
+}
+
+function isTouchDevice(details: UAParser.IResult['device']): boolean {
+  return ['mobile', 'tablet', 'wearable'].includes(details.type || '');
+}
+
+export { isMobile, isTouchDevice };

src/index.tsx

@@ -1,5 +1,6 @@
 import * as React from 'react';
 import * as UAParser from 'ua-parser-js';
+import { isMobile, isTouchDevice } from './helpers';
 
 type IUseUAReturn = Omit<UAParser.IResult, 'ua'>;
 
@@ -20,7 +21,7 @@ function useUA(uastring = defaultUAString) {
         engine: uaParser.getEngine(),
       };
     } catch (err) {
-      return null
+      return null;
     }
   }, [uastring]);
 }
@@ -31,7 +32,7 @@ function useDevice(uastring = defaultUAString) {
       uaParser.setUA(uastring);
       return uaParser.getDevice();
     } catch (err) {
-      return null
+      return null;
     }
   }, [uastring]);
 }
@@ -42,7 +43,7 @@ function useBrowser(uastring = defaultUAString) {
       uaParser.setUA(uastring);
       return uaParser.getBrowser();
     } catch (err) {
-      return null
+      return null;
     }
   }, [uastring]);
 }
@@ -53,7 +54,7 @@ function useCPU(uastring = defaultUAString) {
       uaParser.setUA(uastring);
       return uaParser.getCPU();
     } catch (err) {
-      return null
+      return null;
     }
   }, [uastring]);
 }
@@ -64,9 +65,9 @@ function useEngine(uastring = defaultUAString) {
       uaParser.setUA(uastring);
       return uaParser.getEngine();
     } catch (err) {
-      return null
+      return null;
     }
   }, [uastring]);
 }
 
-export { useUA, useDevice, useBrowser, useCPU, useEngine };
+export { useUA, useDevice, useBrowser, useCPU, useEngine, isMobile, isTouchDevice };