Skip to content

About

Composable text motion primitives for React Native.

Resources

Code of conduct

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

28 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

React Native Text Motion

English | 한국어

React Native Motion Kit logo

Overview

@react-native-motion-kit/text-motion brings composable text animations to React Native with Reanimated. Build reusable animated components for short titles, labels, onboarding copy, and product copy by choosing how text is split, rendered, timed, and animated.

Key Features

  • Composable recipes — Combine splitting, layout, timelines, and effects with a typed API.
  • Word and character motion — Animate words or graphemes with nativeText(), including character-by-character typewriter() reveals.
  • Rendered-line reveals — Use overlayText() and lineReveal() to animate the lines React Native actually rendered.
  • Playback control — Trigger play/replay/reset/stop from events or drive progress with an external Reanimated shared value.
  • Accessibility — Read the whole phrase as one label, hide decorative tokens from screen readers, and respect reduced motion by default.
  • Ready-to-use presets — Start with a preset, then customize its recipe when needed.

Quick Start

Documentation

Full documentation · Installation · Quick start

Examples

AI

See Use with AI tools for documentation workflows.

Installation

pnpm add @react-native-motion-kit/text-motion react-native-reanimated react-native-worklets

The peer minimums are Reanimated 4.0.0 and Worklets 0.5.0. These minimums are not a complete native compatibility matrix. Follow the installation guide and official Reanimated setup for your React Native or Expo version. Reanimated 4 requires the New Architecture.

Basic Usage

Create a component from a preset and pass the text you want to animate:

import { editorialRise } from '@react-native-motion-kit/text-motion/presets';

// Create the reusable component outside render.
const HeroReveal = editorialRise().component();

export function HeroTitle() {
  return <HeroReveal>Design motion that feels native</HeroReveal>;
}

For custom motion, compose a recipe. stagger() uses seconds, and .component() requires a renderer selected with .layout(...).

import {
  defineTextMotion,
  fade,
  nativeText,
  rise,
  stagger,
  words,
} from '@react-native-motion-kit/text-motion';

const WordReveal = defineTextMotion()
  .split(words())
  .layout(nativeText())
  .timeline(stagger(0.04))
  .effect(fade().and(rise({ y: 12 })))
  .component();

Continue with the recipe API, renderers, and playback guide. Use either controls or external progress on an instance; they cannot be combined.

Scope

Designed for short UI text, this library does not replace every native Text feature. nativeText() animates source tokens; overlayText() animates actual rendered lines and must not use .split(...). The lines() splitter handles explicit \n characters only.

Measure long paragraphs and many animated rows on target devices. Browser demos are not native performance evidence. See performance guidance and accessibility.

Project direction

Discuss priorities and feature ideas in Project direction & roadmap.

Current priorities, deferred API candidates, and deliberate design boundaries are preserved in the project context and roadmap.

Development

This pnpm workspace contains the library, Expo example app, and bilingual Rspress documentation.

corepack pnpm install
corepack pnpm run lint
corepack pnpm run typecheck
corepack pnpm run test
corepack pnpm run build
corepack pnpm run docs:dev

Contributing guide · Documentation development · Package README · Releasing

License

MIT

About

Composable text motion primitives for React Native.

Resources

Code of conduct

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages