react-swipeable-list

A configurable react component to render list with swipeable items.

Demo •
Installation •
Usage

---

You like it?
Buy me a coffee :) or a 🍺

---

!GitHub Release Date


React Swipeable List component

A react component to render list with swipeable items. Items can have one or more actions on left (leading) and right (trailing) swipe and different behavior depending on props. See examples

This repository contains new version of sandstreamdev/react-swipeable-list/. Whole component was reimplemented to support buttons in revealed content and different swipe behaviors. More information can be found in this issue: Clarify relationship with @sandstreamdev/react-swipeable-list

Demo

Check working example page


Installation

``bash
npm install react-swipeable-list


or via yarn


yarn add react-swipeable-list
`

Usage

`jsx
import {
LeadingActions,
SwipeableList,
SwipeableListItem,
SwipeAction,
TrailingActions,
} from 'react-swipeable-list';
import 'react-swipeable-list/dist/styles.css';

const leadingActions = () => (

console.info('swipe action triggered')}>
Action name


);

const trailingActions = () => (

destructive={true}
onClick={() => console.info('swipe action triggered')}
>
Delete


);


leadingActions={leadingActions()}
trailingActions={trailingActions()}
>
Item content

;
`

SwipeableList Props

$3

Type: milliseconds (optional, default: 0)

Time in milliseconds after which swipe action and animation should be called after trigggering swipe action.

It can be set for the whole list or for every item. See actionDelay for SwipeableListItem. Value from the SwipeableListItem takes precedence.

$3

Type: boolean (optional, default: false)

Changes behavior of IOS list type.
When true and swipe is done beyond threshold and released the action is triggered.

When set to false actions are only opened and they need to be clicked to trigger action.

$3

Type: milliseconds (optional, default: 1000)

Time in milliseconds after which swipe action should be called for destructive swipe action (item deletion).

It can be set for the whole list or for every item. See destructiveCallbackDelay for SwipeableListItem. Value from the SwipeableListItem takes precedence.

$3

Type: object (optional, default: undefined)

Additional styles for list tag.

$3

Type: ListType (ANDROID | IOS | MS) (optional, default: ANDROID)

Changes behavior of swipeable items.

#### ANDROID

#### IOS

#### MS

$3

Type: string (optional, default: div)

HTML tag that is used to create this component.

$3

Type: number (optional, default: 10)

How far in pixels scroll needs to be done to block swiping. After scrolling is started and goes beyond the threshold, swiping is blocked.

It can be set for the whole list or for every item. See scrollStartThreshold for SwipeableListItem. Value from the SwipeableListItem takes precedence.

$3

Type: number (optional, default: 10)

How far in pixels swipe needs to be done to start swiping on list item. After a swipe is started and goes beyond the threshold, scrolling is blocked.

It can be set for the whole list or for every item. See swipeStartThreshold for SwipeableListItem. Value from the SwipeableListItem takes precedence.

$3

Type: number (optional, default: 0.5)

How far swipe needs to be done to trigger attached action. 0.5 means that item needs to be swiped to half of its width, 0.25 - one-quarter of width.

It can be set for the whole list or for every item. See threshold for SwipeableListItem. Value from the SwipeableListItem takes precedence.

SwipeableListItem Props

$3

Type: milliseconds (optional, default: 0)

Time in milliseconds after which swipe action and animation should be called after trigggering swipe action.

It can be set for the whole list or for every item. See actionDelay for SwipeableList. Value from the SwipeableListItem takes precedence.

$3

Type: boolean (optional, default: false)

If set to true all defined swipe actions are blocked.

$3

Type: milliseconds (optional, default: 1000)

Time in milliseconds after which swipe action should be called for destructive swipe action (item deletion).

It can be set for the whole list or for every item. See destructiveCallbackDelay for SwipeableList. Value from the SwipeableListItem takes precedence.

$3

Type: LeadingActions component

Container component that sets up correct props in SwipeAction. See examples for usage.

$3

Type: 'number' (optional, default: 1.0)

Limit the swipe to percent of width, e.g.: 0.5 will make swipe possible only for 50% of elements's width

$3

Type: function (optional)

Callback function that should be call after list item is clicked.

$3

Type: (dragDirection: string) => void

Fired after swipe has started (after drag gesture passes the swipeStartThreshold distance in pixels). dragDirection can have value of left or right.

$3

Type: (dragDirection: string) => void

Fired after swipe has ended. dragDirection can have value of left or right.

$3

Type: (progress: number, dragDirection: string) => void

Fired every time swipe progress changes. The reported progress value is always an integer in range 0 to 100 inclusive. dragDirection can have value of left or right.

$3

Type: number (default: 10)

How far in pixels scroll needs to be done to block swiping. After scrolling is started and goes beyond the threshold, swiping is blocked.

It can be set for the whole list or for every item. See scrollStartThreshold for SwipeableList. Value from the SwipeableListItem takes precedence.

$3

Type: number (default: 10)

How far in pixels swipe needs to be done to start swiping on list item. After a swipe is started and goes beyond the threshold, scrolling is blocked.

It can be set for the whole list or for every item. See swipeStartThreshold for SwipeableList. Value from the SwipeableListItem takes precedence.

$3

Type: number (default: 0.5)

How far swipe needs to be done to trigger action. 0.5 means that item needs to be swiped to half of its width, 0.25 - one-quarter of width.

It can be set for the whole list or for every item. See threshold for SwipeableList. Value from the SwipeableListItem takes precedence.

$3

Type: TrailingActions component

Container component that sets up correct props in SwipeAction. See examples for usage.

SwipeAction Props

$3

Type: boolean (optional, default: false)

If set to true then remove animation is played and callback is called after destructiveCallbackDelay.

$3

Type: function (required)

Callback function that should be call after swipe action is triggered.

$3

Type: string (optional, default: span`)

HTML tag that is used to create this component.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Marek Rozmus 💻 📖 ⚠️ 💡 🤔 🚧 🎨	Adam Laycock 🐛	Rathes Sachchithananthan 🤔	Niels 🤔	Glenn Harris 🚧	Zdorovtsev Viktor 🤔	Zakaria EL Mesaoudi 💻
Aron Rotteveel 💻	Lucas Furini 🤔	Canberk Akartuna 🐛	Raul Escobar 🐛	Starly26 🐛

This project follows the all-contributors specification. Contributions of any kind welcome!