The Video component for Retool Apps

A content area to display a video.

Video supports popular video services (e.g., YouTube and Vimeo) and direct links to video file types commonly supported by browsers.

For more information about this component, refer to the Embedded media guide.

To embed YouTube Shorts using the Video component, use the following URL format: https://www.youtube.com/embed/{identifier_string}, where identifier_string is the identifier at the end of the YouTube Shorts URL.

Demo

Properties

All properties for this object with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.

currentTimestamp

The playback position of the media.

Type	number
Configurability	Read-only
Default	null

---

duration

The duration of the media, in seconds.

Type	number
Configurability	Read-only
Default	null

---

events

A list of configured event handlers that trigger actions or queries.

Type	array
Array values	object
Configurability	Inspector > Interaction > Event handlers
Default	null

Array Object Properties

event

The event that triggers the action. Refer to the events section for details of available events for this object.

Type	string
Configurability	Inspector > Interaction > Event handlers > Event
Default	null

---

method

The JavaScript method to perform when type is datasource, widget, state, or localStorage.

Type	string
Configurability	Inspector > Interaction > Event handlers > Edit event handler > Run script actions
Default	null

---

type

The type of action to perform.

Type	string
Configurability	Inspector > Interaction > Event handlers > Edit event handler > Action
Allowed Values	Value Description datasource Control query. widget Control component. script Run script. state Set variable. localStorage Set localStorage. util Perform utility action (e.g., Open URL or Confetti).
Default	null

---

---

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Hidden
Default	false

Examples

true

---

hideControls

Whether to hide the controls.

Type	boolean
Configurability	Inspector
Default	null

---

id

The unique identifier (name).

Type	string
Format	Plain Text
Configurability	Inspector
Default	video1

Examples

query1

button1

---

isHiddenOnDesktop

Whether to show or hide this object in the desktop layout.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Show on desktop
Default	false

Examples

true

---

isHiddenOnMobile

Whether to show or hide this object in the mobile layout.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Show on mobile
Default	true

Examples

true

---

loop

Whether to loop the media.

Type	boolean
Format	True/False
Configurability	Inspector
Default	false

Examples

true

---

maintainSpaceWhenHidden

Whether to take up space on the canvas if hidden is true.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Maintain space when hidden
Default	false

Examples

true

---

margin

The amount of margin to render outside.

Type	string
Format	Plain Text
Configurability	Inspector > Spacing > Margin
Allowed Values	Value UI Option Description 4px 8px Normal Normal margin. 0 None No margin.
Default	4px 8px

Examples

4px 8px

---

playbackRate

The playback speed, expressed in increments of 1. Default is 1 for 1x speed. Negative values are not supported. Some video sources and browsers may clamp the speed range.

Type	number
Configurability	Read-only
Default	null

---

playing

Whether the media is playing.

Type	boolean
Configurability	Read-only
Default	null

---

showInEditor

Whether the component remains visible in the editor if hidden is true.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Always show in edit mode
Default	false

Examples

true

---

src

The data source.

Type	string
Format	string
Configurability	Inspector
Default	null

Examples

https://upload.wikimedia.org/wikipedia/commons/1/14/Marspathfinder.pdf

---

style

Custom style options.

Type	object
Configurability	Inspector > Appearance > style
Default	null

---

volume

The volume of the media, from 0 to 1.

Type	number
Configurability	Read-only
Default	null

---

Methods

JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

video.pause()

Pause operation.

Definition

video.pause()

Examples

Pause video.

video.pause();

---

video.play()

Start operation.

Definition

video.play()

Examples

Start video.

video.play();

---

video.seekTo()

Seek to a specific time in the content.

Definition

video.seekTo(time)

Parameters

time

A time, in milliseconds.

Type

number

---

---

Events

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

Event	Description
Ended	An action ends.
Load	Data is loaded.
Pause	An action is paused.
Play	An action is started.