Skip to content

feat: react-native-reanimated as peer dependency #4912

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wonderlul wants to merge 1 commit into
base: v6
Choose a base branch
from
Open

feat: react-native-reanimated as peer dependency #4912

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions babel.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
module.exports = {
presets: ['module:@react-native/babel-preset'],
plugins: ['react-native-worklets/plugin'],
};
10 changes: 10 additions & 0 deletions docs/docs/guides/01-getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,16 @@ npm install react-native-paper
npm install react-native-safe-area-context
```

- You also need to install [react-native-reanimated](https://docs.swmansion.com/react-native-reanimated/) and [react-native-worklets](https://docs.swmansion.com/react-native-worklets/) for animations.

```bash npm2yarn
npm install react-native-reanimated react-native-worklets
```

:::note
If you're using a bare React Native project (not Expo), you need to add `react-native-worklets/plugin` to your `babel.config.js` plugins array. See the [Reanimated installation guide](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/getting-started/) for details.
Copy link
Copy Markdown
Collaborator

@adrcotfas adrcotfas May 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A comment from Claude:

Two problems with the original wording.

Structural: the plugin instruction was inside a :::note block, which reads as "supplemental info you can skip." But this plugin is mandatory; without it, worklets fails at runtime with confusing errors. Required setup belongs in the install steps, not in a sidebar.

Factual: the original implied Expo users skip this. Reanimated v4 / worklets v0.8 require the babel plugin regardless of toolchain. The safe wording is "required for both Expo and bare React Native" rather than guessing per setup.

:::

Additionaly for `iOS` platform there is a requirement to link the native parts of the library:

```bash
Expand Down
1 change: 1 addition & 0 deletions jestSetupAfterEnv.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
require('react-native-reanimated').setUpTests();
Copy link
Copy Markdown
Collaborator

@adrcotfas adrcotfas May 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest converting to ESM with a named import so this file matches testSetup.js (the sibling jest setup file already uses import):

 import { setUpTests } from 'react-native-reanimated';                                                                                                                                            
                                                       
 setUpTests();

