Custom Component

A custom-built React, or HTML and JavaScript, component.

Custom Component supports passing data to and from the Retool app. It can be granted permission for popups, link redirection, and camera access.

You should only build a custom component if you need functionality that isn't already available in an existing component. You can also use an IFrame component to embed web pages or the HTML component to include custom HTML and CSS.

Demo

Settings

Custom Component includes the following configurable options when building apps in the IDE.

Allow cameraAllow downloadsAllow form submissionsAllow fullscreenAllow geolocationAllow microphoneAllow modalsAllow popupsAllow popups to escape sandboxAllow same originAllow top navigationEvent handlersHeightHiddenIFrame CodeShow on desktopShow on mobileMaintain space when hiddenMarginModelAlways show in edit modeStyles

Properties

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

allowCamera

boolean

Whether to allow access to a connected camera.

allowDownloads

boolean

Whether to allow downloads.

allowForms

boolean

Whether to allow form submissions.

allowFullscreen

boolean

Whether to allow fullscreen mode.

allowGeolocation

boolean

Whether to allow access to the user's location.

allowMicrophone

boolean

Whether to allow access to the microphone.

allowModals

boolean

Whether to allow modals.

allowPayment

allowPopups

boolean

Whether to allow popups.

allowPopupsToEscapeSandbox

boolean

Whether to allow popups to escape the sandbox.

allowSameOrigin

boolean

Whether to allow content to be treated as being from the same origin.

allowTopNavigation

boolean

Whether to allow navigation away from the app.

events

object[]

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

Properties

event

enum

The event type.

Values

change	A user changes the value.
click	A user clicks or taps the component.
submit	A user submits the value.
focus	A user selects the input field.
blur	A user deselects the input field.
scan	A user scans a barcode.
open	A user opens the component.
close	A user closes the component.
true	A user sets the value to true.
false	A user sets the value to false.
select	A user selects a value.
clear	A user clears the value.
upload	A user uploads a file.
parse	An uploaded file is parsed.
inputValueChange	A user changes the value of the input field.

method

enum

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

type

enum

The type of action to perform.

Values

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).

heightType

enum

Whether the height automatically resizes to fit content or is a fixed size.

Values

fixed	Fixed height.
auto	Expand to fit content.

hidden

boolean

Whether the component is visible.

id

string

The unique identifier.

iframeCode

string

The HTML code to render.

isHiddenOnDesktop

boolean

Whether the component is visible in the desktop layout.

isHiddenOnMobile

boolean

Whether the component is visible in the mobile layout.

maintainSpaceWhenHidden

boolean

Whether the component takes up space on the canvas if hidden is true.

margin

enum

The amount of margin to render outside.

Values

4px 8px	Normal margin.
0	No margin.

model

any

Dynamic data to pass into the component.

pluginType

string

The plugin type.

showInEditor

boolean

Whether to remain visible in the editor if hidden is true.

style

object

Custom style options in use. Not all style options may be available for all components.

Methods

JavaScript API methods for interacting with Custom Component. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

reload

Reload the component.

customComponent.reload()

scrollIntoView

Scrolls the canvas or parent container so that the selected component appears in the visible area.

customComponent.scrollIntoView(scrollIntoViewOptions)

Parameters

scrollIntoViewOptions

object

The scroll options.

Properties

behavior

enum

The scroll behavior.

Values

auto	Scroll immediately to the specified position.
smooth	Scroll gradually to the specified position.

block

enum

The scroll position relative to the component.

Values

nearest	Scrolls only the minimum amount required for the component to appear in the visible area. Scrolling does not occur if the component is already in view.
start	Scrolls to position the component at the top of the visible area.
center	Scrolls to position the component in the middle of the visible area.
end	Scrolls to position the component at the bottom of the visible area.

updateModel

Update the model with the specified value.

customComponent.updateModel(model)

Parameters

model

any

Dynamic data to pass into the component.

Events

Events are triggered by user interactions, such as clicking a button or entering a value. Use event handlers to trigger queries or other actions in response to events.