@prozilla-os/core 1.0.8 → 1.0.10

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.
Files changed (2) hide show
  1. package/README.md +100 -103
  2. package/package.json +3 -2
package/README.md CHANGED
@@ -1,14 +1,14 @@
1
1
  <div align="center">
2
- <br />
3
- <p>
4
- <a href="https://os.prozilla.dev/"><img src="https://os.prozilla.dev/assets/logo.png" height="200" alt="ProzillaOS" /></a>
5
- </p>
6
- <p>
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>
8
- <a href="https://github.com/prozilla-os/ProzillaOS"><img alt="Stars" src="https://img.shields.io/github/stars/Prozilla/ProzillaOS?style=flat-square&color=FED24C&label=%E2%AD%90"></a>
9
- <a href="https://github.com/prozilla-os/ProzillaOS"><img alt="Forks" src="https://img.shields.io/github/forks/Prozilla/ProzillaOS?style=flat-square&color=4D9CFF&label=Forks&logo=github"></a>
10
- <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>
11
- </p>
2
+ <br />
3
+ <p>
4
+ <a href="https://os.prozilla.dev/"><img src="https://os.prozilla.dev/assets/logo.svg" height="200" alt="ProzillaOS" /></a>
5
+ </p>
6
+ <p>
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>
8
+ <a href="https://github.com/prozilla-os/ProzillaOS"><img alt="Stars" src="https://img.shields.io/github/stars/Prozilla/ProzillaOS?style=flat-square&color=FED24C&label=%E2%AD%90"></a>
9
+ <a href="https://github.com/prozilla-os/ProzillaOS"><img alt="Forks" src="https://img.shields.io/github/forks/Prozilla/ProzillaOS?style=flat-square&color=4D9CFF&label=Forks&logo=github"></a>
10
+ <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>
11
+ </p>
12
12
  </div>
13
13
 
14
14
  ## About
@@ -29,14 +29,14 @@ $ pnpm add @prozilla-os/core
29
29
  import { Desktop, ModalsView, ProzillaOS, Taskbar, WindowsView } from "@prozilla-os/core";
30
30
 
31
31
  function App() {
32
- return (
33
- <ProzillaOS systemName="Example" tagLine="Power by ProzillaOS">
34
- <Taskbar/>
35
- <WindowsView/>
36
- <ModalsView/>
37
- <Desktop/>
38
- </ProzillaOS>
39
- );
32
+ return (
33
+ <ProzillaOS systemName="Example" tagLine="Powered by ProzillaOS">
34
+ <Taskbar/>
35
+ <WindowsView/>
36
+ <ModalsView/>
37
+ <Desktop/>
38
+ </ProzillaOS>
39
+ );
40
40
  }
41
41
  ```
42
42
 
@@ -47,120 +47,117 @@ function App() {
47
47
  ```tsx
