EventProps

com.raquo.laminar.defs.eventProps.EventProps
trait EventProps

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

def eventProp[Ev <: Event](key: String): EventProp[Ev]

Concrete fields

lazy val gotPointerCapture: EventProp[PointerEvent]

fired when an element receives pointer capture.

lazy val lostPointerCapture: EventProp[PointerEvent]

Fired after pointer capture is released for a pointer.

lazy val onAbort: EventProp[Event]

Script to be run on abort

lazy val onAfterPrint: EventProp[Event]

Script to be run after the document is printed

Script to be run after the document is printed

Attributes

See also
lazy val onAnimationEnd: EventProp[AnimationEvent]

The animationend event is event fires when a CSS animation reaches the end of its active period.

The animationend event is event fires when a CSS animation reaches the end of its active period.

Attributes

See also
lazy val onAnimationIteration: EventProp[AnimationEvent]

The animationiteration event is sent when a CSS animation reaches the end of an iteration. An iteration ends when a single pass through the sequence of animation instructions is completed by executing the last animation step.

The animationiteration event is sent when a CSS animation reaches the end of an iteration. An iteration ends when a single pass through the sequence of animation instructions is completed by executing the last animation step.

Attributes

See also
lazy val onAnimationStart: EventProp[AnimationEvent]

The animationstart event is sent when a CSS Animation starts to play.

lazy val onBeforeInput: EventProp[InputEvent]

The DOM beforeinput event fires when the value of an , or

The DOM beforeinput event fires when the value of an , or

Attributes

See also
Note

IE does not support this event.

lazy val onBeforePrint: EventProp[Event]

Script to be run before the document is printed

Script to be run before the document is printed

Attributes

See also
lazy val onBeforeUnload: EventProp[BeforeUnloadEvent]

Script to be run when the document is about to be unloaded

lazy val onBlur: EventProp[FocusEvent]

The blur event is raised when an element loses focus.

lazy val onCanPlay: EventProp[Event]

Script to be run when a file is ready to start playing (when it has buffered enough to begin)

Script to be run when a file is ready to start playing (when it has buffered enough to begin)

Attributes

See also
lazy val onCanPlayThrough: EventProp[Event]

Script to be run when a file can be played all the way to the end without pausing for buffering

Script to be run when a file can be played all the way to the end without pausing for buffering

Attributes

See also
lazy val onChange: EventProp[Event]

The change event is fired for input, select, and textarea elements when a change to the element's value is committed by the user.

The change event is fired for input, select, and textarea elements when a change to the element's value is committed by the user.

Attributes

See also
lazy val onClick: EventProp[MouseEvent]

The click event is raised when the user clicks on an element. The click event will occur after the mousedown and mouseup events.

The click event is raised when the user clicks on an element. The click event will occur after the mousedown and mouseup events.

Attributes

See also
lazy val onContextMenu: EventProp[MouseEvent]

Script to be run when a context menu is triggered

lazy val onCopy: EventProp[ClipboardEvent]

Fires when the user copies the content of an element

lazy val onCueChange: EventProp[Event]

Script to be run when the cue changes in a element

Script to be run when the cue changes in a element

Attributes

See also
lazy val onCut: EventProp[ClipboardEvent]

Fires when the user cuts the content of an element

lazy val onDblClick: EventProp[MouseEvent]

The dblclick event is fired when a pointing device button (usually a mouse button) is clicked twice on a single element.

The dblclick event is fired when a pointing device button (usually a mouse button) is clicked twice on a single element.

Attributes

See also
lazy val onDomContentLoaded: EventProp[Event]

The DOMContentLoaded event is fired when the initial HTML document has been completely loaded and parsed, without waiting for stylesheets, images, and subframes to finish loading. A very different event load should be used only to detect a fully-loaded page.

The DOMContentLoaded event is fired when the initial HTML document has been completely loaded and parsed, without waiting for stylesheets, images, and subframes to finish loading. A very different event load should be used only to detect a fully-loaded page.

It is an incredibly common mistake to use load where DOMContentLoaded would be much more appropriate, so be cautious.

Attributes

See also
lazy val onDrag: EventProp[DragEvent]

Script to be run when an element is dragged

lazy val onDragEnd: EventProp[DragEvent]

Script to be run at the end of a drag operation

lazy val onDragEnter: EventProp[DragEvent]

Script to be run when an element has been dragged to a valid drop target

Script to be run when an element has been dragged to a valid drop target

Attributes

See also
lazy val onDragLeave: EventProp[DragEvent]

Script to be run when an element leaves a valid drop target

lazy val onDragOver: EventProp[DragEvent]

Script to be run when an element is being dragged over a valid drop target

