Skip to content

MinimizableModalConstructorOptions

Options for constructing a MinimizableModal.

Import:

import type { MinimizableModalConstructorOptions } from 'obsidian-dev-utils/obsidian/modals/minimizable-modal';

Signature:

export interface MinimizableModalConstructorOptions

Properties

PropertyTypeDescription
shouldMinimizeOnClickOutside?booleanWhether clicking the dimmed background behind the modal minimizes it instead of closing it. Obsidian's native behavior is to close, which cancels whatever operation the modal is running; minimizing keeps that operation alive so the user can peek at the involved notes and come back.
shouldShowCancelButton?booleanWhether the minimized bar shows a Cancel button that closes the wrapped modal. Closing lets the wrapped modal's own onClose define what "cancel" means (e.g. releasing a held lock).