Skip to content

About

A drag-and-drop system for React Native

Resources

Code of conduct

Contributing

Stars

715 stars

Watchers

11 watching

Forks

Latest commit

 

History

462 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

react-native-drax

React Native CLI Expo CLI platforms GitHub top language CI GitHub license npm version

📚 Visit the official documentation

🎮 See the live example

📖 Overview

Drax is a declarative drag-and-drop framework for React Native, written in TypeScript. It supports free-form drag-and-drop, sortable lists and grids, cross-list reorder, drag handles, collision algorithms, and more.

Built on Reanimated 4 and Gesture Handler 3 with a UI-thread-first architecture for smooth 60fps interactions.

Platforms: iOS, Android, Web

✨ Highlights

  • 📋 List-agnostic sortable — works with FlatList, FlashList, LegendList, or any list component
  • 🔀 Cross-container drag — move items between lists (cross-list reorder)
  • ⚡ UI-thread hit-testing — spatial index worklet for fast receiver detection
  • ✊ Drag handles — only the handle starts a drag, the rest scrolls
  • 💥 Collision algorithms — center, intersect, or contain
  • 📐 Drag bounds — constrain drags within a view
  • 🎨 Hover styles — conditional styles based on drag phase and receiver state
  • 🚫 Drop zone acceptance — accept or reject drops with acceptsDrag
  • 🎬 Animation presets — default, spring, gentle, snappy, none — or custom config
  • 🧲 Snap alignment — snap to 9-point alignment within receivers
  • ♿ Accessibility — auto-generated labels, reduced motion support
  • 📡 19 callback events — full drag lifecycle control
  • 🏗️ New Architecture compatible (Fabric)

🤔 Why Drax?

Feature Drax reanimated-dnd sortables
Free-form drag & drop ✅ ✅ ➖
Sortable list / grid ✅ ✅ ✅
Mixed-size grid (non-uniform spans) ✅ ➖ ➖
Cross-container / cross-list reorder ⚠️ Experimental ➖ ➖
List-agnostic (FlatList, FlashList, LegendList) ✅ ➖ ➖
Drag handles ✅ ✅ ✅
Drag state styling 15 props + inactive onStateChange 5 props + hook
Drop indicator ✅ ➖ Grid only
UI-thread DnD collision ✅ ➖ ➖
Event callbacks 19 types ~12 types ~10 types
Accessibility + reduced motion ✅ Manual Manual
Web support ✅ ➖ Partial
Reanimated ≥ 4 ≥ 4.2 ≥ 3
Gesture Handler ≥ 2 ≥ 2.28 ≥ 2

See full comparison →

📦 Installation

npm install react-native-drax
# or
yarn add react-native-drax

🔗 Peer Dependencies

npm install react-native-reanimated react-native-gesture-handler
Peer Dependency Version
react >= 18
react-native >= 0.68
react-native-reanimated ^4.0.0
react-native-gesture-handler >= 2.0.0 (v3 recommended)

🚀 Quick Start

👋 Basic Drag-and-Drop

import { DraxProvider, DraxView } from 'react-native-drax';

function App() {
  return (
    <DraxProvider>
      <DraxView
        style={{ width: 100, height: 100, backgroundColor: 'blue' }}
        onDragStart={() => console.log('dragging')}
        payload="hello"
      />
      <DraxView
        style={{ width: 100, height: 100, backgroundColor: 'green' }}
        onReceiveDragDrop={({ dragged: { payload } }) => {
          console.log(`received: ${payload}`);
        }}
      />
    </DraxProvider>
  );
}

📋 Sortable List

The simplest way to make a reorderable list:

import { useState } from 'react';
import { Text, View } from 'react-native';
import { DraxProvider, DraxList } from 'react-native-drax';

function App() {
  const [items, setItems] = useState(['A', 'B', 'C', 'D', 'E']);

  return (
    <DraxProvider>
      <DraxList
        data={items}
        keyExtractor={(item) => item}
        onReorder={({ data }) => setItems(data)}
        renderItem={({ item }) => (
          <View style={{ padding: 16, backgroundColor: '#eee', margin: 4 }}>
            <Text>{item}</Text>
          </View>
        )}
      />
    </DraxProvider>
  );
}

