{"id":15805186,"url":"https://github.com/avivkeller/fs-gui","last_synced_at":"2025-10-16T09:30:20.927Z","repository":{"id":57242258,"uuid":"343873663","full_name":"avivkeller/fs-gui","owner":"avivkeller","description":"A GUI for fs. Under development","archived":true,"fork":false,"pushed_at":"2021-03-05T18:38:49.000Z","size":2058,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-27T23:46:50.056Z","etag":null,"topics":["fs","gui","node","nodejs","package"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/avivkeller.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null}},"created_at":"2021-03-02T18:31:01.000Z","updated_at":"2024-09-05T18:07:24.000Z","dependencies_parsed_at":"2022-09-07T22:01:00.772Z","dependency_job_id":null,"html_url":"https://github.com/avivkeller/fs-gui","commit_stats":null,"previous_names":["onlyaviv/fs-gui","avivkeller/fs-gui","redyetidev/fs-gui"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avivkeller%2Ffs-gui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avivkeller%2Ffs-gui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avivkeller%2Ffs-gui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avivkeller%2Ffs-gui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/avivkeller","download_url":"https://codeload.github.com/avivkeller/fs-gui/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":236703148,"owners_count":19191534,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["fs","gui","node","nodejs","package"],"created_at":"2024-10-05T02:04:51.241Z","updated_at":"2025-10-16T09:30:15.604Z","avatar_url":"https://github.com/avivkeller.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# fs-gui\n\n## Overview\n\nWelcome to the `fs-gui`. This package allows you to add file selection menus to your programs. See below to example usage.\n\n## How to use\n1. 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)\n2. You need to `require` it in your code.\n\n```js\nconst Explorer = require(\"fs-gui\")\n```\n\n3. Use the functions below, you can change `Explorer` for whatever you would like.\n\n---\n\n- #### `Explorer.searchDir(message)`\n\n  The `searchDir` function creates a selection menu for selecting a directory.\n\n  This function returns the path of the directory selected.\n\n  The `message` parameter is the message to show the user, [e.g. `\"Select a folder\"`]\n\n---\n\n- #### `Explorer.searchAll(message)`\n\n  The `searchAll` function creates a selection menu for selecting all files.\n\n  This function returns the path to file/directory chosen.\n\n  The `message` parameter is the message to show the user, [e.g. `\"Select a file or folder\"`]\n\n---\n\n- #### `Explorer.searchCustom(message, ext)`\n\n  The `searchCustom` function creates a selection menu for selecting all files. This function returns the path to file/directory chosen\n\n  The `message` parameter is the message to show the user, [e.g. `\"Select a file or folder\"`].\n\n  The `ext` parameter is an array, containing the file extensions. [e.g. `[\".txt\",\".pdf\"]`]\n\n- #### `Explorer.createFile(data)`\n  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.\n  \n- #### `Explorer.createCustomFile(data, name)`\n  Similar to `createFile`, but the name is already specified.\n\n- #### `Explorer.createFolder()`\n    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.\n\n- #### `Explorer.deleteFile()`\n  The delete folder function is like the `searchAll` function, but for deleting files\n\n- #### `Explorer.deletFolder()`\n  The delete folder function is like the `searchDir` function, but for deleting folders.\n\n## Examples\nThe examples below are assuming your code has the following line\n```js\nconst Explorer = require(\"fs-gui\")\n```\n\n- If you wanted the user to select a `pdf` file\n```js\nExplorer.searchCustom(\"Select a PDF\", [\".pdf\"])\n```\n\n- If you wanted the user to select a directory in the `node_modules` folder\n```js\nprocess.chdir(\"node_modules\")\nExplorer.searchDir(\"Select a directory\")\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Favivkeller%2Ffs-gui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Favivkeller%2Ffs-gui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Favivkeller%2Ffs-gui/lists"}