# react-native-card-stack-swiper

> Tinder like react-native card stack swiper

Latest version **1.2.5** (published 2020-08-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-native-card-stack-swiper
pnpm add react-native-card-stack-swiper
yarn add react-native-card-stack-swiper
bun add react-native-card-stack-swiper
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.5 |
| Published | 2020-08-16 |
| First published | 2017-11-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 604.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 426 |
| Author | Ludwig Handel |
| Maintainers | lhandel |
| Keywords | react-native, tinder, cards, card, swiper, swipe, cardstack, deck, card-stack, react-native-component |

## Links

- npm: https://www.npmjs.com/package/react-native-card-stack-swiper
- Repository: https://github.com/lhandel/react-native-card-stack-swiper
- Homepage: https://github.com/lhandel/react-native-card-stack-swiper#readme
- Issues: https://github.com/lhandel/react-native-card-stack-swiper/issues
- npm.io page: https://npm.io/package/react-native-card-stack-swiper

## Dependencies (2)

- [prop-types](https://npm.io/package/prop-types.md) 15.5.10
- [react-lifecycles-compat](https://npm.io/package/react-lifecycles-compat.md) ^3.0.4

## Alternatives

- [adhdev](https://npm.io/package/adhdev.md) — 11.1K weekly downloads
- [react-slide-button](https://npm.io/package/react-slide-button.md) — 310 weekly downloads
- [better](https://npm.io/package/better.md) — 42 weekly downloads
- [react-native-swipe-image](https://npm.io/package/react-native-swipe-image.md) — 22 weekly downloads
- [nl.fokkezb.pulltorefresh](https://npm.io/package/nl.fokkezb.pulltorefresh.md) — 11 weekly downloads

## Recent versions

- 1.2.5 (latest) — 2020-08-16
- 1.2.4 — 2020-02-16
- 1.2.3 — 2020-02-16
- 1.2.2 — 2020-02-16
- 1.2.0 — 2020-02-16
- 1.1.9 — 2019-12-17
- 1.1.8 — 2019-11-12
- 1.1.7 — 2019-11-11
- 1.1.6 — 2019-11-08
- 1.1.5 — 2019-10-22
- 1.1.4 — 2019-10-21
- 1.1.3 — 2019-10-21
- 1.1.1 — 2019-10-21
- 1.1.0 — 2018-12-04
- 1.0.9 — 2018-10-01
- … 12 more at https://npm.io/package/react-native-card-stack-swiper/versions

## README

# react-native-card-stack-swiper
Tinder like react-native card stack swiper

[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/lhandel/react-native-card-stack-swiper/issues)
[![npm version](https://badge.fury.io/js/react-native-card-stack-swiper.svg)](https://badge.fury.io/js/react-native-card-stack-swiper)
[![npm downloads](https://img.shields.io/npm/dt/react-native-card-stack-swiper.svg)](https://badge.fury.io/js/react-native-card-stack-swiper)

## Installation

```
  npm install --save react-native-card-stack-swiper
```

## Preview

![App preview](/animation.gif)
![App preview2](/animation2.gif)

```javascript
import CardStack, { Card } from 'react-native-card-stack-swiper';
```

```javascript
  <CardStack style={styles.content} ref={swiper => { this.swiper = swiper }}>
    <Card style={[styles.card, styles.card1]}><Text style={styles.label}>A</Text></Card>
    <Card style={[styles.card, styles.card2]}><Text style={styles.label}>B</Text></Card>
    <Card style={[styles.card, styles.card1]}><Text style={styles.label}>C</Text></Card>
  </CardStack>
```

# CardStack

## CardStack props
| Props               | type          | description                     | required      | default       |
| --------------------| ------------- | --------------------------------| ------------- | ------------- |
| style               | object        | container style                 |               | {}            |
| cardContainerStyle  | object        | cardContainerStyle style        |               | {}            |
| secondCardZoom      | number        | second card zoom                |               | 0.95          |
| duration            | number        | animation duration              |               | 300           |
| initialIndex        | number        | initial card index              |               | 0             |
| loop                | bool          | keep swiping indefinitely       |               | false         |
| renderNoMoreCards   | func          |                                 |               | false         |
| disableTopSwipe     | bool          | disable top swipe               |               | false         |
| disableBottomSwipe  | bool          | disable bottom swipe            |               | false         |
| disableLeftSwipe    | bool          | disable left swipe              |               | false         |
| disableRightSwipe   | bool          | disable right swipe             |               | false         |
| verticalSwipe       | bool          | enable/disable vertical swiping |               | true          |
| horizontalSwipe     | bool          | enable/disable horizont swiping |               | true          |
| verticalThreshold   | number        | vertical swipe threshold        |               | height/4      |
| horizontalThreshold | number        | horizontal swipe threshold      |               | width/2       |
| outputRotationRange | array         | rotation values for the x values|               | ['-15deg', '0deg', '15deg'] |


## CardStack events
| Props             | type          | description                 |
| ----------------- | ------------- | --------------------------- |
| onSwipeStart      | func           | function to be called when a card swipe starts |
| onSwipeEnd        | func           | function to be called when a card swipe ends (card is released) |
| onSwiped          | func           | function to be called when a card is swiped. it receives the swiped card index   |
| onSwipedLeft      | func           | function to be called when a card is swiped left. it receives the swiped card index   |
| onSwipedRight     | func           | function to be called when a card is swiped right. it receives the swiped card index   |
| onSwipedTop       | func           | function to be called when a card is swiped top. it receives the swiped card index  |
| onSwipedBottom    | func           | function to be called when a card is swiped bottom. it receives the swiped card index |
| onSwipedAll       | async func     | function to be called when the last card is swiped. Could trig action to refresh cards |
| onSwipe           | func           | function to be called when a card is swiped. It receives the current x, and y coordinates|



## CardStack actions
| Props             | type          |
| ----------------- | ------------- |
| swipeLeft         | func          |
| swipeRight        | func          |
| swipeBottom       | func          |
| swipeTop          | func          |
| goBackFromLeft    | func          |
| goBackFromRight   | func          |
| goBackFromBottom  | func          |
| goBackFromTop     | func          |

```javascript
  <CardStack style={styles.content} ref={swiper => { this.swiper = swiper }}>
    <Card style={[styles.card, styles.card1]}><Text style={styles.label}>A</Text></Card>
    <Card style={[styles.card, styles.card2]}><Text style={styles.label}>B</Text></Card>
  </CardStack>

  <TouchableOpacity onPress={ () => { this.swiper.swipeLeft() }}>
    <Text>Left</Text>
  </TouchableOpacity>
```


# Card

## Card props
| Props               | type          | description                     | required      | default       |
| --------------------| ------------- | --------------------------------| ------------- | ------------- |
| style               | object        | container style                 |               | {}            |

## Card events
| Props             | type          | description                 |
| ----------------- | ------------- | --------------------------- |
| onSwiped          | func          | function to be called when a card is swiped.   |
| onSwipedLeft      | func          | function to be called when a card is swiped left.  |
| onSwipedRight     | func          | function to be called when a card is swiped right.   |
| onSwipedTop       | func          | function to be called when a card is swiped top.  |
| onSwipedBottom    | func          | function to be called when a card is swiped bottom. |

---
_Source: https://npm.io/package/react-native-card-stack-swiper · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
