# flip-navigation-bar

> flip navigation bar

Latest version **2.0.1** (published 2016-05-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install flip-navigation-bar
pnpm add flip-navigation-bar
yarn add flip-navigation-bar
bun add flip-navigation-bar
```

## 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 | 2.0.1 |
| Published | 2016-05-23 |
| First published | 2016-04-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+4 in 1 direct dependencies) |
| Install scripts | no |
| Author | tomasran |
| Maintainers | tomasran |
| Keywords | navigation, flip-navigation, flip-navigation-bar |

## Links

- npm: https://www.npmjs.com/package/flip-navigation-bar
- Repository: https://github.com/TomasRan/flip-navigation-bar
- Homepage: https://github.com/TomasRan/flip-navigation-bar#readme
- Issues: https://github.com/TomasRan/flip-navigation-bar/issues
- npm.io page: https://npm.io/package/flip-navigation-bar

## Dependencies (1)

- [jquery](https://npm.io/package/jquery.md) ^2.2.3

## Recent versions

- 2.0.1 (latest) — 2016-05-23
- 2.0.0 — 2016-05-23
- 1.0.0 — 2016-04-30

## README

# flip-navigation-bar

![](https://travis-ci.org/TomasRan/flip-navigation-bar.svg?branch=master)
[![Code Climate](https://codeclimate.com/github/TomasRan/flip-navigation-bar/badges/gpa.svg)](https://codeclimate.com/github/TomasRan/flip-navigation-bar)
[![bitHound Overall Score](https://www.bithound.io/github/TomasRan/flip-navigation-bar/badges/score.svg)](https://www.bithound.io/github/TomasRan/flip-navigation-bar)
[![Issue Count](https://codeclimate.com/github/TomasRan/flip-navigation-bar/badges/issue_count.svg)](https://codeclimate.com/github/TomasRan/flip-navigation-bar)

## Description

Here is [demo](http://tomasran.github.io/flip-navigation-bar/demo/demo.html);

## Install

```
# use npm
$ npm install flip-navigation-bar

# use bower
$ bower install flip-navigation-bar
```

## Usage

```
	var FlipNavBar = require('flip-navigation-bar');

	var flipNavBar = new FilpNavBar({
		'container': '.main',
		'navData': [{
			'id': '',
			'content': '',
			'status': ''
		}, ... ],
		'defaultSelected': '3',
		'calllback': function() {}
	});
```

### Options
> container

##### description:
It's a string or a jquery selector passed to contain the flip nav bar.


> navBarClass

#### description:
the class of navigation bar


> navContentClass

##### description:
the class of navigation section


> navItemClass

##### description:
the class of single navigation item


> navItemSelectedClass

##### description:
the class of single navigation item when selected


> navBtnClass

##### description:
the class of both of pre and next btn


> btnActiveClass

##### description:
the class of pre/next which represents it can be clicked


> btnDisableClass:

##### description:
the class of pre/next which represents it cannot be clicked


> defaultSelected

##### description:
default selected navigation item's id


> jumpToSelected

##### description:
whether jump to selected item


> callback(data)

##### description:
callback when the navigation item is selected, and the data contains attributes: `id` and `status` of current selected.


> preBtn/nextBtn

##### description:
configuration of pre/next button

|attribute|description|
|:--|:--|
|content| content of button |
|className| class of button (if not set, it will inherit `navBtnClass`) |
|activeClass| active class of button (if not set , it will inherit `btnActiveClass`)|
|disableClass| disable class of button (if not set, it will inherit `btnDisableClass`)|


> navData

##### description:
data of navigation section, an array of objects, each object contains:

|attribute|description|
|:--|:--|
|id| id of each item |
|content| display content of each item |
|status| customrized status of each item |


### Methods
> select(id)

##### description:
select the specific navigation item's id


> changeItemStatus(id, status)

##### description:
change the item's status


> getItemStatus(id)

##### description:
get the status of specific item

## License
The MIT License (MIT)
Copyright (c) <year> <copyright holders>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUTNOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRIN GEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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