# @prozilla-os/text-editor

> A text editor application for ProzillaOS.

Latest version **1.1.26** (published 2026-11-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install @prozilla-os/text-editor
pnpm add @prozilla-os/text-editor
yarn add @prozilla-os/text-editor
bun add @prozilla-os/text-editor
```

## Health

**Score 65/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 1.1.26 |
| Published | 2026-11-19 |
| First published | 2024-06-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 8 |
| Unpacked size | 4.5 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 358 |
| Author | Prozilla |
| Maintainers | prozilla |

## Links

- npm: https://www.npmjs.com/package/@prozilla-os/text-editor
- Repository: https://github.com/prozilla-os/ProzillaOS
- Homepage: https://os.prozilla.dev/text-editor
- Issues: https://github.com/prozilla-os/ProzillaOS/issues
- Funding: https://ko-fi.com/prozilla
- npm.io page: https://npm.io/package/@prozilla-os/text-editor

## Dependencies (8)

- [react](https://npm.io/package/react.md) ^18.3.1
- [markdown-to-jsx](https://npm.io/package/markdown-to-jsx.md) ^7.7.17
- [@prozilla-os/core](https://npm.io/package/@prozilla-os/core.md) 3.0.0
- [@prozilla-os/skins](https://npm.io/package/@prozilla-os/skins.md) 1.2.0
- [@prozilla-os/shared](https://npm.io/package/@prozilla-os/shared.md) 1.5.0
- [react-syntax-highlighter](https://npm.io/package/react-syntax-highlighter.md) ^15.6.6
- [@fortawesome/react-fontawesome](https://npm.io/package/@fortawesome/react-fontawesome.md) ^3.3.1
- [@fortawesome/free-solid-svg-icons](https://npm.io/package/@fortawesome/free-solid-svg-icons.md) ^7.2.0

## Recent versions

- 1.1.26 (latest) — 2026-11-19
- 1.1.25 — 2026-05-25
- 1.1.22 — 2026-04-17
- 1.1.21 — 2026-04-13
- 1.1.19 — 2026-01-25
- 1.1.18 — 2026-01-25
- 1.1.17 — 2025-09-22
- 1.1.16 — 2024-10-30
- 1.1.15 — 2024-10-30
- 1.1.14 — 2024-10-30
- 1.1.13 — 2024-10-29
- 1.1.12 — 2024-10-27
- 1.1.11 — 2024-10-27
- 1.1.10 — 2024-10-27
- 1.1.9 — 2024-10-27
- … 18 more at https://npm.io/package/@prozilla-os/text-editor/versions

## README

<div align="center">
  <br />
  <p>
    <a href="https://os.prozilla.dev/"><img src="https://os.prozilla.dev/assets/logo.svg?v=2" height="200" alt="ProzillaOS" /></a>
  </p>
  <p>
    <a href="https://github.com/prozilla-os/ProzillaOS/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/github/license/prozilla-os/ProzillaOS?style=flat-square&color=FF4D5B&label=License"></a>
    <a href="https://github.com/prozilla-os/ProzillaOS"><img alt="Stars" src="https://img.shields.io/github/stars/prozilla-os/ProzillaOS?style=flat-square&color=FED24C&label=%E2%AD%90"></a>
    <a href="https://github.com/prozilla-os/ProzillaOS"><img alt="Forks" src="https://img.shields.io/github/forks/prozilla-os/ProzillaOS?style=flat-square&color=4D9CFF&label=Forks&logo=github"></a>
    <a href="https://www.npmjs.com/package/prozilla-os"><img alt="NPM Version" src="https://img.shields.io/npm/v/prozilla-os?logo=npm&style=flat-square&label=prozilla-os&color=FF4D5B"></a>
  </p>
</div>

## 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 (
    <ProzillaOS
      systemName="Example"
      tagLine="Powered by ProzillaOS"
      config={{
        apps: new AppsConfig({
          apps: [ textEditor ]
        })
      }}
    >
      <Taskbar/>
      <WindowsView/>
      <ModalsView/>
      <Desktop/>
    </ProzillaOS>
  );
}
```

### 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

---
_Source: https://npm.io/package/@prozilla-os/text-editor · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