DraxList is list-agnostic — pass any list component via the component prop:

import { FlashList } from '@shopify/flash-list';

<DraxList
  component={FlashList}
  data={items}
  keyExtractor={(item) => item.id}
  onReorder={({ data }) => setItems(data)}
  renderItem={({ item }) => <ItemCard item={item} />}
  estimatedItemSize={60}
/>

🧱 Composable API

For full control, use the composable primitives directly:

import {
  DraxProvider,
  useSortableList,
  SortableContainer,
  SortableItem,
} from 'react-native-drax';
import { FlatList } from 'react-native';

function App() {
  const [items, setItems] = useState(['A', 'B', 'C', 'D', 'E']);
  const listRef = useRef<FlatList>(null);

  const sortable = useSortableList({
    data: items,
    keyExtractor: (item) => item,
    onReorder: ({ data }) => setItems(data),
  });

  return (
    <DraxProvider>
      <SortableContainer sortable={sortable} scrollRef={listRef}>
        <FlatList
          ref={listRef}
          data={sortable.data}
          keyExtractor={sortable.stableKeyExtractor}
          onScroll={sortable.onScroll}
          onContentSizeChange={sortable.onContentSizeChange}
          renderItem={({ item, index }) => (
            <SortableItem sortable={sortable} index={index}>
              <Text>{item}</Text>
            </SortableItem>
          )}
        />
      </SortableContainer>
    </DraxProvider>
  );
}

This pattern works with any list component — FlatList, FlashList, LegendList, ScrollView, etc.

🎛 Features

✊ Drag Handles

Only the handle area starts a drag — the rest of the view scrolls normally:

import { DraxView, DraxHandle } from 'react-native-drax';

<DraxView dragHandle>
  <Text>This content scrolls normally</Text>
  <DraxHandle>
    <GripIcon />  {/* Only this starts a drag */}
  </DraxHandle>
</DraxView>

📐 Drag Bounds

Constrain a dragged view within a boundary:

const boundsRef = useRef<View>(null);

<View ref={boundsRef} style={{ flex: 1 }}>
  <DraxView dragBoundsRef={boundsRef}>
    <Text>I can only be dragged within the parent</Text>
  </DraxView>
</View>

💥 Collision Algorithms

Control how receiver detection works:

<DraxView collisionAlgorithm="center" />   {/* hover center inside receiver (default) */}
<DraxView collisionAlgorithm="intersect" /> {/* any overlap triggers receiving */}
<DraxView collisionAlgorithm="contain" />   {/* dragged view must be fully inside */}

🚫 Drop Zone Acceptance

Accept or reject drops conditionally:

<DraxView
  acceptsDrag={(draggedPayload) => items.length < 5}
  onReceiveDragDrop={({ dragged }) => addItem(dragged.payload)}
/>

🎨 Hover Styles

Style the hover layer based on drag state:

<DraxView
  hoverStyle={{ opacity: 0.8 }}
  hoverDraggingWithReceiverStyle={{ borderColor: 'green', borderWidth: 2 }}
  hoverDraggingWithoutReceiverStyle={{ opacity: 0.5 }}
  hoverDragReleasedStyle={{ opacity: 0.3 }}
/>

🧲 Snap Alignment

Snap dropped items to specific positions within a receiver:

import { snapToAlignment } from 'react-native-drax';

<DraxView
  onReceiveDragDrop={({ dragged, receiver }) =>
    snapToAlignment(receiver, dragged, 'top-left', { x: 8, y: 8 })
  }
/>

Alignments: center, top-left, top-center, top-right, center-left, center-right, bottom-left, bottom-center, bottom-right

🎬 Animation Presets

<DraxList animationConfig="spring" />  {/* spring physics */}
<DraxList animationConfig="gentle" />  {/* soft spring */}
<DraxList animationConfig="snappy" />  {/* fast spring */}
<DraxList animationConfig="none" />    {/* instant */}

{/* Or custom: */}
<DraxList animationConfig={{
  useSpring: true,
  springDamping: 15,
  springStiffness: 150,
  springMass: 1,
}} />

Device reduced motion settings are respected automatically.

📡 Continuous Drag Callbacks

