react-native-reanimated README

The project's README from github.com/software-mansion/react-native-reanimated. As one markdown file: README.md.

React Native Reanimated and React Native Worklets by Software Mansion

Ad Ad Ad

Reanimated & Worklets

This repository contains two main packages:

Create smooth animations with an excellent developer experience.

Reanimated 4 is here! Check out our documentation page for more information

Nightly CI state

Main branch build NPM Reanimated publish [Nightly] NPM Worklets publish [Nightly] Reanimated + Worklets compatibility check Reanimated compatibility check Use frameworks Reanimated build check [Nightly] React Native nightly Reanimated build check Expo DevClient build check Reanimated TypeScript compatibility test Windows hosted app Reanimated build check URL validation Runtime tests nightly Runtime tests sanitizers nightly

Installation

Check out the detailed installation instructions for Reanimated and instructions for Worklets on their dedicated documentation pages.

Compatibility

Reanimated 4.x and Worklets support only the New React Native architecture 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:

Examples

The source code for the example (showcase) app is under the 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 for installation instructions.

License

Reanimated and Worklets libraries are licensed under The MIT License.

Community Discord

Join the Software Mansion Community Discord to chat about Reanimated, Worklets or other Software Mansion libraries.

Reanimated and Worklets are created by Software Mansion

Since 2012 Software Mansion 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.

react-native-reanimated (software-mansion/react-native-reanimated)

Searching Database…

What is this?React Native Reanimated is a library for building smooth, performant animations and gesture-driven interactions in React Native, re-implementing the Animated API with a modern approach. The repo also contains React Native Worklets, the companion library that enables multi-threaded JavaScript execution.
Is this a standalone app or a library I add to my React Native project?It's a library (actually two packages, Reanimated and Worklets) that you install into an existing React Native project, not a standalone app.
How do I add it to a React Native project?Follow the dedicated installation instructions on the Reanimated and Worklets documentation pages; there's no single inline command in the README itself.
Does it require the New Architecture or can I use the old one?Reanimated 4.x and Worklets only support React Native's New Architecture and the three latest RN versions; apps still on the old architecture need to stay on the 3.x release.
What if my app hasn't migrated to the New Architecture yet?You're limited to the older Reanimated 3.x line, since 4.x and Worklets drop support for the old architecture entirely.
Does it work on both iOS and Android?Yes, it's a cross-platform React Native library and ships CI validation jobs for both Android and Apple (iOS) builds.
How do I try it without adding it to a real app?There's a showcase example app under apps/common-app in the repo, which you can run to explore the API without integrating it into a production project.
What is React Native Worklets exactly?Worklets is the sibling package that lets you run JavaScript functions on separate threads inside a React Native app, which Reanimated relies on for its multi-threaded animations.
Size
835.4 MB
Stars
11K
Age
8y
Commits · 90 Days