Packages
@twind/core › TwindUserConfig
Type parameters
| Name | Type |
|---|---|
Theme | BaseTheme |
Presets | extends Preset<any>[] = Preset[] |
Properties
darkColor
• Optional darkColor: DarkColor<BaseTheme & UnionToIntersection<BaseTheme | ExtractTheme<ExtractUserTheme<Theme>> | ExtractTheme<ArrayType<Presets>>>>
Defined in
packages/core/src/types.ts:415
darkMode
• Optional darkMode: DarkModeConfig
Allows to change how the dark variant is used (default: "media")
Defined in
packages/core/src/types.ts:414
finalize
• Optional finalize: MaybeArray<Finalize<Theme & BaseTheme>>
Defined in
packages/core/src/types.ts:447
hash
• Optional hash: boolean | HashFunction
Enables hashing of all classes (default: false).
If a function is given it can be used to hash only certain classes:
{
hash(className, defaultHash) {
if (/^[~@]\(/.test(className)) {
// a shortcut like `~(...)` or apply like `@(...)`
return defaultHash(className)
}
return className
}
}Defined in
packages/core/src/types.ts:442
ignorelist
• Optional ignorelist: MaybeArray<string | RegExp>
Defined in
packages/core/src/types.ts:445
preflight
• Optional preflight: false | MaybeArray<Preflight | PreflightThunk<BaseTheme & UnionToIntersection<BaseTheme | ExtractTheme<ExtractUserTheme<Theme>> | ExtractTheme<ArrayType<Presets>>>>>
Defined in
packages/core/src/types.ts:419
presets
• Optional presets: Presets
Defined in
packages/core/src/types.ts:411
rules
• Optional rules: Rule<BaseTheme & UnionToIntersection<BaseTheme | ExtractTheme<ExtractUserTheme<Theme>> | ExtractTheme<ArrayType<Presets>>>>[]
Defined in
packages/core/src/types.ts:423
stringify
• Optional stringify: StringifyDeclaration<BaseTheme & UnionToIntersection<BaseTheme | ExtractTheme<ExtractUserTheme<Theme>> | ExtractTheme<ArrayType<Presets>>>>
Defined in
packages/core/src/types.ts:444
theme
• Optional theme: Theme | ThemeConfig<BaseTheme & UnionToIntersection<BaseTheme | ExtractTheme<ExtractUserTheme<Theme>> | ExtractTheme<ArrayType<Presets>>>>
Defined in
packages/core/src/types.ts:417
variants
• Optional variants: Variant<BaseTheme & UnionToIntersection<BaseTheme | ExtractTheme<ExtractUserTheme<Theme>> | ExtractTheme<ArrayType<Presets>>>>[]