# @wobwob/react-swipe-to-delete-ios

> A simple React component to reproduce the way iOS deletes an item in a list. [Demo](https://arnaudambro.github.io/react-swipe-to-delete-ios)

Latest version **1.0.0** (published 2022-04-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install @wobwob/react-swipe-to-delete-ios
pnpm add @wobwob/react-swipe-to-delete-ios
yarn add @wobwob/react-swipe-to-delete-ios
bun add @wobwob/react-swipe-to-delete-ios
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2022-04-22 |
| First published | 2022-04-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 1.6 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 53 |
| Author | Arnaud Ambroselli |
| Maintainers | wobwob |
| Keywords | react, swipe-to-delete, swipeable, delete, ios |

## Links

- npm: https://www.npmjs.com/package/@wobwob/react-swipe-to-delete-ios
- Repository: https://github.com/arnaudambro/react-swipe-to-delete-ios
- Homepage: https://arnaudambro.github.io/react-swipe-to-delete-ios/
- Issues: https://github.com/arnaudambro/react-swipe-to-delete-ios/issues
- npm.io page: https://npm.io/package/@wobwob/react-swipe-to-delete-ios

## Dependencies (1)

- [styled-components](https://npm.io/package/styled-components.md) ^5.0.1

## 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.0.0 (latest) — 2022-04-22

## README

# react-swipe-to-delete-ios

A simple React component to reproduce the way iOS deletes an item in a list.
[Demo](https://arnaudambro.github.io/react-swipe-to-delete-ios)

![GIF Demo](./src/demo/demo.gif?raw=true "Title")


## Installation

```
yarn add react-swipe-to-delete-ios
```

## Usage

```js
import React from 'react'
import SwipeToDelete from 'react-swipe-to-delete-ios'

...

<SwipeToDelete
  onDelete={handleDelete} // required
  height={100} // required
  // optional
  transitionDuration={250} // default
  deleteWidth={75} // default
  deleteColor="rgba(252, 58, 48, 1.00)" // default
  deleteText="Delete" // default
  deleteComponent={<DeleteComponent/>} // not default
  disabled={false} // default
  rtl={false} // default
>
  {children}
</SwipeToDelete>
```

## Props

Prop | Type | Default
--- | --- | ---
**onDelete** | function | _required_
**height** | number | _required_
transitionDuration | number (ms) | 250
deleteWidth | number (px) | 75
deleteColor | string | "rgba(252, 58, 48, 1.00)"
deleteText | string | "Delete" (_deleteText or deleteComponent_)
deleteComponent | node | null (_deleteText or deleteComponent_)
disabled | bool | false
rtl | bool | false


## Todo

- [ ] Tests
- [ ] Browser compatibility check

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