# x-cite-navbar

> material-ui custom navbar package

Latest version **1.0.0** (published 2020-02-19) · 0 weekly downloads

## Install

```sh
npm install x-cite-navbar
pnpm add x-cite-navbar
yarn add x-cite-navbar
bun add x-cite-navbar
```

## 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.0 |
| Published | 2020-02-19 |
| First published | 2020-02-19 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 3.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | jameleddine |
| Maintainers | jameleddine |
| Keywords | NavBar, Responsive navbar |

## Links

- npm: https://www.npmjs.com/package/x-cite-navbar
- npm.io page: https://npm.io/package/x-cite-navbar

## Dependencies (8)

- [react](https://npm.io/package/react.md) ^16.12.0
- [webpack](https://npm.io/package/webpack.md) ^2.6.1
- [react-dom](https://npm.io/package/react-dom.md) ^16.12.0
- [react-router-dom](https://npm.io/package/react-router-dom.md) ^5.1.2
- [@material-ui/core](https://npm.io/package/@material-ui/core.md) ^4.9.0
- [@material-ui/icons](https://npm.io/package/@material-ui/icons.md) ^4.5.1
- [babel-preset-es2015](https://npm.io/package/babel-preset-es2015.md) ^6.24.1
- [react-global-configuration](https://npm.io/package/react-global-configuration.md) ^1.3.0

## Recent versions

- 1.0.0 (latest) — 2020-02-19

## README

# x-cite-navbar

## NavBar example:



### Create an array for the pages link
```sh
const navConfig = [
	{
		title: 'Pages',
		pages: [
			{
				title: 'Dashboard',
				href: '/dashboard',
				icon: HomeIcon
			}
		]
	}
    ...
];
```

### Add those lines in your component
```sh
import { NavBar } from 'x-cite-navbar'

...
...

const classes = useStyles()
const [isOpenNavBar, setOpenNavBarMobile] = useState(false)

const handleNavBarMobile = () => {
  setOpenNavBarMobile(!isOpenNavBar)
}
const closeNavBar = () => setOpenNavBarMobile(false)
...
```
### Some style for the navbar 
```sh
const useStyles = makeStyles(theme => ({
  navBar: {
    zIndex: 3,
    width: 256,
    minWidth: 256,
    flex: '0 0 auto'
  }
}))
```
### last thing : import you x-cite-navbar component in your template

```sh
  <NavBar
    navConfig={navConfig}
    className={classes.navBar}
    handleNavBarMobile={handleNavBarMobile}
    closeNavBar={closeNavBar}
    isOpen={isOpenNavBar}
  />
```

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