Skip to content
This repository was archived by the owner on Jun 29, 2021. It is now read-only.

Commit 7223649

Browse files
committed
🎉 Version 1.0.0
Move to @committed scope
1 parent 0b37b59 commit 7223649

File tree

12 files changed

+32
-38
lines changed

12 files changed

+32
-38
lines changed

.drone.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ steps:
5959
webhook:
6060
from_secret: slack_webhook
6161
template: >
62-
:tada: New version ${DRONE_TAG} of `@commitd/layout` available https://github.com/commitd/layout
62+
:tada: New version ${DRONE_TAG} of `/layout` available https://github.com/commitd/layout
6363
when:
6464
ref:
6565
- refs/tags/v*

README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[![Build Status](https://drone.committed.software/api/badges/commitd/layout/status.svg)](https://drone.committed.software/commitd/layout)
55

66
This 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
2834
import React from 'react'
2935
import 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

3339
const App = () => (
3440
<ThemeProvider>
@@ -72,13 +78,13 @@ The layout adjusts for small screen sizes.
7278

7379
For each config parameter a single value or an object with breakpoint keys can be supplied, e.g.
7480

75-
```
81+
```javascript
7682
const 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

example/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import 'react-app-polyfill/ie11'
22
import * as React from 'react'
33
import * as ReactDOM from 'react-dom'
4-
import { ThemeProvider, Box } from '@commitd/components'
4+
import { ThemeProvider, Box } from '@committed/components'
55
import { Root, Header, Nav, Content, Footer } from '../dist'
66

77
const App = () => (

example/package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@
1616
"scheduler/tracing": "../node_modules/scheduler/tracing-profiling"
1717
},
1818
"devDependencies": {
19-
"@commitd/components": "^0.0.19",
2019
"@types/react": "^16.8.15",
2120
"@types/react-dom": "^16.8.4",
2221
"parcel": "^1.12.3",

example/yarn.lock

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -711,13 +711,6 @@
711711
lodash "^4.17.11"
712712
to-fast-properties "^2.0.0"
713713

714-
"@commitd/components@^0.0.19":
715-
version "0.0.19"
716-
resolved "https://npm.pkg.github.com/download/@commitd/components/0.0.19/fa533286405acfc778be47ecc3edae1a9f5efb50e6f405ef9aebe5f139f05f2e#"
717-
integrity sha512-6laR0AqRbGH31McRuARwk98XANBLlEW8HWMRs+EzXahkPpR5rrsUx1wHk9icXD106Y8YJEY9vIQ5exCNt4PmtQ==
718-
dependencies:
719-
clsx "^1.0.4"
720-
721714
"@iarna/toml@^2.2.0":
722715
version "2.2.3"
723716
resolved "https://registry.yarnpkg.com/@iarna/toml/-/toml-2.2.3.tgz#f060bf6eaafae4d56a7dac618980838b0696e2ab"
@@ -1374,11 +1367,6 @@ clones@^1.2.0:
13741367
resolved "https://registry.yarnpkg.com/clones/-/clones-1.2.0.tgz#b34c872045446a9f264ccceb7731bca05c529b71"
13751368
integrity sha512-FXDYw4TjR8wgPZYui2LeTqWh1BLpfQ8lB6upMtlpDF6WlOOxghmTTxWyngdKTgozqBgKnHbTVwTE+hOHqAykuQ==
13761369

1377-
clsx@^1.0.4:
1378-
version "1.0.4"
1379-
resolved "https://registry.yarnpkg.com/clsx/-/clsx-1.0.4.tgz#0c0171f6d5cb2fe83848463c15fcc26b4df8c2ec"
1380-
integrity sha512-1mQ557MIZTrL/140j+JVdRM6e31/OA4vTYxXgqIIZlndyfjHpyawKZia1Im05Vp9BWmImkcNrNtFYQMyFcgJDg==
1381-
13821370
coa@^2.0.2:
13831371
version "2.0.2"
13841372
resolved "https://registry.yarnpkg.com/coa/-/coa-2.0.2.tgz#43f6c21151b4ef2bf57187db0d73de229e3e7ec3"

package.json

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
2-
"name": "@commitd/layout",
3-
"version": "0.0.4",
2+
"name": "@committed/layout",
3+
"version": "1.0.0",
44
"description": "Committed layout library",
55
"author": "Committed",
66
"license": "MIT",
@@ -21,6 +21,7 @@
2121
"lint": "tsdx lint src test example/index.tsx"
2222
},
2323
"peerDependencies": {
24+
"@committed/components": "^1.0.0",
2425
"@material-ui/icons": "^4.2.1",
2526
"react": ">=16",
2627
"react-dom": "^15.0.0 || ^16.0.0"
@@ -35,7 +36,7 @@
3536
"singleQuote": true
3637
},
3738
"devDependencies": {
38-
"@commitd/components": "^0.0.23",
39+
"@committed/components": "^1.0.0",
3940
"@material-ui/core": "^4.4.2",
4041
"@material-ui/icons": "^4.2.1",
4142
"@types/jest": "^24.0.18",

src/Content.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import React, { useContext, ReactNode } from 'react'
2-
import { Theme, makeStyles } from '@commitd/components'
2+
import { Theme, makeStyles } from '@committed/components'
33
import { LayoutContext } from './Root'
44

55
const useStyles = makeStyles<Theme>(({ transitions }) => ({

src/Footer.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import React, { useContext, ReactNode } from 'react'
22
import { LayoutContext } from './Root'
3-
import { Theme, makeStyles } from '@commitd/components'
3+
import { Theme, makeStyles } from '@committed/components'
44

55
export interface FooterProps {
66
className?: string

src/Header.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import {
88
Icons,
99
makeStyles,
1010
useTheme
11-
} from '@commitd/components'
11+
} from '@committed/components'
1212
import { LayoutContext } from './Root'
1313
import { Layout, Position } from './util'
1414

src/Nav.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import {
77
Theme,
88
Icons,
99
makeStyles
10-
} from '@commitd/components'
10+
} from '@committed/components'
1111
import { LayoutContext } from './Root'
1212

1313
const useStyles = makeStyles<Theme>(

0 commit comments

Comments
 (0)