Script to be run when an element is being dragged over a valid drop target

Attributes

See also
lazy val onDragStart: EventProp[DragEvent]

Script to be run at the start of a drag operation

lazy val onDrop: EventProp[DragEvent]

Script to be run when dragged element is being dropped

lazy val onDurationChange: EventProp[Event]

Script to be run when the length of the media changes

Script to be run when the length of the media changes

Attributes

See also
lazy val onEmptied: EventProp[Event]

Script to be run when something bad happens and the file is suddenly unavailable (like unexpectedly disconnects)

Script to be run when something bad happens and the file is suddenly unavailable (like unexpectedly disconnects)

Attributes

See also
lazy val onEnded: EventProp[Event]

Script to be run when the media has reach the end (a useful event for messages like "thanks for listening")

Script to be run when the media has reach the end (a useful event for messages like "thanks for listening")

Attributes

See also
lazy val onError: EventProp[ErrorEvent]

Script to be run when an error occurs when the file is being loaded

Script to be run when an error occurs when the file is being loaded

Attributes

See also
lazy val onFocus: EventProp[FocusEvent]

The focus event is raised when the user sets focus on the given element.

The focus event is raised when the user sets focus on the given element.

Attributes

See also
lazy val onFullScreenChange: EventProp[Event]

The fullscreenchange event is fired immediately after the browser switches into or out of full-screen mode.

The fullscreenchange event is fired immediately after the browser switches into or out of full-screen mode.

Attributes

See also
lazy val onFullScreenError: EventProp[Event]

The fullscreenerror event is fired when the browser cannot switch to full-screen mode.

The fullscreenerror event is fired when the browser cannot switch to full-screen mode.

Attributes

See also
lazy val onHashChange: EventProp[HashChangeEvent]

Script to be run when there has been changes to the anchor part of the a URL

Script to be run when there has been changes to the anchor part of the a URL

Attributes

See also
lazy val onInput: EventProp[Event]

The input event is fired for input, select, textarea, and contentEditable elements when it gets user input.

The input event is fired for input, select, textarea, and contentEditable elements when it gets user input.

Attributes

See also
lazy val onInvalid: EventProp[Event]

Script to be run when an element is invalid

Script to be run when an element is invalid

Attributes

See also
lazy val onKeyDown: EventProp[KeyboardEvent]

The keydown event is raised when the user presses a keyboard key.

The keydown event is raised when the user presses a keyboard key.

Attributes

See also
lazy val onKeyPress: EventProp[KeyboardEvent]

The keypress event should be raised when the user presses a key on the keyboard. However, not all browsers fire keypress events for certain keys.

The keypress event should be raised when the user presses a key on the keyboard. However, not all browsers fire keypress events for certain keys.

Webkit-based browsers (Google Chrome and Safari, for example) do not fire keypress events on the arrow keys. Firefox does not fire keypress events on modifier keys like SHIFT.

Attributes

See also
lazy val onKeyUp: EventProp[KeyboardEvent]

The keyup event is raised when the user releases a key that's been pressed.

The keyup event is raised when the user releases a key that's been pressed.

Attributes

See also
lazy val onLoad: EventProp[UIEvent]

The onload property of the GlobalEventHandlers mixin is an event handler for the load event of a Window, XMLHttpRequest, element, etc., which fires when the resource has loaded.

The onload property of the GlobalEventHandlers mixin is an event handler for the load event of a Window, XMLHttpRequest, element, etc., which fires when the resource has loaded.

Attributes

See also
lazy val onLoadStart: EventProp[Event]

Script to be run just as the file begins to load before anything is actually loaded

Script to be run just as the file begins to load before anything is actually loaded

Attributes

See also
lazy val onLoadedData: EventProp[Event]

Script to be run when media data is loaded

Script to be run when media data is loaded

Attributes

See also
lazy val onLoadedMetadata: EventProp[Event]

Script to be run when meta data (like dimensions and duration) are loaded

Script to be run when meta data (like dimensions and duration) are loaded

Attributes

See also
lazy val onMessage: EventProp[MessageEvent]

Script to be run when an object receives a message

lazy val onMessageError: EventProp[MessageEvent]

Script to be run when an object receives a message that cannot be deserialized and therefore raises an error

Script to be run when an object receives a message that cannot be deserialized and therefore raises an error

Attributes

See also
lazy val onMouseDown: EventProp[MouseEvent]

The mousedown event is raised when the user presses the mouse button.

The mousedown event is raised when the user presses the mouse button.

Attributes

See also
lazy val onMouseEnter: EventProp[MouseEvent]

The mouseenter event is fired when a pointing device (usually a mouse) is moved over the element that has the listener attached.

