Skip to content

ElectronSaveDialogSyncOptions

Unofficial

Options for Electron synchronous save file dialog.

Import:

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

Signature:

export interface ElectronSaveDialogSyncOptions

Properties

PropertyTypeDescription
buttonLabel?stringThe label for the confirmation button.
defaultPath?stringThe default path to open the dialog at.
filters?ElectronFileFilter[]The file filters to display.
message?stringThe message to display above the dialog on macOS.
nameFieldLabel?stringThe label for the file name text field on macOS.
properties?Array<'createDirectory' | 'dontAddToRecent' | 'showHiddenFiles' | 'showOverwriteConfirmation' | 'treatPackageAsDirectory'>The dialog behavior properties.
securityScopedBookmarks?booleanWhether to create a security scoped bookmark when packaged for the Mac App Store (macOS, mas only).
showsTagField?booleanWhether to show the tags field on macOS.
title?stringThe dialog title.