Skip to content

Latest commit

 

History

History
74 lines (64 loc) · 4.16 KB

README.md

File metadata and controls

74 lines (64 loc) · 4.16 KB
Raw

Sortable list view for react-native

GitHub license npm

Content

Demo

Installation

npm i react-native-sortable-list --save

Examples

API

Props

  • data (Object) data source
  • order? (Array) an array of keys from data, the order of keys from the array will be used to initial rows order
  • style? (Object, Array)
  • contentContainerStyle? (Object, Array) these styles will be applied to the inner scroll view content container
  • innerContainerStyle? (Object, Array) these styles will be applied to the inner scroll view content container, excluding the header and footer
  • horizontal? (boolean) when true, the SortableList's children are arranged horizontally in a row instead of vertically in a column. The default value is false.
  • showsVerticalScrollIndicator (boolean) when false, the vertical scroll indicator will not be visible. The default value is true.
  • showsHorizontalScrollIndicator (boolean) when false, the horizontal scroll indicator will not be visible. The default value is true.
  • sortingEnabled? (boolean) when false, rows are not sortable. The default value is true.
  • scrollEnabled? (boolean) when false, the content does not scrollable. The default value is true.
  • manuallyActivateRows? (bool) whether you intend to use the toggleRowActive method to activate a row or use the out of box solution.
  • autoscrollAreaSize? (number) determines the height for vertical list and the width for horizontal list of the area at the begining and the end of the list that will trigger autoscrolling. Defaults to 60.
  • rowActivationTime? (number) determines time delay in ms before pressed row becomes active. Defaults to 200 ms.
  • refreshControl? (element)
    A RefreshControl that works the same way as a ScrollView's refreshControl.
  • renderRow (function)
    ({key, index, data, disabled, active}) => renderable
    Takes a row key, row index, data entry from the data source and its statuses disabled, active and should return a renderable component to be rendered as the row. The child component will receive a method called toggleRowActive (only if manuallyActivateRows={true}) to manually activate the row. Useful if you have multiple touch responders in your view.
  • renderHeader? (function)
    () => renderable
    Renders returned component at the top of the list.
  • renderFooter? (function)
    () => renderable
    Renders returned component at the bottom of the list.
  • onChangeOrder? (function)
    (nextOrder) => void
    Called when rows were reordered, takes an array of rows keys of the next rows order.
  • onActivateRow? (function)
    (key) => void
    Called when a row was activated (user long tapped).
  • onReleaseRow? (function)
    (key, currentOrder) => void
    Called when the active row was released. Returns the key and the new list order.
  • onPressRow? (function)
    (key) => void
    Called when a row was pressed.

Methods

  • scrollBy(dy?, animated?) scrolls by a given y offset, either immediately or with a smooth animation
  • scrollTo(y?, animated?) scrolls to a given y offset, either immediately or with a smooth animation
  • scrollToRowKey(key, animated?) scrolls to a given row key, either immediately or with a smooth animation

Questions?

Feel free to contact me via

If you find a bug, please submit an issue