Skip to content

Commit 9e5cf8d

Browse files
committed
docs(emotion,ui-themes): small theming documentation fixes
1 parent 485e712 commit 9e5cf8d

File tree

3 files changed

+18
-7
lines changed

3 files changed

+18
-7
lines changed

docs/guides/using-theme-overrides.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ type: example
8686
theme={{ typography: { fontFamily: 'monospace' } }}
8787
>
8888
<Heading level="h3" margin="small small">
89-
monospace font family set via partial theme object.
89+
monospace font family set via override on the parent theme.
9090
</Heading>
9191
</InstUISettingsProvider>
9292
<InstUISettingsProvider
@@ -97,7 +97,7 @@ type: example
9797
}}
9898
>
9999
<Heading level="h3" margin="small small">
100-
monospace font family set via themeOverride.
100+
monospace font family set via override only if the parent theme is 'canvas'.
101101
</Heading>
102102
</InstUISettingsProvider>
103103
</div>
@@ -150,7 +150,7 @@ type: example
150150
}}
151151
>
152152
<Alert variant="warning" margin="small">
153-
My border and icon background should be deep pink just in the 'canvas' theme.
153+
My border and icon background should be deep pink just if the 'canvas' theme is active.
154154
</Alert>
155155
</InstUISettingsProvider>
156156
</div>
@@ -199,8 +199,7 @@ type: example
199199
<div>
200200
<Button color='primary'
201201
themeOverride={{ primaryBackground: "purple" }}
202-
margin="small 0 0"
203-
>
202+
margin="small 0 0">
204203
Purple Primary Button
205204
</Button>
206205
</div>

packages/emotion/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,8 +110,8 @@ type: example
110110
color='primary'
111111
margin="0 0 0 small"
112112
themeOverride={(_componentTheme, currentTheme) => ({
113-
primaryBackground: currentTheme.colors.backgroundWarning,
114-
primaryBorderColor: currentTheme.colors.backgroundLightest,
113+
primaryBackground: currentTheme.colors.primitives.orange57,
114+
primaryBorderColor: '#00AAA4',
115115
borderWidth: currentTheme.borders.widthLarge,
116116
borderStyle: 'dashed'
117117
})}

packages/ui-themes/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ npm install @instructure/ui-themes
2121
- application level theming:
2222

2323
```jsx
24+
---
25+
type: code
26+
---
2427
import canvas from '@instructure/ui-themes'
2528

2629
ReactDOM.render(
@@ -34,6 +37,9 @@ npm install @instructure/ui-themes
3437
- (DEPRECATED) global theming:
3538

3639
```js
40+
---
41+
type: code
42+
---
3743
import canvas from '@instructure/ui-themes'
3844

3945
canvas.use()
@@ -44,6 +50,9 @@ npm install @instructure/ui-themes
4450
- (DEPRECATED) globally:
4551

4652
```js
53+
---
54+
type: code
55+
---
4756
import canvas from '@instructure/ui-themes'
4857

4958
canvas.use({ overrides: { colors: { brand: 'red' } } })
@@ -52,6 +61,9 @@ npm install @instructure/ui-themes
5261
- application level:
5362

5463
```jsx
64+
---
65+
type: code
66+
---
5567
import canvas from '@instructure/ui-themes'
5668
const themeOverrides = { colors: { brand: 'red' } }
5769

0 commit comments

Comments
 (0)