https://github.com/wmira/react-sidenav
React based Sidebar Navigation
https://github.com/wmira/react-sidenav
react sidemenu sidenav sidenavigation
Last synced: about 1 year ago
JSON representation
React based Sidebar Navigation
- Host: GitHub
- URL: https://github.com/wmira/react-sidenav
- Owner: wmira
- License: mit
- Created: 2015-01-06T17:56:38.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2024-02-29T13:40:37.000Z (over 2 years ago)
- Last Synced: 2025-05-27T02:50:57.177Z (about 1 year ago)
- Topics: react, sidemenu, sidenav, sidenavigation
- Language: TypeScript
- Homepage: https://react-sidenav.now.sh
- Size: 4.26 MB
- Stars: 339
- Watchers: 9
- Forks: 63
- Open Issues: 55
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# react-sidenav
[](https://gitlab.com/wmira/react-sidenav/pipelines)
[](https://gitlab.com/wmira/react-sidenav/commits/master)
[](https://badge.fury.io/js/react-sidenav)
Side Navigation Component for React
## Requirements
**react-sidenav** are exported as an es module thus you would need a bundler to use it. It is also written in
Typescript so it can be directly used with a typescript project as well.
### Peer Dependencies
**React 16.8**
### NavContext
As the current version of react-sidenav does not have any fixed rendering template,
the user is free to render Nav items as they see fit. To render conditionally an item can get the context which contains
the following attributes:
| property | type | description |
|------------:|-------------:|------:|
| selected | boolean | if this Nav item is selected |
| id | string | the id of the Nav as per props.id |
| pathId | string | The path id, will be parentId|props.id if rendered with a parent |
| level | number | The level of the Nav, starts with 1 |
| isLeaf | boolean | If true, then this Nav has no children |
Below is an example on how to use it.
```javascript
const Item = () => {
const context = React.useContext(NavContext);
return (
{ props.children }
)
}
Link 1
Link 2
Link 3
```
### SideNav Properties
| property | type | description | isRequired |
|------------|-------------:|------:|-----------------------|
| onSelection | function: ({id, path, payload}) => void | a function that gets called when a navigation has been clicked | false |
| defaultSelectedPath | string | the default selection | false |
| mode | compact, normal | changes rendering style of children | false, defaults to normal |
| childrenToggleMode | hover, click | changes how children are expanded | false, defaults to hover |
| childrenToggleIndicator | React Component | the toggle indicator to render. The collapse, expand state is passed or you can use the NavGroupContext to get the collapse/expand state | false |
### Nav Properties
| property | type | description | isRequired |
|------------|-------------:|------:|-----------------------|
| id | | a function that gets called when a navigation has been clicked | true |
| payload | any | passed to the listener when this nav is clicked | false |
# Development
Please checkout example on CodeSandbox and the src/playground directory for now while
all the documentation/testing is being completed.
# Sponsors
[](https://www.jetbrains.com/?from=react-sidenav)