Skip to main content

Introduction

React Native Lumen is a high-performance, fully customizable app tour library for React Native, powered by Reanimated 3.

npm version

Features

  • High Performance — Built with react-native-reanimated worklets for 60fps animations.
  • 🎨 Fully Customizable — Custom renderers for tooltips, customizable shapes, and backdrops.
  • 🌟 Glow Effects — Beautiful, customizable glow effects around your highlighted elements.
  • 📱 Expo Compatible — Works seamlessly with Expo and bare React Native projects.
  • 🤸 Smooth Transitions — Fluid morphing animations between steps.
  • Animation Presets — Ships with bouncy, gentle, and snappy spring presets.
  • 📜 Auto Scrolling — Automatically scrolls to off-screen steps.
  • 👆 Interaction Control — Choose to block or allow interactions with the underlying app.
  • 🔒 Step Enforcement — Gate step progression with required and completed props.
  • 📱 Multi-Screen Tours — Seamlessly run tours across multiple screens/tabs.

Requirements

PackageVersion
react-native>= 0.70.0
react-native-reanimated>= 3.0.0
react-native-svg>= 12.0.0
react-native-gesture-handler>= 2.0.0