<DraxView
  onDrag={(data) => { /* fires every frame while dragging over empty space */ }}
  onDragOver={(data) => { /* fires every frame while over the same receiver */ }}
/>

🔀 Cross-Container Sortable (Experimental)

Move items between lists (cross-list reorder):

import {
  useSortableBoard,
  SortableBoardContainer,
  useSortableList,
  SortableContainer,
  SortableItem,
} from 'react-native-drax';

const board = useSortableBoard({
  onTransfer: ({ fromColumnId, toColumnId, fromIndex, toIndex, item }) => {
    // Move item between columns
  },
});

<SortableBoardContainer board={board}>
  {columns.map((column) => (
    <Column key={column.id} board={board} column={column} />
  ))}
</SortableBoardContainer>

Note: Cross-container drag is experimental. The API may change in future versions.

🏷️ Namespace API

For convenience, all components are available under the Drax namespace:

import { Drax } from 'react-native-drax';

<Drax.Provider>
  <Drax.View draggable>
    <Drax.Handle><GripIcon /></Drax.Handle>
  </Drax.View>
</Drax.Provider>

🧩 Components

Component Description
DraxProvider Context provider — wrap your app's drag-and-drop area
DraxView Draggable and/or receptive view with 19 callback events
DraxList List-agnostic sortable list (convenience wrapper)
DraxHandle Drag handle — only this area starts a drag
DraxScrollView Scrollable container with auto-scroll during drag
SortableContainer Monitoring wrapper for composable sortable API
SortableItem Per-item wrapper with shift animation
SortableBoardContainer Cross-container board coordinator (experimental)

🪝 Hooks

Hook Description
useSortableList List-agnostic reorder state management
useSortableBoard Cross-container board coordinator (experimental)
useDraxContext Access the Drax context
useDraxId Generate a unique Drax view ID

💡 Examples

The example/ directory contains an Expo Router app with 11 screens demonstrating all features:

Screen Features shown
Color Drag & Drop Drop acceptance, hover styles, snap alignment
Reorderable List DraxList, animation presets, auto-scroll
Reorderable Grid Sortable grid with multi-column layout
Mixed-Size Grid Items with different spans (1×1, 2×2, etc.) using getItemSpan and packGrid
Drag Handles Only the grip icon starts a drag
Drag Bounds Constrain drag within a view
Collision Modes Center vs Intersect vs Contain
Cross-List Reorder FlashList + LegendList + FlatList cross-container drag (experimental)
Knight Moves Chess knight drag puzzle
Scrolling Drag from scroll view to drop zone
Stress Test 100 items in a sortable list

To run the example app:

cd example && yarn start

🔄 Migration from v0.x

v1.0.0 is a complete rewrite. Key changes:

  • DraxList is new — list-agnostic convenience wrapper using the new sortable architecture. The old DraxList / DraxListItem API from v0.10.x and v0.11.0-alpha is removed.
  • New sortable architecture — useSortableList + SortableContainer + SortableItem composable API replaces the old array-indexed approach.
  • Reanimated 4 + Gesture Handler 3 — required peer dependencies (Gesture Handler v2 supported via compat layer with reduced performance).
  • New Architecture (Fabric) compatible.

📋 Changelog

See CHANGELOG.md for a full list of changes.

🤝 Contributing

Issues, pull requests, and discussion are all welcome. See the Contribution Guidelines for details.

📜 Code of Conduct

This project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

🏆 Contributors

Originally created by Joe Lafiosca. v1.0.0 rewrite led by Ovidiu Cristescu.

Thanks to all contributors who have helped make Drax better:

Joe Lafiosca
Joe Lafiosca

💻 📖 💡 🚧 🚇
Ovidiu Cristescu
Ovidiu Cristescu

💻 📖 💡 🚧
François Dupayrat
François Dupayrat

💻
Josh Arnold
Josh Arnold

💻
Rahul Nallappa
Rahul Nallappa

💻
negue
negue

📖
Chris Drackett
Chris Drackett

💻
Matti Salokangas
Matti Salokangas

💻
Andres Garcia
Andres Garcia

💻

📃 License

MIT


Built and maintained using OpenKit.

About

A drag-and-drop system for React Native

Resources

Code of conduct

Contributing

Stars

715 stars

Watchers

11 watching

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages