material-ui-extensions
v0.0.5
Published
A collection of UI elements based on material-ui for react project
Downloads
3
Readme
Material-UI-extensions
A collection of UI elements based on material-ui React package.
Installation
material-ui-extensions is available as an npm package.
rm ```sh npm install material-ui-extensions
## Example
[https://dht.github.io/material-ui-extensions](https://dht.github.io/material-ui-extensions)
## Usage
Here is a quick example to get you started:
**Drawer**
A side panel, either flex or fixed.
```jsx
import Drawer from 'material-ui-extensions/Drawer';
<Drawer
drawerOpen={open}
flex={false}
left={true}
drawerStyle={{padding: '0px'}}
width={300}
hideToggle={false}
toggle={ () => this.setState({open: !open})}>
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse vitae dui
ornare....
</Drawer>
For the flex option, make sure to have a container:
<div style={{display:'flex', flexDirection:'row', alignItems:'stretch'}}>
<Drawer
width={300}
flex={true}
left={true}>
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse vitae dui
ornare....
</Drawer>
<div style={{flex: 1}}>column</div>
<div style={{flex: 1}}>column</div>
</div>
Note that if the drawer is on the right with flex on, the columns should be first:
<div style={{display:'flex', flexDirection:'row', alignItems:'stretch'}}>
<div style={{flex: 1}}>column</div>
<div style={{flex: 1}}>column</div>
<Drawer
width={300}
flex={true}
left={false}>
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse vitae dui
ornare....
</Drawer>
</div>
Contribution
To run locally install all the dependencies:
dev:
npm install
peer:
npm install react@^15.4.1 react-dom@^15.4.1
run with npm:
npm start
first test was added as a starting point:
npm test
License
This project is licensed under the terms of the MIT license