The Modal frame

A container that appears above other content.

The Modal frame is a container that appears as an overlay in the center of the app when visible. You can add multiple instances of the Modal frame that operate independently.

Try it out

Try out a demo of the Modal frame.

Demo

Settings

Modal includes the following configurable options when building apps in the IDE.

Expand contents to fitHiddenHide on escapeShow on desktopShow on mobileLoadingMaintain space when hiddenMarginClose when clicking outsideShow borderFooterShow borderHeaderShow borderAlways show in edit modeShow overlaySizeStyles

Properties

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

enableFullBleed

boolean

Whether the container is in full bleed mode, where it can only contain a single component which expands to fit the available space.

---

footerPadding

string

The amount of padding used within the footer.

---

global

boolean

Whether the object is globally scoped for use in all app pages.

---

headerPadding

string

The amount of padding used within the header.

---

hidden

boolean

Whether the component is visible.

---

hideOnEscape

boolean

Whether to hide the dropdown when the Esc key is pressed.

---

id

string

The unique identifier.

---

isHiddenOnDesktop

boolean

Whether the component is visible in the desktop layout.

---

isHiddenOnMobile

boolean

Whether the component is visible in the mobile layout.

---

loading

boolean

Whether to display a loading indicator.

---

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.

---

overlayInteraction

boolean

Whether to toggle hidden to true if the user clicks outside of the content area.

---

padding

number

The amount of padding to render inside.

---

pluginType

string

The plugin type.

---

showBorder

boolean

Whether to show a border.

---

showFooter

boolean

Whether to show a footer area.

---

showFooterBorder

boolean

Whether to show a border above the footer.

---

showHeader

boolean

Whether to show a header area.

---

showHeaderBorder

boolean

Whether to show a border under the header.

---

showInEditor

boolean

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

---

showOverlay

boolean

Whether to display a darkened overlay when visible.

---

size

enum

The size of the frame.

Values

small	Small.
medium	Medium.
large	Large.
fullscreen	Full screen.

---

style

object

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

---

Methods

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

hide

Hide the component.

modal.hide()

---

setHidden

Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.

modal.setHidden(hidden)

Parameters

hidden

boolean

Whether the component is visible.

---

---

show

Show the component.

modal.show()

---

showFooter

Set the showFooter value to toggle whether the component footer is visible.

modal.showFooter(showFooter)

Parameters

showFooter

boolean

Whether to show a footer area.

---

---

showHeader

Set the showHeader value to toggle whether the component header is visible.

modal.showHeader(showHeader)

Parameters

showHeader

boolean

Whether to show a header area.

---

---

toggleHidden

Toggle the hidden value between true and false.

modal.toggleHidden()

---