The mouseenter event is fired when a pointing device (usually a mouse) is moved over the element that has the listener attached.

Similar to mouseover, it differs in that it doesn't bubble and that it isn't sent when the pointer is moved from one of its descendants' physical space to its own physical space.

With deep hierarchies, the amount of mouseenter events sent can be quite huge and cause significant performance problems. In such cases, it is better to listen for mouseover events.

Attributes

See also
lazy val onMouseLeave: EventProp[MouseEvent]

The mouseleave event is fired when the pointer of a pointing device (usually a mouse) is moved out of an element.

The mouseleave event is fired when the pointer of a pointing device (usually a mouse) is moved out of an element.

mouseleave and mouseout are similar but differ in that mouseleave does not bubble and mouseout does.

This means that mouseleave is fired when the pointer has exited the element and all of its descendants, whereas mouseout is fired when the pointer leaves the element or leaves one of the element's descendants (even if the pointer is still within the element).

Attributes

See also
lazy val onMouseMove: EventProp[MouseEvent]

The mousemove event is raised when the user moves the mouse.

lazy val onMouseOut: EventProp[MouseEvent]

The mouseout event is raised when the mouse leaves an element (e.g, when the mouse moves off of an image in the web page, the mouseout event is raised for that image element).

The mouseout event is raised when the mouse leaves an element (e.g, when the mouse moves off of an image in the web page, the mouseout event is raised for that image element).

Attributes

See also
lazy val onMouseOver: EventProp[MouseEvent]

The mouseover event is raised when the user moves the mouse over a particular element.

The mouseover event is raised when the user moves the mouse over a particular element.

Attributes

See also
lazy val onMouseUp: EventProp[MouseEvent]

The mouseup event is raised when the user releases the mouse button.

The mouseup event is raised when the user releases the mouse button.

Attributes

See also
lazy val onOffline: EventProp[Event]

Script to be run when the browser starts to work offline

Script to be run when the browser starts to work offline

Attributes

See also
lazy val onOnline: EventProp[Event]

Script to be run when the browser starts to work online

Script to be run when the browser starts to work online

Attributes

See also
lazy val onPageHide: EventProp[PageTransitionEvent]

Script to be run when a user navigates away from a page

lazy val onPageShow: EventProp[PageTransitionEvent]

Script to be run when a user navigates to a page

lazy val onPaste: EventProp[ClipboardEvent]

Fires when the user pastes some content in an element

lazy val onPause: EventProp[Event]

Script to be run when the media is paused either by the user or programmatically

Script to be run when the media is paused either by the user or programmatically

Attributes

See also
lazy val onPlay: EventProp[Event]

Script to be run when the media is ready to start playing

Script to be run when the media is ready to start playing

Attributes

See also
lazy val onPlaying: EventProp[Event]

Script to be run when the media actually has started playing

Script to be run when the media actually has started playing

Attributes

See also
lazy val onPointerCancel: EventProp[PointerEvent]

a browser fires this event if it concludes the pointer will no longer be able to generate events (for example the related device is deactived).

a browser fires this event if it concludes the pointer will no longer be able to generate events (for example the related device is deactived).

Attributes

See also
lazy val onPointerDown: EventProp[PointerEvent]

fired when a pointer becomes active.

lazy val onPointerEnter: EventProp[PointerEvent]

fired when a pointing device is moved into the hit test boundaries of an element or one of its descendants, including as a result of a pointerdown event from a device that does not support hover (see pointerdown).

fired when a pointing device is moved into the hit test boundaries of an element or one of its descendants, including as a result of a pointerdown event from a device that does not support hover (see pointerdown).

Attributes

See also
lazy val onPointerLeave: EventProp[PointerEvent]

fired when a pointing device is moved out of the hit test boundaries of an element. For pen devices, this event is fired when the stylus leaves the hover range detectable by the digitizer.

fired when a pointing device is moved out of the hit test boundaries of an element. For pen devices, this event is fired when the stylus leaves the hover range detectable by the digitizer.

Attributes

See also
lazy val onPointerMove: EventProp[PointerEvent]

fired when a pointer changes coordinates.

lazy val onPointerOut: EventProp[PointerEvent]

fired for several reasons including: pointing device is moved out of the hit test boundaries of an element; firing the pointerup event for a device that does not support hover (see pointerup); after firing the pointercancel event (see pointercancel); when a pen stylus leaves the hover range detectable by the digitizer.

fired for several reasons including: pointing device is moved out of the hit test boundaries of an element; firing the pointerup event for a device that does not support hover (see pointerup); after firing the pointercancel event (see pointercancel); when a pen stylus leaves the hover range detectable by the digitizer.

Attributes

