| .. | ||
| src | ||
| CHANGELOG.md | ||
| package.json | ||
| README.md | ||
| tsconfig.build.json | ||
| tsconfig.json | ||
| vite.config.ts | ||
About
@prozilla-os/text-editor is a text editor application for ProzillaOS.
Installation
@prozilla-os/core is required to run this application.
$ 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
import { Desktop, ModalsView, ProzillaOS, Taskbar, WindowsView, AppsConfig } from "@prozilla-os/core";
import { textEditor } from "@prozilla-os/text-editor";
function App() {
return (
<ProzillaOS
systemName="Example"
tagLine="Powered by ProzillaOS"
config={{
apps: new AppsConfig({
apps: [ textEditor ]
})
}}
>
<Taskbar/>
<WindowsView/>
<ModalsView/>
<Desktop/>
</ProzillaOS>
);
}
Window options
/**
* 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";