React-config-hooks NPM

react-config-hooks

Deliver experiences best suited to a user's OS, device type, browser, and other things

This is a suite of React Hooks and utilities for adaptive loading based on a user's:

Operating System
Browser
Configuration

Objective

Make it easier for developer to target different devices based on their configuration. It can be used to check different settings related to config in order to deliver best experiences to user.

Install

npm install --save react-config-hooks

Usage

Operating System

import { useOS } from 'react-config-hooks'

const [ os,isWin,isMac,isUnix,isLinux,isWinMob,isAndroid,isiOS ] = useOS()

Value	Returns	Return type
`os`	Returns the name of OS	String
`isWin`	Returns true if OS is Windows and vice versa	boolean
`isMac`	Returns true if OS is Mac and vice versa	boolean
`isUnix`	Returns true if OS is Unix and vice versa	boolean
`isLinux`	Returns true if OS is Linux and vice versa	boolean
`isWinMob`	Returns true if OS is Windows Mobile and vice versa	boolean
`isAndroid`	Returns true if OS is Android and vice versa	boolean
`isiOS`	Returns true if OS is iOS and vice versa	boolean

Browser

import { useBrowser } from 'react-config-hooks'

const [ browser,isChrome,isFirefox,isIE,isEdge,isSafari,isOpera,isYandex ] = useBrowser()

Value	Returns	Return type
`browser`	Returns the name of browser	String
`isChrome`	Returns true if browser is Chrome and vice versa	boolean
`isFirefox`	Returns true if browser is Firefox and vice versa	boolean
`isIE`	Returns true if browser is IE and vice versa	boolean
`isEdge`	Returns true if browser is Edge and vice versa	boolean
`isSafari`	Returns true if browser is Safari and vice versa	boolean
`isOpera`	Returns true if browser is Opera and vice versa	boolean
`isYandex`	Returns true if browser is Yandex and vice versa	boolean

Config

import { useConfig } from 'react-config-hooks'

const [ deviceConfig,isCookieEnabled,isOnLine,knownLangs,prefLang,isJavaEnabled ] = useConfig()

Value	Returns	Return type
`deviceConfig`	Returns the different properties (`isCookieEnabled`,`isOnLine`,`knownLangs`,`prefLang`,`isJavaEnabled`) related to config	Arrays of objects
`isCookieEnabled`	Returns true if cookie is enabled and vice versa	boolean
`isOnLine`	Returns true if user is online and vice versa	boolean
`knownLangs`	Returns an array representing the languages known to the user, by order of preference	array
`prefLang`	Returns an string representing the preferred language of the user, usually the language of the browser UI. The null value is returned when this is unknown.	String
`isJavaEnabled`	Returns true if Java is enabled and vice versa	boolean

License

@infinitebrahmanuniverse/nolb-react-con @everything-registry/sub-chunk-2547

1.1.0

4 years ago

1.0.0

4 years ago