Documentation

Class: PreviewFrame

wp.customize. PreviewFrame

new PreviewFrame(options)

An object that fetches a preview in the background of the document, which allows for seamless replacement of an existing preview.
Parameters:
Name Type Description
params.container object
params.previewUrl object
params.query object
options object
Source:

Extends

Methods

add(key, initial, options)

Create a new Value.
Parameters:
Name Type Description
key string Unique identifier.
initial mixed Initial value.
options mixed Options hash. Optional.
Inherited From:
Source:
Returns:
Class instance of the Value.
Type
Value

initialize(params, options)

Initialize Messenger.
Parameters:
Name Type Description
params object Parameters to configure the messenger. {string} params.url - The URL to communicate with. {window} params.targetWindow - The window instance to communicate with. Default window.parent. {string} params.channel - If provided, will send the channel with each message and only accept messages a matching channel.
options object Extend any instance parameter or method with this object.
Inherited From:
Source:

receive(event)

Receive data from the other window.
Parameters:
Name Type Description
event jQuery.Event Event with embedded data.
Inherited From:
Source:

run(deferred)

Run the preview request.
Parameters:
Name Type Description
deferred object jQuery Deferred object to be resolved with the request.
Source:

send(id, data)

Send data to the other window.
Parameters:
Name Type Description
id string The event name.
data object Data.
Inherited From:
Source: