Installation

Install the library

npm

npm install react-native-header-motion

yarn

yarn add react-native-header-motion

pnpm

pnpm add react-native-header-motion

bun

bun add react-native-header-motion

Peer dependencies

Header Motion relies on three peer dependencies that your project must provide:

Package	Required version
react-native-reanimated	^4.0.0
react-native-gesture-handler	^2.0.0
react-native-worklets	>= 0.4.0

If you already have these installed, you're good to go. Otherwise, follow their respective installation guides:

• Reanimated & Worklets installation
• Gesture Handler installation

caution

Make sure the version of react-native-worklets you install is compatible with your version of Reanimated. Check the compatibility table before installing.

Version notes

• If you are upgrading from v0.3.x, read the Migration from v0 guide.
• For the old v0 docs, see the README on the v0 branch.

What's next?

With everything installed, head to the Quick Start to build your first animated header.