mui-nav-menu/README.md

Navigation menu component based on material ui

[![npm version](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2Fbigrivi%2Fmui-nav-menu%2Fmain%2Fpackage.json&query=version&prefix=v&label=npm%20package)](https://www.npmjs.com/package/mui-nav-menu)

# Material UI Multi-level Navigation Menu

## Overview

Nested navigation menu based on Material ui and Reactjs,Suitable for use in sidebars, top-level menu bar, and drop-down menus

## Key Features

- Multi-level menu items nesting
- Multi-mode support：inline,vertical,horizontal
- Mini variant
- Support keyboard navigation
- Menu grouping
- Controlled menu opening items
- Route navigation support
- Easier custom theme styles
- Content customization


## Prerequisites

- react >= 18.0.0
- @mui/material >= 5.15.2


## Based on

- [TypeScript](https://www.typescriptlang.org/)
- [React](https://reactjs.org/)
- [Material UI](https://mui.com/)


## Installation

```sh
npm install --save mui-nav-menu
```

## Documentation

[Documentation is here](https://bigrivi.github.io/mui-nav-menu/).

## Author

👤 **bigrivi**
* GitHub: [bigrivi](https://github.com/bigrivi)

## 🤝 Contributing

Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/bigrivi/mui-nav-menu/issues).

## Reference design

* [rc-menu](https://github.com/react-component/menu)
* [antd menu](https://ant.design/components/menu)