{%- extends "theming/base_component.html" -%} {%- set parametrized = parametrized or ["modal", "modal_handle", "modal_close_handle", "confirm_modal"] -%} {%- block overview -%}
The modal component creates modal dialog containers that
overlay the main content to focus user attention on specific tasks or
information. Modals are used for forms, detailed views, settings, and
any content that requires focused user attention without navigating
away from the current page.
Modal components handle overlay backgrounds, positioning, and
interaction patterns to ensure they capture user attention
appropriately while remaining accessible. They typically include close
mechanisms and may prevent interaction with the background content
until dismissed. The component works with modal_handle and
modal_close_handle components to provide complete modal
interaction experiences.
There is a special version of modal dialog called
confirm_modal. The confirm_modal component
creates confirmation dialog modals that require user acknowledgment
before proceeding with potentially important or destructive
actions. These modals are essential for preventing accidental data loss
or unintended operations by requiring explicit user confirmation.
Confirmation modals typically include clear messaging about the action to be confirmed, prominent action buttons (usually "Confirm" and "Cancel"), and sometimes additional context about the consequences of the action.
The confirm modal works by submitting a form when the user confirms the
action. In simple cases, it submits an empty form via POST, but you can
specify the ID of an existing form when building the
confirm_modal - in this case, that specific form will be
submitted upon confirmation. This allows for integration with existing
form workflows.