prozilla-os 1.0.13 → 1.0.15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,7 +1,7 @@
1
1
  <div align="center">
2
2
  <br />
3
3
  <p>
4
- <a href="https://os.prozilla.dev/"><img src="https://os.prozilla.dev/assets/logo.svg" height="200" alt="ProzillaOS" /></a>
4
+ <a href="https://os.prozilla.dev/"><img src="https://os.prozilla.dev/assets/logo.svg?v=2" height="200" alt="ProzillaOS" /></a>
5
5
  </p>
6
6
  <p>
7
7
  <a href="https://github.com/prozilla-os/ProzillaOS/blob/main/LICENSE.md"><img alt="License" src="https://img.shields.io/github/license/Prozilla/ProzillaOS?style=flat-square&color=FF4D5B&label=License"></a>
@@ -13,7 +13,9 @@
13
13
 
14
14
  ## About
15
15
 
16
- `prozilla-os` is a React component library written in TypeScript for building web-based operating systems, made by Prozilla.
16
+ `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.
17
+
18
+ **Live demo: [os.prozilla.dev][website]** - [(source)][website-source]
17
19
 
18
20
  ## Installation
19
21
 
@@ -23,8 +25,25 @@ $ yarn add prozilla-os
23
25
  $ pnpm add prozilla-os
24
26
  ```
25
27
 
28
+ ## Packages
29
+
30
+ `prozilla-os` combines the following packages into one:
31
+
32
+ - [`@prozilla-os/core`][core] - Core functionality, React components and hooks
33
+ - [`@prozilla-os/file-explorer`][file-explorer] - File explorer app
34
+ - [`@prozilla-os/terminal`][terminal] - Terminal/shell app
35
+ - [`@prozilla-os/text-editor`][text-editor] - Text editor app
36
+ - [`@prozilla-os/settings`][settings] - Settings app
37
+ - [`@prozilla-os/media-viewer`][media-viewer] - Media viewer app
38
+ - [`@prozilla-os/browser`][browser] - Browser app
39
+ - [`@prozilla-os/calculator`][calculator] - Calculator app
40
+
26
41
  ## Usage
27
42
 
