## About
`@prozilla-os/file-explorer` is a standard ProzillaOS application for browsing files.
## Installation
`@prozilla-os/core` is required to run this application.
```sh
$ npm install @prozilla-os/core @prozilla-os/file-explorer
$ yarn add @prozilla-os/core @prozilla-os/file-explorer
$ pnpm add @prozilla-os/core @prozilla-os/file-explorer
```
## Usage
### Basic setup
```tsx
import { Desktop, ModalsView, ProzillaOS, Taskbar, WindowsView, AppsConfig } from "@prozilla-os/core";
import { fileExplorer } from "@prozilla-os/file-explorer";
function App() {
return (
);
}
```
### Window options
```tsx
/**
* Initial path that the app will open
* @default "~" - Home directory
*/
path: string;
/**
* Defines in which mode the application is running
* 0: None
* 1: Single
* 2: Multiple
* @default 0
*/
selectorMode: number;
/**
* Footer component that will be displayed when `selectorMode` != 0
* Can be used to display a list of selected files for example
*/
Footer: React.FC;
/**
* Gets called each time the selection changes if `selectorMode` != 0
*/
onSelectionChange: (params: OnSelectionChangeParams) => void;
/**
* Gets called when the selection is finished if `selectorMode` != 0
*/
onSelectionFinish: Function;
```
## Links
- [Demo][demo]
- [Docs][docs]
- [GitHub][github]
- [npm][npm]
- [Discord][discord]
- [Ko-fi][ko-fi]
[demo]: https://os.prozilla.dev/file-explorer
[docs]: https://os.prozilla.dev/docs/reference/apps/file-explorer
[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/apps/file-explorer
[npm]: https://www.npmjs.com/package/@prozilla-os/file-explorer
[discord]: https://discord.gg/JwbyQP4tdz
[ko-fi]: https://ko-fi.com/prozilla
