# easy-step

> Handle steps as you want to

Latest version **1.3.0** (published 2016-09-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install easy-step
pnpm add easy-step
yarn add easy-step
bun add easy-step
```

## 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.3.0 |
| Published | 2016-09-30 |
| First published | 2016-09-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | 'Alexsey Zhyravlev, Yuriy Yakovenko |
| Maintainers | exbinet |
| Keywords | step, animation, delay, stepcallback, events |

## Links

- npm: https://www.npmjs.com/package/easy-step
- Repository: https://github.com/djleonskennedy/stepper
- Homepage: https://github.com/djleonskennedy/stepper#readme
- Issues: https://github.com/djleonskennedy/stepper/issues
- npm.io page: https://npm.io/package/easy-step

## Dependencies (1)

- [array-from](https://npm.io/package/array-from.md) 2.1.1

## Alternatives

- [async-exit-hook](https://npm.io/package/async-exit-hook.md) — 3.7M weekly downloads
- [evnty](https://npm.io/package/evnty.md) — 7.2K weekly downloads
- [eleventy-plugin-asciidoc](https://npm.io/package/eleventy-plugin-asciidoc.md) — 3.5K weekly downloads
- [@jswork/next-get2get](https://npm.io/package/@jswork/next-get2get.md) — 945 weekly downloads
- [@dashersw/axon](https://npm.io/package/@dashersw/axon.md) — 934 weekly downloads

## Recent versions

- 1.3.0 (latest) — 2016-09-30
- 1.2.1 — 2016-09-26
- 1.2.0 — 2016-09-14
- 1.1.0 — 2016-09-13
- 1.0.0 — 2016-09-13

## README

# EASY STEP

helps to handle stepped animation programmatically

[![travis build](https://img.shields.io/travis/djleonskennedy/stepper.svg?style=flat-square)](https://travis-ci.org/djleonskennedy/stepper.svg?branch=master)
[![travis build](https://img.shields.io/codecov/c/github/codecov/c/djleonskennedy/stepper.svg?style=flat-square)](https://travis-ci.org/djleonskennedy/stepper.svg?branch=master)

## Installation

npm

`npm i easy-step`

cdn

`<script src="https://unpkg.com/easy-step@1.2.1/dist/index.umd.min.js"></script>`

## Usage

browser
```
var stepper = new EasyStep()
```

es5 umd
```
var EasyStep = require('easy-step')

var stepper = new EasyStep()
```

es6
```
import EasyStep from 'easy-step'

var stepper = new EasyStep()
```

### Constructor `EasyStep`

| Parameter      | type             | Status           | Description |
| :------------- | :--------------- | :--------------- | :---------- |
| `trigger`      | `DOM element`    | `optional`       | Use it to trigger animation, also you can use api to trigger animation so it's optional |
| `items`        | `any`            | `required`       | item that should be animated, can be everything because they will be passed in callback as parameter |
| `delay`        | `Int`            | `required`       | delay animation |

### API

| function              | params               | Return           | Description |
| :-------------------- | :------------------  | :--------------- | :---------- |
| `on`                  | `String`, `function` | `null`           | subscribe on event |
| `off`                 | `String`, `function` | `null`           | unsubscribe on event |
| `trigger`             |                      | `null`           | trigger amination |
| `reverseDirection`    |                      | `null`           | reverse animation direction |
| `isForward`           |                      | `Bool`           | check if forward |
| `isBackward`          |                      | `Bool`           | check if backward |

### Events

| event                 | callback args type    | Description |
| :-------------------- | :------------------   | :---------- |
| `forward`             | `any`                 | fires on forward |
| `backward`            | `any`                 | fires on backward |
| `complete`            | `any`                 | on all items animated |

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