DialogConfirmation

Overlay & Surface
stable

Opinionated dialog with built-in Validate / Cancel footer buttons and a read-to-enable guard — the Validate button is only enabled once the user has scrolled to the bottom of the content (isRead pattern).

Structure

Anatomy

Visual breakdown of the component's internal structure with BEM class call-outs.

Anatomy of OrigamDialogConfirmationSchematic of the DialogConfirmation component showing its inner OrigamDialog with header, content, and a two-button footer. OrigamDialog (inner overlay) header — prepend (status icon) | title | append (close) #content slot + isRead IntersectionObserver sentinel Cancel Validate Validate enabled only when isRead = true (user scrolled to bottom) 1 2 3 4
Anatomy of <origam-dialog-confirmation> — wraps OrigamDialog with 4 zones: ① overlay scrim, ② header (status icon + title), ③ scrollable content + isRead sentinel, ④ two-button footer (Cancel / Validate).
1.origam-overlay (scrim)
Full-viewport overlay inherited from OrigamDialog. Handles click-outside and Escape (unless persistent=true).
2.origam-card (header)
Card header with status icon in prepend slot, title, and close button in append slot. All header-* slots are forwarded transparently.
3.origam-card__content
Scrollable content body. An IntersectionObserver sentinel at the bottom fires the @isRead event when it enters the viewport, enabling the Validate button.
4.origam-card__footer (two-button bar)
Default footer with Cancel (left) and Validate (right) in a space-between row. The Validate button is disabled until isRead=true. Override with the #footer slot.

API

Props

All props accepted by this component, with their type, default value and description.

cancellable
boolean
true
When true (default), a Cancel button is rendered in the footer alongside Validate. Set to false for non-cancellable flows.
cancelTextKey
string
validateTextKey
string
fullscreen
boolean
false
Expands the dialog to cover the full viewport.
retainFocus
boolean
size
'default'
Controls the dialog width (xs: 320px … xl: 1080px) via size tokens.
closeLabel
string
id
string
class
string | Array<string> | object
style
string | Array<string> | object | StyleValue
scrollable
boolean
false
Enables vertical scrolling inside the dialog body while header and footer remain fixed. Required for the isRead pattern to work correctly (the sentinel must be at the bottom of a scrollable area).
absolute
boolean
closeOnBack
boolean
contentClass
string | Array<string>
contentProps
any
disabled
boolean
false
Disables the activator and prevents the dialog from opening.
noClickAnimation
boolean
modelValue
boolean
v-model binding for the dialog open/close state.
zIndex
number | string
disableGlobalStack
boolean
persistent
boolean
false
Prevents closing via Escape or outside-click. Recommended for critical confirmation flows.
height
number | string
maxHeight
number | string
maxWidth
number | string
minHeight
number | string
minWidth
number | string
width
number | string
target
'parent' | 'cursor' | TAnyString | Element | ComponentPublicInstance | [x: number, y: number] | undefined
activator
'parent' | 'cursor' | TAnyString | Element | ComponentPublicInstance
activatorProps
any
openOnClick
boolean
openOnContextMenu
boolean
openOnHover
boolean
openOnFocus
boolean
closeOnContentClick
boolean
closeDelay
number | string
openDelay
number | string
locationStrategy
TLocationStrategy | TLocationStrategyFn
location
TAnchor
origin
TAnchor | 'auto' | 'overlap'
offset
number | string | Array<number>
viewportMargin
number
scrollStrategy
TScrollStrategy | TScrollStrategyFn
contained
boolean
eager
boolean
transition
boolean | string | TTransitionProps
scrim
boolean | string
attach
boolean | string | Element | null
contentDisplay
TCardContentDisplay
flat
boolean
image
string
link
boolean
subtitle
string | number
Subtitle rendered below the title in the dialog header.
text
string | number
Body text forwarded to the inner dialog card text slot.
title
string | number
Dialog title forwarded to the inner OrigamDialog header.
type
TCardType
titleId
string
tag
string
border
boolean | number | string | TDirectionBoth | Array<TDirectionBoth>
borderTop
boolean | number | string
borderLeft
boolean | number | string
borderBottom
boolean | number | string
borderRight
boolean | number | string
borderBlock
boolean | number | string
borderInline
boolean | number | string
borderInlineStart
boolean | number | string
borderInlineEnd
boolean | number | string
borderBlockStart
boolean | number | string
borderBlockEnd
boolean | number | string
borderColor
string
borderStyle
string
borderTopColor
TColor
borderRightColor
TColor
borderBottomColor
TColor
borderLeftColor
TColor
borderInlineStartColor
TColor
borderInlineEndColor
TColor
borderBlockStartColor
TColor
borderBlockEndColor
TColor
color
Intent or custom colour forwarded to the inner OrigamDialog.
bgColor
TColor
density
TDensity
elevation
TElevation
loading
TLoadingValue
loadingText
string
position
TPosition
top
number | string
bottom
number | string
left
number | string
right
number | string
rounded
boolean | number | string | TRounded | null | undefined
roundedTopRight
boolean | number | string
roundedTopLeft
boolean | number | string
roundedBottomLeft
boolean | number | string
roundedBottomRight
boolean | number | string
roundedStartStart
boolean | number | string
roundedStartEnd
boolean | number | string
roundedEndStart
boolean | number | string
roundedEndEnd
boolean | number | string
margin
boolean | number | string
marginTop
boolean | number | string
marginLeft
boolean | number | string
marginBottom
boolean | number | string
marginRight
boolean | number | string
marginBlock
boolean | number | string
marginInline
boolean | number | string
marginInlineStart
boolean | number | string
marginInlineEnd
boolean | number | string
marginBlockStart
boolean | number | string
marginBlockEnd
boolean | number | string
padding
boolean | number | string
paddingTop
boolean | number | string
paddingLeft
boolean | number | string
paddingBottom
boolean | number | string
paddingRight
boolean | number | string
paddingBlock
boolean | number | string
paddingInline
boolean | number | string
paddingInlineStart
boolean | number | string
paddingInlineEnd
boolean | number | string
paddingBlockStart
boolean | number | string
paddingBlockEnd
boolean | number | string
href
string
replace
boolean
to
RouteLocationRaw
exact
boolean
ripple
boolean | { class: string }
appendAvatar
string
appendIcon
TIcon
prependAvatar
string
prependIcon
TIcon
prependAriaLabel
string
appendAriaLabel
string
active
boolean | IStateEffectConfig
activeClass
string
hover
boolean | IStateEffectConfig
hoverClass
string
status
Semantic status (success, warning, danger, info). Resolves the header prepend icon and applies a status CSS class.
statusIconPosition
TStatusPosition
icon
Custom icon in the dialog header prepend slot. Overrides the status icon when both are set.

