easy-file-dialogs

Open file/directory dialogs in Node.js

1const directory = await openDirectory({
2  title: "Select Resource Pack",
3  initialDir: "C:/Users/ewanh/AppData/Roaming/.minecraft/resourcepacks"
4})

Install

1npm i easy-file-dialogs

Import

1import {
2  openDirectory,
3  openFile,
4  openFileName,
5  saveFile,
6  saveFileName,
7  confirm
8} from "easy-file-dialogs"
9
10// or
11
12import dialogs from "easy-file-dialogs"

Functions

openDirectory(args)

Open a directory selection dialog. Returns the selected directory path.

1const directory = await openDirectory({
2  title: // The title at the top of the dialog
3  icon: // An ico file that is shown at the top of the dialog
4  initialDir: // The directory the dialog shows when opened
5})

openFile(args)

Open a file selection dialog. Returns the file path and opened file in an array.

1const file = await openFile({
2  // All arguments seen in openDirectory
3  initialFile: // A file name to be selected when opened
4  fileTypes: [ // An array of file types that are allowed to be selected
5    [
6      "PNG", // The name for the file type
7      "*.png" // The file type pattern
8    ],
9    [
10      "JPEG", // The name for the file type
11      "*.jpg *.jpeg" // Supports multiple
12    ]
13  ],
14  multiple: // Boolean to allow multiple files to be picked. Will return an array of arrays instead
15  encoding: // The encoding to open the file with
16})

openFileName(args)

Open a file selection dialog. Returns the selected file path.

1const filePath = await openFileName({
2  // All arguments same as openFile just without encoding
3})

saveFile(file, args)

Open a file save dialog. Saves the provided file to the selected file path and returns the selected file path.

1const filePath = await saveFile(fileData, {
2  // All arguments same as openFile
3  confirmOverwrite: // Boolean to disable the confirm overwrite message that appears
4})

saveFileName(file, args)

Open a file save dialog. Returns the selected file path.

1const filePath = await saveFileName({
2  // All arguments same as saveFile just without encoding
3})

---

Canceling

When a user cancels a file/directory dialog, a No file/directory selected error will be thrown.

---

confirm(args)

Show a confirmation messagebox. The user can either select Yes or No. Returns a boolean.

1await confirm({
2  title: // The title at the top of the dialog
3  icon: // An ico file that is shown at the top of the dialog
4  message: // The message to show in the dialog,
5  warning: // Boolean to enable warning mode. Changes the icon shown to a warning icon.
6})

---

Optional arguments

Literally all arguments are optional for every function. Only add the things you want to use.