Skip to content

ElectronDialog

Unofficial

Electron Dialog for showing native system dialogs.

Import:

import type { ElectronDialog } from '@obsidian-typings/obsidian-public-latest';

Signature:

export interface ElectronDialog

Methods

MethodReturnsDescription
showCertificateTrustDialog(browserWindow, options)Promise<void>Shows a certificate trust dialog (macOS, Windows only).
showCertificateTrustDialog(options)Promise<void>Shows a certificate trust dialog (macOS, Windows only).
showErrorBox(title, content)voidShows an error message box.
showMessageBox(browserWindow, options)Promise<ElectronMessageBoxReturnValue>Shows a message box dialog.
showMessageBox(options)Promise<ElectronMessageBoxReturnValue>Shows a message box dialog.
showMessageBoxSync(browserWindow, options)numberShows a message box dialog, blocking the process until it is closed.
showMessageBoxSync(options)numberShows a message box dialog, blocking the process until it is closed.
showOpenDialog(browserWindow, options)Promise<ElectronOpenDialogReturnValue>Shows an open file dialog.
showOpenDialog(options)Promise<ElectronOpenDialogReturnValue>Shows an open file dialog.
showOpenDialogSync(browserWindow, options)string[] | undefinedShows an open file dialog, blocking the process until it is closed.
showOpenDialogSync(options)string[] | undefinedShows an open file dialog, blocking the process until it is closed.
showSaveDialog(browserWindow, options)Promise<ElectronSaveDialogReturnValue>Shows a save file dialog.
showSaveDialog(options)Promise<ElectronSaveDialogReturnValue>Shows a save file dialog.
showSaveDialogSync(browserWindow, options)string | undefinedShows a save file dialog, blocking the process until it is closed.
showSaveDialogSync(options)string | undefinedShows a save file dialog, blocking the process until it is closed.

Links to this page: