3.0.0 • Published 1 year ago

@react-native-community/hooks v3.0.0

Weekly downloads
25,215
License
ISC
Repository
github
Last release
1 year ago

React Native Hooks

React Native Hooks

Version

React Native APIs turned into React Hooks allowing you to access asynchronous APIs directly in your functional components.

Note: You must use React Native >= 0.59.0

Installation with npm

npm install @react-native-community/hooks

Installation with yarn

yarn add @react-native-community/hooks

API

useAccessibilityInfo

import {useAccessibilityInfo} from '@react-native-community/hooks'

const {
  boldTextEnabled,
  screenReaderEnabled,
  reduceMotionEnabled, // requires RN60 or newer
  grayscaleEnabled, // requires RN60 or newer
  invertColorsEnabled, // requires RN60 or newer
  reduceTransparencyEnabled, // requires RN60 or newer
} = useAccessibilityInfo()

useAppState

AppState will change between one of 'active', 'background', or (iOS) 'inactive' when the app is closed or put into the background.

import {useAppState} from '@react-native-community/hooks'

const currentAppState = useAppState()

useBackHandler

import {useBackHandler} from '@react-native-community/hooks'

useBackHandler(() => {
  if (shouldBeHandledHere) {
    // handle it
    return true
  }
  // let the default thing happen
  return false
})

useImageDimensions

import {useImageDimensions} from '@react-native-community/hooks'

const source = require('./assets/yourImage.png')
// or
const source = {uri: 'https://your.image.URI'}

const {dimensions, loading, error} = useImageDimensions(source)

if (loading || error || !dimensions) {
  return null
}
const {width, height, aspectRatio} = dimensions

useKeyboard

import {useKeyboard} from '@react-native-community/hooks'

const keyboard = useKeyboard()

console.log('keyboard isKeyboardShow: ', keyboard.keyboardShown)
console.log('keyboard keyboardHeight: ', keyboard.keyboardHeight)

useInteractionManager

import {useInteractionManager} from '@react-native-community/hooks'

const interactionReady = useInteractionManager()

console.log('interaction ready: ', interactionReady)

useDeviceOrientation

import {useDeviceOrientation} from '@react-native-community/hooks'

const orientation = useDeviceOrientation()

console.log('orientation is:', orientation)

useLayout

import { useLayout } from '@react-native-community/hooks'

const { onLayout, ...layout } = useLayout()

console.log('layout: ', layout)

<View onLayout={onLayout} style={{width: 200, height: 200, marginTop: 30}} />

useRefresh

import { useRefresh } from '@react-native-community/hooks'

const fetch = () => {
    return new Promise((resolve) => setTimeout(resolve, 500))
}

const { isRefreshing, onRefresh } = useRefresh(fetch);

<ScrollView 
  refreshControl= {
    <RefreshControl
      refreshing={isRefreshing}
      onRefresh={onRefresh}
    />
  }
/>

Thanks

We use auto for automatic releases, an awesome tool by an awesome dude!

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

@neur0base/app-sdk@gkasdorf/react-native-image-viewingreact-native-sdk-ui-test@infinitebrahmanuniverse/nolb-_react-n@everything-registry/sub-chunk-765txradicalfaeriesgathering2022@ezri00/trackapp@fullstackcraft/react-native-keyboard-shift@hongtangyun/react-native-mini-apps-engines@iterable/react-native-sdktailwind-rntailwind-rn-web@ha_tecno/live-id-sdkrid-lightboxscorpiousscorpious_kogornshellsharedtextstorybook-compostorybook-components@misagamingvn/tea_profoozard-mobile-components@manishoo/rn-matrix-ui@kacgrzes/expo-template@kafudev/react-native-core@kafudev/react-native-shellklarify-ui-components@bigbinary/neetoui-rn@boltss/react-native-hooksnodjs-mobile-native-templateccl-base@appello/mobile-uimbco-react-native-common-ui@bibletags/bibletags-react-native-app@communi/chat-ui-react-native@wu_rong_tai/react-native-aliplayermanual-billing-system-miniappminibili@andreciornavei/rn-essentials@dropthought/react-native-uipaintbox@drawone/jojo-clireact-native-aliplayer-wureact-native-aliplayerreact-native-aliplayer-breact-native-aliplayer-purereact-native-ali-videoreact-native-ali-video-playerreact-native-mpod-videoreact-native-nj-aliplayerreact-native-chatgptreact-native-gpp-utilsreact-native-basic-uireact-native-test-aliplayerreact-native-template-nativegoreact-native-txplayerreact-native-xm-aliplayer@jfkz/tailwind-rn@htyf-mp/enginesfowler-chat-reactnative@klutch-card/klutch-components@raydeck/react-native-theme-provider@raydeck/usecolorscheme@paintbox/native@peersyst/react-native-components@nandorojo/dripsy@proximus/myproximus-design-system@piscale/chat-ui-react-native@ronas-it/react-native-starterdu-cart-microappdu-track-order@tg1518/react-native-txplayeregenie-mobile-common
3.0.0

1 year ago

2.8.1

2 years ago

2.7.0

3 years ago

2.8.0

3 years ago

2.6.0

4 years ago

2.5.1

4 years ago

2.5.0

4 years ago

2.4.9

4 years ago

2.4.8

4 years ago

2.4.7

4 years ago

2.4.6

4 years ago

2.4.5

4 years ago

2.4.4

4 years ago

2.4.3

4 years ago

2.4.2

4 years ago

2.4.1

4 years ago

2.3.1

4 years ago

2.4.0

4 years ago

2.3.0

4 years ago

2.2.0

4 years ago

2.0.5

4 years ago

2.1.0

4 years ago

2.0.4

4 years ago

2.0.2

4 years ago

1.0.0

4 years ago

2.0.0

4 years ago

1.1.0

4 years ago