Skip to content

ElectronMessageBoxSyncOptions

Unofficial

Options for Electron synchronous message box dialog.

Import:

import type { ElectronMessageBoxSyncOptions } from '@obsidian-typings/obsidian-catalyst-latest';

Signature:

export interface ElectronMessageBoxSyncOptions

Properties

Property Type Description
buttons? string[] The array of button labels. On Windows, an empty array will result in one button labeled OK.
cancelId? number The index of the button to be used to cancel the dialog.
defaultId? number The index of the button that is selected by default.
detail? string Extra information about the message.
icon? ElectronNativeImage | string The icon to display in the message box.
message string The content of the message box.
noLink? boolean Whether to set the no link flag for the message box on Windows.
normalizeAccessKeys? boolean Whether to normalize keyboard access keys across platforms.
textWidth? number Custom width of the text in the message box (macOS only).
title? string The title of the message box.
type? 'error' | 'info' | 'none' | 'question' | 'warning' The type of the message box.