react-native-hooks

@dji-dev/react-native-hooks

Useful React Native hooks.

Installing

yarn add -D @dji-dev/react-native-hooks

Using yarn is highly recommended but not required.

License

Copyright 2020 DJI Technology LLC.

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

API

Table of Contents

• useOffline
• useTimeoutValue
  • Parameters
• useAppState
  • Parameters
• useImageSize
  • Parameters
• useOriginTranslateY
  • Parameters
• useScrollY

useOffline

packages/react-native-hooks/lib/useOffline.ts:9-16

React Hook that returns if the device is currently offline.

If the network is not yet ready to query, returns true to prevent UI glitches.

Returns boolean

useTimeoutValue

packages/react-native-hooks/lib/useTimeoutValue.ts:9-23

React Hook that returns a Reanimated value. This value is initially 0, then next idle after {@param duration} (uses setTimeout) changes to 1 on the JS thread.

Parameters

• duration number

Returns Animated.Value<(0 | 1)>

useAppState

packages/react-native-hooks/lib/useAppState.ts:10-26

React Hook that will call whenever the AppState changes.

Parameters

• callback function (): any

Meta

• author: Jiuyi Zhang <[email protected]>

useImageSize

packages/react-native-hooks/lib/useImageSize.ts:10-46

React Hook that returns the size of the given {@param image} using Image.getSize.

Parameters

• image string

Returns {width: number, height: number}

Meta

• author: Jiuyi Zhang <[email protected]>

useOriginTranslateY

packages/react-native-hooks/lib/useOriginTranslateY.ts:12-16

React Native does not support transform-origin, so we need to fake it by controlling the translateY.

Intended functionality: origin of scale is the top-center.

Parameters

• height number
• scale Animated.Node<number>

useScrollY

packages/react-native-hooks/lib/useScrollY.ts:13-34

This function is a hook-version of this tutorial for react-native-reanimated: https://callstack.com/blog/reanimating-your-react-native-experience/

Returns ScrollYHook