@graffft-waggle/burger
v0.0.4-alpha.8
Published
graffft-waggle: a burger component
Downloads
9
Readme
filename: /packages/atoms/Burger/Burger.tsx
Burger API
The API documentation of the Burger Graffft Waggle
component.
Import
import { Burger } from '@graffft-waggle/burger';
Burger
Required Props
| Name | Type | Description |
| :----- | :-------- | :-------------------------------------------------- |
| isOpen | boolean
| The open state of the burger menu (true
if open). |
Optional Props
| Name | Type | Default | Description |
| :------------ | :----------- | :--------- | :------------------------------------------------ |
| burgerColor
| string
| '#000'
| The color of the burger menu |
| onClick
| () => void
| () => {}
| Function to be called when burger menu is clicked |
Demos
- TODO