@prozilla-os/text-editor 1.0.2 → 1.0.4
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 +24 -0
- package/dist/main.js +796 -796
- package/dist/main.js.map +1 -1
- package/package.json +8 -3
package/README.md
CHANGED
|
@@ -27,6 +27,8 @@ $ pnpm add @prozilla-os/core @prozilla-os/text-editor
|
|
|
27
27
|
|
|
28
28
|
## Usage
|
|
29
29
|
|
|
30
|
+
### Basic setup
|
|
31
|
+
|
|
30
32
|
```tsx
|
|
31
33
|
import { Desktop, ModalsView, ProzillaOS, Taskbar, WindowsView, AppsConfig } from "@prozilla-os/core";
|
|
32
34
|
import { textEditor } from "@prozilla-os/text-editor";
|
|
@@ -51,6 +53,28 @@ function App() {
|
|
|
51
53
|
}
|
|
52
54
|
```
|
|
53
55
|
|
|
56
|
+
### Window options
|
|
57
|
+
|
|
58
|
+
```tsx
|
|
59
|
+
/**
|
|
60
|
+
* Initial path that the app will open
|
|
61
|
+
* @default "~" - Home directory
|
|
62
|
+
*/
|
|
63
|
+
path: string;
|
|
64
|
+
|
|
65
|
+
/**
|
|
66
|
+
* Virtual file to open the app with
|
|
67
|
+
*/
|
|
68
|
+
file: VirtualFile;
|
|
69
|
+
|
|
70
|
+
/**
|
|
71
|
+
* Mode in which to run the app
|
|
72
|
+
* "view" - Renders markdown files and renders syntax highlighting of other file formats, disables text editing
|
|
73
|
+
* "edit" - Raw text editor
|
|
74
|
+
*/
|
|
75
|
+
mode: "view" | "edit";
|
|
76
|
+
```
|
|
77
|
+
|
|
54
78
|
## Links
|
|
55
79
|
|
|
56
80
|
- [Website/demo][website]
|