# wheelnav

> Animated wheel navigation JavaScript library based on Raphaël.js (SVG/VML). It can be a pie menu (radial menu, circular menu) and many more.

Latest version **1.7.1** (published 2017-07-14) · MIT license · 0 weekly downloads

## Install

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

## 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.7.1 |
| Published | 2017-07-14 |
| First published | 2015-01-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 704 |
| Author | Gábor Berkesi |
| Maintainers | softwaretailoring |
| Keywords | animated, navigation, pie-menu, radial-menu, circular-menu, SVG, Raphael, wheel |

## Links

- npm: https://www.npmjs.com/package/wheelnav
- Repository: https://github.com/softwaretailoring/wheelnav
- Homepage: http://wheelnavjs.softwaretailoring.net
- Issues: https://github.com/softwaretailoring/wheelnav/issues
- npm.io page: https://npm.io/package/wheelnav

## Alternatives

- [express-promise-router](https://npm.io/package/express-promise-router.md) — 736.1K weekly downloads
- [next-usequerystate](https://npm.io/package/next-usequerystate.md) — 29.8K weekly downloads
- [@bitkyc08/opencodex](https://npm.io/package/@bitkyc08/opencodex.md) — 4.6K weekly downloads
- [lynkr](https://npm.io/package/lynkr.md) — 575 weekly downloads
- [baremetal.js](https://npm.io/package/baremetal.js.md) — 42 weekly downloads

## Recent versions

- 1.7.1 (latest) — 2017-07-14
- 1.7.0 — 2016-11-03
- 1.6.1 — 2015-10-29
- 1.6.0 — 2015-10-25
- 1.5.5 — 2015-06-11
- 1.5.4 — 2015-05-09
- 1.5.3 — 2015-05-09
- 1.5.2 — 2015-04-20
- 1.5.1 — 2015-04-16
- 1.5.0 — 2015-03-30
- 1.4.0 — 2015-01-03

## README

wheelnav.js
===========

[![Join the chat at https://gitter.im/softwaretailoring/wheelnav](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/softwaretailoring/wheelnav?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

Animated wheel navigation JavaScript library based on [Raphaël.js][raphaeljs] (SVG/VML).

It works on all major desktop and mobile browser.

Possible uses:
- tab navigation
- pie menu (radial menu, circular menu)
- sub menu
- option button
- checkboxes
- and more...

For more insight please visit [http://wheelnavjs.softwaretailoring.net][projectpage]

## Using

### Via JavaScript

HTML
```html
<div id="divWheelnav"></div>
```

JS
```javascript
var myWheelnav = new wheelnav("divWheelnav");
myWheelnav.slicePathFunction = slicePath().WheelSlice;
myWheelnav.colors = colorpalette.parrot;
myWheelnav.createWheel([icon.smile, icon.star, icon.fork, icon.$]);
```

### Via data attributes

HTML
```html
<div id="divWheelnav" data-wheelnav data-wheelnav-slicepath="WheelSlice" data-wheelnav-colors="#D80351,#F5D908,#00A3EE,#929292">
    <div data-wheelnav-navitemicon="smile">smile</div>
    <div data-wheelnav-navitemicon="star">star</div>
    <div data-wheelnav-navitemicon="fork">fork</div>
    <div data-wheelnav-navitemicon="$">donate</div>
</div>
```

JS
```javascript
var myWheelnav = new wheelnav("divWheelnav");
```

![demo image](wheelnav_demo.gif)

The index.html of this repo (test page) is available [here][testpage].

## Install

wheelnav.js is available over [npm][npm]

```sh
$ npm install wheelnav
```

and [bower][bower]

```sh
$ bower install wheelnav
```

or CDN by [jsDelivr][jsdelivr]

```html
<script type="text/javascript" src="https://cdn.jsdelivr.net/wheelnav/1.7.1/wheelnav.min.js"></script>
```

## Author

Developer: Gábor Berkesi (gabor.berkesi@softwaretailoring.net)

Development environment: [Visual Studio Community 2013][vs2013] with [Web Essentials][webessentials]

## License

Licensed under [MIT][mit]. Enjoy the spinning.

[projectpage]: http://wheelnavjs.softwaretailoring.net
[testpage]: http://wheelnavjs.softwaretailoring.net/test
[mit]: http://www.opensource.org/licenses/mit-license.php
[raphaeljs]: http://dmitrybaranovskiy.github.io/raphael
[npm]: https://www.npmjs.com/package/wheelnav
[bower]: http://bower.io/search/?q=wheelnav
[jsdelivr]: http://www.jsdelivr.com/?query=wheelnav
[vs2013]: https://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx
[webessentials]: http://vswebessentials.com/

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