https://github.com/avivkeller/fs-gui
A GUI for fs. Under development
https://github.com/avivkeller/fs-gui
fs gui node nodejs package
Last synced: 9 months ago
JSON representation
A GUI for fs. Under development
- Host: GitHub
- URL: https://github.com/avivkeller/fs-gui
- Owner: avivkeller
- Archived: true
- Created: 2021-03-02T18:31:01.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-03-05T18:38:49.000Z (over 5 years ago)
- Last Synced: 2025-01-27T23:46:50.056Z (over 1 year ago)
- Topics: fs, gui, node, nodejs, package
- Language: JavaScript
- Homepage:
- Size: 1.96 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# fs-gui
## Overview
Welcome to the `fs-gui`. This package allows you to add file selection menus to your programs. See below to example usage.
## How to use
1. First you have to install the [package](https://npmjs.com/package/fs-gui) using `npm i fs-gui` or fork the [repo](https://github.com/RedYetiDev/fs-gui)
2. You need to `require` it in your code.
```js
const Explorer = require("fs-gui")
```
3. Use the functions below, you can change `Explorer` for whatever you would like.
---
- #### `Explorer.searchDir(message)`
The `searchDir` function creates a selection menu for selecting a directory.
This function returns the path of the directory selected.
The `message` parameter is the message to show the user, [e.g. `"Select a folder"`]
---
- #### `Explorer.searchAll(message)`
The `searchAll` function creates a selection menu for selecting all files.
This function returns the path to file/directory chosen.
The `message` parameter is the message to show the user, [e.g. `"Select a file or folder"`]
---
- #### `Explorer.searchCustom(message, ext)`
The `searchCustom` function creates a selection menu for selecting all files. This function returns the path to file/directory chosen
The `message` parameter is the message to show the user, [e.g. `"Select a file or folder"`].
The `ext` parameter is an array, containing the file extensions. [e.g. `[".txt",".pdf"]`]
- #### `Explorer.createFile(data)`
The `createFile` functions creates a menu, showing the normal folders, but adds an extra option `Create File`. Once selected `Create File` asks for the name and extension. The `data` parameter is the contents of the file. It must be string.
- #### `Explorer.createCustomFile(data, name)`
Similar to `createFile`, but the name is already specified.
- #### `Explorer.createFolder()`
The `createFolder` functions creates a menu, showing the normal folders, but adds an extra option `Create Folder`. Once selected `Create Folder` asks for the folder name.
- #### `Explorer.deleteFile()`
The delete folder function is like the `searchAll` function, but for deleting files
- #### `Explorer.deletFolder()`
The delete folder function is like the `searchDir` function, but for deleting folders.
## Examples
The examples below are assuming your code has the following line
```js
const Explorer = require("fs-gui")
```
- If you wanted the user to select a `pdf` file
```js
Explorer.searchCustom("Select a PDF", [".pdf"])
```
- If you wanted the user to select a directory in the `node_modules` folder
```js
process.chdir("node_modules")
Explorer.searchDir("Select a directory")
```