Wix Blocks is open to all Wix Studio users. To get access to Blocks, join Wix Studio.
Use the Widget API to add properties to your widget. Properties allow the site owner to access information from your widget. For example, in a shopping widget, you can add properties that represent the products you are selling and the customers. Site creators can then access the Widget API properties when editing their site on the Wix Editor or Wix Studio (learn more about using your widget API when editing a site).
To add a new property to your widget:
4. Name your property, select its type and default values, add a description and click Create.
Change property type Hover over the property in the Widget API panel and click the Edit icon to change the property type.
These are the types of properties you can add to your Widget API:
http(s)://www.<domainname>.<topleveldomain>
, such as www.wix.comThe $widget object includes:
Use the following syntax to access your Widget API properties in your widget's code. Internal properties are optional - they're needed only if you're using a custom type property.
1
For example, let's say that you want to present the size of a shoe in a text element in your widget. The property is "shoe". Shoe is a custom type that has an internal property named "size". So the statement will look like this:
1
The onPropsChanged() event is fired when there is a change in your widget's properties.
It receives oldProps and newProps as its parameters. Here is the syntax to use in the Widget code:
1
The initial code for onPropsChanged() is created automatically in every new Blocks widget. You can define what happens in this event through adding Velo code.
For example, in a shopping widget, if the product id is changed - load the data for the new product and customer:
1
When your widget is installed on a site, it comes with a default Settings panel, which includes any properties that you defined in your API (Learn more about using your Widget API when editing a site). You can also use a custom Settings panel by using the panel builder in Blocks. Use Blocks's Test API Properties to see how these properties look on a site:
To test your widget's API properties:
Don't forget to document Make sure to document your widget API by describing any property, event or function you add to it. These descriptions are available to site creators who install your widget.
Learn more about your Widget API:
Want to learn more about Blocks? Check out the Wix Blocks help articles