# navigationbar-circle

> demo: https://navigationbar-circle.herokuapp.com/

Latest version **1.0.3** (published 2021-02-13) · 0 weekly downloads

## Install

```sh
npm install navigationbar-circle
pnpm add navigationbar-circle
yarn add navigationbar-circle
bun add navigationbar-circle
```

## 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.0.3 |
| Published | 2021-02-13 |
| First published | 2021-02-13 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 561.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Harish S Khot |
| Maintainers | khot.harish1207 |
| Keywords | react, navigationbar-circle, navigationbar circle, circle, circle navigationbar |

## Links

- npm: https://www.npmjs.com/package/navigationbar-circle
- Repository: https://github.com/khotharish1207/navigationbar-circle
- Homepage: https://github.com/khotharish1207/navigationbar-circle#readme
- Issues: https://github.com/khotharish1207/navigationbar-circle/issues
- npm.io page: https://npm.io/package/navigationbar-circle

## Dependencies (2)

- [react](https://npm.io/package/react.md) ^16.10.1
- [prop-types](https://npm.io/package/prop-types.md) ^15.7.2

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2021-02-13
- 1.0.2 — 2021-02-13
- 1.0.1 — 2021-02-13
- 1.0.0 — 2021-02-13

## README

# navigationbar-circle

demo: https://navigationbar-circle.herokuapp.com/

## Getting Started

### Prerequisites

Add the class `container-circle-navbar` to your root element in index.html

```
 <div id="root" class="container-circle-navbar"></div>
```

### Installing

```
npm i navigationbar-circle --save
```

### How to use

```
import Nav from 'navigationbar-circle';

class App extends React.Component {
	 render () {
		 return (
             <Nav 
             navItems={
                [
                    <div onClick={() => alert('Home')}><i className="fas fa-home"></i> Home</div>,
                    <div onClick={() => alert('About')}><i className="fas fa-user-alt"></i> About</div>,
                    <div onClick={() => alert('Contact')}><i className="fas fa-envelope"></i> Contact</div>
                ]
            }
             />
             { ... your app }
          }
          />
		 )
	 }
}

```

### Props

| prop        | type   |   default value    |
| ----------- | ------ | :----------------: |
| circleBackgroundColor      | string  | transparent |
| navItems | array   |        []        |
| openIcon | Element   |       <i className="fas fa-times"></i>         |
| closeIcon | Element   |        <i className="fas fa-bars"></i>        |


Navbar events

| Event         |      default value |
| ------------- | :-----------:    |
| onClose| () => {} |
| onOpen| () => {} |

## Author

- **Harish S Khot**

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