## 1. Project Overview & Quickstart (software-mansion/react-native-reanimated)

[](https://swm-delivery.com/www/delivery/ck-slug.php?zoneid=zone-gh-react-native-reanimated-1\&n=1)
[](https://swm-delivery.com/www/delivery/ck-slug.php?zoneid=zone-gh-react-native-reanimated-2\&n=1)
[](https://swm-delivery.com/www/delivery/ck-slug.php?zoneid=zone-gh-react-native-reanimated-3\&n=1)

# Reanimated & Worklets

This repository contains two main packages:

- [React Native Reanimated](/packages/react-native-reanimated) — a library for creating smooth animations and interactions in React Native,
- [React Native Worklets](/packages/react-native-worklets) — a library that enables multi-threaded JavaScript execution in React Native applications.

### Create smooth animations with an excellent developer experience.

> Reanimated 4 is here! Check out our [documentation page](https://docs.swmansion.com/react-native-reanimated/) for more information

## Nightly CI state

[](https://github.com/software-mansion/react-native-reanimated/actions/workflows/main-branch-build.yml)
[](https://github.com/software-mansion/react-native-reanimated/actions/workflows/npm-reanimated-publish.yml)
[](https://github.com/software-mansion/react-native-reanimated/actions/workflows/npm-worklets-publish.yml)
[](https://github.com/software-mansion/react-native-reanimated/actions/workflows/reanimated-worklets-compatibility-check.yml)
[](https://github.com/software-mansion/react-native-reanimated/actions/workflows/reanimated-compatibility-check-nightly.yml)
[](https://github.com/software-mansion/react-native-reanimated/actions/workflows/use-frameworks-reanimated-build-check-nightly.yml)
[](https://github.com/software-mansion/react-native-reanimated/actions/workflows/react-native-nightly-reanimated-build-check-nightly.yml)
[](https://github.com/software-mansion/react-native-reanimated/actions/workflows/expo-devclient-build-check-nightly.yml)
[](https://github.com/software-mansion/react-native-reanimated/actions/workflows/reanimated-typescript-compatibility-test-nightly.yml)
[](https://github.com/software-mansion/react-native-reanimated/actions/workflows/windows-hosted-app-reanimated-build-check-nightly.yml)
[](https://github.com/software-mansion/react-native-reanimated/actions/workflows/url-validation-nightly.yml)
[](https://github.com/software-mansion/react-native-reanimated/actions/workflows/runtime-tests-nightly.yml)
[](https://github.com/software-mansion/react-native-reanimated/actions/workflows/runtime-tests-sanitizers-nightly.yml)

## Installation

Check out the detailed installation [instructions for Reanimated](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/getting-started/#installation) and [instructions for Worklets](https://docs.swmansion.com/react-native-worklets/docs/fundamentals/getting-started/#installation) on their dedicated documentation pages.

## Compatibility

Reanimated 4.x and Worklets support only the [New React Native architecture](https://reactnative.dev/architecture/landing-page) and three latest React Native versions.

If your app still runs on the old architecture, please consider adopting the New Architecture or stay with latest 3.x release.

## Documentation

You can find more information about Reanimated and Worklets, their API references and more in their dedicated documentation pages:

- Reanimated — [https://docs.swmansion.com/react-native-reanimated/](https://docs.swmansion.com/react-native-reanimated/)
- Worklets — [https://docs.swmansion.com/react-native-worklets/](https://docs.swmansion.com/react-native-worklets/)

## Examples

The source code for the example (showcase) app is under the [`apps/common-app`](https://github.com/software-mansion/react-native-reanimated/blob/main/apps/common-app/) directory.
If you want to play with the API but don't feel like trying it on a real app, you can run the example project. Check [Example README](apps/fabric-example/README.md) for installation instructions.

## License

Reanimated and Worklets libraries are licensed under [The MIT License](LICENSE).

## Community Discord

[Join the Software Mansion Community Discord](https://discord.swmansion.com) to chat about Reanimated, Worklets or other Software Mansion libraries.

## Reanimated and Worklets are created by Software Mansion

Since 2012 [Software Mansion](https://swmansion.com) is a software agency with experience in building web and mobile apps. We are Core React Native Contributors and experts in dealing with all kinds of React Native issues. We can help you build your next dream product – [Hire us](https://swmansion.com/contact/projects?utm_source=reanimated\&utm_medium=readme).

## 2. Official Technical Reference & Guides (software-mansion/software-mansion.github.io)

# Software Mansion open source documentation

> Documentation for the libraries and tools built and maintained by Software Mansion (https://swmansion.com).

Each project below is a separate documentation site served from this domain. Where a project publishes its own llms.txt, it sits at /llms.txt.

## React Native

- [React Native Reanimated](https://docs.swmansion.com/react-native-reanimated/): A powerful animation library that makes it easy to create smooth animations and interactions that run in the UI thread.
- [React Native Gesture Handler](https://docs.swmansion.com/react-native-gesture-handler/): Declarative API exposing platform native touch and gesture system to React Native.
- [React Native Screens](https://docs.swmansion.com/react-native-screens/): Native Navigation primitives for your React Native app.
- [React Native Audio API](https://docs.swmansion.com/react-native-audio-api/): React Native Audio API is a library that lets you build powerful audio features in your app – from real-time effects and visualization to multi-track playback
- [React Native Enriched HTML](https://docs.swmansion.com/react-native-enriched-html/)
- [React Native WHIP/WHEP](https://docs.swmansion.com/react-native-whip-whep/): Documentation for react-native-whip-whep
- [npx setup-ci](https://docs.swmansion.com/setup-ci/): Quickly bootstrap CI for your React Native app

## Cairo and Starknet

- [Scarb](https://docs.swmansion.com/scarb/): Scarb is a build toolchain and package manager for Cairo and Starknet ecosystems.
- [Cairo Language Server](https://docs.swmansion.com/cairols/): Cairo Language Server is an implementation of Language Server Protocol for the Cairo language.
- [Cairo lint](https://docs.swmansion.com/cairo-lint/): Cairo lint is a static code analyzer tool for Cairo language.
- [Cairo Debugger](https://docs.swmansion.com/cairo-debugger/): Cairo Debugger is an implementation of Debug Adapter Protocol for the Cairo language.
- [Protostar](https://docs.swmansion.com/protostar/): Protostar manages your dependencies, compiles your project, and runs test.
- [starknet-jvm](https://docs.swmansion.com/starknet-jvm/)
- [starknet.swift](https://docs.swmansion.com/starknet.swift/)

## Elixir

- [LiveDebugger](https://docs.swmansion.com/live-debugger/): A must-have tool for Elixir developers. See your LiveComponents tree, inspect assigns, trace and filter callback executions, and more.

## Kotlin Multiplatform

- [KMP Maps](https://docs.swmansion.com/kmp-maps/)
- [KMP Sharing](https://docs.swmansion.com/kmp-sharing/)

## Apple platforms

- [Pulsar](https://docs.swmansion.com/pulsar/): Pulsar is an open-source library that offers ready-to-use haptic presets. With it, you can add haptics to your Kotlin, Swift, or React Native app in minutes.

## Web and GPU

- [TypeGPU](https://docs.swmansion.com/TypeGPU/)
- [byegl](https://docs.swmansion.com/byegl/)
- [tsover](https://docs.swmansion.com/tsover/)

## Other

- [Ma’at](https://docs.swmansion.com/maat/)

## About

- [Software Mansion](https://swmansion.com): the company behind these projects
- [Site map for swmansion.com](https://swmansion.com/llms.txt)