@materialr/drawer
v2.0.2
Published
Material drawer implementation for React
Downloads
24
Readme
MaterialR Drawer
@materialr/drawer
Material drawer implementation for React
Installation
$ npm install --save @materialr/drawer
Demo
A full demo is available on the MaterialR website showcasing all variants.
Components
Named exports
import { PermanentDrawer } from '@materialr/drawer';
Props
| Prop | Type | Required | Default | Description |
| ----------- | ------ | -------- | --------- | ---------------------------- |
| children
| node | Yes | N/A | The child elements to render |
| className
| string | No | undefined | Additional classNames to add |
import { PersistentDrawer } from '@materialr/drawer';
Props
| Prop | Type | Required | Default | Description |
| ----------- | ------ | -------- | --------- | ------------------------------------------- |
| children
| node | Yes | N/A | The child elements to render |
| className
| string | No | undefined | Additional classNames to add |
| onClose
| func | No | undefined | An event handler for when the drawer closes |
| onOpen
| func | No | undefined | An event handler for when the drawer opens |
import { TemporaryDrawer } from '@materialr/drawer';
Props
| Prop | Type | Required | Default | Description |
| ----------- | ------ | -------- | --------- | ------------------------------------------- |
| children
| node | Yes | N/A | The child elements to render |
| className
| string | No | undefined | Additional classNames to add |
| onClose
| func | No | undefined | An event handler for when the drawer closes |
| onOpen
| func | No | undefined | An event handler for when the drawer opens |
import { Header } from '@materialr/drawer';
Props
| Prop | Type | Required | Default | Description |
| ----------- | ------ | -------- | --------- | ---------------------------- |
| children
| node | No | undefined | The child elements to render |
| className
| string | No | undefined | Additional classNames to add |
import { ToolbarSpacer } from '@materialr/drawer';
Props
| Prop | Type | Required | Default | Description |
| ----------- | ------ | -------- | --------- | ---------------------------- |
| children
| node | No | undefined | The child elements to render |
| className
| string | No | undefined | Additional classNames to add |