## About
`@prozilla-os/text-editor` is a text editor application for ProzillaOS.
## Installation
`@prozilla-os/core` is required to run this application.
```sh
$ npm install @prozilla-os/core @prozilla-os/text-editor
$ yarn add @prozilla-os/core @prozilla-os/text-editor
$ pnpm add @prozilla-os/core @prozilla-os/text-editor
```
## Usage
### Basic setup
```tsx
import { Desktop, ModalsView, ProzillaOS, Taskbar, WindowsView, AppsConfig } from "@prozilla-os/core";
import { textEditor } from "@prozilla-os/text-editor";
function App() {
return (
);
}
```
### Window options
```tsx
/**
* Initial path that the app will open
* @default "~" - Home directory
*/
path: string;
/**
* Virtual file to open the app with
*/
file: VirtualFile;
/**
* Mode in which to run the app
* "view" - Renders markdown files and renders syntax highlighting of other file formats, disables text editing
* "edit" - Raw text editor
*/
mode: "view" | "edit";
```
## Links
- [Demo][demo]
- [Docs][docs]
- [GitHub][github]
- [npm][npm]
- [Discord][discord]
- [Ko-fi][ko-fi]
[demo]: https://os.prozilla.dev/text-editor
[docs]: https://os.prozilla.dev/docs/reference/apps/text-editor
[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/apps/text-editor
[npm]: https://www.npmjs.com/package/@prozilla-os/text-editor
[discord]: https://discord.gg/JwbyQP4tdz
[ko-fi]: https://ko-fi.com/prozilla
