Interface: SettingsProperties

Defined in: packages/core/src/react/provider/types.ts:354

Indexable

[k: string]: unknown

Properties

appearanceTools?

optional appearanceTools: boolean

Defined in: packages/core/src/react/provider/types.ts:358

Setting that enables ui tools.

---

border?

optional border: object

Defined in: packages/core/src/react/provider/types.ts:362

Settings related to borders.

color?

optional color: boolean

Allow users to set custom border colors.

radius?

optional radius: boolean

Allow users to set custom border radius.

style?

optional style: boolean

Allow users to set custom border styles.

width?

optional width: boolean

Allow users to set custom border widths.

---

color?

optional color: object

Defined in: packages/core/src/react/provider/types.ts:383

Settings related to colors.

background?

optional background: boolean

Allow users to set background colors.

custom?

optional custom: boolean

Allow users to select custom colors.

customDuotone?

optional customDuotone: boolean

Allow users to create custom duotone filters.

customGradient?

optional customGradient: boolean

Allow users to create custom gradients.

defaultGradients?

optional defaultGradients: boolean

Allow users to choose colors from the default gradients.

defaultPalette?

optional defaultPalette: boolean

Allow users to choose colors from the default palette.

duotone?

optional duotone: SettingsDuotone

Duotone presets for the duotone picker. Doesn't generate classes or properties.

gradients?

optional gradients: SettingsGradient

Gradient presets for the gradient picker. Generates a single class (.has-{slug}-background) and custom property (--wp--preset--gradient--{slug}) per preset value.

link?

optional link: boolean

Allow users to set link colors.

palette?

optional palette: SettingsColorPalette

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.

text?

optional text: boolean

Allow users to set text colors.

---

custom?

optional custom: object

Defined in: packages/core/src/react/provider/types.ts:543

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.

Index Signature

[k: string]: string | number | SettingsCustomAdditionalProperties

---

layout?

optional layout: object

Defined in: packages/core/src/react/provider/types.ts:435

Settings related to layout.

contentSize?

optional contentSize: string

Sets the max-width of the content.

wideSize?

optional wideSize: string

Sets the max-width of wide (.alignwide) content.

---

spacing?

optional spacing: object

Defined in: packages/core/src/react/provider/types.ts:448

Settings related to spacing.

blockGap?

optional blockGap: null | boolean

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.

margin?

optional margin: boolean

Allow users to set a custom margin.

padding?

optional padding: boolean

Allow users to set a custom padding.

units?

optional units: string[]

List of units the user can use for spacing values.

---

typography?

optional typography: object

Defined in: packages/core/src/react/provider/types.ts:470

Settings related to typography.

customFontSize?

optional customFontSize: boolean

Allow users to set custom font sizes.

dropCap?

optional dropCap: boolean

Enable drop cap.

fontFamilies?

optional fontFamilies: object[]

Font family presets for the font family selector. Generates a single custom property (--wp--preset--font-family--{slug}) per preset value.

fontSizes?

optional fontSizes: object[]

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.

fontStyle?

optional fontStyle: boolean

Allow users to set custom font styles.

fontWeight?

optional fontWeight: boolean

Allow users to set custom font weights.

letterSpacing?

optional letterSpacing: boolean

Allow users to set custom letter spacing.

lineHeight?

optional lineHeight: boolean

Allow users to set custom line height.

textDecoration?

optional textDecoration: boolean

Allow users to set custom text decorations.

textTransform?

optional textTransform: boolean

Allow users to set custom text transforms.