Getting started

What is React Native Worklets?

React Native Worklets is a library that allows you to run JavaScript code in parallel on multiple threads and runtimes.

Installation

Step 1: Install the package

Install react-native-worklets package from npm:

NPM

npm install react-native-worklets

YARN

yarn add react-native-worklets

Step 2: Configure your project

The remaining steps depend on how you build your app — pick your framework:

Expo

Run prebuild to update the native code in the ios and android directories.

NPM

npx expo prebuild

YARN

yarn expo prebuild

And that's it! Worklets library is now configured in your Expo project.

Don't I need the Worklets babel plugin?

Since Expo SDK 54, the Expo starter template includes the Worklets babel plugin by default, so there's nothing to add. On older SDKs, add react-native-worklets/plugin to your babel.config.js as described in the React Native Community CLI tab.

To learn more about the plugin go to Worklets babel plugin section.

Clear Metro bundler cache (recommended)

NPM

npx expo start --clear

YARN

yarn expo start --clear

React Native Community CLI

When using React Native Community CLI, you need to manually add the react-native-worklets/plugin plugin to your babel.config.js.

module.exports = {
  presets: [
    ... // don't add it here :)
  ],
  plugins: [
    ...
    'react-native-worklets/plugin',
  ],
};

Worklets Babel plugin comes with several options, you can explore what they are and how to use them in the Options for Worklets Babel Plugin section.

Why do I need this?

In short, the Worklets babel plugin automatically converts special JavaScript functions (called worklets) to allow them to be passed and run on the Worklet Runtimes

To learn more about the plugin go to Worklets babel plugin section.

iOS

While developing for iOS, make sure to install pods first before running the app:

cd ios && pod install && cd ..

Clear Metro bundler cache (recommended)

NPM

npm start -- --reset-cache

YARN

yarn start --reset-cache