$w.HtmlComponentMessageEvent

$w.HtmlComponentMessageEvent

Event that is fired when the code in an HtmlComponent sends a message.

Mixes In

$w.Event

Contents

context Gets the context of the event on a repeated element.
data Gets the event data.
target Gets the element that the event was fired on.
type Gets the type of event that was fired.
context

context

Gets the context of the event on a repeated element.

Syntax

get context(): Object

Description

An event's context contains information about the circumstances surrounding the firing of the event. The context property only appears in events on repeated elements.

You can use the evnet context with $w.at() to get a selector function which selects items from a specific repeater item. It contains an object with one key:value pair. The key is "itemId" and the value is the ID of the repeated item on which the event occurred.

Type

EventContext

Examples

Get the context of the event

Ly8gbm9uLXJlcGVhdGVyIGV2ZW50CgokdygiI215RWxlbWVudCIpLm9uRXZlbnQoIChldmVudCkgPT4gewogIGxldCB0eXBlID0gZXZlbnQuY29udGV4dC50eXBlOyAvLyAiR0xPQkFMX1NDT1BFIgp9ICk7CgoKLy8gcmVwZWF0ZXIgZXZlbnQKCiR3KCIjbXlSZXBlYXRlZEVsZW1lbnQiKS5vbkV2ZW50KCAoZXZlbnQpID0+IHsKICBsZXQgJGl0ZW0gPSAkdy5hdChldmVudC5jb250ZXh0KQogICRpdGVtKCIjYW5vdGhlclJlcGVhdGVkRWxlbWVudCIpLnZhbHVlID0gIm5ldyB2YWx1ZSI7CgogIGxldCBpdGVtSWQgPSBldmVudC5jb250ZXh0Lml0ZW1JZDsgIC8vICJpdGVtMSIKfSApOwo=
// non-repeater event

$w("#myElement").onEvent( (event) => {
  let type = event.context.type; // "GLOBAL_SCOPE"
} );


// repeater event

$w("#myRepeatedElement").onEvent( (event) => {
  let $item = $w.at(event.context)
  $item("#anotherRepeatedElement").value = "new value";

  let itemId = event.context.itemId;  // "item1"
} );

Mixed In From

$w.Event

data

data

Gets the event data.

Syntax

get data(): string

Type

Element

Examples

Receive a message from an HTML Component

JHcoIiNteUh0bWxDb21wb25lbnQiKS5vbk1lc3NhZ2UoIChldmVudCwgJHcpID0+IHsKICBsZXQgcmVjZWl2ZWRNZXNzYWdlID0gZXZlbnQuZGF0YTsKfSApOwo=
$w("#myHtmlComponent").onMessage( (event, $w) => {
  let receivedMessage = event.data;
} );
target

target

Gets the element that the event was fired on.

Syntax

get target(): string

Type

Element

Examples

Get the ID of the target element

JHcoIiNteUVsZW1lbnQiKS5vbkV2ZW50KCAoZXZlbnQsICR3KSA9PiB7CiAgbGV0IHRhcmdldElkID0gZXZlbnQudGFyZ2V0LmlkOyAgLy8gIm15RWxlbWVudCIKfSApOwo=
$w("#myElement").onEvent( (event, $w) => {
  let targetId = event.target.id;  // "myElement"
} );

Mixed In From

$w.Event

type

type

Gets the type of event that was fired.

Syntax

get type(): string

Type

String

Examples

Get the type of the event

JHcoIiNteUVsZW1lbnQiKS5vbkV2ZW50KCAoZXZlbnQsICR3KSA9PiB7CiAgbGV0IGV2ZW50VHlwZSA9IGV2ZW50LnR5cGU7IC8vICJjbGljayIKfSApOwo=
$w("#myElement").onEvent( (event, $w) => {
  let eventType = event.type; // "click"
} );

Mixed In From

$w.Event