API

Slots

Content slots exposed by this component.

#default
Replaces the entire dialog body (including the default card layout).
#header-title
Custom title content.
#footer
Overrides the default Cancel / Validate footer layout with custom content.
#header
Replaces the entire card header with custom content.
#text
Body text forwarded to the inner card text slot.
#content
Main dialog content. The isRead IntersectionObserver sentinel is appended after this slot — scroll to the bottom to enable the Validate button.
#loader
Custom loading indicator forwarded to the inner OrigamDialog loader slot.
#activator
Element that triggers the dialog. Bind the provided props to wire aria-haspopup="dialog", aria-expanded and the click handler.
#header-append
Content after the title row (defaults to close icon).
#header-prepend
Content before the title. By default renders the status/icon.
#header-subtitle
Custom subtitle below the title in the header.
#header-content
Extra content area inside the header.
#asset
Visual asset rendered above the body text.

API

Emits

Events emitted by this component.

@validate
MouseEvent
Fired when the user clicks the Validate button (only possible after isRead=true). The dialog closes automatically.
@cancel
MouseEvent
Fired when the user clicks the Cancel button. The dialog closes automatically.
@update:modelValue
any
Fired when the dialog open/close state changes.

API

Exposed members

Properties and methods accessible via template ref (defineExpose). Use them for programmatic control.

<T extends object>(props: T, exclude?: string[]) => Partial<T>
Utility to forward a filtered subset of props to the inner OrigamDialog.

Customisation

CSS variables

CSS custom properties exposed by this component. Override them to customise the component without losing theme compatibility.

Size of the status icon in the header prepend slot.
Icon colour when no status is set.
Icon colour when status="success".
Icon colour when status="warning".
Icon colour when status="danger".
Icon colour when status="info".
Title font size.
Title font weight.
Gap between footer action buttons.

Inclusion

Accessibility

ARIA roles, keyboard navigation and focus management. Sourced from the real component template.

ARIA roles

dialog

Keyboard interactions

Keyboard interactions
KeyAction
EscapeCloses the dialog (unless persistent=true).
TabCycles focus through Cancel, Validate and any other focusable elements inside the dialog (focus trap inherited from OrigamDialog).
Shift+TabCycles focus backwards.

Notes

  • The Validate button is rendered with disabled=true and aria-disabled until the user scrolls to the bottom of the content (isRead=true). This is intentional — it enforces that users read critical content before confirming.
  • role="dialog" and aria-modal="true" are applied by the inner OrigamDialog on the card element. The title is linked via aria-labelledby.
  • On open, focus moves to the overlay content. On close, focus returns to the activator element.

Interactive

Playground

Edit props live and see the component update in real time. The generated code snippet updates as you change values.

Rendering the live preview…

Usage

Examples

Ready-to-paste code snippets for your templates.

Basic confirmation dialog

vue

Read-to-enable (terms of service)

vue

Non-cancellable confirmation

vue

Ecosystem

Family

Components from the same folder that share conventions and often compose together.