https://github.com/subzane/treemenu-reactjs
treemenu-reactjs is an off-canvas tree menu component written in ReactJS with TypeScript and Styled Components.
https://github.com/subzane/treemenu-reactjs
Last synced: about 1 year ago
JSON representation
treemenu-reactjs is an off-canvas tree menu component written in ReactJS with TypeScript and Styled Components.
- Host: GitHub
- URL: https://github.com/subzane/treemenu-reactjs
- Owner: SubZane
- License: mit
- Created: 2023-05-25T12:09:46.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-04T20:59:54.000Z (about 3 years ago)
- Last Synced: 2025-03-30T14:34:19.455Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://subzane.github.io/treemenu-reactjs/
- Size: 3.44 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Description
treemenu-reactjs is an off-canvas menu component written in ReactJS with TypeScript and Styled Components.
## Demo
A demo can be found here: Demo
## Installation
```
yarn add treemenu-reactjs
# or via npm
npm install treemenu-reactjs --save
```
## Theme Options
There is a small theme settings file located in `/src/helpers/theme.tsx` where you can change colors and such.
### Properties
`` component
- `showButton = true`: If the default menu button should be used
- `state = ''`: If the menu should be visible or not. Only used when not using the default menu button `'open' | 'close' | ''`
- `animation = 'door-left'`: Animation effect of the menu. You can choose between `'door-left' | 'door-right' | 'flip-bottom' | 'flip-top'`
`` component
- `menuDataSource`: Menudata object used to render the menu
## Local development and usage
Install dependencies and start the development server
```
yarn install
yarn start
```
Open [`localhost:3000`](http://localhost:3000) in your browser.
## Requirements
Requires Node 10+ to run