applyPreset()

Applies a preset to the selected component. A preset is a named, predefined visual variation of the component, declared in the manifest's presets property.

Call this from your custom panel in response to a Wix user's action there, for example when they click a preset thumbnail in your panel's UI. The change applies to the component on the canvas immediately, updating its standard cssProperties and data to match that preset's declared defaults. It only runs when your panel calls it, while a Wix user is actively editing.

This is unrelated to which preset a component starts with when a Wix user first adds it to a page. That starting preset comes from the manifest's installation.presets setting, not from a call to applyPreset().

Syntax

Copy

Parameters

NameTypeDescription
options.keystringKey of the preset to apply. Must match a key returned by getPresetDefinitions().

Returns

Promise<void>

Example

Copy

See also

Last updated: 8 September 2026

Did this help?