IDialogProps

interface
Overlay

Props for OrigamDialog — the full-featured modal dialog. Extends overlay, card and status interfaces and adds fullscreen, focus retention, scroll-lock and size controls.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

Inheritance

Extends

Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.

API

Properties

Every property declared by this interface, with its type, optionality and default.

fullscreen
boolean
Expand the dialog to cover the entire viewport.
retainFocus
boolean
When true, focus is trapped inside the dialog and cannot escape to the document while it is open.
size
TSize
Predefined width preset for the dialog surface (xs | sm | md | lg | xl).
scrollable
boolean
Allow the dialog body to scroll independently of the viewport when the content overflows.
closeLabel
string

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Scrollable medium-sized dialog

html