# React Native Swipe Deck

> High-performance Tinder-style swipe deck documentation for React Native apps.

## Guide

- [Overview](/guide/getting-started/overview.md): @react-native-motion-kit/swipe-deck is a high-performance Tinder-style swipe deck for React Native. It is built for apps that need a smooth card stack, programmatic like/pass buttons, progress-driven overlays, and a typed API that does not make every screen wire a controller by hand.
- [Installation](/guide/getting-started/installation.md): Install the package and its React Native gesture/animation peer dependencies: You can use your package manager of choice. For Yarn:
- [Quick Start](/guide/getting-started/quick-start.md): Create one typed deck family for your item type. Root, Card, hooks, actions, and events from that factory share the same registry namespace.
- [AI Usage Guide](/guide/getting-started/ai.md): When generating code with an AI assistant, give it these rules. They prevent the most common integration mistakes.
- [Basic Usage](/guide/usage/basic-usage.md): Learn when to use the factory API, Card render info, allowed directions, and the static SwipeDeck API.
- [Deck Hooks](/guide/usage/deck-hooks.md): Factory hooks expose deck state, actions, and interaction values without a provider prop or controller object.
- [Handling Events](/guide/usage/handling-events.md): Event hooks describe committed model events. They are separate from live interaction values.
- [Programmatic Actions](/guide/usage/programmatic-actions.md): Programmatic actions come from useDeckActions(). Use them for buttons, external controls, or any app logic that should dismiss the active card.
- [Undo](/guide/usage/undo.md): Undo is opt-in. Add undoEnabled to a Root when the deck exposes undo or back-swipe UX. When enabled, each successful swipe stores one key/index/direction metadata entry in a LIFO undo stack. Lookups use a key-to-index map for the current data, and invalid entries are pruned when data or keys change. When omitted, successful swipes do not store undo metadata, canUndo stays false, and actions.undo() returns false.
- [Motion](/guide/usage/motion.md): SwipeDeckMotion.tinder() is the built-in motion preset for Tinder-style card stacks.
- [Multi-Instance Management](/guide/usage/multi-instance-management.md): Use id only when you render multiple roots from the same factory. id is a factory-scoped deck namespace, not an item key. Two different factories can both use the default id safely, but two mounted roots from the same factory and same id are invalid.
- [Visible Card Budget](/guide/usage/visible-card-budget.md): visibleCardCount controls the maximum number of cards kept mounted from the active card forward.
- [API Reference](/guide/usage/api-reference.md): Reference the main exports, Root and Card props, hooks, events, and built-in motion helpers.