# @odopod/odo-scroll-feedback

> Based user input from mouse, keyboard, and touch, the `ScrollFeedback` instance will emit navigation events.

Latest version **1.2.0** (published 2018-02-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install @odopod/odo-scroll-feedback
pnpm add @odopod/odo-scroll-feedback
yarn add @odopod/odo-scroll-feedback
bun add @odopod/odo-scroll-feedback
```

## 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 | 1.2.0 |
| Published | 2018-02-23 |
| First published | 2017-07-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 102.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 27 |
| Author | Odopod |
| Maintainers | nathanbuchar, odopod-admin, vestride |
| Keywords | odo, odo-component, odopod, scroll jack |

## Links

- npm: https://www.npmjs.com/package/@odopod/odo-scroll-feedback
- Repository: https://github.com/odopod/code-library
- Homepage: https://github.com/odopod/code-library/tree/master/packages/odo-scroll-feedback
- npm.io page: https://npm.io/package/@odopod/odo-scroll-feedback

## Dependencies (1)

- [tiny-emitter](https://npm.io/package/tiny-emitter.md) ^2.0.1

## Recent versions

- 1.2.0 (latest) — 2018-02-23
- 1.1.0 — 2018-02-13
- 1.0.3 — 2018-01-16
- 1.0.2 — 2017-11-14
- 1.0.1 — 2017-09-01
- 1.0.0 — 2017-07-21

## README

# Odo Scroll Feedback

> Based user input from mouse, keyboard, and touch, the `ScrollFeedback` instance will emit navigation events with a `direction` property signifying which way the user should be taken

## Install

```shell
npm install @odopod/odo-scroll-feedback --save
```

## Quick Start

```js
import OdoScrollFeedback from '@odopod/odo-scroll-feedback';

var scrollFeedback = new OdoScrollFeedback(document.body);

scrollFeedback.on(OdoScrollFeedback.Events.NAVIGATE, function(data) {
  switch (data.direction) {
    case OdoScrollFeedback.Direction.NEXT:
      console.log('go to the next state');
      break;
    case OdoScrollFeedback.Direction.PREVIOUS:
      console.log('go to the previous state');
      break;
    case OdoScrollFeedback.Direction.START:
      console.log('home key pressed');
      break;
    case OdoScrollFeedback.Direction.END:
      console.log('end key pressed');
      break;
  }
}, false);
```

## [Documentation][permalink]

Visit the [Odo component directory][permalink] for demos, code examples, and documentation.

[permalink]: http://code.odopod.com/odo-scroll-feedback/

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