@modern-js/main-doc 2.32.0 → 2.32.2-alpha.1
Sign up to get free protection for your applications and to get access to all the features.
- package/CHANGELOG.md +16 -0
- package/docs/en/apis/app/runtime/app/define-config.mdx +2 -2
- package/docs/en/apis/app/runtime/model/auto-actions.mdx +2 -2
- package/docs/en/apis/app/runtime/model/model_.mdx +0 -1
- package/docs/en/apis/app/runtime/model/use-static-model.mdx +1 -1
- package/docs/en/components/enable-bff-caution.mdx +1 -1
- package/docs/en/configure/app/auto-load-plugin.mdx +2 -2
- package/docs/en/configure/app/bff/_category_.json +1 -1
- package/docs/en/configure/app/builder-plugins.mdx +2 -2
- package/docs/en/configure/app/dev/_category_.json +1 -1
- package/docs/en/configure/app/experiments/_category_.json +1 -1
- package/docs/en/configure/app/html/_category_.json +1 -1
- package/docs/en/configure/app/output/_category_.json +1 -1
- package/docs/en/configure/app/output/ssg.mdx +1 -1
- package/docs/en/configure/app/plugins.mdx +0 -1
- package/docs/en/configure/app/runtime/_category_.json +1 -1
- package/docs/en/configure/app/security/_category_.json +1 -1
- package/docs/en/configure/app/server/_category_.json +1 -1
- package/docs/en/configure/app/source/_category_.json +1 -1
- package/docs/en/configure/app/source/enable-async-entry.mdx +1 -1
- package/docs/en/configure/app/source/mainEntryName.mdx +1 -1
- package/docs/en/configure/app/testing/_category_.json +1 -1
- package/docs/en/configure/app/tools/_category_.json +1 -1
- package/docs/en/configure/app/tools/tailwindcss.mdx +45 -5
- package/docs/en/guides/advanced-features/bff/_category_.json +1 -1
- package/docs/en/guides/advanced-features/bff/frameworks.mdx +2 -2
- package/docs/en/guides/advanced-features/bff/function.mdx +1 -1
- package/docs/en/guides/advanced-features/code-split.mdx +2 -2
- package/docs/en/guides/advanced-features/eslint.mdx +2 -2
- package/docs/en/guides/advanced-features/low-level.mdx +2 -2
- package/docs/en/guides/advanced-features/ssg.mdx +2 -3
- package/docs/en/guides/advanced-features/ssr.mdx +2 -3
- package/docs/en/guides/advanced-features/testing.mdx +3 -3
- package/docs/en/guides/advanced-features/using-storybook.mdx +1 -1
- package/docs/en/guides/advanced-features/web-server.mdx +2 -2
- package/docs/en/guides/basic-features/alias.mdx +3 -3
- package/docs/en/guides/basic-features/css.mdx +27 -64
- package/docs/en/guides/basic-features/data-fetch.mdx +2 -2
- package/docs/en/guides/basic-features/env-vars.mdx +2 -2
- package/docs/en/guides/basic-features/html.mdx +0 -1
- package/docs/en/guides/basic-features/mock.mdx +4 -4
- package/docs/en/guides/basic-features/proxy.mdx +3 -3
- package/docs/en/guides/basic-features/routes.mdx +1 -2
- package/docs/en/guides/concept/builder.mdx +2 -2
- package/docs/en/guides/concept/entries.mdx +1 -1
- package/docs/en/guides/get-started/upgrade.mdx +1 -2
- package/docs/en/guides/topic-detail/framework-plugin/hook.mdx +2 -2
- package/docs/en/guides/topic-detail/generator/plugin/category.md +1 -1
- package/docs/en/guides/topic-detail/generator/plugin/context.md +1 -1
- package/docs/en/guides/topic-detail/micro-frontend/c02-development.mdx +2 -2
- package/docs/en/guides/topic-detail/model/auto-actions.mdx +1 -1
- package/docs/en/guides/topic-detail/model/performance.mdx +2 -1
- package/docs/en/guides/topic-detail/model/typescript-best-practice.mdx +1 -1
- package/docs/en/guides/topic-detail/model/use-model.mdx +1 -1
- package/docs/en/tutorials/first-app/c05-loader.mdx +0 -2
- package/docs/zh/community/releases.mdx +1 -1
- package/docs/zh/community/team.mdx +1 -1
- package/docs/zh/components/enable-bff-caution.mdx +2 -2
- package/docs/zh/configure/app/auto-load-plugin.mdx +2 -3
- package/docs/zh/configure/app/bff/_category_.json +2 -2
- package/docs/zh/configure/app/builder-plugins.mdx +2 -3
- package/docs/zh/configure/app/deploy/_category_.json +1 -1
- package/docs/zh/configure/app/dev/_category_.json +2 -2
- package/docs/zh/configure/app/experiments/_category_.json +2 -2
- package/docs/zh/configure/app/html/_category_.json +2 -2
- package/docs/zh/configure/app/output/_category_.json +2 -2
- package/docs/zh/configure/app/output/ssg.mdx +1 -1
- package/docs/zh/configure/app/performance/_category_.json +1 -1
- package/docs/zh/configure/app/plugins.mdx +1 -2
- package/docs/zh/configure/app/runtime/_category_.json +2 -2
- package/docs/zh/configure/app/security/_category_.json +2 -2
- package/docs/zh/configure/app/server/_category_.json +2 -2
- package/docs/zh/configure/app/source/_category_.json +2 -2
- package/docs/zh/configure/app/testing/_category_.json +2 -2
- package/docs/zh/configure/app/tools/_category_.json +2 -2
- package/docs/zh/configure/app/tools/tailwindcss.mdx +44 -6
- package/docs/zh/guides/advanced-features/bff/_category_.json +1 -1
- package/docs/zh/guides/advanced-features/code-split.mdx +2 -2
- package/docs/zh/guides/advanced-features/compatibility.mdx +1 -1
- package/docs/zh/guides/advanced-features/eslint.mdx +1 -1
- package/docs/zh/guides/advanced-features/low-level.mdx +2 -2
- package/docs/zh/guides/advanced-features/rspack-start.mdx +0 -1
- package/docs/zh/guides/advanced-features/ssg.mdx +3 -4
- package/docs/zh/guides/advanced-features/ssr.mdx +2 -3
- package/docs/zh/guides/advanced-features/testing.mdx +2 -2
- package/docs/zh/guides/advanced-features/using-storybook.mdx +1 -1
- package/docs/zh/guides/advanced-features/web-server.mdx +2 -2
- package/docs/zh/guides/basic-features/alias.mdx +3 -3
- package/docs/zh/guides/basic-features/css.mdx +27 -64
- package/docs/zh/guides/basic-features/data-fetch.mdx +1 -2
- package/docs/zh/guides/basic-features/env-vars.mdx +1 -1
- package/docs/zh/guides/basic-features/mock.mdx +2 -2
- package/docs/zh/guides/basic-features/proxy.mdx +3 -3
- package/docs/zh/guides/basic-features/routes.mdx +1 -2
- package/docs/zh/guides/concept/builder.mdx +1 -1
- package/docs/zh/guides/concept/entries.mdx +3 -3
- package/docs/zh/guides/get-started/upgrade.mdx +1 -2
- package/modern.config.ts +8 -0
- package/package.json +5 -5
- package/src/i18n/enUS.ts +1 -1
- package/src/i18n/zhCN.ts +1 -1
- package/docs/en/configure/app/source/design-system.mdx +0 -1175
- package/docs/zh/configure/app/source/design-system.mdx +0 -1174
@@ -1,1175 +0,0 @@
|
|
1
|
-
---
|
2
|
-
sidebar_label: designSystem
|
3
|
-
---
|
4
|
-
|
5
|
-
# source.designSystem
|
6
|
-
|
7
|
-
- **Type:** `Object`
|
8
|
-
- **Default:** See configuration details below.
|
9
|
-
|
10
|
-
:::caution
|
11
|
-
Tailwind CSS feature needs to be enabled first by running `pnpm run new`.
|
12
|
-
|
13
|
-
:::
|
14
|
-
|
15
|
-
<details>
|
16
|
-
<summary>DesignSystem Configuration Details</summary>
|
17
|
-
|
18
|
-
```js
|
19
|
-
const designSystem = {
|
20
|
-
screens: {
|
21
|
-
sm: '640px',
|
22
|
-
md: '768px',
|
23
|
-
lg: '1024px',
|
24
|
-
xl: '1280px',
|
25
|
-
},
|
26
|
-
colors: {
|
27
|
-
transparent: 'transparent',
|
28
|
-
current: 'currentColor',
|
29
|
-
|
30
|
-
black: '#000',
|
31
|
-
white: '#fff',
|
32
|
-
|
33
|
-
gray: {
|
34
|
-
100: '#f7fafc',
|
35
|
-
200: '#edf2f7',
|
36
|
-
300: '#e2e8f0',
|
37
|
-
400: '#cbd5e0',
|
38
|
-
500: '#a0aec0',
|
39
|
-
600: '#718096',
|
40
|
-
700: '#4a5568',
|
41
|
-
800: '#2d3748',
|
42
|
-
900: '#1a202c',
|
43
|
-
},
|
44
|
-
red: {
|
45
|
-
100: '#fff5f5',
|
46
|
-
200: '#fed7d7',
|
47
|
-
300: '#feb2b2',
|
48
|
-
400: '#fc8181',
|
49
|
-
500: '#f56565',
|
50
|
-
600: '#e53e3e',
|
51
|
-
700: '#c53030',
|
52
|
-
800: '#9b2c2c',
|
53
|
-
900: '#742a2a',
|
54
|
-
},
|
55
|
-
orange: {
|
56
|
-
100: '#fffaf0',
|
57
|
-
200: '#feebc8',
|
58
|
-
300: '#fbd38d',
|
59
|
-
400: '#f6ad55',
|
60
|
-
500: '#ed8936',
|
61
|
-
600: '#dd6b20',
|
62
|
-
700: '#c05621',
|
63
|
-
800: '#9c4221',
|
64
|
-
900: '#7b341e',
|
65
|
-
},
|
66
|
-
yellow: {
|
67
|
-
100: '#fffff0',
|
68
|
-
200: '#fefcbf',
|
69
|
-
300: '#faf089',
|
70
|
-
400: '#f6e05e',
|
71
|
-
500: '#ecc94b',
|
72
|
-
600: '#d69e2e',
|
73
|
-
700: '#b7791f',
|
74
|
-
800: '#975a16',
|
75
|
-
900: '#744210',
|
76
|
-
},
|
77
|
-
green: {
|
78
|
-
100: '#f0fff4',
|
79
|
-
200: '#c6f6d5',
|
80
|
-
300: '#9ae6b4',
|
81
|
-
400: '#68d391',
|
82
|
-
500: '#48bb78',
|
83
|
-
600: '#38a169',
|
84
|
-
700: '#2f855a',
|
85
|
-
800: '#276749',
|
86
|
-
900: '#22543d',
|
87
|
-
},
|
88
|
-
teal: {
|
89
|
-
100: '#e6fffa',
|
90
|
-
200: '#b2f5ea',
|
91
|
-
300: '#81e6d9',
|
92
|
-
400: '#4fd1c5',
|
93
|
-
500: '#38b2ac',
|
94
|
-
600: '#319795',
|
95
|
-
700: '#2c7a7b',
|
96
|
-
800: '#285e61',
|
97
|
-
900: '#234e52',
|
98
|
-
},
|
99
|
-
blue: {
|
100
|
-
100: '#ebf8ff',
|
101
|
-
200: '#bee3f8',
|
102
|
-
300: '#90cdf4',
|
103
|
-
400: '#63b3ed',
|
104
|
-
500: '#4299e1',
|
105
|
-
600: '#3182ce',
|
106
|
-
700: '#2b6cb0',
|
107
|
-
800: '#2c5282',
|
108
|
-
900: '#2a4365',
|
109
|
-
},
|
110
|
-
indigo: {
|
111
|
-
100: '#ebf4ff',
|
112
|
-
200: '#c3dafe',
|
113
|
-
300: '#a3bffa',
|
114
|
-
400: '#7f9cf5',
|
115
|
-
500: '#667eea',
|
116
|
-
600: '#5a67d8',
|
117
|
-
700: '#4c51bf',
|
118
|
-
800: '#434190',
|
119
|
-
900: '#3c366b',
|
120
|
-
},
|
121
|
-
purple: {
|
122
|
-
100: '#faf5ff',
|
123
|
-
200: '#e9d8fd',
|
124
|
-
300: '#d6bcfa',
|
125
|
-
400: '#b794f4',
|
126
|
-
500: '#9f7aea',
|
127
|
-
600: '#805ad5',
|
128
|
-
700: '#6b46c1',
|
129
|
-
800: '#553c9a',
|
130
|
-
900: '#44337a',
|
131
|
-
},
|
132
|
-
pink: {
|
133
|
-
100: '#fff5f7',
|
134
|
-
200: '#fed7e2',
|
135
|
-
300: '#fbb6ce',
|
136
|
-
400: '#f687b3',
|
137
|
-
500: '#ed64a6',
|
138
|
-
600: '#d53f8c',
|
139
|
-
700: '#b83280',
|
140
|
-
800: '#97266d',
|
141
|
-
900: '#702459',
|
142
|
-
},
|
143
|
-
},
|
144
|
-
spacing: {
|
145
|
-
px: '1px',
|
146
|
-
0: '0',
|
147
|
-
1: '0.25rem',
|
148
|
-
2: '0.5rem',
|
149
|
-
3: '0.75rem',
|
150
|
-
4: '1rem',
|
151
|
-
5: '1.25rem',
|
152
|
-
6: '1.5rem',
|
153
|
-
8: '2rem',
|
154
|
-
10: '2.5rem',
|
155
|
-
12: '3rem',
|
156
|
-
16: '4rem',
|
157
|
-
20: '5rem',
|
158
|
-
24: '6rem',
|
159
|
-
32: '8rem',
|
160
|
-
40: '10rem',
|
161
|
-
48: '12rem',
|
162
|
-
56: '14rem',
|
163
|
-
64: '16rem',
|
164
|
-
},
|
165
|
-
backgroundColor: theme => theme('colors'),
|
166
|
-
backgroundOpacity: theme => theme('opacity'),
|
167
|
-
backgroundPosition: {
|
168
|
-
bottom: 'bottom',
|
169
|
-
center: 'center',
|
170
|
-
left: 'left',
|
171
|
-
'left-bottom': 'left bottom',
|
172
|
-
'left-top': 'left top',
|
173
|
-
right: 'right',
|
174
|
-
'right-bottom': 'right bottom',
|
175
|
-
'right-top': 'right top',
|
176
|
-
top: 'top',
|
177
|
-
},
|
178
|
-
backgroundSize: {
|
179
|
-
auto: 'auto',
|
180
|
-
cover: 'cover',
|
181
|
-
contain: 'contain',
|
182
|
-
},
|
183
|
-
borderColor: theme => ({
|
184
|
-
...theme('colors'),
|
185
|
-
default: theme('colors.gray.300', 'currentColor'),
|
186
|
-
}),
|
187
|
-
borderOpacity: theme => theme('opacity'),
|
188
|
-
borderRadius: {
|
189
|
-
none: '0',
|
190
|
-
sm: '0.125rem',
|
191
|
-
default: '0.25rem',
|
192
|
-
md: '0.375rem',
|
193
|
-
lg: '0.5rem',
|
194
|
-
full: '9999px',
|
195
|
-
},
|
196
|
-
borderWidth: {
|
197
|
-
default: '1px',
|
198
|
-
0: '0',
|
199
|
-
2: '2px',
|
200
|
-
4: '4px',
|
201
|
-
8: '8px',
|
202
|
-
},
|
203
|
-
boxShadow: {
|
204
|
-
xs: '0 0 0 1px rgba(0, 0, 0, 0.05)',
|
205
|
-
sm: '0 1px 2px 0 rgba(0, 0, 0, 0.05)',
|
206
|
-
default: '0 1px 3px 0 rgba(0, 0, 0, 0.1), 0 1px 2px 0 rgba(0, 0, 0, 0.06)',
|
207
|
-
md: '0 4px 6px -1px rgba(0, 0, 0, 0.1), 0 2px 4px -1px rgba(0, 0, 0, 0.06)',
|
208
|
-
lg: '0 10px 15px -3px rgba(0, 0, 0, 0.1), 0 4px 6px -2px rgba(0, 0, 0, 0.05)',
|
209
|
-
xl: '0 20px 25px -5px rgba(0, 0, 0, 0.1), 0 10px 10px -5px rgba(0, 0, 0, 0.04)',
|
210
|
-
'2xl': '0 25px 50px -12px rgba(0, 0, 0, 0.25)',
|
211
|
-
inner: 'inset 0 2px 4px 0 rgba(0, 0, 0, 0.06)',
|
212
|
-
outline: '0 0 0 3px rgba(66, 153, 225, 0.5)',
|
213
|
-
none: 'none',
|
214
|
-
},
|
215
|
-
container: {},
|
216
|
-
cursor: {
|
217
|
-
auto: 'auto',
|
218
|
-
default: 'default',
|
219
|
-
pointer: 'pointer',
|
220
|
-
wait: 'wait',
|
221
|
-
text: 'text',
|
222
|
-
move: 'move',
|
223
|
-
'not-allowed': 'not-allowed',
|
224
|
-
},
|
225
|
-
divideColor: theme => theme('borderColor'),
|
226
|
-
divideOpacity: theme => theme('borderOpacity'),
|
227
|
-
divideWidth: theme => theme('borderWidth'),
|
228
|
-
fill: {
|
229
|
-
current: 'currentColor',
|
230
|
-
},
|
231
|
-
flex: {
|
232
|
-
1: '1 1 0%',
|
233
|
-
auto: '1 1 auto',
|
234
|
-
initial: '0 1 auto',
|
235
|
-
none: 'none',
|
236
|
-
},
|
237
|
-
flexGrow: {
|
238
|
-
0: '0',
|
239
|
-
default: '1',
|
240
|
-
},
|
241
|
-
flexShrink: {
|
242
|
-
0: '0',
|
243
|
-
default: '1',
|
244
|
-
},
|
245
|
-
fontFamily: {
|
246
|
-
sans: [
|
247
|
-
'system-ui',
|
248
|
-
'-apple-system',
|
249
|
-
'BlinkMacSystemFont',
|
250
|
-
'"Segoe UI"',
|
251
|
-
'Roboto',
|
252
|
-
'"Helvetica Neue"',
|
253
|
-
'Arial',
|
254
|
-
'"Noto Sans"',
|
255
|
-
'sans-serif',
|
256
|
-
'"Apple Color Emoji"',
|
257
|
-
'"Segoe UI Emoji"',
|
258
|
-
'"Segoe UI Symbol"',
|
259
|
-
'"Noto Color Emoji"',
|
260
|
-
],
|
261
|
-
serif: ['Georgia', 'Cambria', '"Times New Roman"', 'Times', 'serif'],
|
262
|
-
mono: [
|
263
|
-
'Menlo',
|
264
|
-
'Monaco',
|
265
|
-
'Consolas',
|
266
|
-
'"Liberation Mono"',
|
267
|
-
'"Courier New"',
|
268
|
-
'monospace',
|
269
|
-
],
|
270
|
-
},
|
271
|
-
fontSize: {
|
272
|
-
xs: '0.75rem',
|
273
|
-
sm: '0.875rem',
|
274
|
-
base: '1rem',
|
275
|
-
lg: '1.125rem',
|
276
|
-
xl: '1.25rem',
|
277
|
-
'2xl': '1.5rem',
|
278
|
-
'3xl': '1.875rem',
|
279
|
-
'4xl': '2.25rem',
|
280
|
-
'5xl': '3rem',
|
281
|
-
'6xl': '4rem',
|
282
|
-
},
|
283
|
-
fontWeight: {
|
284
|
-
hairline: '100',
|
285
|
-
thin: '200',
|
286
|
-
light: '300',
|
287
|
-
normal: '400',
|
288
|
-
medium: '500',
|
289
|
-
semibold: '600',
|
290
|
-
bold: '700',
|
291
|
-
extrabold: '800',
|
292
|
-
black: '900',
|
293
|
-
},
|
294
|
-
height: theme => ({
|
295
|
-
auto: 'auto',
|
296
|
-
...theme('spacing'),
|
297
|
-
full: '100%',
|
298
|
-
screen: '100vh',
|
299
|
-
}),
|
300
|
-
inset: {
|
301
|
-
0: '0',
|
302
|
-
auto: 'auto',
|
303
|
-
},
|
304
|
-
letterSpacing: {
|
305
|
-
tighter: '-0.05em',
|
306
|
-
tight: '-0.025em',
|
307
|
-
normal: '0',
|
308
|
-
wide: '0.025em',
|
309
|
-
wider: '0.05em',
|
310
|
-
widest: '0.1em',
|
311
|
-
},
|
312
|
-
lineHeight: {
|
313
|
-
none: '1',
|
314
|
-
tight: '1.25',
|
315
|
-
snug: '1.375',
|
316
|
-
normal: '1.5',
|
317
|
-
relaxed: '1.625',
|
318
|
-
loose: '2',
|
319
|
-
3: '.75rem',
|
320
|
-
4: '1rem',
|
321
|
-
5: '1.25rem',
|
322
|
-
6: '1.5rem',
|
323
|
-
7: '1.75rem',
|
324
|
-
8: '2rem',
|
325
|
-
9: '2.25rem',
|
326
|
-
10: '2.5rem',
|
327
|
-
},
|
328
|
-
listStyleType: {
|
329
|
-
none: 'none',
|
330
|
-
disc: 'disc',
|
331
|
-
decimal: 'decimal',
|
332
|
-
},
|
333
|
-
margin: (theme, { negative }) => ({
|
334
|
-
auto: 'auto',
|
335
|
-
...theme('spacing'),
|
336
|
-
...negative(theme('spacing')),
|
337
|
-
}),
|
338
|
-
maxHeight: {
|
339
|
-
full: '100%',
|
340
|
-
screen: '100vh',
|
341
|
-
},
|
342
|
-
maxWidth: (theme, { breakpoints }) => ({
|
343
|
-
none: 'none',
|
344
|
-
xs: '20rem',
|
345
|
-
sm: '24rem',
|
346
|
-
md: '28rem',
|
347
|
-
lg: '32rem',
|
348
|
-
xl: '36rem',
|
349
|
-
'2xl': '42rem',
|
350
|
-
'3xl': '48rem',
|
351
|
-
'4xl': '56rem',
|
352
|
-
'5xl': '64rem',
|
353
|
-
'6xl': '72rem',
|
354
|
-
full: '100%',
|
355
|
-
...breakpoints(theme('screens')),
|
356
|
-
}),
|
357
|
-
minHeight: {
|
358
|
-
0: '0',
|
359
|
-
full: '100%',
|
360
|
-
screen: '100vh',
|
361
|
-
},
|
362
|
-
minWidth: {
|
363
|
-
0: '0',
|
364
|
-
full: '100%',
|
365
|
-
},
|
366
|
-
objectPosition: {
|
367
|
-
bottom: 'bottom',
|
368
|
-
center: 'center',
|
369
|
-
left: 'left',
|
370
|
-
'left-bottom': 'left bottom',
|
371
|
-
'left-top': 'left top',
|
372
|
-
right: 'right',
|
373
|
-
'right-bottom': 'right bottom',
|
374
|
-
'right-top': 'right top',
|
375
|
-
top: 'top',
|
376
|
-
},
|
377
|
-
opacity: {
|
378
|
-
0: '0',
|
379
|
-
25: '0.25',
|
380
|
-
50: '0.5',
|
381
|
-
75: '0.75',
|
382
|
-
100: '1',
|
383
|
-
},
|
384
|
-
order: {
|
385
|
-
first: '-9999',
|
386
|
-
last: '9999',
|
387
|
-
none: '0',
|
388
|
-
1: '1',
|
389
|
-
2: '2',
|
390
|
-
3: '3',
|
391
|
-
4: '4',
|
392
|
-
5: '5',
|
393
|
-
6: '6',
|
394
|
-
7: '7',
|
395
|
-
8: '8',
|
396
|
-
9: '9',
|
397
|
-
10: '10',
|
398
|
-
11: '11',
|
399
|
-
12: '12',
|
400
|
-
},
|
401
|
-
padding: theme => theme('spacing'),
|
402
|
-
placeholderColor: theme => theme('colors'),
|
403
|
-
placeholderOpacity: theme => theme('opacity'),
|
404
|
-
space: (theme, { negative }) => ({
|
405
|
-
...theme('spacing'),
|
406
|
-
...negative(theme('spacing')),
|
407
|
-
}),
|
408
|
-
stroke: {
|
409
|
-
current: 'currentColor',
|
410
|
-
},
|
411
|
-
strokeWidth: {
|
412
|
-
0: '0',
|
413
|
-
1: '1',
|
414
|
-
2: '2',
|
415
|
-
},
|
416
|
-
textColor: theme => theme('colors'),
|
417
|
-
textOpacity: theme => theme('opacity'),
|
418
|
-
width: theme => ({
|
419
|
-
auto: 'auto',
|
420
|
-
...theme('spacing'),
|
421
|
-
'1/2': '50%',
|
422
|
-
'1/3': '33.333333%',
|
423
|
-
'2/3': '66.666667%',
|
424
|
-
'1/4': '25%',
|
425
|
-
'2/4': '50%',
|
426
|
-
'3/4': '75%',
|
427
|
-
'1/5': '20%',
|
428
|
-
'2/5': '40%',
|
429
|
-
'3/5': '60%',
|
430
|
-
'4/5': '80%',
|
431
|
-
'1/6': '16.666667%',
|
432
|
-
'2/6': '33.333333%',
|
433
|
-
'3/6': '50%',
|
434
|
-
'4/6': '66.666667%',
|
435
|
-
'5/6': '83.333333%',
|
436
|
-
'1/12': '8.333333%',
|
437
|
-
'2/12': '16.666667%',
|
438
|
-
'3/12': '25%',
|
439
|
-
'4/12': '33.333333%',
|
440
|
-
'5/12': '41.666667%',
|
441
|
-
'6/12': '50%',
|
442
|
-
'7/12': '58.333333%',
|
443
|
-
'8/12': '66.666667%',
|
444
|
-
'9/12': '75%',
|
445
|
-
'10/12': '83.333333%',
|
446
|
-
'11/12': '91.666667%',
|
447
|
-
full: '100%',
|
448
|
-
screen: '100vw',
|
449
|
-
}),
|
450
|
-
zIndex: {
|
451
|
-
auto: 'auto',
|
452
|
-
0: '0',
|
453
|
-
10: '10',
|
454
|
-
20: '20',
|
455
|
-
30: '30',
|
456
|
-
40: '40',
|
457
|
-
50: '50',
|
458
|
-
},
|
459
|
-
gap: theme => theme('spacing'),
|
460
|
-
gridTemplateColumns: {
|
461
|
-
none: 'none',
|
462
|
-
1: 'repeat(1, minmax(0, 1fr))',
|
463
|
-
2: 'repeat(2, minmax(0, 1fr))',
|
464
|
-
3: 'repeat(3, minmax(0, 1fr))',
|
465
|
-
4: 'repeat(4, minmax(0, 1fr))',
|
466
|
-
5: 'repeat(5, minmax(0, 1fr))',
|
467
|
-
6: 'repeat(6, minmax(0, 1fr))',
|
468
|
-
7: 'repeat(7, minmax(0, 1fr))',
|
469
|
-
8: 'repeat(8, minmax(0, 1fr))',
|
470
|
-
9: 'repeat(9, minmax(0, 1fr))',
|
471
|
-
10: 'repeat(10, minmax(0, 1fr))',
|
472
|
-
11: 'repeat(11, minmax(0, 1fr))',
|
473
|
-
12: 'repeat(12, minmax(0, 1fr))',
|
474
|
-
},
|
475
|
-
gridColumn: {
|
476
|
-
auto: 'auto',
|
477
|
-
'span-1': 'span 1 / span 1',
|
478
|
-
'span-2': 'span 2 / span 2',
|
479
|
-
'span-3': 'span 3 / span 3',
|
480
|
-
'span-4': 'span 4 / span 4',
|
481
|
-
'span-5': 'span 5 / span 5',
|
482
|
-
'span-6': 'span 6 / span 6',
|
483
|
-
'span-7': 'span 7 / span 7',
|
484
|
-
'span-8': 'span 8 / span 8',
|
485
|
-
'span-9': 'span 9 / span 9',
|
486
|
-
'span-10': 'span 10 / span 10',
|
487
|
-
'span-11': 'span 11 / span 11',
|
488
|
-
'span-12': 'span 12 / span 12',
|
489
|
-
},
|
490
|
-
gridColumnStart: {
|
491
|
-
auto: 'auto',
|
492
|
-
1: '1',
|
493
|
-
2: '2',
|
494
|
-
3: '3',
|
495
|
-
4: '4',
|
496
|
-
5: '5',
|
497
|
-
6: '6',
|
498
|
-
7: '7',
|
499
|
-
8: '8',
|
500
|
-
9: '9',
|
501
|
-
10: '10',
|
502
|
-
11: '11',
|
503
|
-
12: '12',
|
504
|
-
13: '13',
|
505
|
-
},
|
506
|
-
gridColumnEnd: {
|
507
|
-
auto: 'auto',
|
508
|
-
1: '1',
|
509
|
-
2: '2',
|
510
|
-
3: '3',
|
511
|
-
4: '4',
|
512
|
-
5: '5',
|
513
|
-
6: '6',
|
514
|
-
7: '7',
|
515
|
-
8: '8',
|
516
|
-
9: '9',
|
517
|
-
10: '10',
|
518
|
-
11: '11',
|
519
|
-
12: '12',
|
520
|
-
13: '13',
|
521
|
-
},
|
522
|
-
gridTemplateRows: {
|
523
|
-
none: 'none',
|
524
|
-
1: 'repeat(1, minmax(0, 1fr))',
|
525
|
-
2: 'repeat(2, minmax(0, 1fr))',
|
526
|
-
3: 'repeat(3, minmax(0, 1fr))',
|
527
|
-
4: 'repeat(4, minmax(0, 1fr))',
|
528
|
-
5: 'repeat(5, minmax(0, 1fr))',
|
529
|
-
6: 'repeat(6, minmax(0, 1fr))',
|
530
|
-
},
|
531
|
-
gridRow: {
|
532
|
-
auto: 'auto',
|
533
|
-
'span-1': 'span 1 / span 1',
|
534
|
-
'span-2': 'span 2 / span 2',
|
535
|
-
'span-3': 'span 3 / span 3',
|
536
|
-
'span-4': 'span 4 / span 4',
|
537
|
-
'span-5': 'span 5 / span 5',
|
538
|
-
'span-6': 'span 6 / span 6',
|
539
|
-
},
|
540
|
-
gridRowStart: {
|
541
|
-
auto: 'auto',
|
542
|
-
1: '1',
|
543
|
-
2: '2',
|
544
|
-
3: '3',
|
545
|
-
4: '4',
|
546
|
-
5: '5',
|
547
|
-
6: '6',
|
548
|
-
7: '7',
|
549
|
-
},
|
550
|
-
gridRowEnd: {
|
551
|
-
auto: 'auto',
|
552
|
-
1: '1',
|
553
|
-
2: '2',
|
554
|
-
3: '3',
|
555
|
-
4: '4',
|
556
|
-
5: '5',
|
557
|
-
6: '6',
|
558
|
-
7: '7',
|
559
|
-
},
|
560
|
-
transformOrigin: {
|
561
|
-
center: 'center',
|
562
|
-
top: 'top',
|
563
|
-
'top-right': 'top right',
|
564
|
-
right: 'right',
|
565
|
-
'bottom-right': 'bottom right',
|
566
|
-
bottom: 'bottom',
|
567
|
-
'bottom-left': 'bottom left',
|
568
|
-
left: 'left',
|
569
|
-
'top-left': 'top left',
|
570
|
-
},
|
571
|
-
scale: {
|
572
|
-
0: '0',
|
573
|
-
50: '.5',
|
574
|
-
75: '.75',
|
575
|
-
90: '.9',
|
576
|
-
95: '.95',
|
577
|
-
100: '1',
|
578
|
-
105: '1.05',
|
579
|
-
110: '1.1',
|
580
|
-
125: '1.25',
|
581
|
-
150: '1.5',
|
582
|
-
},
|
583
|
-
rotate: {
|
584
|
-
'-180': '-180deg',
|
585
|
-
'-90': '-90deg',
|
586
|
-
'-45': '-45deg',
|
587
|
-
0: '0',
|
588
|
-
45: '45deg',
|
589
|
-
90: '90deg',
|
590
|
-
180: '180deg',
|
591
|
-
},
|
592
|
-
translate: (theme, { negative }) => ({
|
593
|
-
...theme('spacing'),
|
594
|
-
...negative(theme('spacing')),
|
595
|
-
'-full': '-100%',
|
596
|
-
'-1/2': '-50%',
|
597
|
-
'1/2': '50%',
|
598
|
-
full: '100%',
|
599
|
-
}),
|
600
|
-
skew: {
|
601
|
-
'-12': '-12deg',
|
602
|
-
'-6': '-6deg',
|
603
|
-
'-3': '-3deg',
|
604
|
-
0: '0',
|
605
|
-
3: '3deg',
|
606
|
-
6: '6deg',
|
607
|
-
12: '12deg',
|
608
|
-
},
|
609
|
-
transitionProperty: {
|
610
|
-
none: 'none',
|
611
|
-
all: 'all',
|
612
|
-
default:
|
613
|
-
'background-color, border-color, color, fill, stroke, opacity, box-shadow, transform',
|
614
|
-
colors: 'background-color, border-color, color, fill, stroke',
|
615
|
-
opacity: 'opacity',
|
616
|
-
shadow: 'box-shadow',
|
617
|
-
transform: 'transform',
|
618
|
-
},
|
619
|
-
transitionTimingFunction: {
|
620
|
-
linear: 'linear',
|
621
|
-
in: 'cubic-bezier(0.4, 0, 1, 1)',
|
622
|
-
out: 'cubic-bezier(0, 0, 0.2, 1)',
|
623
|
-
'in-out': 'cubic-bezier(0.4, 0, 0.2, 1)',
|
624
|
-
},
|
625
|
-
transitionDuration: {
|
626
|
-
75: '75ms',
|
627
|
-
100: '100ms',
|
628
|
-
150: '150ms',
|
629
|
-
200: '200ms',
|
630
|
-
300: '300ms',
|
631
|
-
500: '500ms',
|
632
|
-
700: '700ms',
|
633
|
-
1000: '1000ms',
|
634
|
-
},
|
635
|
-
transitionDelay: {
|
636
|
-
75: '75ms',
|
637
|
-
100: '100ms',
|
638
|
-
150: '150ms',
|
639
|
-
200: '200ms',
|
640
|
-
300: '300ms',
|
641
|
-
500: '500ms',
|
642
|
-
700: '700ms',
|
643
|
-
1000: '1000ms',
|
644
|
-
},
|
645
|
-
};
|
646
|
-
```
|
647
|
-
|
648
|
-
</details>
|
649
|
-
|
650
|
-
:::tip
|
651
|
-
For more information on TailwindCSS configuration, please refer to [here](https://tailwindcss.com/docs/configuration#theme).
|
652
|
-
|
653
|
-
:::
|
654
|
-
|
655
|
-
The `designSystem` is used to define the project's color palette, typographic scales, font list, breakpoints, border radius values, and more. As Modern.js uses the design approach of Tailwind Theme and also integrates Tailwind CSS internally, the usage of `designSystem` is the same as that of Tailwind CSS Theme.
|
656
|
-
|
657
|
-
### Structure
|
658
|
-
|
659
|
-
The `designSystem` object contains properties for `screens`, `colors`, `spacing`, and each customizable core plugin.
|
660
|
-
|
661
|
-
#### Screens
|
662
|
-
|
663
|
-
Use `screens` to customize the responsive breakpoints in your project:
|
664
|
-
|
665
|
-
```js
|
666
|
-
const designSystem = {
|
667
|
-
screens: {
|
668
|
-
sm: '640px',
|
669
|
-
md: '768px',
|
670
|
-
lg: '1024px',
|
671
|
-
xl: '1280px',
|
672
|
-
},
|
673
|
-
};
|
674
|
-
```
|
675
|
-
|
676
|
-
The property names in the `screens` object are screen names (used as prefixes for the responsive utility variants generated by TailwindCSS, such as `md:text-center`), and the values are the `min-width` at which the breakpoint should start.
|
677
|
-
|
678
|
-
The default breakpoints are inspired by common device resolutions:
|
679
|
-
|
680
|
-
```js
|
681
|
-
const designSystem = {
|
682
|
-
screens: {
|
683
|
-
sm: '640px',
|
684
|
-
// => @media (min-width: 640px) { ... }
|
685
|
-
|
686
|
-
md: '768px',
|
687
|
-
// => @media (min-width: 768px) { ... }
|
688
|
-
|
689
|
-
lg: '1024px',
|
690
|
-
// => @media (min-width: 1024px) { ... }
|
691
|
-
|
692
|
-
xl: '1280px',
|
693
|
-
// => @media (min-width: 1280px) { ... }
|
694
|
-
},
|
695
|
-
};
|
696
|
-
```
|
697
|
-
|
698
|
-
You can use any names you like as properties for your breakpoints in your project:
|
699
|
-
|
700
|
-
```js
|
701
|
-
const designSystem = {
|
702
|
-
screens: {
|
703
|
-
tablet: '640px',
|
704
|
-
// => @media (min-width: 640px) { ... }
|
705
|
-
|
706
|
-
laptop: '1024px',
|
707
|
-
// => @media (min-width: 1024px) { ... }
|
708
|
-
|
709
|
-
desktop: '1280px',
|
710
|
-
// => @media (min-width: 1280px) { ... }
|
711
|
-
},
|
712
|
-
};
|
713
|
-
```
|
714
|
-
|
715
|
-
These screen names are reflected in `utilities`, so `text-center` would now look like this:
|
716
|
-
|
717
|
-
```css
|
718
|
-
.text-center {
|
719
|
-
text-align: center;
|
720
|
-
}
|
721
|
-
|
722
|
-
@media (min-width: 640px) {
|
723
|
-
.tablet\:text-center {
|
724
|
-
text-align: center;
|
725
|
-
}
|
726
|
-
}
|
727
|
-
|
728
|
-
@media (min-width: 1024px) {
|
729
|
-
.laptop\:text-center {
|
730
|
-
text-align: center;
|
731
|
-
}
|
732
|
-
}
|
733
|
-
|
734
|
-
@media (min-width: 1280px) {
|
735
|
-
.desktop\:text-center {
|
736
|
-
text-align: center;
|
737
|
-
}
|
738
|
-
}
|
739
|
-
```
|
740
|
-
|
741
|
-
##### Max-width Breakpoint
|
742
|
-
|
743
|
-
If you want to use `max-width` breakpoints instead of `min-width`, you can specify the screen as an object with a `max` property:
|
744
|
-
|
745
|
-
```js
|
746
|
-
const designSystem = {
|
747
|
-
screens: {
|
748
|
-
xl: { max: '1279px' },
|
749
|
-
// => @media (max-width: 1279px) { ... }
|
750
|
-
|
751
|
-
lg: { max: '1023px' },
|
752
|
-
// => @media (max-width: 1023px) { ... }
|
753
|
-
|
754
|
-
md: { max: '767px' },
|
755
|
-
// => @media (max-width: 767px) { ... }
|
756
|
-
|
757
|
-
sm: { max: '639px' },
|
758
|
-
// => @media (max-width: 639px) { ... }
|
759
|
-
},
|
760
|
-
};
|
761
|
-
```
|
762
|
-
|
763
|
-
If necessary, you can create breakpoints with both `min-width` and `max-width` definitions, like so:
|
764
|
-
|
765
|
-
```js
|
766
|
-
const designSystem = {
|
767
|
-
screens: {
|
768
|
-
sm: { min: '640px', max: '767px' },
|
769
|
-
md: { min: '768px', max: '1023px' },
|
770
|
-
lg: { min: '1024px', max: '1279px' },
|
771
|
-
xl: { min: '1280px' },
|
772
|
-
},
|
773
|
-
};
|
774
|
-
```
|
775
|
-
|
776
|
-
##### Breakpoints with Multiple Ranges
|
777
|
-
|
778
|
-
Sometimes it can be useful to apply a single breakpoint definition to multiple ranges.
|
779
|
-
|
780
|
-
For example, suppose you have a `sidebar` and want to base the breakpoints on the width of the content area rather than the entire viewport. You can simulate this by using a smaller breakpoint style when the `sidebar` is visible and the content area is reduced:
|
781
|
-
|
782
|
-
```js
|
783
|
-
const designSystem = {
|
784
|
-
screens: {
|
785
|
-
sm: '500px',
|
786
|
-
md: [
|
787
|
-
// Sidebar appears at 768px, so revert to `sm:` styles between 768px
|
788
|
-
// and 868px, after which the main content area is wide enough again to
|
789
|
-
// apply the `md:` styles.
|
790
|
-
{ min: '668px', max: '767px' },
|
791
|
-
{ min: '868px' },
|
792
|
-
],
|
793
|
-
lg: '1100px',
|
794
|
-
xl: '1400px',
|
795
|
-
},
|
796
|
-
};
|
797
|
-
```
|
798
|
-
|
799
|
-
##### Custom Media Queries
|
800
|
-
|
801
|
-
If you need to provide fully custom media queries for your breakpoints, you can use an object with a `raw` property:
|
802
|
-
|
803
|
-
```js
|
804
|
-
const designSystem = {
|
805
|
-
extend: {
|
806
|
-
screens: {
|
807
|
-
portrait: { raw: '(orientation: portrait)' },
|
808
|
-
// => @media (orientation: portrait) { ... }
|
809
|
-
},
|
810
|
-
},
|
811
|
-
};
|
812
|
-
```
|
813
|
-
|
814
|
-
##### Print Style
|
815
|
-
|
816
|
-
The `raw` option may be especially useful if you need to apply different styles for printing.
|
817
|
-
|
818
|
-
All you need to do is add a `print` under `designSystem.extend.screens`:
|
819
|
-
|
820
|
-
```js
|
821
|
-
const designSystem = {
|
822
|
-
extend: {
|
823
|
-
screens: {
|
824
|
-
print: { raw: 'print' },
|
825
|
-
// => @media print { ... }
|
826
|
-
},
|
827
|
-
},
|
828
|
-
};
|
829
|
-
```
|
830
|
-
|
831
|
-
Then, you can use classes like `print:text-black` to specify styles that should only be applied when someone tries to print the page:
|
832
|
-
|
833
|
-
```html
|
834
|
-
<div class="text-gray-700 print:text-black">
|
835
|
-
{/* ... */}
|
836
|
-
</div>
|
837
|
-
```
|
838
|
-
|
839
|
-
##### Dark Mode
|
840
|
-
|
841
|
-
The `raw` option can be used to implement "dark mode" screens:
|
842
|
-
|
843
|
-
```js
|
844
|
-
const designSystem = {
|
845
|
-
extend: {
|
846
|
-
screens: {
|
847
|
-
dark: { raw: '(prefers-color-scheme: dark)' },
|
848
|
-
// => @media (prefers-color-scheme: dark) { ... }
|
849
|
-
},
|
850
|
-
},
|
851
|
-
};
|
852
|
-
```
|
853
|
-
|
854
|
-
Then, you can use the `dark:` prefix to set different styles for elements in dark mode:
|
855
|
-
|
856
|
-
```html
|
857
|
-
<div class="text-gray-700 dark:text-gray-200">
|
858
|
-
{/* ... */}
|
859
|
-
</div>
|
860
|
-
```
|
861
|
-
|
862
|
-
Please note that since these screen variants are implemented in TailwindCSS, **it is not possible to use this method to combine breakpoints with dark mode**, e.g. `md:dark:text-gray-300` will not work.
|
863
|
-
|
864
|
-
#### Colors
|
865
|
-
|
866
|
-
The `colors` property allows you to customize the global color palette for your project.
|
867
|
-
|
868
|
-
```js
|
869
|
-
const designSystem = {
|
870
|
-
colors: {
|
871
|
-
transparent: 'transparent',
|
872
|
-
black: '#000',
|
873
|
-
white: '#fff',
|
874
|
-
gray: {
|
875
|
-
100: '#f7fafc',
|
876
|
-
// ...
|
877
|
-
900: '#1a202c',
|
878
|
-
},
|
879
|
-
|
880
|
-
// ...
|
881
|
-
},
|
882
|
-
};
|
883
|
-
```
|
884
|
-
|
885
|
-
By default, these colors are inherited by the `backgroundColor`, `textColor`, and `borderColor` core plugins.
|
886
|
-
|
887
|
-
For more information, see [Customizing Colors](https://tailwindcss.com/docs/customizing-colors).
|
888
|
-
|
889
|
-
#### Spacing
|
890
|
-
|
891
|
-
Use the `space` property to customize the global spacing and scale ratios for your project:
|
892
|
-
|
893
|
-
```js
|
894
|
-
const designSystem = {
|
895
|
-
spacing: {
|
896
|
-
px: '1px',
|
897
|
-
0: '0',
|
898
|
-
1: '0.25rem',
|
899
|
-
2: '0.5rem',
|
900
|
-
3: '0.75rem',
|
901
|
-
4: '1rem',
|
902
|
-
5: '1.25rem',
|
903
|
-
6: '1.5rem',
|
904
|
-
8: '2rem',
|
905
|
-
10: '2.5rem',
|
906
|
-
12: '3rem',
|
907
|
-
16: '4rem',
|
908
|
-
20: '5rem',
|
909
|
-
24: '6rem',
|
910
|
-
32: '8rem',
|
911
|
-
40: '10rem',
|
912
|
-
48: '12rem',
|
913
|
-
56: '14rem',
|
914
|
-
64: '16rem',
|
915
|
-
},
|
916
|
-
};
|
917
|
-
```
|
918
|
-
|
919
|
-
By default, these values are inherited by the `padding`, `margin`, `negativeMargin`, `width`, and `height` core plugins.
|
920
|
-
|
921
|
-
For more information, see [Customizing Spacing](https://tailwindcss.com/docs/customizing-spacing).
|
922
|
-
|
923
|
-
#### Core Plugins
|
924
|
-
|
925
|
-
The rest of the theme section is used to configure the values available for each core plugin.
|
926
|
-
|
927
|
-
For example, the `borderRadius` property allows you to customize the `utilities` for the generated border radius:
|
928
|
-
|
929
|
-
```js
|
930
|
-
const designSystem = {
|
931
|
-
borderRadius: {
|
932
|
-
none: '0',
|
933
|
-
sm: '.125rem',
|
934
|
-
default: '.25rem',
|
935
|
-
lg: '.5rem',
|
936
|
-
full: '9999px',
|
937
|
-
},
|
938
|
-
};
|
939
|
-
```
|
940
|
-
|
941
|
-
**The property name determines the suffix of the generated classes, and the value determines the value of the actual CSS declaration.** The `borderRadius` configuration example above will generate the following CSS classes:
|
942
|
-
|
943
|
-
```css
|
944
|
-
.rounded-none {
|
945
|
-
border-radius: 0;
|
946
|
-
}
|
947
|
-
.rounded-sm {
|
948
|
-
border-radius: 0.125rem;
|
949
|
-
}
|
950
|
-
.rounded {
|
951
|
-
border-radius: 0.25rem;
|
952
|
-
}
|
953
|
-
.rounded-lg {
|
954
|
-
border-radius: 0.5rem;
|
955
|
-
}
|
956
|
-
.rounded-full {
|
957
|
-
border-radius: 9999px;
|
958
|
-
}
|
959
|
-
```
|
960
|
-
|
961
|
-
You may notice that the `rounded` class without a suffix is created using the `default` property in the theme configuration. This is a common convention in Tailwind CSS that many (although not all) core plugins support.
|
962
|
-
|
963
|
-
For more information on customizing specific core plugins, see the documentation for that plugin.
|
964
|
-
|
965
|
-
### Customizing the Default Configuration
|
966
|
-
|
967
|
-
Out of the box, your project will inherit values from the default theme configuration. If you want to customize the default theme, there are a few different options depending on your goals.
|
968
|
-
|
969
|
-
#### Overriding Default Configuration
|
970
|
-
|
971
|
-
To override an option in the default configuration, add the property you want to override to `designSystem`:
|
972
|
-
|
973
|
-
```ts title="modern.config.ts"
|
974
|
-
const designSystem = {
|
975
|
-
// Replaces all of the default `opacity` values
|
976
|
-
opacity: {
|
977
|
-
0: '0',
|
978
|
-
20: '0.2',
|
979
|
-
40: '0.4',
|
980
|
-
60: '0.6',
|
981
|
-
80: '0.8',
|
982
|
-
100: '1',
|
983
|
-
},
|
984
|
-
};
|
985
|
-
|
986
|
-
export default defineConfig({
|
987
|
-
source: {
|
988
|
-
designSystem,
|
989
|
-
},
|
990
|
-
});
|
991
|
-
```
|
992
|
-
|
993
|
-
This will completely replace the default property configuration, so in the example above, the default `opacity utilities` will not be generated.
|
994
|
-
|
995
|
-
Any properties you don't provide will still inherit from the default theme, so in the example above, the default theme configuration for colors, spacing, border radius, background positions, etc. will be preserved.
|
996
|
-
|
997
|
-
#### Extending Default Configuration
|
998
|
-
|
999
|
-
If you want to keep the default values for a theme option but add new values, add the extension under the `designSystem.extend` property.
|
1000
|
-
|
1001
|
-
For example, if you want to add an additional breakpoint but keep the existing ones, you can extend the `screens` property:
|
1002
|
-
|
1003
|
-
```ts title="modern.config.ts"
|
1004
|
-
const designSystem = {
|
1005
|
-
extend: {
|
1006
|
-
// Adds a new breakpoint in addition to the default breakpoints
|
1007
|
-
screens: {
|
1008
|
-
'2xl': '1440px',
|
1009
|
-
},
|
1010
|
-
},
|
1011
|
-
};
|
1012
|
-
|
1013
|
-
export default defineConfig({
|
1014
|
-
source: {
|
1015
|
-
designSystem,
|
1016
|
-
},
|
1017
|
-
});
|
1018
|
-
```
|
1019
|
-
|
1020
|
-
Of course, you can override some parts of the default theme and extend other parts of the default theme in the same configuration:
|
1021
|
-
|
1022
|
-
```ts title="modern.config.ts"
|
1023
|
-
const designSystem = {
|
1024
|
-
opacity: {
|
1025
|
-
0: '0',
|
1026
|
-
20: '0.2',
|
1027
|
-
40: '0.4',
|
1028
|
-
60: '0.6',
|
1029
|
-
80: '0.8',
|
1030
|
-
100: '1',
|
1031
|
-
},
|
1032
|
-
extend: {
|
1033
|
-
screens: {
|
1034
|
-
'2xl': '1440px',
|
1035
|
-
},
|
1036
|
-
},
|
1037
|
-
};
|
1038
|
-
|
1039
|
-
export default defineConfig({
|
1040
|
-
source: {
|
1041
|
-
designSystem,
|
1042
|
-
},
|
1043
|
-
});
|
1044
|
-
```
|
1045
|
-
|
1046
|
-
#### Referencing Other Values
|
1047
|
-
|
1048
|
-
If you need to reference another value in your configuration, you can do so by providing a closure function instead of a static value. The function will receive the `theme()` function as an argument, which you can use to look up other values in the configuration using dot notation.
|
1049
|
-
|
1050
|
-
For example, you can generate `fill` utilities for each color in your palette by referencing `theme('colors')` on the `fill` configuration:
|
1051
|
-
|
1052
|
-
```ts title="modern.config.ts"
|
1053
|
-
const designSystem = {
|
1054
|
-
colors: {
|
1055
|
-
// ...
|
1056
|
-
},
|
1057
|
-
fill: theme => theme('colors'),
|
1058
|
-
};
|
1059
|
-
|
1060
|
-
export default defineConfig({
|
1061
|
-
source: {
|
1062
|
-
designSystem,
|
1063
|
-
},
|
1064
|
-
});
|
1065
|
-
```
|
1066
|
-
|
1067
|
-
The `theme()` function attempts to find the value you're looking for from the fully merged configuration object, so it can reference your own custom settings as well as default theme values. It also works recursively, so as long as there's a static value at the end of the chain, it can resolve the value you're looking for.
|
1068
|
-
|
1069
|
-
**Referencing Default Configuration**
|
1070
|
-
|
1071
|
-
If you want to reference a value from the default configuration for any reason, you can import it from `tailwindcss/defaultTheme`. A useful example is if you want to add a font from the fonts provided by the default configuration:
|
1072
|
-
|
1073
|
-
```ts title="modern.config.ts"
|
1074
|
-
const defaultTheme = require('tailwindcss/defaultTheme');
|
1075
|
-
|
1076
|
-
const designSystem = {
|
1077
|
-
extend: {
|
1078
|
-
fontFamily: {
|
1079
|
-
sans: ['Lato', ...defaultTheme.fontFamily.sans],
|
1080
|
-
},
|
1081
|
-
},
|
1082
|
-
};
|
1083
|
-
|
1084
|
-
export default defineConfig({
|
1085
|
-
source: {
|
1086
|
-
designSystem,
|
1087
|
-
},
|
1088
|
-
});
|
1089
|
-
```
|
1090
|
-
|
1091
|
-
#### Disabling Entire Core Plugins
|
1092
|
-
|
1093
|
-
If you don't want to generate any classes for a particular core plugin, it's best to set that plugin to `false` in the `corePlugins` configuration rather than providing an empty object for that property in the configuration:
|
1094
|
-
|
1095
|
-
```js
|
1096
|
-
// Don't assign an empty object in your theme configuration
|
1097
|
-
|
1098
|
-
const designSystem = {
|
1099
|
-
opacity: {},
|
1100
|
-
};
|
1101
|
-
|
1102
|
-
// Do disable the plugin in your corePlugins configuration
|
1103
|
-
const designSyttem = {
|
1104
|
-
corePlugins: {
|
1105
|
-
opacity: false,
|
1106
|
-
},
|
1107
|
-
};
|
1108
|
-
```
|
1109
|
-
|
1110
|
-
The end result is the same, but since many core plugins don't expose any configuration, they can only be disabled using `corePlugins`, so it's best to be consistent.
|
1111
|
-
|
1112
|
-
#### Adding Your Own Keys
|
1113
|
-
|
1114
|
-
In many cases, adding your own properties to the configuration object can be useful.
|
1115
|
-
|
1116
|
-
One example of this is adding a new property for reuse between multiple core plugins. For example, you could extract a `positions` object that both the `backgroundPosition` and `objectPosition` plugins could reference:
|
1117
|
-
|
1118
|
-
```js
|
1119
|
-
const designSystem = {
|
1120
|
-
positions: {
|
1121
|
-
bottom: 'bottom',
|
1122
|
-
center: 'center',
|
1123
|
-
left: 'left',
|
1124
|
-
'left-bottom': 'left bottom',
|
1125
|
-
'left-top': 'left top',
|
1126
|
-
right: 'right',
|
1127
|
-
'right-bottom': 'right bottom',
|
1128
|
-
'right-top': 'right top',
|
1129
|
-
top: 'top',
|
1130
|
-
},
|
1131
|
-
backgroundPosition: theme => theme('positions'),
|
1132
|
-
objectPosition: theme => theme('positions'),
|
1133
|
-
};
|
1134
|
-
```
|
1135
|
-
|
1136
|
-
Another example is adding new properties for reference in custom plugins. For example, if you've written a gradient plugin for your project, you could add a `gradients` property to the theme object that the plugin references:
|
1137
|
-
|
1138
|
-
```ts title="modern.config.ts"
|
1139
|
-
const designSystem = {
|
1140
|
-
gradients: theme => ({
|
1141
|
-
'blue-green': [theme('colors.blue.500'), theme('colors.green.500')],
|
1142
|
-
'purple-blue': [theme('colors.purple.500'), theme('colors.blue.500')],
|
1143
|
-
// ...
|
1144
|
-
}),
|
1145
|
-
};
|
1146
|
-
|
1147
|
-
export default defineConfig({
|
1148
|
-
source: {
|
1149
|
-
designSystem,
|
1150
|
-
},
|
1151
|
-
tools: {
|
1152
|
-
tailwind: {
|
1153
|
-
plugins: [require('./plugins/gradients')],
|
1154
|
-
},
|
1155
|
-
},
|
1156
|
-
});
|
1157
|
-
```
|
1158
|
-
|
1159
|
-
### Configuration Reference
|
1160
|
-
|
1161
|
-
In addition to `screens`, `colors`, and `spacing`, all properties in the configuration object map to core plugins in TailwindCSS. Because many plugins are responsible for CSS properties that only accept a set of static values (e.g. `float`), not every plugin has a corresponding property in the theme object.
|
1162
|
-
|
1163
|
-
All of these properties can also be extended from the default theme under the `designSystem.extend` property.
|
1164
|
-
|
1165
|
-
For a complete list of all properties and their effects, see this [link](https://tailwindcss.com/docs/theme#configuration-reference).
|
1166
|
-
|
1167
|
-
### Additional Configuration
|
1168
|
-
|
1169
|
-
In addition to the configuration that is the same as Tailwind CSS Theme, there is additional configuration provided by Modern.js.
|
1170
|
-
|
1171
|
-
#### source.designSystem.supportStyledComponents
|
1172
|
-
|
1173
|
-
This configuration is of type `boolean` and defaults to `false`.
|
1174
|
-
|
1175
|
-
When this configuration value is `true`, a `styled-components` `ThemeProvider` component is provided at the outermost layer of the application at runtime, and the `Theme Token` object generated through `designSystem` is injected.
|