Use single-line syntax for private types comments (#8420)
This prevents the comments from appearing in editors
This commit is contained in:
parent
33dff03743
commit
22f9dc8895
1 changed files with 19 additions and 19 deletions
38
types/config.d.ts
vendored
38
types/config.d.ts
vendored
|
|
@ -64,11 +64,11 @@ type ExperimentalConfig = Expand<'all' | Partial<Record<ExperimentalConfigValues
|
|||
|
||||
// DarkMode related config
|
||||
type DarkModeConfig =
|
||||
/** Use the `media` query strategy. */
|
||||
// Use the `media` query strategy.
|
||||
| 'media'
|
||||
/** Use the `class` stategy, which requires a `.dark` class on the `html`. */
|
||||
// Use the `class` stategy, which requires a `.dark` class on the `html`.
|
||||
| 'class'
|
||||
/** Use the `class` stategy with a custom class instead of `.dark`. */
|
||||
// Use the `class` stategy with a custom class instead of `.dark`.
|
||||
| ['class', string]
|
||||
|
||||
type Screen = { raw: string } | { min: string } | { max: string } | { min: string; max: string }
|
||||
|
|
@ -76,14 +76,14 @@ type ScreensConfig = string[] | KeyValuePair<string, string | Screen | Screen[]>
|
|||
|
||||
// Theme related config
|
||||
interface ThemeConfig {
|
||||
/** Responsiveness */
|
||||
// Responsiveness
|
||||
screens: ResolvableTo<ScreensConfig>
|
||||
|
||||
/** Reusable base configs */
|
||||
// Reusable base configs
|
||||
colors: ResolvableTo<RecursiveKeyValuePair>
|
||||
spacing: ResolvableTo<KeyValuePair>
|
||||
|
||||
/** Components */
|
||||
// Components
|
||||
container: ResolvableTo<
|
||||
Partial<{
|
||||
screens: ScreensConfig
|
||||
|
|
@ -92,7 +92,7 @@ interface ThemeConfig {
|
|||
}>
|
||||
>
|
||||
|
||||
/** Utilities */
|
||||
// Utilities
|
||||
inset: ThemeConfig['spacing']
|
||||
zIndex: ResolvableTo<KeyValuePair>
|
||||
order: ResolvableTo<KeyValuePair>
|
||||
|
|
@ -215,7 +215,7 @@ interface ThemeConfig {
|
|||
willChange: ResolvableTo<KeyValuePair>
|
||||
content: ResolvableTo<KeyValuePair>
|
||||
|
||||
/** Custom */
|
||||
// Custom
|
||||
[key: string]: any
|
||||
}
|
||||
|
||||
|
|
@ -240,7 +240,7 @@ type ValueType =
|
|||
| 'relative-size'
|
||||
| 'shadow'
|
||||
export interface PluginAPI {
|
||||
/** for registering new static utility styles */
|
||||
// for registering new static utility styles
|
||||
addUtilities(
|
||||
utilities: RecursiveKeyValuePair | RecursiveKeyValuePair[],
|
||||
options?: Partial<{
|
||||
|
|
@ -248,7 +248,7 @@ export interface PluginAPI {
|
|||
respectImportant: boolean
|
||||
}>
|
||||
): void
|
||||
/** for registering new dynamic utility styles */
|
||||
// for registering new dynamic utility styles
|
||||
matchUtilities<T>(
|
||||
utilities: KeyValuePair<string, (value: T) => RecursiveKeyValuePair>,
|
||||
options?: Partial<{
|
||||
|
|
@ -259,7 +259,7 @@ export interface PluginAPI {
|
|||
supportsNegativeValues: boolean
|
||||
}>
|
||||
): void
|
||||
/** for registering new static component styles */
|
||||
// for registering new static component styles
|
||||
addComponents(
|
||||
components: RecursiveKeyValuePair | RecursiveKeyValuePair[],
|
||||
options?: Partial<{
|
||||
|
|
@ -267,7 +267,7 @@ export interface PluginAPI {
|
|||
respectImportant: boolean
|
||||
}>
|
||||
): void
|
||||
/** for registering new dynamic component styles */
|
||||
// for registering new dynamic component styles
|
||||
matchComponents<T>(
|
||||
components: KeyValuePair<string, (value: T) => RecursiveKeyValuePair>,
|
||||
options?: Partial<{
|
||||
|
|
@ -278,20 +278,20 @@ export interface PluginAPI {
|
|||
supportsNegativeValues: boolean
|
||||
}>
|
||||
): void
|
||||
/** for registering new base styles */
|
||||
// for registering new base styles
|
||||
addBase(base: RecursiveKeyValuePair | RecursiveKeyValuePair[]): void
|
||||
/** for registering custom variants */
|
||||
// for registering custom variants
|
||||
addVariant(name: string, definition: string | string[] | (() => string) | (() => string)[]): void
|
||||
/** for looking up values in the user’s theme configuration */
|
||||
// for looking up values in the user’s theme configuration
|
||||
theme: <TDefaultValue = Config['theme']>(
|
||||
path?: string,
|
||||
defaultValue?: TDefaultValue
|
||||
) => TDefaultValue
|
||||
/** for looking up values in the user’s Tailwind configuration */
|
||||
// for looking up values in the user’s Tailwind configuration
|
||||
config: <TDefaultValue = Config>(path?: string, defaultValue?: TDefaultValue) => TDefaultValue
|
||||
/** for checking if a core plugin is enabled */
|
||||
// for checking if a core plugin is enabled
|
||||
corePlugins(path: string): boolean
|
||||
/** for manually escaping strings meant to be used in class names */
|
||||
// for manually escaping strings meant to be used in class names
|
||||
e: (className: string) => string
|
||||
}
|
||||
export type PluginCreator = (api: PluginAPI) => void
|
||||
|
|
@ -318,7 +318,7 @@ interface OptionalConfig {
|
|||
theme: Partial<ThemeConfig & { extend: Partial<ThemeConfig> }>
|
||||
corePlugins: Partial<CorePluginsConfig>
|
||||
plugins: Partial<PluginsConfig>
|
||||
/** Custom */
|
||||
// Custom
|
||||
[key: string]: any
|
||||
}
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue