# rx-wheel

> A small test to make a wheel navigation on sections thanks RxJS

Latest version **0.1.0** (published 2016-08-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install rx-wheel
pnpm add rx-wheel
yarn add rx-wheel
bun add rx-wheel
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2016-08-09 |
| First published | 2016-08-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | nmondon |
| Maintainers | seracio |

## Links

- npm: https://www.npmjs.com/package/rx-wheel
- Repository: https://github.com/seracio/rx-wheel
- Homepage: https://github.com/seracio/rx-wheel#readme
- Issues: https://github.com/seracio/rx-wheel/issues
- npm.io page: https://npm.io/package/rx-wheel

## Recent versions

- 0.1.0 (latest) — 2016-08-09

## README

# rx-wheel

A small higher-order function returning an RxJS Observable that emits at the start of a `wheel` event and try to deal with OSX inertia  

## Usage

```
npm i rxjs rx-wheel --save
```

```javascript
import rxWheel from 'rx-wheel';

rxWheel({ treshold, throttleTime }).subscribe(val => {    
    console.log(val.direction); // "down" or "up" 
    $('body')
        .animate({
            scrollTop: (val.direction === 'up' ? '-=' : '+=') + $(window).height()
        }, {
            duration: 500,
            easing: 'easeOutQuart'
        });
});
```
## Parameters

* treshold: energy treshold to emit (default to 10)
* throttleTime: throttle time (default to 150 ms)

## Development

```
npm run build:local
```

## Build

```
npm run build:prod
```

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