Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

eventName

string

A data object that is passed to the event handler.

data

object

Fires an event that is defined in the Widget API.

The `fireEvent()` function fires a widget event, which can then be handled from outside the widget (by code in a parent widget or a site page).
When using the widget's API, the event is named `on`, for example, `onAddedToCart`.

$w(`#button1`).onClick(() => {
  $widget.fireEvent(`addedToCart`, {productId: product.id, customerId: customer.id})
});

Fire a widget event

fireEvent

void

The name of the function or
 the function expression to run when the value of a widget property is changed.

handler

onPropsChangedHandler

Adds an event handler that runs when the value of a widget property is changed.

A widget receives an `onPropsChanged` event when one or more of its properties is changed via its API.

$widget.onPropsChanged((oldProps, newProps) => {
  loadProductData(newProps.productId);
  loadCustomerData(newProps.customerId);
});

Load updated data when a widget's property is changed

onPropsChanged

# Introduction
> **Important**:
> This namespace is available only in Wix Blocks widget code. [Wix Blocks](https://support.wix.com/en/article/wix-blocks-check-out-our-articles) is an editor for building Wix apps.

Blocks widgets can expose a [widget API](https://support.wix.com/en/article/wix-blocks-about-the-widget-api), letting you add properties, events, and functions to your widget.
The `$widget` namespace provides functionality for working with to your widget's API from within the widget code.

velo_$widget

Sets or gets the [widget's properties](https://support.wix.com/en/article/wix-blocks-widget-api-properties).

The `props` property is an object containing all of the widget's properties.

$w('#text1').text = $widget.props.shoe.size; // "43"

Get a widget's properties

$widget.props = { saleIndicator: "No Sale" };