App event handlers reference

Reference documentation for app event handlers.

Version: Cloud and 3.188 Edge

Events

Events triggered by user interactions. You can configure event handlers in the IDE to trigger queries or other actions in response to events.

Support for each event depends upon the component or object being configured.

Event	Description
Blur	The input field is deselected.
Button Press	A button is pressed.
Cancel	An action is canceled.
Cancel Changes	A change is canceled.
Capture	A value is captured.
Cell Change	A cell value is changed.
Change	The value is changed.
Change Cell	A cell value is changed.
Change Event	An event is changed.
Change Filter	A filter is changed.
Change Page	The current page is changed.
Change Row Selection	The selected row is changed.
Change Sort	A sorting option is changed.
Checkbox Press	A checkbox is pressed.
Clear	A value is cleared.
Click	An item is clicked or pressed.
Click Action	An action button is clicked or pressed.
Click Cell	A cell is clicked or pressed.
Click Event	An event is clicked or pressed.
Click Row	A row is clicked or pressed.
Click Toolbar	A toolbar button is clicked or pressed.
Click Value	A value is clicked or pressed.
Close	The component or item is closed.
Create Event	An event is created.
Deselect Row	A row is deselected.
Double Click Row	A row is double-clicked or pressed.
Ended	An action ends.
Expand Row	A row is expanded.
Failure	A query or action has failed.
False	The value is set to false.
Filter Change	A filter is changed.
Focus	The input field is selected.
Hover	An item is hovered over.
Input Value Change	The input value is changed.
Invalid	A value is invalid.
Legend Click	A legend item is clicked or pressed.
Legend Double Click	A legend item is double-clicked or pressed.
Load	Data is loaded.
Logo Click	The logo is clicked or pressed.
On Point Hovered Over	A point of interest is hovered over.
On Point Hovered Over End	A point of interest is no longer hovered over.
On Point Selected	A point of interest is selected.
On Stripe Token Created	A Stripe token is created.
On Viewport Change	The viewport is changed.
Open	The component or item is opened.
Page Change	A page is changed.
Parse	Data is parsed.
Pause	An action is paused.
Play	An action is started.
Point Pressed	A point of interest is clicked or pressed or pressed.
Press	An item is pressed.
Refresh	Data is refreshed.
Remove Event	An event is removed.
Reset	A value is reset.
Row Click	A row is clicked or pressed.
Row Select Change	A selected row is changed.
Save	Changes are saved.
Save Changes	Changes are saved.
Save New	New changes are saved.
Scan	A value is scanned.
Select	A value is selected.
Select Cell	A cell is selected.
Select Row	A row is selected.
Sort Change	A sorting option is changed.
Stop	An action is stopped.
Submit	The value is submitted.
Success	A query or action is successfully completed.
Suffix Icon Press	A suffix icon is pressed.
Switch Press	A switch is toggled.
Toggle	A value is toggled.
True	The value is set to true.
Unhover	An item is no longer hovered over.
Upload	Data is uploaded.

Actions

All actions that can be triggered by event handlers. Actions can be set in the Action dropdown when creating or editing an event handler.

Action	Description
Control query	Trigger, reset, or clear the cache for a query.
Control components	Choose a component and call one of its methods. View component events and methods in the component library.
Run script	Run a JavaScript script.
Go to app	Navigate with optional query or hash parameters to a Retool app.
Go to page	Navigate to another page from within an app.
Go to URL	Navigate with optional query or hash parameters to an external URL.
Show notification	Show an informational, success, warning, or error message.
Set variable	Store any data in a variable, similar to a global variable in JavaScript.
Set local storage	Set or clear data in local storage.
Copy to clipboard	Copy a value to the user's clipboard.
Export data	Export data to a CSV, TSV, JSON, or Excel (.xlsx) file.
Confetti	Show confetti animation.