decoupled-kit-js
Classes
Type Aliases
Color
Ƭ Color: Object
Type declaration
| Name | Type |
|---|---|
hexDefault | string |
name | string |
tailwindDefault | string |
themeName | string |
Defined in
packages/wordpress-kit/src/types/index.ts:220
ColorConfig
Ƭ ColorConfig: Object
Type declaration
| Name | Type |
|---|---|
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
| Name | Type |
|---|---|
default | string |
name | string |
tailwind | string |
Defined in
packages/wordpress-kit/src/types/index.ts:227
FontSizeConfig
Ƭ FontSizeConfig: Object
Type declaration
| Name | Type |
|---|---|
4xl? | string |
7xl? | string |
sm? | string |
xl? | string |
Defined in
packages/wordpress-kit/src/types/index.ts:30
GradientColors
Ƭ GradientColors: Object
Type declaration
| Name | Type |
|---|---|
color | string |
position | string |
Defined in
packages/wordpress-kit/src/types/index.ts:233
PaddingConfig
Ƭ PaddingConfig: Object
Type declaration
| Name | Type |
|---|---|
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
| Name | Type |
|---|---|
T | PartialThemeConfig | undefined |
Parameters
| Name | Type |
|---|---|
path? | string |
defaultValue? | T |
Returns
T
Defined in
packages/wordpress-kit/src/types/index.ts:246
WordPressMapConfig
Ƭ WordPressMapConfig: Object
Type declaration
| Name | Type |
|---|---|
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
| Name | Type |
|---|---|
__namedParameters | Object |
__namedParameters.cacheControl? | string |
__namedParameters.res | ServerResponse<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
| Name | Type | Description |
|---|---|---|
keys | null | string | Value for surrogate-key header in API response. |
res | ServerResponse<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