# rc-swipeout

> swipe out ui component for react(web and react-native)

Latest version **2.0.11** (published 2018-06-12) · 0 weekly downloads

## Install

```sh
npm install rc-swipeout
pnpm add rc-swipeout
yarn add rc-swipeout
bun add rc-swipeout
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.11 |
| Published | 2018-06-12 |
| First published | 2016-06-16 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 289.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 216 |
| Author | rjmuqiang@gmail.com |
| Maintainers | paranoidjk, quentinyang1985, silentcloud |
| Keywords | react, react-component, swipeout, rc-swipeout, swipe delete |

## Links

- npm: https://www.npmjs.com/package/rc-swipeout
- Repository: https://github.com/react-component/swipeout
- Issues: https://github.com/react-component/swipeout/issues
- npm.io page: https://npm.io/package/rc-swipeout

## Dependencies (4)

- [classnames](https://npm.io/package/classnames.md) 2.x
- [rc-gesture](https://npm.io/package/rc-gesture.md) ~0.0.22
- [babel-runtime](https://npm.io/package/babel-runtime.md) 6.x
- [react-native-swipeout](https://npm.io/package/react-native-swipeout.md) ^2.2.2

## 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

- 2.0.11 (latest) — 2018-06-12
- 2.0.0-alpha.2 (beta) — 2017-09-01
- 2.0.10 — 2018-06-12
- 2.0.7 — 2018-06-07
- 2.0.6 — 2018-06-06
- 2.0.5 — 2018-05-25
- 2.0.4 — 2017-11-14
- 2.0.3 — 2017-11-10
- 2.0.2 — 2017-10-24
- 2.0.1 — 2017-09-19
- 1.4.7 — 2017-09-15
- 2.0.0 — 2017-09-04
- 2.0.0-alpha.1 — 2017-08-29
- 1.4.6 — 2017-08-29
- 2.0.0-alpha.0 — 2017-08-29
- … 39 more at https://npm.io/package/rc-swipeout/versions

## README

# rc-swipeout
---

iOS-style swipeout buttons that appear from behind a component (web & react-native support)

[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][coveralls-image]][coveralls-url]

[npm-image]: http://img.shields.io/npm/v/rc-swipeout.svg?style=flat-square
[npm-url]: http://npmjs.org/package/rc-swipeout
[travis-image]: https://img.shields.io/travis/react-component/swipeout.svg?style=flat-square
[travis-url]: https://travis-ci.org/react-component/swipeout
[coveralls-image]: https://img.shields.io/coveralls/react-component/swipeout.svg?style=flat-square
[coveralls-url]: https://coveralls.io/r/react-component/swipeout?branch=master

## Screenshots

![rc-swipeout](https://zos.alipayobjects.com/rmsportal/dqxQTtxrKrGMVEc.gif)

## Installation

`npm install --save rc-swipeout`

## Development

```
web:
npm install
npm start

rn:
tnpm run rn-start
```

## Example

- local: http://localhost:8000/examples/
- online: http://react-component.github.io/swipeout/

## react-native

```
./node_modules/rc-tools run react-native-init
react-native run-ios
```

## Usage

```js
import Swipeout from 'rc-swipeout';
import 'rc-swipeout/assets/index.less'; (web only)

<Swipeout
  left={[
    {
      text: 'reply',
      onPress:() => console.log('reply'),
      style: { backgroundColor: 'orange', color: 'white' },
      className: 'custom-class-1'
    }
  ]}
  right={[
    {
      text: 'delete',
      onPress:() => console.log('delete'),
      style: { backgroundColor: 'red', color: 'white' },
      className: 'custom-class-2'
    }
  ]}
  onOpen={() => console.log('open')}
  onClose={() => console.log('close')}
>
  <div style={{height: 44}}> swipeout demo </div>
</Swipeout>

```


## API

### props

| name        | description                   | type   | default    |
|-------------|------------------------|--------|------------|
| prefixCls       | className prefix     | String | `rc-swipeout` |
| style       | swipeout style      | Object | `` |
| left       | swipeout buttons on left      | Array | `[]` |
| right       | swipeout buttons on right      | Array | `[]` |
| autoClose       | auto close on button press   | Boolean | `function() {}` |
| onOpen       |       | Function | `function() {}` |
| onClose       |       | Function | `function() {}` |
| disabled       |   disabled swipeout    | Boolean | `false` |

### button props

| name        | description                   | type   | default    |
|-------------|------------------------|--------|------------|
| text       | button text     | String | `Click` |
| style       | button style     | Object | `` |
| onPress       | button press function      | Function | `function() {}` |
| className       | button custom class     | String | `` |

## Test Case

```
npm test
npm run chrome-test
```

## Coverage

```
npm run coverage
```

open coverage/ dir

## License

rc-swipeout is released under the MIT license.

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