Introduction

Important:

This module is available only in Wix Blocks. Wix Blocks is an editor for building Wix apps.
This module doesn't work in preview mode.

The wix-widget API is used within the code of panels built with the Blocks Panel Builder. It enables your panel to interact with your Blocks widgets by controlling their properties, design presets, and more.
To use this API, import wixWidget from the wix-widget module:

Copy


import wixWidget from "wix-widget";

Did this help?

getDesignPreset( )

Gets the widget's current design preset.

The getDesignPreset() function returns a Promise that resolves to the widget's current preset name. To use this function on an inner (nested) widget, use getNestedWidget().

Note: The getDesignPreset() function doesn't work in preview mode.

Method Declaration

Copy

function getDesignPreset(): Promise<string>;

Request

This method does not take any parameters

Returns

Return Type:Promise<string>

Example shown:Get a widget's design preset

JavaScript


import wixWidget from "wix-widget";

// ...

wixWidget.getDesignPreset().then((designPreset) => {
  // Code to execute with the designPreset string
});

// For example, designPreset can be "preset-1-wide"

Did this help?

getNestedWidget( )

Gets the wix-widget module scoped to an inner (nested) widget.

The getNestedWidget() function lets you use wix-widget functions on inner (nested) widgets. It receives a selector of an inner widget and returns a promise that resolves with an object representing the scope of the inner widget.

Note: The getNestedWidget() function doesn't work in preview mode.

Method Declaration

Copy

function getNestedWidget(Selector: string): Promise<object>;

Method Parameters

SelectorstringRequired

A string of one or more nested widget selectors, which can include a few levels of nesting from outer to inner, separated by spaces. For example: ("#nestedWidget1"), or ("#nestedWidget1 #nestedWidget2").

Returns

Return Type:Promise<object>

Example shown:Get a nested widget's preset

JavaScript


import wixWidget from "wix-widget";

//...

wixWidget
  .getNestedWidget("#nestedWidget1 #nestedWidget2") //nestedWidget2 is inside nestedWidget1
  .then((nestedWixWidget) => nestedWixWidget.getDesignPreset())
  .then((nestedWidgetPreset) => {
    // do something with the design preset of nestedWidget2
  });

Did this help?

getProps( )

Gets the widget's properties.

The getProps() function returns a Promise that resolves to an object with all of the widget's properties. To use this function on an inner (nested) widget, use getNestedWidget().

Note: The getProps() function doesn't work in preview mode.

Method Declaration

Copy

function getProps(): Promise<object>;

Request

This method does not take any parameters

Returns

Return Type:Promise<object>

Example shown:Get a widget's properties

JavaScript


import wixWidget from "wix-widget";

// ...

wixWidget.getProps().then((props) => {
  // Code to execute with the props object
});

// Props object can be, for example: {country: "us", upperLimit: 7}

Did this help?