# vue-page-swipe

> A page swipe using Vue.js

Latest version **1.0.4** (published 2017-07-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install vue-page-swipe
pnpm add vue-page-swipe
yarn add vue-page-swipe
bun add vue-page-swipe
```

## 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.4 |
| Published | 2017-07-25 |
| First published | 2017-07-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 4.0.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 3 |
| Maintainers | pickcle, zhouyuan1990 |
| Keywords | vue, swipe, scrolling, slider |

## Links

- npm: https://www.npmjs.com/package/vue-page-swipe
- Repository: https://github.com/zhouyuan1990/vue-page-swipe
- Homepage: https://github.com/zhouyuan1990/vue-page-swipe#readme
- Issues: https://github.com/zhouyuan1990/vue-page-swipe/issues
- npm.io page: https://npm.io/package/vue-page-swipe

## Dependencies (1)

- [vue](https://npm.io/package/vue.md) ^2.3.3

## 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.0.4 (latest) — 2017-07-25
- 1.0.3 — 2017-07-24
- 1.0.2 — 2017-07-24
- 1.0.1 — 2017-07-24
- 1.0.0 — 2017-07-24

## README

# vue-page-swipe

a page swipe using vue.js (using slot and render)

# Using vue-page-swipe

## Install
```bash
$ npm install vue-page-swipe
```

## Import and register module
```JavaScript
import PageSwipe from 'vue-page-swipe';
Vue.component('page-swipe', PageSwipe);
```
## Using "page-swipe" tag simply
```HTML
<page-swipe>
  <div swipe-title="page1" class="page1">Page1</div>
  <div swipe-title="page2" class="page2">Page2</div>
  <div swipe-title="page3" class="page3">Page3</div>
</page-swipe>
```

# Develop

Run example:
```bash
$ npm run dev
```

Build src to /dist
```bash
$ npm run build
```

# Options
## For page-swipe 
| Option | Description |
| ----- | ----- |
| showIndicators | Boolean (default: true) - Defines whether indicators are shown or not. |
| allowLoop | Boolean (default: false) - If set to true, scrolling up in the first page will scroll to the last page, and scrolling down in the last page will scroll to the first page. |
| direction | String (default: vertical) - Defines the scroll direction is vertical or horizontal |
## For children under page-swipe
| Option | Description |
| ----- | ----- |
| swipe-title | String - Defines the text shown beside indicators while hovering on indicators. |

# Demo
![img](https://raw.githubusercontent.com/zhouyuan1990/vue-page-swipe/master/demo.gif)

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