# react-swipe-plus

> forked from voronianski's react-swipe&swipe-js-iso, as a React component

Latest version **1.1.11** (published 2017-11-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-swipe-plus
pnpm add react-swipe-plus
yarn add react-swipe-plus
bun add react-swipe-plus
```

## 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.1.11 |
| Published | 2017-11-02 |
| First published | 2017-07-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | qilovehua |
| Maintainers | qilovehua |
| Keywords | react, component, carousel, swipe, react-component |

## Links

- npm: https://www.npmjs.com/package/react-swipe-plus
- Repository: https://github.com/qilovehua/react-swipe-plus
- Issues: https://github.com/qilovehua/react-swipe-plus/issues
- npm.io page: https://npm.io/package/react-swipe-plus

## Dependencies (2)

- [prop-types](https://npm.io/package/prop-types.md) ^15.5.7
- [object-assign](https://npm.io/package/object-assign.md) ^4.1.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.1.11 (latest) — 2017-11-02
- 1.1.10 — 2017-08-25
- 1.1.9 — 2017-08-10
- 1.1.8 — 2017-08-10
- 1.1.7 — 2017-08-10
- 1.1.6 — 2017-08-09
- 1.1.5 — 2017-08-06
- 1.1.4 — 2017-08-01
- 1.1.3 — 2017-07-26
- 1.1.2 — 2017-07-26
- 1.1.1 — 2017-07-21
- 1.1.0 — 2017-07-21
- 1.0.9 — 2017-07-20
- 1.0.8 — 2017-07-19
- 1.0.7 — 2017-07-19
- … 6 more at https://npm.io/package/react-swipe-plus/versions

## README

# react-swipe-plus

forked from voronianski's react-swipe & swipe-js-iso

## Diff
1. new swipeOptions - margin, default 0(slide_width = 100% - margin * 2)
1. new swipeOptions - degree, default 0(no 3D when swipe)

## Demo

with 3D
<p>
<img src="https://github.com/qilovehua/react-swipe-plus/blob/master/demo/swipe-3d.gif" width="600" />
<p>
swipeOptions:
file:///Users/qilovehua/react/react-swipe/demo/index.html?slidesNum=5&continuous=true&auto=0&speed=3000&startSlide=3&margin=30&degree=9

====

without 3D
<p>
<img src="https://github.com/qilovehua/react-swipe-plus/blob/master/demo/swipe-no-3d.gif" width="600" />
</p>
swipeOptions:
file:///Users/qilovehua/react/react-swipe/demo/index.html?slidesNum=5&continuous=true&auto=0&speed=3000&startSlide=3&margin=30

## Config Options
[See detail from voronianski/swipe-js-iso](https://github.com/voronianski/swipe-js-iso#config-options)


Swipe can take an optional second parameter– an object of key/value settings:

- **startSlide** Integer *(default:0)* - index position Swipe should start at

- **speed** Integer *(default:300)* - speed of prev and next transitions by auto slideshow in milliseconds.

- **touchSpeed** Integer *(default:300)* - speed of prev and next transitions by touch in milliseconds.

- **auto** Integer - begin with auto slideshow (time in milliseconds between slides)

- **continuous** Boolean *(default:true)* - create an infinite feel with no endpoints

- **disableScroll** Boolean *(default:false)* - stop any touches on this container from scrolling the page

- **stopPropagation** Boolean *(default:false)* - stop event propagation

- **swiping** Function - invoked while swiping with the percentage (0-1) of the full width that has been swiped.

- **callback** Function - runs at slide change.

- **transitionEnd** Function - runs at the end slide transition.

- **margin** Integer *(default:0)* - set slide_width = 100% - margin * 2.

- **degree** Integer *(default:0)* - 3D when slide change.


## How to use

```bash
git clone react-swipe-plus
cd react-swipe-plus/demo
open index.html (by browser)
```

## Usage


**MIT Licensed**

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