Skip to content

Commit 3455f98

Browse files
committedDec 27, 2021
docs: Write migration notes for v0.13
1 parent 8cb18ce commit 3455f98

File tree

5 files changed

+38
-5
lines changed

5 files changed

+38
-5
lines changed
 

‎.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@ coverage
1212
.envrc.ps1
1313
.publish-log.txt
1414
.yarn-error.log
15-
15+
yarn-error.log
1616

1717
.vercel

‎MIGRATING.md

+32
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,37 @@
11
# Migration Guides
22

3+
## v0.13
4+
5+
**Moved Emotion and `@mdx-js/react` to peerDependencies to solve context
6+
mismatch bugs**
7+
8+
You now install `theme-ui` umbrella package like this:
9+
10+
```
11+
npm install theme-ui @emotion/react @emotion/styled @mdx-js/react
12+
```
13+
14+
- `@emotion/react` is now a peer dependency of the majority of Theme UI
15+
libraries
16+
- `@emotion/styled` is now a peer dependency of `@theme-ui/components`,
17+
`@theme-ui/mdx`, and `theme-ui`
18+
- `@mdx-js/react` is now a peer dependency of `@theme-ui/mdx` and `theme-ui`
19+
20+
This is a revert of change from Theme UI v0.3, and it's meant to help solve
21+
version clashes and context mismatch bugs on user side. Connected issues:
22+
[#1793](https://github.com/system-ui/theme-ui/pull/1793),
23+
[#1531](https://github.com/system-ui/theme-ui/pull/1531),
24+
[#1530](https://github.com/system-ui/theme-ui/pull/1530),
25+
[#1388](https://github.com/system-ui/theme-ui/pull/1388),
26+
[#1345](https://github.com/system-ui/theme-ui/pull/1345),
27+
[#1130](https://github.com/system-ui/theme-ui/pull/1130).
28+
29+
_Disclaimer: You might still encounter this problem if other libraries install
30+
clashing Emotion versions._
31+
32+
Learn more at
33+
[#1867](https://github.com/system-ui/theme-ui/pull/1867#issue-948084198).
34+
335
## v0.9
436

537
**Dropped support for legacy browsers.**

‎packages/core/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
},
1616
"dependencies": {
1717
"@theme-ui/css": "0.12.1",
18-
"@theme-ui/parse-props": "0.12.1",
18+
"@theme-ui/parse-props": "0.12.1"
1919
},
2020
"peerDependencies": {
2121
"react": "^16 || ^17",

‎packages/theme-ui/README.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ scales help you build UI rooted in constraint-based design principles.
113113
## Getting Started
114114

115115
```sh
116-
npm install theme-ui @emotion/react @mdx-js/react
116+
npm install theme-ui @emotion/react @emotion/styled @mdx-js/react
117117
```
118118

119119
_If you don't need color modes, components and MDX support, you can install
@@ -176,7 +176,8 @@ export default (props) => (
176176
fontWeight: 'bold',
177177
fontSize: 4, // picks up value from `theme.fontSizes[4]`
178178
color: 'primary', // picks up value from `theme.colors.primary`
179-
}}>
179+
}}
180+
>
180181
Hello
181182
</div>
182183
)

‎yarn.lock

+1-1
Original file line numberDiff line numberDiff line change
@@ -1467,7 +1467,7 @@
14671467
dependencies:
14681468
"@emotion/memoize" "0.7.4"
14691469

1470-
"@emotion/is-prop-valid@^1.1.1":
1470+
"@emotion/is-prop-valid@^1.1.0", "@emotion/is-prop-valid@^1.1.1":
14711471
version "1.1.1"
14721472
resolved "https://registry.yarnpkg.com/@emotion/is-prop-valid/-/is-prop-valid-1.1.1.tgz#cbd843d409dfaad90f9404e7c0404c55eae8c134"
14731473
integrity sha512-bW1Tos67CZkOURLc0OalnfxtSXQJMrAMV0jZTVGJUPSOd4qgjF3+tTD5CwJM13PHA8cltGW1WGbbvV9NpvUZPw==

0 commit comments

Comments
 (0)
Please sign in to comment.