Package Exports
- react-use
- react-use/lib/useAsync
- react-use/lib/useAudio
- react-use/lib/useBoolean
- react-use/lib/useGetSetState
- react-use/lib/useIdle
- react-use/lib/useList
- react-use/lib/useLocalStorage
- react-use/lib/useLocation
- react-use/lib/useMedia
- react-use/lib/useObservable
- react-use/lib/useSetState
- react-use/lib/useSpring
- react-use/lib/useToggle
- react-use/lib/useVideo
- react-use/lib/useWindowSize
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-use) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
👍
react-use
Collection of essential React Hooks.
Port of
libreact
to React Hooks. See demos.
npm i react-use
- Sensors
useBattery
— tracks device battery state.useGeolocation
— tracks geo location state of user's device.useHover
— tracks mouse hover state of some element.useIdle
— tracks whether user is being inactive.useLocation
— tracks page navigation bar location state.useMedia
— tracks state of a CSS media query.useMediaDevices
— tracks state of connected hardware devices.useMotion
— tracks state of device's motion sensor.useNetwork
— tracks state of user's internet connection.useOrientation
— tracks state of device's screen orientation.useSize
— tracks some HTML element's dimensions.useWindowSize
— tracksWindow
dimensions.
- UI
- Animations
useRaf
— re-renders component on eachreaquestAnimationFrame
.useSpring
— interpolates number over time according to spring dynamics.useTimeout
— returns true after a timeout.useTween
— re-renders component, while tweening a number from 0 to 1.useUpdate
— returns a callback, which re-renders component when called.
- Side-effects
useAsync
— resolves anasync
function.useCss
— dynamically adjusts CSS.useFavicon
— sets favicon of the page.useTitle
— sets title of the page.
- Lifecycles
useLifecycles
— callsmount
andunmount
callbacks.useLogger
— logs in console as component goes though life-cycles.useMount
— callsmount
callbacks.useUnmount
— callsunmount
callbacks.
- State
createMemo
— factory of memoized hooks.useGetSet
— returns state getterget()
instead of raw state.useGetSetState
— as ifuseGetSet
anduseSetState
had a baby.useObservable
— tracks latest value of anObservable
.useSetState
— createssetState
method which works likethis.setState
.useToggle
anduseBoolean
— tracks state of a boolean.useCounter
anduseNumber
— tracks state of a number.useList
— tracks state of an array.useMap
— tracks state of an object.
Usage
- You need to have React
16.7.0-alpha.0
or later installed to use Hooks API. - You can import each hook individually
import useToggle from 'react-use/lib/useToggle'
.
License
Unlicense — public domain.