@@ -64,26 +64,26 @@ type ExperimentalConfig = Expand<'all' | Partial<Record<ExperimentalConfigValues
64
64
65
65
// DarkMode related config
66
66
type DarkModeConfig =
67
- /** Use the `media` query strategy. */
67
+ // Use the `media` query strategy.
68
68
| 'media'
69
- /** Use the `class` stategy, which requires a `.dark` class on the `html`. */
69
+ // Use the `class` stategy, which requires a `.dark` class on the `html`.
70
70
| 'class'
71
- /** Use the `class` stategy with a custom class instead of `.dark`. */
71
+ // Use the `class` stategy with a custom class instead of `.dark`.
72
72
| [ 'class' , string ]
73
73
74
74
type Screen = { raw : string } | { min : string } | { max : string } | { min : string ; max : string }
75
75
type ScreensConfig = string [ ] | KeyValuePair < string , string | Screen | Screen [ ] >
76
76
77
77
// Theme related config
78
78
interface ThemeConfig {
79
- /** Responsiveness */
79
+ // Responsiveness
80
80
screens : ResolvableTo < ScreensConfig >
81
81
82
- /** Reusable base configs */
82
+ // Reusable base configs
83
83
colors : ResolvableTo < RecursiveKeyValuePair >
84
84
spacing : ResolvableTo < KeyValuePair >
85
85
86
- /** Components */
86
+ // Components
87
87
container : ResolvableTo <
88
88
Partial < {
89
89
screens : ScreensConfig
@@ -92,7 +92,7 @@ interface ThemeConfig {
92
92
} >
93
93
>
94
94
95
- /** Utilities */
95
+ // Utilities
96
96
inset : ThemeConfig [ 'spacing' ]
97
97
zIndex : ResolvableTo < KeyValuePair >
98
98
order : ResolvableTo < KeyValuePair >
@@ -215,7 +215,7 @@ interface ThemeConfig {
215
215
willChange : ResolvableTo < KeyValuePair >
216
216
content : ResolvableTo < KeyValuePair >
217
217
218
- /** Custom */
218
+ // Custom
219
219
[ key : string ] : any
220
220
}
221
221
@@ -240,15 +240,15 @@ type ValueType =
240
240
| 'relative-size'
241
241
| 'shadow'
242
242
export interface PluginAPI {
243
- /** for registering new static utility styles */
243
+ // for registering new static utility styles
244
244
addUtilities (
245
245
utilities : RecursiveKeyValuePair | RecursiveKeyValuePair [ ] ,
246
246
options ?: Partial < {
247
247
respectPrefix : boolean
248
248
respectImportant : boolean
249
249
} >
250
250
) : void
251
- /** for registering new dynamic utility styles */
251
+ // for registering new dynamic utility styles
252
252
matchUtilities < T > (
253
253
utilities : KeyValuePair < string , ( value : T ) => RecursiveKeyValuePair > ,
254
254
options ?: Partial < {
@@ -259,15 +259,15 @@ export interface PluginAPI {
259
259
supportsNegativeValues : boolean
260
260
} >
261
261
) : void
262
- /** for registering new static component styles */
262
+ // for registering new static component styles
263
263
addComponents (
264
264
components : RecursiveKeyValuePair | RecursiveKeyValuePair [ ] ,
265
265
options ?: Partial < {
266
266
respectPrefix : boolean
267
267
respectImportant : boolean
268
268
} >
269
269
) : void
270
- /** for registering new dynamic component styles */
270
+ // for registering new dynamic component styles
271
271
matchComponents < T > (
272
272
components : KeyValuePair < string , ( value : T ) => RecursiveKeyValuePair > ,
273
273
options ?: Partial < {
@@ -278,20 +278,20 @@ export interface PluginAPI {
278
278
supportsNegativeValues : boolean
279
279
} >
280
280
) : void
281
- /** for registering new base styles */
281
+ // for registering new base styles
282
282
addBase ( base : RecursiveKeyValuePair | RecursiveKeyValuePair [ ] ) : void
283
- /** for registering custom variants */
283
+ // for registering custom variants
284
284
addVariant ( name : string , definition : string | string [ ] | ( ( ) => string ) | ( ( ) => string ) [ ] ) : void
285
- /** for looking up values in the user’s theme configuration */
285
+ // for looking up values in the user’s theme configuration
286
286
theme : < TDefaultValue = Config [ 'theme' ] > (
287
287
path ?: string ,
288
288
defaultValue ?: TDefaultValue
289
289
) => TDefaultValue
290
- /** for looking up values in the user’s Tailwind configuration */
290
+ // for looking up values in the user’s Tailwind configuration
291
291
config : < TDefaultValue = Config > ( path ?: string , defaultValue ?: TDefaultValue ) => TDefaultValue
292
- /** for checking if a core plugin is enabled */
292
+ // for checking if a core plugin is enabled
293
293
corePlugins ( path : string ) : boolean
294
- /** for manually escaping strings meant to be used in class names */
294
+ // for manually escaping strings meant to be used in class names
295
295
e : ( className : string ) => string
296
296
}
297
297
export type PluginCreator = ( api : PluginAPI ) => void
@@ -318,7 +318,7 @@ interface OptionalConfig {
318
318
theme : Partial < ThemeConfig & { extend : Partial < ThemeConfig > } >
319
319
corePlugins : Partial < CorePluginsConfig >
320
320
plugins : Partial < PluginsConfig >
321
- /** Custom */
321
+ // Custom
322
322
[ key : string ] : any
323
323
}
324
324
0 commit comments