dialog
System dialog functionality, including opening, saving files, prompts, alerts, etc.
Last updated
System dialog functionality, including opening, saving files, prompts, alerts, etc.
Last updated
Below is an example of a dialog box for selecting multiple files:
Displays the open file dialog.
options
Object
title
string (optional) - The title of the dialog window
defaultPath
string (optional) - The default display path of the dialog
buttonLabel
string (optional) - Custom label for the "Confirm" button; if empty, the default label is used.
filters
[] (optional)
name
string
extensions
string[]
properties
string[] (optional) - Contains dialog-related attributes. The following attribute values are supported:
openFile
- Allows selecting files
openDirectory
- Allows selecting folders
multiSelections
- Allows multiple selections.
showHiddenFiles
- Displays hidden files in the dialog.
createDirectory
macOS
- Allows you to create a new directory through the dialog.
promptToCreate
Windows
- If the entered file path does not exist in the dialog, prompt to create it. This does not actually create a file on the path but allows returning some non-existent addresses for the application to create.
message
string (optional) macOS
- The message displayed above the input box.
Returns Promise<result: Object>
result
Object
canceled
boolean - Whether the dialog was canceled
filePaths
string[] - Array of chosen file paths by the user. If the dialog is canceled, this will be an empty array.
Displays the save file dialog.
options
Object
title
string (optional) - The title of the dialog window
defaultPath
string (optional) - The default display path of the dialog
buttonLabel
string (optional) - Custom label for the "Confirm" button; if empty, the default label is used.
name
string
extensions
string[]
properties
string[] (optional) - Contains dialog-related attributes. The following attribute values are supported:
openDirectory
- Allows selecting folders
showHiddenFiles
- Displays hidden files in the dialog.
createDirectory
macOS
- Allows you to create a new directory through the dialog.
Returns Promise<result: Object>
result
Object
canceled
boolean - Whether the dialog was canceled
filePath
string - If the dialog is canceled, this value will be undefined
.
Display a message dialog.
options
Object
message
string - The main content of the dialog
title
string (optional) - Dialog title
detail
string (optional) - Additional information
buttons
strings[] (optional) - Array of button texts
type
string (optional) - Can be none
, info
, error
, question
, or warning
Returns Promise<result: Object>
result
Object
response
Integer - The index of the clicked button
Display an error message dialog.
title
string - The title displayed in the error box
content
string - The text content displayed in the error box
Returns Promise<void>
Note: This feature is similar to Electron API's feature.
filters
[] (optional)
Note: This function is similar to the Electron API's function.
This function is similar to the Electron API's function.
Note: This function is similar to the Electron API's function.