# swipeout

> Basic swipeable interaction helper

Latest version **1.0.0** (published 2015-08-07) · ISC license · 0 weekly downloads

## Install

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

## 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.0.0 |
| Published | 2015-08-07 |
| First published | 2015-08-07 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | korynunn |

## Links

- npm: https://www.npmjs.com/package/swipeout
- Repository: https://github.com/KoryNunn/swipeout
- Homepage: https://github.com/KoryNunn/swipeout#readme
- Issues: https://github.com/KoryNunn/swipeout/issues
- npm.io page: https://npm.io/package/swipeout

## Dependencies (4)

- [doc-js](https://npm.io/package/doc-js.md) ^1.3.0
- [interact](https://npm.io/package/interact.md) 0.0.3
- [dirvector](https://npm.io/package/dirvector.md) ^1.1.1
- [interact-js](https://npm.io/package/interact-js.md) ^2.0.1

## Recent versions

- 1.0.0 (latest) — 2015-08-07

## README

# swipeout

Basic swipeable interaction helper

## Usage

See the example folder for usage.

var swipeout = require('swipeout');

```
var destroy = swipeout(targetElement, function(type, event){

    type; -> 'drag' or 'rebound'

    event; -> {
        x: position x
        y: position y
        pause: function, pause momentum
        resume: function, resume momentum
        preventDefault: function, prevent default on the event.
    }

});

destroy; -> function, destroy the swipeout
```

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