See also
lazy val onPointerOver: EventProp[PointerEvent]

fired when a pointing device is moved into an element's hit test boundaries.

fired when a pointing device is moved into an element's hit test boundaries.

Attributes

See also
lazy val onPointerUp: EventProp[PointerEvent]

fired when a pointer is no longer active.

lazy val onPopState: EventProp[PopStateEvent]

Script to be run when the window's history changes

lazy val onProgress: EventProp[Event]

Script to be run when the browser is in the process of getting the media data

Script to be run when the browser is in the process of getting the media data

Attributes

See also
lazy val onRateChange: EventProp[Event]

Script to be run each time the playback rate changes (like when a user switches to a slow motion or fast forward mode)

Script to be run each time the playback rate changes (like when a user switches to a slow motion or fast forward mode)

Attributes

See also
lazy val onReset: EventProp[Event]

The reset event is fired when a form is reset.

The reset event is fired when a form is reset.

Attributes

See also
lazy val onResize: EventProp[UIEvent]

The GlobalEventHandlers.onresize property contains an EventHandler triggered when a resize event is received.

The GlobalEventHandlers.onresize property contains an EventHandler triggered when a resize event is received.

Attributes

See also
lazy val onScroll: EventProp[UIEvent]

An event handler for scroll events on element.

lazy val onSearch: EventProp[Event]

Fires when the user writes something in a search field (for <input="search">)

Fires when the user writes something in a search field (for <input="search">)

Attributes

See also
lazy val onSeeked: EventProp[Event]

Script to be run when the seeking attribute is set to false indicating that seeking has ended

Script to be run when the seeking attribute is set to false indicating that seeking has ended

Attributes

See also
lazy val onSeeking: EventProp[Event]

Script to be run when the seeking attribute is set to true indicating that seeking is active

Script to be run when the seeking attribute is set to true indicating that seeking is active

Attributes

See also
lazy val onSelect: EventProp[Event]

The select event only fires when text inside a text input or textarea is selected. The event is fired after the text has been selected.

The select event only fires when text inside a text input or textarea is selected. The event is fired after the text has been selected.

Attributes

See also
lazy val onShow: EventProp[Event]

Fires when a

element is shown as a context menu

Fires when a

element is shown as a context menu

Attributes

See also
lazy val onStalled: EventProp[Event]

Script to be run when the browser is unable to fetch the media data for whatever reason

Script to be run when the browser is unable to fetch the media data for whatever reason

Attributes

See also
lazy val onStorage: EventProp[StorageEvent]

Script to be run when a Web Storage area is updated

lazy val onSubmit: EventProp[Event]

The submit event is fired when the user clicks a submit button in a form ().

The submit event is fired when the user clicks a submit button in a form ().

Attributes

See also
lazy val onSuspend: EventProp[Event]

Script to be run when fetching the media data is stopped before it is completely loaded for whatever reason

Script to be run when fetching the media data is stopped before it is completely loaded for whatever reason

Attributes

See also
lazy val onTimeUpdate: EventProp[Event]

Script to be run when the playing position has changed (like when the user fast forwards to a different point in the media)

Script to be run when the playing position has changed (like when the user fast forwards to a different point in the media)

Attributes

See also
lazy val onToggle: EventProp[Event]

Fires when the user opens or closes the

element

Fires when the user opens or closes the

element

Attributes

See also
lazy val onTransitionEnd: EventProp[Event]

The transitionend event is sent to when a CSS transition completes.

The transitionend event is sent to when a CSS transition completes.

Attributes

See also
Note

If the transition is removed from its target node before the transition completes execution, the transitionend event won't be generated. One way this can happen is by changing the value of the transition-property attribute which applies to the target. Another is if the display attribute is set to none.

lazy val onUnload: EventProp[UIEvent]

Fires once a page has unloaded (or the browser window has been closed)

Fires once a page has unloaded (or the browser window has been closed)

Attributes

See also
lazy val onVisibilityChange: EventProp[Event]

The visibilitychange event is fired when the content of a tab has become visible or has been hidden.

The visibilitychange event is fired when the content of a tab has become visible or has been hidden.

Attributes

See also
lazy val onVolumeChange: EventProp[Event]

Script to be run each time the volume is changed which (includes setting the volume to "mute")

Script to be run each time the volume is changed which (includes setting the volume to "mute")

Attributes

See also
lazy val onWaiting: EventProp[Event]

Script to be run when the media has paused but is expected to resume (like when the media pauses to buffer more data)

Script to be run when the media has paused but is expected to resume (like when the media pauses to buffer more data)

Attributes

See also
lazy val onWheel: EventProp[WheelEvent]

Fires when the mouse wheel rolls up or down over an element