44[ ![ Build Status] ( https://drone.committed.software/api/badges/commitd/layout/status.svg )] ( https://drone.committed.software/commitd/layout )
55
66This is a simple layout for standard looking material based apps, based on [ Mui Layout] ( https://mui-treasury.com/components/layout )
7- but using ` @commitd /components ` as its base.
7+ but using ` @committed /components ` as its base.
88
99<p align =" center " >
1010 <img src =" images/layout.png " style =" width : 600px ; box-shadow : 0 4px 8px 0 rgba (0 , 0 , 0 , 0.2 ), 0 6px 20px 0 rgba (0 , 0 , 0 , 0.19 );" />
@@ -16,19 +16,25 @@ Here's a [live demo](https://committed.software/docs)
1616
1717## 🚀 Quickstart
1818
19- For use with [ ` @commitd /components ` ] ( https://github.com/commitd/components ) ,
19+ For use with [ ` @committed /components ` ] ( https://github.com/commitd/components ) ,
2020
2121``` bash
22- yarn add @commitd/layout
22+ yarn add @committed/layout
23+ ```
24+
25+ add any missing peer dependencies
26+
27+ ``` bash
28+ yarn add @committed/components @material-ui/core @material-ui/icons react react-dom
2329```
2430
2531### Usage
2632
2733``` tsx
2834import React from ' react'
2935import ReactDOM from ' react-dom'
30- import { ThemeProvider } from ' @commitd /components'
31- import { Root , Header , Nav , Content , Footer } from ' @commitd /layout'
36+ import { ThemeProvider } from ' @committed /components'
37+ import { Root , Header , Nav , Content , Footer } from ' /layout'
3238
3339const App = () => (
3440 <ThemeProvider >
@@ -72,13 +78,13 @@ The layout adjusts for small screen sizes.
7278
7379For each config parameter a single value or an object with breakpoint keys can be supplied, e.g.
7480
75- ```
81+ ``` javascript
7682const config = {
77- navWidth: {
78- // xs is 256px by default
79- sm: 200, // in sm
80- md: 256, // mdUp
81- }
83+ navWidth: {
84+ // xs is 256px by default
85+ sm: 200 , // in sm
86+ md: 256 // mdUp
87+ }
8288}
8389```
8490
0 commit comments