blessed-components - v1.20.0
    Preparing search index...

    Interface ConfirmDialogData

    Stateful data accepted by confirmDialog.

    interface ConfirmDialogData {
        backgroundTone?: keyof ThemeColors;
        cancelLabel?: string;
        confirmLabel?: string;
        closeOnAction?: boolean;
        description?: string;
        id: string;
        initialFocusId?: "cancel" | "confirm";
        message?: string;
        modal?: boolean;
        theme?: Theme;
        title: string;
        onCancel?: () => void;
        onConfirm?: () => void;
        onResult?: (result: ConfirmDialogResult) => void;
        defaultOpen?: boolean;
        onOpenChange?: (open: boolean) => void;
        open?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    backgroundTone? cancelLabel? confirmLabel? closeOnAction? description? id initialFocusId? message? modal? theme? title onCancel? onConfirm? onResult? defaultOpen? onOpenChange? open?

    Properties

    backgroundTone?: keyof ThemeColors

    Semantic background token.

    cancelLabel?: string

    Cancel action label.

    'Cancel'

    confirmLabel?: string

    Confirm action label.

    'Confirm'

    closeOnAction?: boolean

    Whether choosing an action requests closing.

    true

    description?: string

    Supporting text shown below the title.

    id: string

    Stable overlay identifier.

    initialFocusId?: "cancel" | "confirm"

    Preferred registered focus identifier.

    'cancel'

    message?: string

    Main decision message.

    modal?: boolean

    Whether this ConfirmDialog blocks lower overlay layers.

    true

    theme?: Theme

    Semantic terminal theme.

    title: string

    Dialog title.

    onCancel?: () => void

    Called when the cancel action is chosen.

    onConfirm?: () => void

    Called when the confirm action is chosen.

    onResult?: (result: ConfirmDialogResult) => void

    Called after either action is chosen.

    defaultOpen?: boolean

    Initial state for uncontrolled usage.

    false

    onOpenChange?: (open: boolean) => void

    Called when Dialog requests an open-state change.

    open?: boolean

    Controlled open state.

    Settings

    Member Visibility

    On This Page

    Properties