Documentation

Class: WidgetPartial

wp.customize.widgetsPreview. WidgetPartial

new WidgetPartial(id, options)

Represents a partial widget instance.
Parameters:
Name Type Description
id string The partial's ID.
options Object Options used to initialize the partial's instance.
Properties
Name Type Description
params Object The options parameters.
Since:
  • 4.5.0
Source:

Extends

Methods

refresh()

Refreshes the widget partial.
Since:
  • 4.5.0
Source:
Returns:
Either a promise postponing the refresh, or void.
Type
Promise | void

renderContent(placement)

Sends the widget-updated message to the parent so the spinner will get removed from the widget control.
Parameters:
Name Type Description
placement wp.customize.selectiveRefresh.Placement The placement function.
Source:
Returns:
Type
void