schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
theme.json
defaultPalette
Allow users to choose colors from the default palette.
{"type": "boolean", "default": true}
theme.json
duotone
Duotone presets for the duotone picker. Doesn't generate classes or properties.
{"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "slug": {"type": "string"}, "colors": {"type": "array", "items": {"type": "string"}}}, "required": ["name", "slug", "colors"], "additionalProperties": false}}
theme.json
name
Name of the duotone preset, translatable.
{"type": "string"}
theme.json
slug
Kebab-case unique identifier for the duotone preset.
{"type": "string"}
theme.json
colors
List of colors from dark to light.
{"type": "array", "items": {"type": "string"}}
theme.json
items
CSS hex or rgb string.
{"type": "string"}
theme.json
gradients
Gradient presets for the gradient picker. Generates a single class (`.has-{slug}-background`) and custom property (`--wp--preset--gradient--{slug}`) per preset value.
{"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "slug": {"type": "string"}, "gradient": {"type": "string"}}, "required": ["name", "slug", "gradient"], "additionalProperties": false}}
theme.json
name
Name of the gradient preset, translatable.
{"type": "string"}
theme.json
slug
Kebab-case unique identifier for the gradient preset.
{"type": "string"}
theme.json
gradient
CSS gradient string.
{"type": "string"}
theme.json
link
Allow users to set link colors.
{"type": "boolean", "default": false}
theme.json
palette
Color palette presets for the color picker. Generates three classes (`.has-{slug}-color`, `.has-{slug}-background-color`, and `.has-{slug}-border-color`) and a single custom property (`--wp--preset--color--{slug}`) per preset value.
{"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "slug": {"type": "string"}, "color": {"type": "string"}}, "required": ["name", "slug", "color"], "additionalProperties": false}}
theme.json
name
Name of the color preset, translatable.
{"type": "string"}
theme.json
slug
Kebab-case unique identifier for the color preset.
{"type": "string"}
theme.json
color
CSS hex or rgb(a) string.
{"type": "string"}
theme.json
text
Allow users to set text colors.
{"type": "boolean", "default": true}
theme.json
dimensions
Settings related to dimensions.
{"type": "object", "properties": {"minHeight": {"type": "boolean", "default": false}}, "additionalProperties": false}
theme.json
minHeight
Allow users to set custom minimum height.
{"type": "boolean", "default": false}
theme.json
layout
Settings related to layout.
{"type": "object", "properties": {"contentSize": {"type": "string"}, "wideSize": {"type": "string"}, "allowEditing": {"type": "boolean", "default": true}}, "additionalProperties": false}
theme.json
contentSize
Sets the max-width of the content.
{"type": "string"}
theme.json
wideSize
Sets the max-width of wide (`.alignwide`) content. Also used as the maximum viewport when calculating fluid font sizes
{"type": "string"}
theme.json
allowEditing
Disable the layout UI controls.
{"type": "boolean", "default": true}
theme.json
position
Settings related to position.
{"type": "object", "properties": {"sticky": {"type": "boolean", "default": false}}, "additionalProperties": false}
theme.json
sticky
Allow users to set sticky position.
{"type": "boolean", "default": false}
theme.json
spacing
Settings related to spacing.
{"type": "object", "properties": {"blockGap": {"oneOf": [{"type": "boolean"}, {"type": "null"}], "default": null}, "margin": {"type": "boolean", "default": false}, "padding": {"type": "boolean", "default": false}, "units": {"type": "array", "items": {"type": "string"}, "default": ["px", "em", "rem", "vh", "vw", "%"]}, "customSpacingSize": {"type": "boolean", "default": true}, "spacingSizes": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "slug": {"type": "string"}, "size": {"type": "string"}}, "additionalProperties": false}}, "spacingScale": {"type": "object", "properties": {"operator": {"type": "string", "enum": ["+", "*"], "default": "*"}, "increment": {"type": "number", "default": 1.5}, "steps": {"type": "integer", "default": 7}, "mediumStep": {"type": "number", "default": 1.5}, "unit": {"type": "string", "enum": ["px", "em", "rem", "vh", "vw", "%"], "default": "rem"}}, "additionalProperties": false}}, "additionalProperties": false}
theme.json
blockGap
Enables `--wp--style--block-gap` to be generated from styles.spacing.blockGap. A value of `null` instead of `false` further disables layout styles from being generated.
{"oneOf": [{"type": "boolean"}, {"type": "null"}], "default": null}
theme.json
margin
Allow users to set a custom margin.
{"type": "boolean", "default": false}
theme.json
padding
Allow users to set a custom padding.
{"type": "boolean", "default": false}
theme.json
units
List of units the user can use for spacing values.
{"type": "array", "items": {"type": "string"}, "default": ["px", "em", "rem", "vh", "vw", "%"]}
theme.json
customSpacingSize
Allow users to set custom space sizes.
{"type": "boolean", "default": true}
theme.json
spacingSizes
Space size presets for the space size selector. Generates a custom property (`--wp--preset--spacing--{slug}`) per preset value.
{"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "slug": {"type": "string"}, "size": {"type": "string"}}, "additionalProperties": false}}
theme.json
name
Name of the space size preset, translatable.
{"type": "string"}
theme.json
slug
Unique identifier for the space size preset. For best cross theme compatibility these should be in the form '10','20','30','40','50','60', etc. with '50' representing the 'Medium' size step.
{"type": "string"}
theme.json
size
CSS space-size value, including units.
{"type": "string"}
theme.json
spacingScale
Settings to auto-generate space size presets for the space size selector. Generates a custom property (--wp--preset--spacing--{slug}`) per preset value.
{"type": "object", "properties": {"operator": {"type": "string", "enum": ["+", "*"], "default": "*"}, "increment": {"type": "number", "default": 1.5}, "steps": {"type": "integer", "default": 7}, "mediumStep": {"type": "number", "default": 1.5}, "unit": {"type": "string", "enum": ["px", "em", "rem", "vh", "vw", "%"], "default": "rem"}}, "additionalProperties": false}
theme.json
operator
With + or * depending on whether scale is generated by increment or multiplier.
{"type": "string", "enum": ["+", "*"], "default": "*"}
theme.json
increment
The amount to increment each step by.
{"type": "number", "default": 1.5}
theme.json
steps
Number of steps to generate in scale.
{"type": "integer", "default": 7}
theme.json
mediumStep
The value to medium setting in the scale.
{"type": "number", "default": 1.5}
theme.json
unit
Unit that the scale uses, eg. rem, em, px.
{"type": "string", "enum": ["px", "em", "rem", "vh", "vw", "%"], "default": "rem"}
theme.json
typography
Settings related to typography.
{"type": "object", "properties": {"customFontSize": {"type": "boolean", "default": true}, "fontStyle": {"type": "boolean", "default": true}, "fontWeight": {"type": "boolean", "default": true}, "fluid": {"oneOf": [{"type": "object", "properties": {"minFontSize": {"type": "string"}, "maxViewportWidth": {"type": "string"}, "minViewportWidth": {"type": "string"}}, "additionalProperties": false}, {"type": "boolean"}], "default": false}, "letterSpacing": {"type": "boolean", "default": true}, "lineHeight": {"type": "boolean", "default": false}, "textColumns": {"type": "boolean", "default": false}, "textDecoration": {"type": "boolean", "default": true}, "writingMode": {"type": "boolean", "default": false}, "textTransform": {"type": "boolean", "default": true}, "dropCap": {"type": "boolean", "default": true}, "fontSizes": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "slug": {"type": "string"}, "size": {"type": "string"}, "fluid": {"oneOf": [{"type": "object", "properties": {"min": {"type": "string"}, "max": {"type": "string"}}, "additionalProperties": false}, {"type": "boolean"}]}}, "additionalProperties": false}}, "fontFamilies": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "slug": {"type": "string"}, "fontFamily": {"type": "string"}, "fontFace": {"type": "array", "items": {"type": "object", "properties": {"fontFamily": {"type": "string", "default": ""}, "fontStyle": {"type": "string", "default": "normal"}, "fontWeight": {"default": "400", "oneOf": [{"type": "string"}, {"type": "integer"}]}, "fontDisplay": {"type": "string", "default": "fallback", "enum": ["auto", "block", "fallback", "swap", "optional"]}, "src": {"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}], "default": []}, "fontStretch": {"type": "string"}, "ascentOverride": {"type": "string"}, "descentOverride": {"type": "string"}, "fontVariant": {"type": "string"}, "fontFeatureSettings": {"type": "string"}, "fontVariationSettings": {"type": "string"}, "lineGapOverride": {"type": "string"}, "sizeAdjust": {"type": "string"}, "unicodeRange": {"type": "string"}}, "required": ["fontFamily", "src"], "additionalProperties": false}}}, "additionalProperties": false}}}, "additionalProperties": false}
theme.json
customFontSize
Allow users to set custom font sizes.
{"type": "boolean", "default": true}
theme.json
fontStyle
Allow users to set custom font styles.
{"type": "boolean", "default": true}
theme.json
fontWeight
Allow users to set custom font weights.
{"type": "boolean", "default": true}
theme.json
fluid
Enables fluid typography and allows users to set global fluid typography parameters.
{"oneOf": [{"type": "object", "properties": {"minFontSize": {"type": "string"}, "maxViewportWidth": {"type": "string"}, "minViewportWidth": {"type": "string"}}, "additionalProperties": false}, {"type": "boolean"}], "default": false}
theme.json
minFontSize
Allow users to set a global minimum font size boundary in px, rem or em. Custom font sizes below this value will not be clamped, and all calculated minimum font sizes will be, at a minimum, this value.
{"type": "string"}
theme.json
maxViewportWidth
Allow users to set custom a max viewport width in px, rem or em, used to set the maximum size boundary of a fluid font size.
{"type": "string"}
theme.json
minViewportWidth
Allow users to set a custom min viewport width in px, rem or em, used to set the minimum size boundary of a fluid font size.
{"type": "string"}
theme.json
letterSpacing
Allow users to set custom letter spacing.
{"type": "boolean", "default": true}
theme.json
lineHeight
Allow users to set custom line height.
{"type": "boolean", "default": false}
theme.json
textColumns
Allow users to set the number of text columns.
{"type": "boolean", "default": false}
theme.json
textDecoration
Allow users to set custom text decorations.
{"type": "boolean", "default": true}
theme.json
writingMode
Allow users to set the writing mode.
{"type": "boolean", "default": false}
theme.json
textTransform
Allow users to set custom text transforms.
{"type": "boolean", "default": true}
theme.json
dropCap
Enable drop cap.
{"type": "boolean", "default": true}
theme.json
fontSizes
Font size presets for the font size selector. Generates a single class (`.has-{slug}-color`) and custom property (`--wp--preset--font-size--{slug}`) per preset value.
{"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "slug": {"type": "string"}, "size": {"type": "string"}, "fluid": {"oneOf": [{"type": "object", "properties": {"min": {"type": "string"}, "max": {"type": "string"}}, "additionalProperties": false}, {"type": "boolean"}]}}, "additionalProperties": false}}
theme.json
name
Name of the font size preset, translatable.
{"type": "string"}
theme.json
slug
Kebab-case unique identifier for the font size preset.
{"type": "string"}
theme.json
size
CSS font-size value, including units.
{"type": "string"}
theme.json
fluid
Specifies the minimum and maximum font size value of a fluid font size. Set to `false` to bypass fluid calculations and use the static `size` value.
{"oneOf": [{"type": "object", "properties": {"min": {"type": "string"}, "max": {"type": "string"}}, "additionalProperties": false}, {"type": "boolean"}]}
theme.json
min
A min font size for fluid font size calculations in px, rem or em.
{"type": "string"}
theme.json
max
A max font size for fluid font size calculations in px, rem or em.
{"type": "string"}
theme.json
fontFamilies
Font family presets for the font family selector. Generates a single custom property (`--wp--preset--font-family--{slug}`) per preset value.
{"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "slug": {"type": "string"}, "fontFamily": {"type": "string"}, "fontFace": {"type": "array", "items": {"type": "object", "properties": {"fontFamily": {"type": "string", "default": ""}, "fontStyle": {"type": "string", "default": "normal"}, "fontWeight": {"default": "400", "oneOf": [{"type": "string"}, {"type": "integer"}]}, "fontDisplay": {"type": "string", "default": "fallback", "enum": ["auto", "block", "fallback", "swap", "optional"]}, "src": {"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}], "default": []}, "fontStretch": {"type": "string"}, "ascentOverride": {"type": "string"}, "descentOverride": {"type": "string"}, "fontVariant": {"type": "string"}, "fontFeatureSettings": {"type": "string"}, "fontVariationSettings": {"type": "string"}, "lineGapOverride": {"type": "string"}, "sizeAdjust": {"type": "string"}, "unicodeRange": {"type": "string"}}, "required": ["fontFamily", "src"], "additionalProperties": false}}}, "additionalProperties": false}}
theme.json
name
Name of the font family preset, translatable.
{"type": "string"}
theme.json
slug
Kebab-case unique identifier for the font family preset.
{"type": "string"}
theme.json
fontFamily
CSS font-family value.
{"type": "string"}
theme.json
fontFace
Array of font-face declarations.
{"type": "array", "items": {"type": "object", "properties": {"fontFamily": {"type": "string", "default": ""}, "fontStyle": {"type": "string", "default": "normal"}, "fontWeight": {"default": "400", "oneOf": [{"type": "string"}, {"type": "integer"}]}, "fontDisplay": {"type": "string", "default": "fallback", "enum": ["auto", "block", "fallback", "swap", "optional"]}, "src": {"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}], "default": []}, "fontStretch": {"type": "string"}, "ascentOverride": {"type": "string"}, "descentOverride": {"type": "string"}, "fontVariant": {"type": "string"}, "fontFeatureSettings": {"type": "string"}, "fontVariationSettings": {"type": "string"}, "lineGapOverride": {"type": "string"}, "sizeAdjust": {"type": "string"}, "unicodeRange": {"type": "string"}}, "required": ["fontFamily", "src"], "additionalProperties": false}}
theme.json
fontFamily
CSS font-family value.
{"type": "string", "default": ""}
theme.json
fontStyle
CSS font-style value.
{"type": "string", "default": "normal"}
theme.json
fontWeight
List of available font weights, separated by a space.
{"default": "400", "oneOf": [{"type": "string"}, {"type": "integer"}]}
theme.json
fontDisplay
CSS font-display value.
{"type": "string", "default": "fallback", "enum": ["auto", "block", "fallback", "swap", "optional"]}
theme.json
src
Paths or URLs to the font files.
{"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}], "default": []}
theme.json
fontStretch
CSS font-stretch value.
{"type": "string"}
theme.json
ascentOverride
CSS ascent-override value.
{"type": "string"}
theme.json
descentOverride
CSS descent-override value.
{"type": "string"}
theme.json
fontVariant
CSS font-variant value.
{"type": "string"}
theme.json
fontFeatureSettings
CSS font-feature-settings value.
{"type": "string"}
theme.json
fontVariationSettings
CSS font-variation-settings value.
{"type": "string"}
theme.json
lineGapOverride
CSS line-gap-override value.
{"type": "string"}
theme.json
sizeAdjust
CSS size-adjust value.
{"type": "string"}
theme.json
unicodeRange
CSS unicode-range value.
{"type": "string"}
theme.json
custom
Generate custom CSS custom properties of the form `--wp--custom--{key}--{nested-key}: {value};`. `camelCased` keys are transformed to `kebab-case` as to follow the CSS property naming schema. Keys at different depth levels are separated by `--`, so keys should not include `--` in the name.
{}
theme.json
behaviors
Settings related to behaviors.
{"type": "object", "properties": {"lightbox": {"type": "boolean", "default": false}}, "additionalProperties": false}
theme.json
lightbox
Allow users to enable/disable lightbox.
{"type": "boolean", "default": false}
theme.json
border
Border styles.
{"type": "object", "properties": {"color": {"oneOf": [{"type": "string"}, {}]}, "radius": {"anyOf": [{"type": "string"}, {}, {"type": "object", "properties": {"topLeft": {"oneOf": [{"type": "string"}, {}]}, "topRight": {"oneOf": [{"type": "string"}, {}]}, "bottomLeft": {"oneOf": [{"type": "string"}, {}]}, "bottomRight": {"oneOf": [{"type": "string"}, {}]}}}]}, "style": {"oneOf": [{"type": "string"}, {}]}, "width": {"oneOf": [{"type": "string"}, {}]}, "top": {"type": "object", "properties": {"color": {"oneOf": [{"type": "string"}, {}]}, "style": {"oneOf": [{"type": "string"}, {}]}, "width": {"oneOf": [{"type": "string"}, {}]}}, "additionalProperties": false}, "right": {"type": "object", "properties": {"color": {"oneOf": [{"type": "string"}, {}]}, "style": {"oneOf": [{"type": "string"}, {}]}, "width": {"oneOf": [{"type": "string"}, {}]}}, "additionalProperties": false}, "bottom": {"type": "object", "properties": {"color": {"oneOf": [{"type": "string"}, {}]}, "style": {"oneOf": [{"type": "string"}, {}]}, "width": {"oneOf": [{"type": "string"}, {}]}}, "additionalProperties": false}, "left": {"type": "object", "properties": {"color": {"oneOf": [{"type": "string"}, {}]}, "style": {"oneOf": [{"type": "string"}, {}]}, "width": {"oneOf": [{"type": "string"}, {}]}}, "additionalProperties": false}}, "additionalProperties": false}
theme.json
color
Sets the `border-color` CSS property.
{"oneOf": [{"type": "string"}, {}]}
theme.json
radius
Sets the `border-radius` CSS property.
{"anyOf": [{"type": "string"}, {}, {"type": "object", "properties": {"topLeft": {"oneOf": [{"type": "string"}, {}]}, "topRight": {"oneOf": [{"type": "string"}, {}]}, "bottomLeft": {"oneOf": [{"type": "string"}, {}]}, "bottomRight": {"oneOf": [{"type": "string"}, {}]}}}]}
theme.json
topLeft
Sets the `border-top-left-radius` CSS property.
{"oneOf": [{"type": "string"}, {}]}
theme.json
topRight
Sets the `border-top-right-radius` CSS property.
{"oneOf": [{"type": "string"}, {}]}
theme.json
bottomLeft
Sets the `border-bottom-left-radius` CSS property.
{"oneOf": [{"type": "string"}, {}]}
theme.json
bottomRight
Sets the `border-bottom-right-radius` CSS property.
{"oneOf": [{"type": "string"}, {}]}
theme.json
style
Sets the `border-style` CSS property.
{"oneOf": [{"type": "string"}, {}]}
theme.json
width
Sets the `border-width` CSS property.
{"oneOf": [{"type": "string"}, {}]}
theme.json
color
Sets the `border-top-color` CSS property.
{"oneOf": [{"type": "string"}, {}]}
theme.json
style
Sets the `border-top-style` CSS property.
{"oneOf": [{"type": "string"}, {}]}
theme.json
width
Sets the `border-top-width` CSS property.
{"oneOf": [{"type": "string"}, {}]}
theme.json
color
Sets the `border-right-color` CSS property.
{"oneOf": [{"type": "string"}, {}]}
theme.json
style
Sets the `border-right-style` CSS property.
{"oneOf": [{"type": "string"}, {}]}
theme.json
width
Sets the `border-right-width` CSS property.
{"oneOf": [{"type": "string"}, {}]}
theme.json
color
Sets the `border-bottom-color` CSS property.
{"oneOf": [{"type": "string"}, {}]}