Skip to main content

decoupled-kit-js

Classes

Type Aliases

Color

Ƭ Color: Object

Type declaration

NameType
hexDefaultstring
namestring
tailwindDefaultstring
themeNamestring

Defined in

packages/wordpress-kit/src/types/index.ts:220


ColorConfig

Ƭ ColorConfig: Object

Type declaration

NameType
cyanBluishGray?string
darkGray?string
foreground?string
lightGray?string
lightGreenCyan?string
luminousVividAmber?string
luminousVividOrange?string
paleCyanBlue?string
palePink?string
primary?string
secondary?string
stripes?string
tertiary?string
vividCyanBlue?string
vividGreenCyan?string
vividPurple?string
vividRed?string
white?string

Defined in

packages/wordpress-kit/src/types/index.ts:4


FontSize

Ƭ FontSize: Object

Type declaration

NameType
defaultstring
namestring
tailwindstring

Defined in

packages/wordpress-kit/src/types/index.ts:227


FontSizeConfig

Ƭ FontSizeConfig: Object

Type declaration

NameType
4xl?string
7xl?string
sm?string
xl?string

Defined in

packages/wordpress-kit/src/types/index.ts:30


GradientColors

Ƭ GradientColors: Object

Type declaration

NameType
colorstring
positionstring

Defined in

packages/wordpress-kit/src/types/index.ts:233


PaddingConfig

Ƭ PaddingConfig: Object

Type declaration

NameType
backgroundX?string
backgroundY?string

Defined in

packages/wordpress-kit/src/types/index.ts:25


TailwindcssConfig

Ƭ TailwindcssConfig: Config & WordPressMapConfig

Defined in

packages/wordpress-kit/src/types/index.ts:238


ThemeType

Ƭ ThemeType: <T>(path?: string, defaultValue?: T) => T

Type declaration

▸ <T>(path?, defaultValue?): T

Type parameters
NameType
TPartialThemeConfig | undefined
Parameters
NameType
path?string
defaultValue?T
Returns

T

Defined in

packages/wordpress-kit/src/types/index.ts:246


WordPressMapConfig

Ƭ WordPressMapConfig: Object

Type declaration

NameType
theme?{ colors?: ColorConfig ; extend?: { colors?: ColorConfig ; fontSize?: FontSizeConfig ; padding?: PaddingConfig } ; fontSize?: FontSizeConfig ; padding?: PaddingConfig }
theme.colors?ColorConfig
theme.extend?{ colors?: ColorConfig ; fontSize?: FontSizeConfig ; padding?: PaddingConfig }
theme.extend.colors?ColorConfig
theme.extend.fontSize?FontSizeConfig
theme.extend.padding?PaddingConfig
theme.fontSize?FontSizeConfig
theme.padding?PaddingConfig

Defined in

packages/wordpress-kit/src/types/index.ts:37

Variables

tailwindcssPlugin

tailwindcssPlugin: Object

Tailwindcss plugin that maps WordPress block editor styles to tailwindcss classes.

Defined in

packages/wordpress-kit/src/lib/tailwindcssPlugin/index.ts:24

Functions

setEdgeHeader

setEdgeHeader(__namedParameters): void

Sets response headers for edge caching.

Parameters

NameType
__namedParametersObject
__namedParameters.cacheControl?string
__namedParameters.resServerResponse<IncomingMessage>

Returns

void

Defined in

packages/wordpress-kit/src/lib/setEdgeHeader.ts:11


setSurrogateKeyHeader

setSurrogateKeyHeader(keys, res): string | void

Adds an aggregated list of surrogate keys in the working response.

Parameters

NameTypeDescription
keysnull | stringValue for surrogate-key header in API response.
resServerResponse<IncomingMessage>The active http.ServerResponse object.

Returns

string | void

The current known unique set of surrogate keys.

Defined in

packages/cms-kit/dist/src/utils/setSurrogateKeyHeader.d.ts:8