react-native-worklets-core

(★ 788)

🧵 A library to run JS functions ("Worklets") on separate Threads

File Explorer

Download Latest Version (.zip)

- - build-android.yml
  - build-ios.yml
  - ci.yml
- build.gradle
- CMakeLists.txt
- cpp-adapter.cpp
- fix-prefab.gradle
- gradle.properties
- - WKTJsiHostObject.cpp
  - WKTJsiHostObject.h
  - WKTRuntimeAwareCache.h
  - WKTRuntimeLifecycleMonitor.cpp
  - WKTRuntimeLifecycleMonitor.h
- - WKTJsiConsoleDecorator.h
  - WKTJsiJsDecorator.h
  - WKTJsiPerformanceDecorator.h
  - WKTJsiSetImmediateDecorator.h
- - WKTDispatchQueue.cpp
  - WKTDispatchQueue.h
- - WKTJsiSharedValue.h
- - WKTArgumentsWrapper.h
  - WKTJsiArrayWrapper.h
  - WKTJsiObjectWrapper.h
  - WKTJsiPromiseWrapper.cpp
  - WKTJsiPromiseWrapper.h
  - WKTJsiWrapper.cpp
  - WKTJsiWrapper.h
- WKTJsiBaseDecorator.h
- WKTJsiDispatcher.h
- WKTJsiWorklet.h
- WKTJsiWorkletApi.cpp
- WKTJsiWorkletApi.h
- WKTJsiWorkletContext.cpp
- WKTJsiWorkletContext.h
- WKTJsRuntimeFactory.h
- USAGE.md
- WORKLETS.md
- - config
- - build.gradle
  - gradle.properties
  - gradlew
  - gradlew.bat
  - settings.gradle
- - .xcode.env
  - Podfile
  - Podfile.lock
- - App.tsx
- - index.ts
  - sharedvalue-tests.ts
  - tests.ts
  - TestWrapper.tsx
  - types.ts
  - useTestRunner.ts
  - useTests.ts
  - utils.ts
  - worklet-context-tests.ts
  - worklet-tests.ts
  - wrapper-tests.ts
- .node-version
- .ruby-version
- .watchmanconfig
- app.json
- babel.config.js
- Gemfile
- Gemfile.lock
- index.js
- metro.config.js
- package.json
- react-native.config.js
- yarn.lock
- banner.svg
- - project.pbxproj
- Worklets.h
- Worklets.mm
- bootstrap.js
- - useRunOnJS.ts
  - useSharedValue.ts
  - useWorklet.ts
- - index.js
- index.ts
- NativeWorklets.ts
- types.ts
- worklet.ts
.editorconfig
.eslintignore
.eslintrc.js
.gitattributes
.gitignore
.prettierrc
.watchmanconfig
.yarnrc
babel.config.js
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE
package.json
plugin.js
react-native-worklets-core.podspec
README.md
tsconfig.build.json
tsconfig.json
yarn.lock

# Installation Guide

1. Get the code

git clone https://github.com/margelo/react-native-worklets-core

Downloads the entire project code from GitHub to your computer.

cd react-native-worklets-core

Moves into the project folder you just downloaded.

2. CMake

Medium Recommended

Prerequisites

Git Needed to download the project code from GitHub.
CMake The tool used to generate build configuration.
C/C++ 컴파일러 Windows needs Visual Studio (Community edition, free), macOS needs Xcode Command Line Tools, Linux needs the gcc/g++ package.

cd android

This project's files live in a subfolder, so move into it first.

mkdir build && cd build

Creates a folder to hold the build output and moves into it.

cmake ..

Analyzes the source code and generates build configuration files (must be run inside the build folder).

make

Compiles the code based on the generated build configuration to produce an executable.

✅ Check that an executable was created inside the build folder, then run it directly (e.g. ./build/app_name).

3. Gradle (Java/Kotlin)

Medium

Prerequisites

Git Needed to download the project code from GitHub.
JDK (Java) Required to build and run Java/Kotlin projects.
Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.

cd android

This project's files live in a subfolder, so move into it first.

./gradlew build

Builds the project using Gradle.

✅ A BUILD SUCCESSFUL message means it worked. The output is created under build/.

4. Node.js

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

yarn add react-native-worklets-core

Type this command into your terminal and run it.

yarn start --reset-cache

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.