onPropsChanged( )

Adds an event handler that runs when the value of a widget property is changed.

Description

A widget receives an onPropsChanged event when one or more of its properties is changed via its API.

function onPropsChanged(handler: onPropsChangedHandler): any
handler: function onPropsChangedHandler(oldProps: Object, newProps: Object): void

handler

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

Return Type:

any

oldProps

Object

The old widget properties.

newProps

Object

The new widget properties.

This function does not return anything.

Return Type:

void

Was this helpful?

Copy Code

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