Skip to main content

Modal

The modal is container called by a button. Once you click on the button, a modal will appear on which you can display other components.

The following section details Modal component's specific settings. For more details on the App editor, check the dedicated documentation or the App editor Quickstart:

NameTypeConnectableTemplatableDefaultDescription
modalTitlestringfalsefalseModal titleThe title of the modal.
buttonLabelstringtruefalsePress meThe button label.
buttonColorblue, red, dark, light, green, gray, nonefalsefalseblueThe button color.
buttonSizexs, sm, md , lg, xlfalsefalsexsThe button size.
buttonFillContainerbooleanfalsefalsefalseWhether the button should fill the container.
buttonDisabledbooleanfalsefalsefalseWhether the button should be disabled.

Controls

This component can be controlled by frontend scripts using these functions:

NameParametersDescriptionExample
openid: stringOpen the drawer.open('a')
closeid: stringClose the drawer.close('a')

Event handlers

The modal component has the following event handlers:

  • onOpen: Trigger a runnable when the drawer is opened.
  • onClose: Trigger a runnable when the drawer is closed.

Multiple runnables can be added to each event handler.