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.
Settings
Custom Component includes the following configurable options when building apps in the IDE.
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
Whether to allow access to a connected camera.
allowDownloads
Whether to allow downloads.
allowForms
Whether to allow form submissions.
allowFullscreen
Whether to allow fullscreen mode.
allowGeolocation
Whether to allow access to the user's location.
allowMicrophone
Whether to allow access to the microphone.
allowModals
Whether to allow modals.
allowPayment
allowPopups
Whether to allow popups.
allowPopupsToEscapeSandbox
Whether to allow popups to escape the sandbox.
allowSameOrigin
Whether to allow content to be treated as being from the same origin.
Properties
event
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 |
false | A user sets the value to |
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
The JavaScript method to perform when type is datasource, widget, state, or localStorage.
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). |
global
Whether the object is globally scoped for use in all app pages.
heightType
Whether the height automatically resizes to fit content or is a fixed size.
Values
fixed | Fixed height. |
auto | Expand to fit content. |
id
The unique identifier.
iframeCode
The HTML code to render.
isHiddenOnDesktop
Whether the component is visible in the desktop layout.
isHiddenOnMobile
Whether the component is visible in the mobile layout.
maintainSpaceWhenHidden
Whether the component takes up space on the canvas if hidden is true.
pluginType
The plugin type.
showInEditor
Whether to remain visible in the editor if hidden is true.
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
The scroll options.
Properties
behavior
The scroll behavior.
Values
auto | Scroll immediately to the specified position. |
smooth | Scroll gradually to the specified position. |
block
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.
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.