Package com.vaadin.flow.component.trigger.internal
@NullMarked
package com.vaadin.flow.component.trigger.internal
Trigger API and its internal wiring. Not part of the public API; classes here
may be renamed or removed in any release.
-
ClassDescriptionSomething that runs on the client when a
Triggerfires.Action.Input<T>A value anActionconsumes at fire time.Forwards a value from the trigger's handler scope back to the server and hands it to aSerializableConsumeron the UI thread.Calls a JavaScript method on a target element when the bound trigger fires.Fires on the host component'sclickDOM event.Textual clipboard contents delivered toReadFromClipboardAction's handler.Fires when the host component receives a DOM event with the given name.Fires on the host component'sdblclickDOM event.Starts a file download in the browser when the bound trigger fires.Briefly adds a CSS class to a target element when the bound trigger fires, removing it again when the associated CSS animation ends.Input that produces the source<img>element of a component, for use as the image slot ofWriteToClipboardAction.Fires on a DOM keyboard event (keydown,keyup).TheKeyboardEventproperties exposed as staticAction.Inputsources.LiteralInput<T>Input backed by a server-side literal that is captured into the renderedJsFunctionand Jackson-encoded into a JS value on the client.Common super class for triggers that fire on a DOMMouseEvent—ClickTrigger,DoubleClickTrigger, and any future mouse-event trigger.TheMouseEventproperties exposed as staticAction.Inputsources.Opens a URL in a new browser tab or window viawindow.open(url, "_blank", features)when the bound trigger fires.Base class for actions that run a JS expression yielding a Promise and optionally report the outcome back to the server.Information delivered to theonErrorconsumer after the promise rejects.Reads a JavaScript property from a target component's root element at the moment a trigger fires.Reads the user's clipboard vianavigator.clipboard.read()when the bound trigger fires and delivers the textual contents to the handler on the UI thread.Replaces a target component's children with a server-provided list of components when the bound trigger fires, then restores the original children after a configurable timeout.Asks the browser to enter fullscreen when the bound trigger fires.Fires when a specific ordered sequence of keys is pressed on the host's root element — e.g. the konami code or a "hello" Easter egg.Assigns a value to an HTML attribute on a target element when the bound trigger fires.Assigns a value to a JavaScript property on a target element when the bound trigger fires.Assigns a value to a JavaScript property on a target element when the bound trigger fires, then reverts the property to its previous value after a configurable timeout.NamedCallbackActionthat callsseton aValueSignal— the common case of bridging a client-side trigger into server-side signal state.Fires when a specific key + modifier combination is pressed on the host's root element.SignalInput<T>Reads the current value of a server-sideSignalat the moment a trigger fires.Fires when the host component's root element changes size, as reported by the browser'sResizeObserverAPI.Something that fires on the client when some condition is met — a DOM event, a signal change, an observer firing, a timer elapsing, an idle timeout, aBroadcastChannelmessage, a media-query match, … — and, when it does, runs one or moreactions.Writes aClipboardItemto the user's clipboard vianavigator.clipboard.write.