Modal

In the Modals tab at the top of the form, you’ll be able to create pop-up modals by integrating components into them, as you would with a form. You may use these to provide the user additional information or steps required to continue working on the form.

More than one modal can be opened at a time.

Parameters

• Title - The title of your modal.
• Description - The description of your modal.
• Closable - Enabled by default. When enabled, users can close the modal using the close icon, an outside click, or the Escape key.

Related functions

• showModal(path: List[Union[str, int]]) - opens a modal.
• closeModal(path: List[Union[str, int]]) - closes a modal. If the Closable setting is disabled and you want the modal to close for any reason, you can use this function to do it.
• sa.isValid(path: str | list[str]) - true if all referenced components have valid values, false if any component is invalid or fails validation.

Related events

• on_<component_id>_opened(path: List[Union[str, int]]) - fired after the modal is opened.
• on_<component_id>_closed(path: List[Union[str, int]]) - fired after the modal is closed.

📘

Component requirements

Leaving required fields empty in a modal won’t stop users from progressing the item’s status to the next. It’ll only mean that those fields are required for whatever action flow was configured for that modal.