7 changes: 6 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,9 @@
"react-dom": "18.3.1",
"react-native": "0.82.1",
"react-native-builder-bob": "^0.21.3",
"react-native-reanimated": "^4.3.0",
"react-native-safe-area-context": "5.5.2",
"react-native-worklets": "^0.8.1",
"react-test-renderer": "19.1.1",
"release-it": "^13.4.0",
"rimraf": "^3.0.2",
Expand All @@ -105,7 +107,9 @@
"peerDependencies": {
"react": "*",
"react-native": "*",
"react-native-safe-area-context": "*"
"react-native-reanimated": ">=4.3.0",
"react-native-safe-area-context": "*",
"react-native-worklets": ">=0.8.1"
Copy link
Copy Markdown
Collaborator

@adrcotfas adrcotfas May 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a comment, not necessarily requesting changes as I'm not sure about best practices for devDependencies vs peerDependencies but reanimated 4.3.0's own peer dep is react-native-worklets: 0.8.x. This would allow react-native-worklets: 0.9.0 even though reanimated would reject it.

},
"husky": {
"hooks": {
Expand All @@ -119,6 +123,7 @@
"<rootDir>/testSetup.js"
],
"setupFilesAfterEnv": [
"<rootDir>/jestSetupAfterEnv.js",
"@testing-library/jest-native/extend-expect"
],
"cacheDirectory": "./cache/jest",
Expand Down
4 changes: 4 additions & 0 deletions testSetup.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ jest.useFakeTimers();

jest.mock('react-native-safe-area-context', () => mockSafeAreaContext);

jest.mock('react-native-worklets', () =>
require('react-native-worklets/src/mock')
Copy link
Copy Markdown
Collaborator

@adrcotfas adrcotfas May 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest react-native-worklets/lib/module/mock instead like reanimated uses too in their source code. It's the same artifact runtime code uses, so it doesn't depend on a working TS transform pipeline at test time.

);

jest.mock('@react-native-vector-icons/material-design-icons', () => {
const React = require('react');
const { Text } = require('react-native');
Expand Down
63 changes: 62 additions & 1 deletion yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1972,7 +1972,7 @@ __metadata:
languageName: node
linkType: hard

"@babel/preset-typescript@npm:^7.12.1, @babel/preset-typescript@npm:^7.16.7, @babel/preset-typescript@npm:^7.17.12, @babel/preset-typescript@npm:^7.18.6, @babel/preset-typescript@npm:^7.23.0":
"@babel/preset-typescript@npm:^7.12.1, @babel/preset-typescript@npm:^7.16.7, @babel/preset-typescript@npm:^7.17.12, @babel/preset-typescript@npm:^7.18.6, @babel/preset-typescript@npm:^7.23.0, @babel/preset-typescript@npm:^7.27.1":
version: 7.28.5
resolution: "@babel/preset-typescript@npm:7.28.5"
dependencies:
Expand Down Expand Up @@ -20025,6 +20025,16 @@ __metadata:
languageName: node
linkType: hard

"react-native-is-edge-to-edge@npm:^1.3.1":
version: 1.3.1
resolution: "react-native-is-edge-to-edge@npm:1.3.1"
peerDependencies:
react: "*"
react-native: "*"
checksum: 10c0/28cebd5f1f3632864ff5e342278721d1e5e38627ae73859a8814012116ef15c629fee7137a6c9c97bb05d94bbe639b0b47e69b36fc2735ab53ed31570140663f
languageName: node
linkType: hard

"react-native-monorepo-config@npm:^0.1.6":
version: 0.1.10
resolution: "react-native-monorepo-config@npm:0.1.10"
Expand Down Expand Up @@ -20120,7 +20130,9 @@ __metadata:
react-dom: "npm:18.3.1"
react-native: "npm:0.82.1"
react-native-builder-bob: "npm:^0.21.3"
react-native-reanimated: "npm:^4.3.0"
react-native-safe-area-context: "npm:5.5.2"
react-native-worklets: "npm:^0.8.1"
react-test-renderer: "npm:19.1.1"
release-it: "npm:^13.4.0"
rimraf: "npm:^3.0.2"
Expand All @@ -20129,10 +20141,26 @@ __metadata:
peerDependencies:
react: "*"
react-native: "*"
react-native-reanimated: ">=4.3.0"
react-native-safe-area-context: "*"
react-native-worklets: ">=0.8.1"
languageName: unknown
linkType: soft

"react-native-reanimated@npm:^4.3.0":
version: 4.3.0
resolution: "react-native-reanimated@npm:4.3.0"
dependencies:
react-native-is-edge-to-edge: "npm:^1.3.1"
semver: "npm:^7.7.3"
peerDependencies:
react: "*"
react-native: 0.81 - 0.85
react-native-worklets: 0.8.x
checksum: 10c0/e882660f8876b5571b4cb6fe99cbf123f7329e1282376cd92fb4b45991a765aa364b295781acea2658bee1b0196ea122b624be63b3a906c06a72c2a67ab56486
languageName: node
linkType: hard

"react-native-reanimated@npm:~4.1.1":
version: 4.1.6
resolution: "react-native-reanimated@npm:4.1.6"
Expand Down Expand Up @@ -20252,6 +20280,30 @@ __metadata:
languageName: node
linkType: hard

"react-native-worklets@npm:^0.8.1":
version: 0.8.1
resolution: "react-native-worklets@npm:0.8.1"
dependencies:
"@babel/plugin-transform-arrow-functions": "npm:^7.27.1"
"@babel/plugin-transform-class-properties": "npm:^7.27.1"
"@babel/plugin-transform-classes": "npm:^7.28.4"
"@babel/plugin-transform-nullish-coalescing-operator": "npm:^7.27.1"
"@babel/plugin-transform-optional-chaining": "npm:^7.27.1"
"@babel/plugin-transform-shorthand-properties": "npm:^7.27.1"
"@babel/plugin-transform-template-literals": "npm:^7.27.1"
"@babel/plugin-transform-unicode-regex": "npm:^7.27.1"
"@babel/preset-typescript": "npm:^7.27.1"
convert-source-map: "npm:^2.0.0"
semver: "npm:^7.7.3"
peerDependencies:
"@babel/core": "*"
"@react-native/metro-config": "*"
react: "*"
react-native: 0.81 - 0.85
checksum: 10c0/a82edbd65b09a31d973497dac899adcd618677b56f7e5c460fd9f3b1b4ef1547b7bfd2edaa644d1ebf866bf70658bdbd1314c9d0ab2856e98c6975d0e97fd449
languageName: node
linkType: hard

"react-native@npm:0.81.4":
version: 0.81.4
resolution: "react-native@npm:0.81.4"
Expand Down Expand Up @@ -21701,6 +21753,15 @@ __metadata:
languageName: node
linkType: hard

"semver@npm:^7.7.3":
version: 7.7.4
resolution: "semver@npm:7.7.4"
bin:
semver: bin/semver.js
checksum: 10c0/5215ad0234e2845d4ea5bb9d836d42b03499546ddafb12075566899fc617f68794bb6f146076b6881d755de17d6c6cc73372555879ec7dce2c2feee947866ad2
languageName: node
linkType: hard

"semver@npm:~7.5.4":
version: 7.5.4
resolution: "semver@npm:7.5.4"
Expand Down
Loading