Packages

@twind/core › ThemeFunction

Type parameters

NameType
Themeextends BaseTheme = BaseTheme

Callable

ThemeFunction

ThemeFunction(): Theme

Returns

Theme

Defined in

packages/core/src/types.ts:149

ThemeFunction

ThemeFunction<Section>(section): Theme[Section]

Type parameters

NameType
Sectionextends string

Parameters

NameType
sectionSection | KebabCase<Section>

Returns

Theme[Section]

Defined in

packages/core/src/types.ts:151

ThemeFunction

ThemeFunction<Section, Key>(section, key): undefined | ThemeValue<Theme[Section]>

Type parameters

NameType
Sectionextends string
Keyextends string | number | symbol

Parameters

NameType
sectionSection | KebabCase<Section>
keyKey

Returns

undefined | ThemeValue<Theme[Section]>

Defined in

packages/core/src/types.ts:153

ThemeFunction

ThemeFunction<Section>(section, key): undefined | ThemeValue<Theme[Section]>

Type parameters

NameType
Sectionextends string

Parameters

NameType
sectionSection | KebabCase<Section>
keystring

Returns

undefined | ThemeValue<Theme[Section]>

Defined in

packages/core/src/types.ts:158

ThemeFunction

ThemeFunction<Section, Key>(section, key, defaultValue): ThemeValue<Theme[Section]>

Type parameters

NameType
Sectionextends string
Keyextends string | number | symbol

Parameters

NameType
sectionSection | KebabCase<Section>
keyKey
defaultValueThemeValue<Theme[Section]>

Returns

ThemeValue<Theme[Section]>

Defined in

packages/core/src/types.ts:162

ThemeFunction

ThemeFunction<Section>(section, key, defaultValue): ThemeValue<Theme[Section]>

Type parameters

NameType
Sectionextends string

Parameters

NameType
sectionSection | KebabCase<Section>
keystring
defaultValueThemeValue<Theme[Section]>

Returns

ThemeValue<Theme[Section]>

Defined in

packages/core/src/types.ts:168

ThemeFunction

ThemeFunction<Section>(key): ThemeValue<Theme[Section]>

Type parameters

NameType
Sectionextends string

Parameters

NameType
key`${Section}.${string}`

Returns

ThemeValue<Theme[Section]>

Defined in

packages/core/src/types.ts:175

ThemeFunction

ThemeFunction<Section>(key, defaultValue): ThemeValue<Theme[Section]>

Type parameters

NameType
Sectionextends string

Parameters

NameType
key`${Section}.${string}`
defaultValueThemeValue<Theme[Section]>

Returns

ThemeValue<Theme[Section]>

Defined in

packages/core/src/types.ts:177

ThemeFunction

ThemeFunction(section): unknown

Parameters

NameType
sectionstring

Returns

unknown

Defined in

packages/core/src/types.ts:182

ThemeFunction

ThemeFunction(section, key): unknown

Parameters

NameType
sectionstring
keystring

Returns

unknown

Defined in

packages/core/src/types.ts:183

ThemeFunction

ThemeFunction<T>(section, key, defaultValue): string | T

Type parameters

Name
T

Parameters

NameType
sectionstring
keystring
defaultValueT

Returns

string | T

Defined in

packages/core/src/types.ts:184

ThemeFunction

ThemeFunction<T>(key, defaultValue): string | T

Type parameters

Name
T

Parameters

NameType
keystring
defaultValueT

Returns

string | T

Defined in

packages/core/src/types.ts:185