CodeAPI

Event

Events are fired when certain actions occur to elements.

Events can be caused by user interactions, such as clicking the mouse or pressing a key, or generated programmatically, such as hiding or showing an element using the hide() and show() functions.

Table of Contents

PROPERTIES

?
Store values associated with an object.
contextGets the context of the event on a repeated element.
targetGets the element that the event was fired on.
typeGets the type of event that was fired.

OBJECTS

?
Objects used when setting, getting, or calling the properties and methods listed above.
EventContextAn object that contains information about the context in which an event was fired.

context

Gets the context of the event on a repeated element.

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.

Syntax

get context(): EventContext

Examples

Get the context of the event

// 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"
} );

target

Gets the element that the event was fired on.

Note

When using the target to get the value of a text input or text box in an onKeyPress event handler, you may receive the value of the element before the key was pressed. To get the text input or text box's updated value, use the updatedTargetValue property of the event handler's event parameter.

Syntax

get target(): Element
TYPE
?
The kind of data the property stores.

Examples

Get the ID of the target element

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

type

Gets the type of event that was fired.

Syntax

get type(): string
TYPE
?
The kind of data the property stores.
string

Examples

Get the type of the event

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

EventContext

An object that contains information about the context in which an event was fired.

See Also

context

Syntax

type EventContext = {
  type: string
  itemId: string
}
MEMBERS
?
The kind of data the property stores.
type
string

"GLOBAL_SCOPE" for events fired outside of repeaters, or "COMPONENT_SCOPE" for events fired from repeaters.

itemId
string

ID of the repeater item where the event was fired from.

Examples

Get the context of the event

// 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"
} );