react-native-sortable-dynamic

react-native-sortable-dynamic is a highly customizable, drag-and-drop library for creating sortable grid and list layouts in React Native. It provides smooth animations and supports reordering items in a dynamic, flexible layout. Ideal for creating dashboards, photo galleries, task boards, and more, with easy-to-use configuration options for both grid and list layouts.

Features

• 🖱️ Drag-and-drop: Easily reorder grid and list items using intuitive gestures.
• 🖼️ Grid & List Support: Configurable for both grid and list views.
• 🧩 Flexible Layout: Customize columns, margins, and item sizes to fit your needs.
• 🛠️ Editable Mode: Toggle between editing and non-editing modes to enable/disable reordering.
• ⚡ Smooth Animations: Built using react-native-reanimated for seamless and performant animations.
• 🔐 Lock Items: Mark specific items as non-reorderable or non-draggable.
• 🧩 Dynamic Layout Configuration: Easily switch between grid and list views by configuring the layout dynamically.

Installation

Step 1: Install the package

npm install react-native-sortable-dynamic

or

yarn add react-native-sortable-dynamic

Step 2: Install dependencies

You'll also need to install dependencies like react-native-reanimated and react-native-gesture-handler if you haven't already:

npm install react-native-reanimated react-native-gesture-handler

or

yarn add react-native-reanimated react-native-gesture-handler

Step 3: Additional setup

1. Reanimated Setup: Follow the react-native-reanimated installation guide to properly set up react-native-reanimated. This includes updating the babel.config.js file:

   // babel.config.js
   module.exports = {
     presets: ['module:metro-react-native-babel-preset'],
     plugins: [
       'react-native-reanimated/plugin', // Add this line
     ],
   };

2. Gesture Handler Setup: Follow the react-native-gesture-handler installation guide to set up react-native-gesture-handler correctly.

3. Android Specific Configuration:

   • If you're using this library on Android, make sure to wrap the root component with GestureHandlerRootView.
   • Update MainActivity.java to enable gesture handling:

   import com.facebook.react.ReactActivity;
   import com.facebook.react.ReactActivityDelegate;
   import com.facebook.react.ReactRootView;
   import com.swmansion.gesturehandler.react.RNGestureHandlerEnabledRootView; // Add this import
   
   public class MainActivity extends ReactActivity {
     @Override
     protected ReactActivityDelegate createReactActivityDelegate() {
       return new ReactActivityDelegate(this, getMainComponentName()) {
         @Override
         protected ReactRootView createRootView() {
           return new RNGestureHandlerEnabledRootView(MainActivity.this); // Modify this line
         }
       };
     }
   }

4. iOS Specific Configuration:

   • For iOS, ensure that you run pod install in the ios directory of your project after installing the dependencies:

   cd ios
   pod install

Usage

Basic Example

Here's a simple example of how to use react-native-sortable-dynamic in your React Native project:

import React, { useState } from 'react';
import { Text, View } from 'react-native';
import { SafeAreaView } from 'react-native-safe-area-context';
import { SortableView } from 'react-native-sortable-dynamic';

const data = [
  { id: 1, text: 'Tile 1' },
  { id: 2, text: 'Tile 2' },
  { id: 3, text: 'Tile 3' },
  { id: 4, text: 'Tile 4', reorderable: false },
];

const App = () => {
  const [enableEditing, setEnableEditing] = useState(false);

  const handleLongPress = () => {
    setEnableEditing((prev) => !prev);
  };

  const renderItem = ({ item, index }) => (
    <View
      key={`${item.id}-${index}`}
      style={{
        backgroundColor: 'red',
        flex: 1,
        justifyContent: 'center',
        alignItems: 'center',
        borderRadius: 5,
        margin: 10,
        opacity:
          enableEditing &&
          item.draggable !== false &&
          item.reorderable !== false
            ? 0.5
            : 1,
      }}
    >
      <Text style={{ color: 'white', fontSize: 20 }}>{item.text}</Text>
    </View>
  );

  return (
    <SafeAreaView style={{ flex: 1 }}>
      <SortableView
        config={{ MARGIN: 10, COL: 2 }}
        data={data}
        editing={enableEditing}
        onDragEnd={(positions) => console.log(positions)}
        renderItem={renderItem}
        onPress={handleLongPress}
        onLongPress={handleLongPress}
      />
    </SafeAreaView>
  );
};

export default App;

Props

SortableView

| Prop | Type | Description | | ----------------------------- | ---------- | -------------------------------------------------------------------------------------------------- | | config | object | Configuration options such as MARGIN and COL. Use this to dynamically adjust the grid layout. | | data | array | Array of items to be rendered and sorted. | | editing | boolean | If true, allows items to be dragged and reordered. | | onDragEnd | function | Callback function that receives updated positions when the drag ends. | | renderItem | function | Function to render each item inside the sortable container. Receives item and index as parameters. | | onPress | function | Function to handle the press event on a sortable item. | | onLongPress | function | Function to handle the long press event on a sortable item. | | itemStyle | object | Custom style to apply to each SortableItem. | | itemProps | object | Additional props to be passed to each SortableItem. | | scrollContainerStyle | object | Custom style to apply to the scroll container. | | scrollContentContainerStyle | object | Custom style to apply to the scroll content container. |

Note

renderItem function will receive the item and index as parameters, allowing you to customize the rendering of each item.

Roadmap

• ✅ Support for grid layouts
• ✅ Improve accessibility and performance
• 🔜 Support for list layouts
• 🔜 Add more customization options for animations and gestures

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contributing

Contributions are welcome! See the contributing guide to learn how to contribute to the repository and the development workflow.