48
48
  {
49
49
 
50
- systemName: string,
50
+ systemName: string,
51
51
 
52
- tagLine: string,
52
+ tagLine: string,
53
53
 
54
- config: {
55
- apps: new AppsConfig({
54
+ config: {
55
+ apps: new AppsConfig({
56
56
 
57
- apps: App[]
57
+ apps: App[]
58
58
 
59
- }),
60
- desktop: new DesktopConfig({
59
+ }),
60
+ desktop: new DesktopConfig({
61
61
 
62
- /** Array of URLs of wallpaper images */
63
- wallpapers: string[],
62
+ /** Array of URLs of wallpaper images */
63
+ wallpapers: string[],
64
64
 
65
- /** URL of default wallpaper image */
66
- defaultWallpaper: string,
65
+ /** URL of default wallpaper image */
66
+ defaultWallpaper: string,
67
67
 
68
- /**
69
- * @default 1
70
- */
71
- defaultIconSize: 0 | 1 | 2,
68
+ /**
69
+ * @default 1
70
+ */
71
+ defaultIconSize: 0 | 1 | 2,
72
72
 
73
- /**
74
- * 0: vertical, 1: horizontal
75
- * @default 0
76
- * */
77
- defaultIconDirection: 0 | 1
73
+ /**
74
+ * 0: vertical, 1: horizontal
75
+ * @default 0
76
+ * */
77
+ defaultIconDirection: 0 | 1
78
78
 
79
- }),
80
- modals: new ModalsConfig({
79
+ }),
80
+ modals: new ModalsConfig({
81
81
 
82
- /**
83
- * Default size of a dialog box
84
- * @default new Vector2(400, 200)
85
- */
86
- defaultDialogSize: Vector2,
82
+ /**
83
+ * Default size of a dialog box
84
+ * @default new Vector2(400, 200)
85
+ */
86
+ defaultDialogSize: Vector2,
87
87
 
88
- /**
89
- * Default size of a file selector
90
- * @default new Vector2(700, 400)
91
- */
92
- defaultFileSelectorSize: Vector2
88
+ /**
89
+ * Default size of a file selector
90
+ * @default new Vector2(700, 400)
91
+ */
92
+ defaultFileSelectorSize: Vector2
93
93
 
94
- }),
95
- taskbar: new TaskbarConfig({
94
+ }),
95
+ taskbar: new TaskbarConfig({
96
96
 
97
- /**
98
- * Height of the taskbar in CSS pixels
99
- * @default 3 * 16
100
- */
101
- height: number
97
+ /**
98
+ * Height of the taskbar in CSS pixels
99
+ * @default 3 * 16
100
+ */
101
+ height: number
102
102
 
103
- }),
104
- tracking: new TrackingConfig({
103
+ }),
104
+ tracking: new TrackingConfig({
105
105
 
106
- /**
107
- * Enable tracking
108
- * @default true
109
- */
110
- enabled: boolean,
106
+ /**
107
+ * Enable tracking
108
+ * @default true
109
+ */
110
+ enabled: boolean,
111
111
 
112
- /** Google Analytics measurement ID */
113
- GAMeasurementId: string
112
+ /** Google Analytics measurement ID */
113
+ GAMeasurementId: string
114
114
 
115
- }),
116
- virtualDrive: new VirtualDriveConfig({
115
+ }),
116
+ virtualDrive: new VirtualDriveConfig({
117
117
 
118
- fileIcon: string,
119
- infoFileIcon: string,
120
- textFileIcon: string,
121
- codeFileIcon: string,
118
+ fileIcon: string,
119
+ infoFileIcon: string,
120
+ textFileIcon: string,
121
+ codeFileIcon: string,
122
122
 
123
- folderIcon: string,
124
- imagesFolderIcon: string,
125
- textFolderIcon: string,
126
- folderLinkIcon: string
123
+ folderIcon: string,
124
+ imagesFolderIcon: string,
125
+ textFolderIcon: string,
126
+ folderLinkIcon: string
127
127
 
128
- }),
129
- windows: new WindowsConfig({
128
+ }),
129
+ windows: new WindowsConfig({
130
130
 
131
- /**
132
- * @default 32
133
- */
134
- screenMargin: number,
131
+ /**
132
+ * @default 32
133
+ */
134
+ screenMargin: number,
135
135
 
136
- /**
137
- * @default "-"
138
- */
139
- titleSeparator: string,
136
+ /**
137
+ * @default "-"
138
+ */
139
+ titleSeparator: string,
140
140
 
141
- /**
142
- * If the user's screen is smaller than these values, windows will always be maximized
143
- * @default new Vector2(350, 350)
144
- */
145
- minScreenSize: Vector2
141
+ /**
142
+ * If the user's screen is smaller than these values, windows will always be maximized
143
+ * @default new Vector2(350, 350)
144
+ */
145
+ minScreenSize: Vector2
146
146
 
147
- })
148
- }
147
+ })
148
+ }
149
149
 
150
150
  }
151
151
  ```
152
152
 
153
153
  ## Links
154
154
 
155
- - [Website/demo](website)
156
- - [GitHub](github)
157
- - [npm](npm)
158
- - [Ko-fi](ko-fi)
155
+ - [Website/demo][website]
156
+ - [GitHub][github]
157
+ - [npm][npm]
158
+ - [Ko-fi][ko-fi]
159
159
 
160
160
  [website]: https://os.prozilla.dev/
161
- [github]: https://github.com/prozilla-os/ProzillaOS
162
- [npm]: https://www.npmjs.com/package/prozilla-os
163
- [ko-fi]: https://ko-fi.com/prozilla
164
- [issues]: https://github.com/prozilla-os/ProzillaOS/issues
165
- [boilerplate]: https://github.com/prozilla-os/ProzillaOS-boilerplate
166
- [prozilla]: https://prozilla.dev/
161
+ [github]: https://github.com/prozilla-os/ProzillaOS/tree/convert-to-monorepo/packages/core
162
+ [npm]: https://www.npmjs.com/package/@prozilla-os/core
163
+ [ko-fi]: https://ko-fi.com/prozilla
package/package.json CHANGED
@@ -1,6 +1,7 @@
1
1
  {
2
2
  "name": "@prozilla-os/core",
3
- "version": "1.0.8",
3
+ "description": "A React component library written in TypeScript for building web-based operating systems, made by Prozilla.",
4
+ "version": "1.0.10",
4
5
  "author": {
5
6
  "name": "Prozilla",
6
7
  "email": "business@prozilla.dev",
@@ -24,7 +25,7 @@
24
25
  "react-error-boundary": "^4.0.13",
25
26
  "react-ga4": "^2.1.0",
26
27
  "react-svg": "^16.1.34",
27
- "@prozilla-os/file-explorer": "1.0.5"
28
+ "@prozilla-os/file-explorer": "1.0.7"
28
29
  },
29
30
  "devDependencies": {
30
31
  "@types/node": "^20.14.5",