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

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