43
+ For more information about the in-depth usage of each package, check out the links in the section above.
44
+
45
+ ### Basic setup
46
+
28
47
  ```tsx
29
48
  import { Desktop, ModalsView, ProzillaOS, Taskbar, WindowsView } from "prozilla-os";
30
49
 
@@ -155,9 +174,20 @@ function App() {
155
174
  - [Website/demo][website]
156
175
  - [GitHub][github]
157
176
  - [npm][npm]
177
+ - [Discord][discord]
158
178
  - [Ko-fi][ko-fi]
159
179
 
160
180
  [website]: https://os.prozilla.dev/
181
+ [website-source]: https://github.com/prozilla-os/ProzillaOS
161
182
  [github]: https://github.com/prozilla-os/ProzillaOS/tree/convert-to-monorepo/packages/prozilla-os
162
183
  [npm]: https://www.npmjs.com/package/prozilla-os
163
- [ko-fi]: https://ko-fi.com/prozilla
184
+ [discord]: https://discord.gg/JwbyQP4tdz
185
+ [ko-fi]: https://ko-fi.com/prozilla
186
+ [core]: https://www.npmjs.com/package/@prozilla-os/core
187
+ [file-explorer]: https://www.npmjs.com/package/@prozilla-os/file-explorer
188
+ [terminal]: https://www.npmjs.com/package/@prozilla-os/terminal
189
+ [text-editor]: https://www.npmjs.com/package/@prozilla-os/text-editor
190
+ [settings]: https://www.npmjs.com/package/@prozilla-os/settings
191
+ [media-viewer]: https://www.npmjs.com/package/@prozilla-os/media-viewer
192
+ [browser]: https://www.npmjs.com/package/@prozilla-os/browser
193
+ [calculator]: https://www.npmjs.com/package/@prozilla-os/calculator
@@ -1 +1 @@
1
- ._TextEditor_dix3z_1{display:flex;flex-direction:column;width:100%;height:100%;text-align:start}._TextEditor_dix3z_1 p,._TextEditor_dix3z_1 div,._TextEditor_dix3z_1 span,._TextEditor_dix3z_1 textarea{font-size:1em}._View_dix3z_31,._Code_dix3z_31{width:100%;height:100%;padding:1rem!important;color:var(--foreground-color-0)!important;background-color:var(--background-color-2)!important;border:none;outline:none;font-size:1rem;font-family:var(--body-font-family);resize:none;overflow:auto}._View_dix3z_31{z-index:2}._MarkdownImage_dix3z_67{max-width:100%;object-fit:contain;border-radius:var(--border-radius-0);margin:1rem .5rem 1rem 0}._MarkdownBlockquote_dix3z_81{display:flex;gap:1rem;flex-direction:column;margin:0}._AlertContainer_dix3z_95{--color-0: var(--color-1);--color-1: var(--background-color-0);--color-2: var(--background-color-1);margin:0;padding:1rem 1.5rem;border-left:1rem solid var(--color-1);background-color:var(--color-2);border-radius:var(--border-radius-1)}._Alert_dix3z_95{display:inline-flex;gap:.5rem;justify-content:flex-start;align-items:center;margin-bottom:.5rem;color:var(--color-0);font-weight:600}._Alert_dix3z_95>svg *{fill:var(--color-0)}._ImportantAlert_dix3z_147{--color-0: var(--purple-0);--color-1: var(--purple-1);--color-2: var(--purple-2)}._NoteAlert_dix3z_159{--color-0: var(--blue-0);--color-1: var(--blue-1);--color-2: var(--blue-2)}._TipAlert_dix3z_171{--color-0: var(--green-0);--color-1: var(--green-1);--color-2: var(--green-2)}._WarningAlert_dix3z_183{--color-0: var(--yellow-0);--color-1: var(--yellow-1);--color-2: var(--yellow-2)}._CautionAlert_dix3z_195{--color-0: var(--red-0);--color-1: var(--red-1);--color-2: var(--red-2)}._View_dix3z_31 code{position:relative;font-family:var(--mono-font-family);border-radius:var(--border-radius-1);padding:.125rem .25rem;font-size:.875rem;letter-spacing:-.01rem}._View_dix3z_31 code:after{content:"";position:absolute;top:0;left:0;width:100%;height:100%;background-color:var(--background-color-1);border-radius:inherit;z-index:-1}._MarkdownLink_dix3z_251{position:relative;display:inline-block;color:var(--light-blue-0);transition:color .2s ease-in-out}._MarkdownLink_dix3z_251:hover,._MarkdownLink_dix3z_251:focus-visible{color:var(--light-blue-1)}._MarkdownLink_dix3z_251>*{color:inherit}div>._MarkdownLink_dix3z_251{margin:1rem 0}._MarkdownLink_dix3z_251>._MarkdownImage_dix3z_67{margin:0}._View_dix3z_31 h1,._View_dix3z_31 h2,._View_dix3z_31 h3,._View_dix3z_31 h4,._View_dix3z_31 h5,._View_dix3z_31 h6{margin-top:1.75rem;margin-bottom:-.25rem}._View_dix3z_31 p{line-height:1.375rem}._View_dix3z_31 li>ul{margin:1rem 0}._View_dix3z_31 table{margin:1rem 0;border-collapse:collapse}._View_dix3z_31 table,._View_dix3z_31 th,._View_dix3z_31 td{border:.2rem solid var(--background-color-0)}._View_dix3z_31 th,._View_dix3z_31 td{padding:.5rem}._Code_dix3z_31{margin:0;cursor:default}._Code_dix3z_31 *[class*=hljs-string]{color:var(--green-0)}._Code_dix3z_31 *[class*=hljs-literal],._Code_dix3z_31 *[class*=hljs-number]{color:var(--yellow-0)}._Code_dix3z_31 *[class*=hljs-keyword]{color:var(--blue-0)}._Code_dix3z_31 *[class*=hljs-title]{color:var(--cyan-0)}._Code_dix3z_31 *[class*=hljs-name]{color:var(---red-0)}._Code_dix3z_31 *[class*=hljs-attr]{color:var(--blue-0)}._Code_dix3z_31 *[class*=hljs-param]{color:var(---red-0)}._Code_dix3z_31 *[class*=hljs-comment],._Code_dix3z_31 *[class*=linenumber]{color:var(--black-0)}._Code_dix3z_31 *[class*=hljs-meta]{color:var(--blue-0)}
1
+ ._TextEditor_dix3z_1{display:flex;flex-direction:column;width:100%;height:100%;text-align:start}._TextEditor_dix3z_1 p,._TextEditor_dix3z_1 div,._TextEditor_dix3z_1 span,._TextEditor_dix3z_1 textarea{font-size:1em}._View_dix3z_31,._Code_dix3z_31{width:100%;height:100%;padding:1rem!important;color:var(--foreground-color-0)!important;background-color:var(--background-color-2)!important;border:none;outline:none;font-size:1rem;font-family:var(--body-font-family);resize:none;overflow:auto}._View_dix3z_31{z-index:2}._MarkdownImage_dix3z_67{max-width:100%;object-fit:contain;border-radius:var(--border-radius-0);margin:1rem .5rem 1rem 0}._MarkdownBlockquote_dix3z_81{display:flex;gap:1rem;flex-direction:column;margin:0}._AlertContainer_dix3z_95{--color-0: var(--color-1);--color-1: var(--background-color-0);--color-2: var(--background-color-1);margin:0;padding:1rem 1.5rem;border-left:1rem solid var(--color-1);background-color:var(--color-2);border-radius:var(--border-radius-1)}._Alert_dix3z_95{display:inline-flex;gap:.5rem;justify-content:flex-start;align-items:center;margin-bottom:.5rem;color:var(--color-0);font-weight:600}._Alert_dix3z_95>svg *{fill:var(--color-0)}._ImportantAlert_dix3z_147{--color-0: var(--purple-0);--color-1: var(--purple-1);--color-2: var(--purple-2)}._NoteAlert_dix3z_159{--color-0: var(--blue-0);--color-1: var(--blue-1);--color-2: var(--blue-2)}._TipAlert_dix3z_171{--color-0: var(--green-0);--color-1: var(--green-1);--color-2: var(--green-2)}._WarningAlert_dix3z_183{--color-0: var(--yellow-0);--color-1: var(--yellow-1);--color-2: var(--yellow-2)}._CautionAlert_dix3z_195{--color-0: var(--red-0);--color-1: var(--red-1);--color-2: var(--red-2)}._View_dix3z_31 code{position:relative;font-family:var(--mono-font-family);border-radius:var(--border-radius-1);padding:.125rem .25rem;font-size:.875rem;letter-spacing:-.01rem}._View_dix3z_31 code:after{content:"";position:absolute;top:0;left:0;width:100%;height:100%;background-color:var(--background-color-1);border-radius:inherit;z-index:-1}._MarkdownLink_dix3z_251{position:relative;display:inline-block;color:var(--light-blue-0);transition:color .2s ease-in-out}._MarkdownLink_dix3z_251:hover,._MarkdownLink_dix3z_251:focus-visible{color:var(--light-blue-1)}._MarkdownLink_dix3z_251>*{color:inherit}div>._MarkdownLink_dix3z_251{margin:1rem 0}._MarkdownLink_dix3z_251>._MarkdownImage_dix3z_67{margin:0}._View_dix3z_31 h1,._View_dix3z_31 h2,._View_dix3z_31 h3,._View_dix3z_31 h4,._View_dix3z_31 h5,._View_dix3z_31 h6{margin-top:1.75rem;margin-bottom:-.25rem}._View_dix3z_31 p{line-height:1.375rem}._View_dix3z_31 li>ul{margin:1rem 0}._View_dix3z_31 table{margin:1rem 0;border-collapse:collapse}._View_dix3z_31 table,._View_dix3z_31 th,._View_dix3z_31 td{border:.2rem solid var(--background-color-0)}._View_dix3z_31 th,._View_dix3z_31 td{padding:.5rem}._Code_dix3z_31{margin:0;cursor:default}._Code_dix3z_31 *[class*=hljs-string]{color:var(--green-0)}._Code_dix3z_31 *[class*=hljs-literal],._Code_dix3z_31 *[class*=hljs-number]{color:var(--yellow-0)}._Code_dix3z_31 *[class*=hljs-keyword]{color:var(--blue-0)}._Code_dix3z_31 *[class*=hljs-title]{color:var(--cyan-0)}._Code_dix3z_31 *[class*=hljs-name]{color:var(---red-0)}._Code_dix3z_31 *[class*=hljs-attr]{color:var(--blue-0)}._Code_dix3z_31 *[class*=hljs-param]{color:var(---red-0)}._Code_dix3z_31 *[class*=hljs-comment],._Code_dix3z_31 *[class*=linenumber]{color:var(--black-0)}._Code_dix3z_31 *[class*=hljs-meta]{color:var(--blue-0)}._Calculator_1ddjk_1{display:flex;flex-direction:column;height:100%;--output-height: 20%;--button-gap: .25rem}._Output_1ddjk_19{display:flex;gap:.25rem;flex-direction:column;justify-content:center;align-items:flex-end;height:var(--output-height);padding:.5rem}._Calculation_1ddjk_39,._Preview_1ddjk_39{margin:0}._Calculation_1ddjk_39{color:var(--foreground-color-2);height:1.25rem}._Preview_1ddjk_39{color:var(--foreground-color-0);font-size:2.5rem}._Input_1ddjk_67{display:flex;gap:var(--button-gap);flex-direction:column;height:calc(100% - var(--output-height));padding:.5rem}._InputRow_1ddjk_83{flex:1;display:flex;gap:var(--button-gap)}._Button_1ddjk_95{flex:1;border-radius:var(--border-radius-0);font-size:1.5rem}._InputRow_1ddjk_83:first-of-type ._Button_1ddjk_95{--normal-color: var(--background-color-1);--hover-color: var(--background-color-2)}._InputRow_1ddjk_83 ._Button_1ddjk_95:last-of-type{--text-color: var(--background-color-0);--normal-color: var(--blue-0);--hover-color: var(--blue-1)}._ButtonLarge_1ddjk_129{min-width:calc(50% - var(--button-gap) / 2)}
package/dist/main.d.ts CHANGED
@@ -145,6 +145,9 @@ export declare class AppsConfig {
145
145
  FileExplorer: string;
146
146
  Terminal: string;
147
147
  TextEditor: string;
148
+ Settings: string;
149
+ MediaViewer: string;
150
+ Browser: string;
148
151
  };
149
152
  constructor(options?: OptionalInterface<AppsConfigOptions>);
150
153
  getAppById(id: string): App | null;
@@ -165,6 +168,12 @@ declare interface AppsConfigOptions {
165
168
  apps: App<any>[];
166
169
  }
167
170
 
171
+ export declare const browser: App<BrowserProps>;
172
+
173
+ declare interface BrowserProps extends WindowProps {
174
+ url?: string;
175
+ }
176
+
168
177
  export declare function Button({ className, href, children, icon, target, ...props }: ButtonProps): JSX_2.Element;
169
178
 
170
179
  declare interface ButtonProps {
@@ -176,6 +185,8 @@ declare interface ButtonProps {
176
185
  [key: string]: unknown;
177
186
  }
178
187
 
188
+ export declare const calculator: App<WindowProps>;
189
+
179
190
  export declare function clamp(value: number, min: number, max: number): number;
180
191
 
181
192
  export declare const ClickAction: MemoExoticComponent<({ actionId, label, shortcut, disabled, onTrigger, icon }: ClickActionProps) => JSX_2.Element>;
@@ -283,9 +294,9 @@ export declare const fileExplorer: App<FileExplorerProps>;
283
294
  declare interface FileExplorerProps extends WindowProps {
284
295
  path?: string;
285
296
  selectorMode?: number;
286
- Footer: FC;
287
- onSelectionChange: (params: OnSelectionChangeParams) => void;
288
- onSelectionFinish: Function;
297
+ Footer?: FC;
298
+ onSelectionChange?: (params: OnSelectionChangeParams) => void;
299
+ onSelectionFinish?: Function;
289
300
  }
290
301
 
291
302
  export declare enum FileSelectorMode {
@@ -324,6 +335,8 @@ export declare function getViewportParams(): Record<string, string>;
324
335
 
325
336
  export declare function HeaderMenu({ children, ...props }: ActionsProps): JSX_2.Element;
326
337
 
338
+ export declare const IMAGE_EXTENSIONS: string[];
339
+
327
340
  export declare function ImagePreview({ source, className, onError, ...props }: ImagePreviewProps): JSX_2.Element;
328
341
 
329
342
  declare interface ImagePreviewProps {
@@ -345,6 +358,12 @@ export declare function isValidInteger(number: number | string): number | boolea
345
358
 
346
359
  export declare function isValidUrl(string: string): boolean;
347
360
 
361
+ export declare const mediaViewer: App<MediaViewerProps>;
362
+
363
+ declare interface MediaViewerProps extends WindowProps {
364
+ file?: VirtualFile;
365
+ }
366
+
348
367
  export declare class MiscConfig {
349
368
  doubleClickDelay: MiscConfigOptions["doubleClickDelay"];
350
369
  constructor(options?: OptionalInterface<MiscConfigOptions>);
@@ -562,6 +581,8 @@ declare class Settings {
562
581
  set(key: string, value: string): Promise<void>;
563
582
  }
564
583
 
584
+ export declare const settings: App<SettingsProps>;
585
+
565
586
  export declare class SettingsManager {
566
587
  #private;
567
588
  static VIRTUAL_PATHS: {
@@ -573,6 +594,10 @@ export declare class SettingsManager {
573
594
 
574
595
  declare type SettingsManagerState = SettingsManager | undefined;
575
596
 
597
+ declare interface SettingsProps extends WindowProps {
598
+ tab?: number;
599
+ }
600
+
576
601
  export declare function setViewportIcon(url: string): void;
577
602
 
578
603
  export declare function setViewportTitle(title: string): void;
@@ -636,8 +661,8 @@ declare interface TaskbarConfigOptions {
636
661
  export declare const terminal: App<TerminalProps>;
637
662
 
638
663
  declare interface TerminalProps extends WindowProps {
639
- path: string;
640
- input: string;
664
+ path?: string;
665
+ input?: string;
641
666
  }
642
667
 
643
668
  export declare function TextDisplay({ children }: TextDisplayProps): JSX_2.Element;