flymenu-reactjs
v1.0.4
Published
flymenu-reactjs is an off-canvas menu component written in ReactJS with TypeScript and Styled Components.
Downloads
4
Readme
Description
flymenu-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 flymenu-reactjs
# or via npm
npm install flymenu-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
<OffCanvasPanel />
component
showButton = true
: If the default menu button should be usedstate = ''
: 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'
<Slidemenu />
component
menuDataSource
: Menudata object used to render the menubackButtonText = 'Go back'
: Text on the back-button
Local development and usage
Install dependencies and start the development server
yarn install
yarn start
Open localhost:3000
in your browser.
Requirements
Requires Node 11 to run