@fenderdigital/react-off-canvas
v1.6.1
Published
Fender React UI Kit OffCanvas Component
Downloads
3
Readme
OffCanvas for Fender React UI Kit
Description
The OffCanvas component allows for content to be displayed on and off the viewport.
Installation and Usage
yarn add @fenderdigital/react-off-canvas --save
import OffCanvas from '@fenderdigital/react-off-canvas';
Props
- children - renders any child elements
- isVisible - controls expanded and collapsed state
- onCallback - callback after the visibility state is set
- opacity - controls opacity level of the bg color
- placement - position child content will slide in from (left or right)
| propName | propType | defaultValue | isRequired | | ---------- | -------- | ------------ | ---------- | | children | node | null | - | | isVisible | boolean | null | - | | onCallback | func | () => {} | - | | opacity | number | null | - | | placement | string | left | - |
Development
Check the Monorepo README for development documentation.