# prozilla-os

> a React component library written in TypeScript for building web-based operating systems, made by Prozilla.

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

## Install

```sh
npm install prozilla-os
pnpm add prozilla-os
yarn add prozilla-os
bun add prozilla-os
```

## Health

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

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

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 3.0.0 |
| Published | 2026-11-19 |
| First published | 2024-06-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 12 |
| Unpacked size | 10.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 360 |
| Author | Prozilla |
| Maintainers | prozilla |
| Keywords | react, typescript, web-os, components, internet-os, virtual-desktop |

## Links

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

## Dependencies (12)

- [@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
- [@prozilla-os/browser](https://npm.io/package/@prozilla-os/browser.md) 1.1.26
- [@prozilla-os/settings](https://npm.io/package/@prozilla-os/settings.md) 1.1.27
- [@prozilla-os/terminal](https://npm.io/package/@prozilla-os/terminal.md) 2.0.6
- [@prozilla-os/app-center](https://npm.io/package/@prozilla-os/app-center.md) 1.2.0
- [@prozilla-os/calculator](https://npm.io/package/@prozilla-os/calculator.md) 1.1.26
- [@prozilla-os/code-editor](https://npm.io/package/@prozilla-os/code-editor.md) 1.0.1
- [@prozilla-os/text-editor](https://npm.io/package/@prozilla-os/text-editor.md) 1.1.26
- [@prozilla-os/media-viewer](https://npm.io/package/@prozilla-os/media-viewer.md) 1.1.26
- [@prozilla-os/file-explorer](https://npm.io/package/@prozilla-os/file-explorer.md) 1.2.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 3.0.0 (latest) — 2026-11-19
- 2.0.6 — 2026-11-19
- 2.0.5 — 2026-05-25
- 2.0.1 — 2026-04-17
- 2.0.0 — 2026-04-13
- 1.3.19 — 2026-04-13
- 1.3.18 — 2026-04-13
- 1.3.16 — 2026-01-25
- 1.3.15 — 2026-01-25
- 1.3.12 — 2025-09-22
- 1.3.11 — 2024-10-30
- 1.3.10 — 2024-10-30
- 1.3.9 — 2024-10-30
- 1.3.8 — 2024-10-29
- 1.3.7 — 2024-10-27
- … 33 more at https://npm.io/package/prozilla-os/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` is a React Vite component library written in TypeScript for building web-based operating systems, made by Prozilla. This package combines multiple other packages for easy access to different ProzillaOS features. You can also download these packages separately instead.

**Live demo: [os.prozilla.dev][demo]** - [(source)][website-source]

## Installation

```sh
npm install prozilla-os
yarn add prozilla-os
pnpm add prozilla-os
```

## Packages

`prozilla-os` combines the following packages into one:

- [`@prozilla-os/core`][core] - Core functionality, React components and hooks
- [`@prozilla-os/shared`][shared] - Common utility functions
- [`@prozilla-os/file-explorer`][file-explorer] - File explorer app
- [`@prozilla-os/terminal`][terminal] - Terminal/shell app
- [`@prozilla-os/text-editor`][text-editor] - Text editor app
- [`@prozilla-os/settings`][settings] - Settings app
- [`@prozilla-os/media-viewer`][media-viewer] - Media viewer app
- [`@prozilla-os/browser`][browser] - Browser app
- [`@prozilla-os/calculator`][calculator] - Calculator app
- [`@prozilla-os/app-center`][app-center] - App center
- [`@prozilla-os/code-editor`][code-editor] - Code editor app

## Usage

For more information about the in-depth usage of each package, check out the links in the section above.

### Basic setup

```tsx
import { Desktop, ModalsView, ProzillaOS, Taskbar, WindowsView } from "prozilla-os";

function App() {
  return (
    <ProzillaOS systemName="Example" tagLine="Powered by ProzillaOS">
      <Taskbar/>
      <WindowsView/>
      <ModalsView/>
      <Desktop/>
    </ProzillaOS>
  );
}
```

<br />

### Configuration

```ts
interface ProzillaOSProps {
  systemName?: string;
  tagLine?: string;
  skin?: Skin;
  config?: {
    apps?: Partial<AppsConfigOptions>;
    desktop?: Partial<DesktopConfigOptions>;
    misc?: Partial<MiscConfigOptions>;
    modals?: Partial<ModalsConfigOptions>;
    taskbar?: Partial<TaskbarConfigOptions>;
    tracking?: Partial<TrackingConfigOptions>;
    windows?: Partial<WindowsConfigOptions>;
    virtualDrive?: Partial<VirtualDriveConfigOptions>;
  };
  children?: ReactNode;
}
```

```ts
interface SkinOptions {
  systemIcon: string;
  appIcons?: { [key: string]: string };
  appNames?: { [key: string]: string };
  wallpapers: string[];
  defaultWallpaper: string;
  fileIcons: {
    generic: string;
    info?: string;
    text?: string;
    code?: string;
    external?: string;
    video?: string;
    audio?: string;
  };
  folderIcons: {
    generic: string;
    images?: string;
    text?: string;
    link?: string;
    video?: string;
    audio?: string;
  };
  loadStyleSheet?: () => void;
  defaultTheme?: Theme;
}
```

```ts
interface AppsConfigOptions {
  apps: App[];
}

interface DesktopConfigOptions {
  /** @default 1 */
  defaultIconSize: 0 | 1 | 2;
  /** 0: vertical, 1: horizontal @default 0 */
  defaultIconDirection: 0 | 1;
}

interface MiscConfigOptions {
  /** @default 250 */
  doubleClickDelay: number;
}

interface ModalsConfigOptions {
  /** Default size of a dialog box @default new Vector2(400, 200) */
  defaultDialogSize: Vector2;
  /** Default size of a file selector @default new Vector2(700, 400) */
  defaultFileSelectorSize: Vector2;
}

interface TaskbarConfigOptions {
  /** Height of the taskbar in CSS pixels @default 3 * 16 */
  height: number;
}

interface TrackingConfigOptions {
  /** Enable tracking @default true */
  enabled: boolean;
  /** Google Analytics measurement ID */
  GAMeasurementId: string;
}

interface WindowsConfigOptions {
  /** @default 32 */
  screenMargin: number;
  /** @default "-" */
  titleSeparator: string;
  /** If the user's screen is smaller than these values, windows will always be maximized @default new Vector2(350, 350) */
  minScreenSize: Vector2;
}

interface VirtualDriveConfigOptions {
  /** Enables persistent storage of the virtual drive. */
  saveData: false | {
    enableCompression: boolean;
    prefix?: string;
    migrations?: [string, string][];
  };
  /** Configure the data that is loaded initially. */
  defaultData: {
    includePicturesFolder?: boolean;
    includeAudioFolder?: boolean;
    includeVideoFolder?: boolean;
    includeDocumentsFolder?: boolean;
    includeDesktopFolder?: boolean;
    includeSourceTree?: boolean;
    includeAppsFolder?: boolean;
    includeScriptsFolder?: boolean;
    loadData?: (virtualRoot: VirtualRoot) => void;
  };
}
```

## Links

- [Demo][demo]
- [Docs][docs]
- [GitHub][github]
- [npm][npm]
- [Discord][discord]
- [Ko-fi][ko-fi]

[demo]: https://os.prozilla.dev/
[docs]: https://os.prozilla.dev/docs/reference/prozilla-os
[website-source]: https://github.com/prozilla-os/ProzillaOS
[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/prozilla-os
[npm]: https://www.npmjs.com/package/prozilla-os
[discord]: https://discord.gg/JwbyQP4tdz
[ko-fi]: https://ko-fi.com/prozilla
[core]: https://www.npmjs.com/package/@prozilla-os/core
[shared]: https://www.npmjs.com/package/@prozilla-os/shared
[file-explorer]: https://www.npmjs.com/package/@prozilla-os/file-explorer
[terminal]: https://www.npmjs.com/package/@prozilla-os/terminal
[text-editor]: https://www.npmjs.com/package/@prozilla-os/text-editor
[settings]: https://www.npmjs.com/package/@prozilla-os/settings
[media-viewer]: https://www.npmjs.com/package/@prozilla-os/media-viewer
[browser]: https://www.npmjs.com/package/@prozilla-os/browser
[app-center]: https://www.npmjs.com/package/@prozilla-os/app-center
[calculator]: https://www.npmjs.com/package/@prozilla-os/calculator
[code-editor]: https://www.npmjs.com/package/@prozilla-os/code-editor

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