Search.../

onPause( )

Adds an event handler that runs when playback is paused.

Description

An element can be paused by a user clicking the gallery or slideshow's pause button or by calling its pause() function

Notes:

  • Deprecation note: The $w parameter of event handlers is being deprecated. To get a scoped selector for working with elements in repeater items, use the $w.at() function and pass it the context property of the event parameter: $item = $w.at(event.context). To learn more, see here.

Syntax

function onPause(handler: EventHandler): Gallery | Slideshow
handler: function EventHandler(event: Event, $w: $w): void

onPause Parameters

NAME
TYPE
DESCRIPTION
handler

EventHandler

The name of the function or the function expression to run when the element is paused.

Returns

The gallery or slideshow that triggered the event.

Return Type:

EventHandler Parameters

NAME
TYPE
DESCRIPTION
event

Event

The event that occurred.

$w

$w

Deprecated: A selector function. The $w function was used to enable event handlers to work with elements in repeaters. Now, to get a scoped selector for working with repeater items, use the $w.at() function and pass it the context property of the event parameter: $item = $w.at(event.context).

Returns

This function does not return anything.

Return Type:

void
Mixed in from:$w.PlayableMixin

Related Content:

Was this helpful?

Get the ID of the element that has been paused

Code Example

Copy Code
1$w("#myElement").onPause( (event) => {
2 let targetId = event.target.id; // "myElement"
3});