Skip to content

Commit a6ca40d

Browse files
committed
update readme
1 parent 0e23737 commit a6ca40d

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

.prettierignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Ignore all markdown files:
2+
*.md

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ All props are spread onto underlying [FlatList](https://facebook.github.io/react
3434
| Name | Type | Description
3535
| :------------------------- | :---------------------------------------------------------------------------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
3636
| `data` | `T[]` | Items to be rendered. |
37-
| `horizontal` | `boolean` | Orientation of list. |
37+
| `ref` | `React.RefObject<FlatList<T>>` | FlatList ref to be forwarded to the underlying FlatList. |
3838
| `renderItem` | `(params: { item: T, index: number, drag: () => void, isActive: boolean}) => JSX.Element` | Call `drag` when the row should become active (i.e. in an `onLongPress` or `onPressIn`). |
3939
| `renderPlaceholder` | `(params: { item: T, index: number }) => React.ReactNode` | Component to be rendered underneath the hovering component |
4040
| `keyExtractor` | `(item: T, index: number) => string` | Unique key for each item |
@@ -43,7 +43,6 @@ All props are spread onto underlying [FlatList](https://facebook.github.io/react
4343
| `onDragEnd` | `(params: { data: T[], from: number, to: number }) => void` | Called after animation has completed. Returns updated ordering of `data` |
4444
| `autoscrollThreshold` | `number` | Distance from edge of container where list begins to autoscroll when dragging. |
4545
| `autoscrollSpeed` | `number` | Determines how fast the list autoscrolls. |
46-
| `onRef` | `(ref: DraggableFlatList<T>) => void` | Returns underlying Animated FlatList ref. |
4746
| `animationConfig` | `Partial<Animated.SpringConfig>` | Configure list animations. See [reanimated spring config](https://github.com/software-mansion/react-native-reanimated/blob/master/react-native-reanimated.d.ts#L112-L120) |
4847
| `activationDistance` | `number` | Distance a finger must travel before the gesture handler activates. Useful when using a draggable list within a TabNavigator so that the list does not capture navigator gestures. |
4948
| `onScrollOffsetChange` | `(offset: number) => void` | Called with scroll offset. Stand-in for `onScroll`. |

0 commit comments

Comments
 (0)