prozilla-os 1.3.11 → 1.3.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/LICENSE CHANGED
@@ -1,21 +1,21 @@
1
- MIT License
2
-
3
- Copyright (c) 2023 Sieben De Beule
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
1
+ MIT License
2
+
3
+ Copyright (c) 2023 Sieben De Beule
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
21
  SOFTWARE.
package/README.md CHANGED
@@ -1,212 +1,212 @@
1
- <div align="center">
2
- <br />
3
- <p>
4
- <a href="https://os.prozilla.dev/"><img src="https://os.prozilla.dev/assets/logo.svg?v=2" 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
- </div>
13
-
14
- ## About
15
-
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][demo]** - [(source)][website-source]
19
-
20
- ## Installation
21
-
22
- ```sh
23
- npm install prozilla-os
24
- yarn add prozilla-os
25
- pnpm add prozilla-os
26
- ```
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
-
41
- ## Usage
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
-
47
- ```tsx
48
- import { Desktop, ModalsView, ProzillaOS, Taskbar, WindowsView } from "prozilla-os";
49
-
50
- function App() {
51
- return (
52
- <ProzillaOS systemName="Example" tagLine="Powered by ProzillaOS">
53
- <Taskbar/>
54
- <WindowsView/>
55
- <ModalsView/>
56
- <Desktop/>
57
- </ProzillaOS>
58
- );
59
- }
60
- ```
61
-
62
- <br />
63
-
64
- ### Configuration
65
-
66
- ```tsx
67
- interface ProzillaOSProps {
68
-
69
- systemName: string,
70
-
71
- tagLine: string,
72
-
73
- skin: new Skin({
74
-
75
- appIcons: Record<number, string> | undefined,
76
-
77
- appNames: Record<number, string> | undefined,
78
-
79
- wallpapers: string[],
80
-
81
- defaultWallpaper: string,
82
-
83
- fileIcons: {
84
- generic: string;
85
- info: string | undefined;
86
- text: string | undefined;
87
- code: string | undefined;
88
- },
89
-
90
- folderIcons: {
91
- generic: string;
92
- images: string | undefined;
93
- text: string | undefined;
94
- link: string | undefined;
95
- },
96
-
97
- loadStyleSheet: () => void | undefined
98
-
99
- })
100
-
101
- config: {
102
- apps: new AppsConfig({
103
-
104
- apps: App[]
105
-
106
- }),
107
- desktop: new DesktopConfig({
108
-
109
- /**
110
- * @default 1
111
- */
112
- defaultIconSize: 0 | 1 | 2,
113
-
114
- /**
115
- * 0: vertical, 1: horizontal
116
- * @default 0
117
- * */
118
- defaultIconDirection: 0 | 1
119
-
120
- }),
121
- misc: new MiscConfig({
122
-
123
- /**
124
- * @default 250
125
- */
126
- doubleClickDelay: number
127
-
128
- })
129
- modals: new ModalsConfig({
130
-
131
- /**
132
- * Default size of a dialog box
133
- * @default new Vector2(400, 200)
134
- */
135
- defaultDialogSize: Vector2,
136
-
137
- /**
138
- * Default size of a file selector
139
- * @default new Vector2(700, 400)
140
- */
141
- defaultFileSelectorSize: Vector2
142
-
143
- }),
144
- taskbar: new TaskbarConfig({
145
-
146
- /**
147
- * Height of the taskbar in CSS pixels
148
- * @default 3 * 16
149
- */
150
- height: number
151
-
152
- }),
153
- tracking: new TrackingConfig({
154
-
155
- /**
156
- * Enable tracking
157
- * @default true
158
- */
159
- enabled: boolean,
160
-
161
- /** Google Analytics measurement ID */
162
- GAMeasurementId: string
163
-
164
- }),
165
- windows: new WindowsConfig({
166
-
167
- /**
168
- * @default 32
169
- */
170
- screenMargin: number,
171
-
172
- /**
173
- * @default "-"
174
- */
175
- titleSeparator: string,
176
-
177
- /**
178
- * If the user's screen is smaller than these values, windows will always be maximized
179
- * @default new Vector2(350, 350)
180
- */
181
- minScreenSize: Vector2
182
-
183
- })
184
- }
185
-
186
- }
187
- ```
188
-
189
- ## Links
190
-
191
- - [Demo][demo]
192
- - [Docs][docs]
193
- - [GitHub][github]
194
- - [npm][npm]
195
- - [Discord][discord]
196
- - [Ko-fi][ko-fi]
197
-
198
- [demo]: https://os.prozilla.dev/
199
- [docs]: https://os.prozilla.dev/docs/reference/prozilla-os
200
- [website-source]: https://github.com/prozilla-os/ProzillaOS
201
- [github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/prozilla-os
202
- [npm]: https://www.npmjs.com/package/prozilla-os
203
- [discord]: https://discord.gg/JwbyQP4tdz
204
- [ko-fi]: https://ko-fi.com/prozilla
205
- [core]: https://www.npmjs.com/package/@prozilla-os/core
206
- [file-explorer]: https://www.npmjs.com/package/@prozilla-os/file-explorer
207
- [terminal]: https://www.npmjs.com/package/@prozilla-os/terminal
208
- [text-editor]: https://www.npmjs.com/package/@prozilla-os/text-editor
209
- [settings]: https://www.npmjs.com/package/@prozilla-os/settings
210
- [media-viewer]: https://www.npmjs.com/package/@prozilla-os/media-viewer
211
- [browser]: https://www.npmjs.com/package/@prozilla-os/browser
212
- [calculator]: https://www.npmjs.com/package/@prozilla-os/calculator
1
+ <div align="center">
2
+ <br />
3
+ <p>
4
+ <a href="https://os.prozilla.dev/"><img src="https://os.prozilla.dev/assets/logo.svg?v=2" 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
+ </div>
13
+
14
+ ## About
15
+
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][demo]** - [(source)][website-source]
19
+
20
+ ## Installation
21
+
22
+ ```sh
23
+ npm install prozilla-os
24
+ yarn add prozilla-os
25
+ pnpm add prozilla-os
26
+ ```
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
+
41
+ ## Usage
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
+
47
+ ```tsx
48
+ import { Desktop, ModalsView, ProzillaOS, Taskbar, WindowsView } from "prozilla-os";
49
+
50
+ function App() {
51
+ return (
52
+ <ProzillaOS systemName="Example" tagLine="Powered by ProzillaOS">
53
+ <Taskbar/>
54
+ <WindowsView/>
55
+ <ModalsView/>
56
+ <Desktop/>
57
+ </ProzillaOS>
58
+ );
59
+ }
60
+ ```
61
+
62
+ <br />
63
+
64
+ ### Configuration
65
+
66
+ ```tsx
67
+ interface ProzillaOSProps {
68
+
69
+ systemName: string,
70
+
71
+ tagLine: string,
72
+
73
+ skin: new Skin({
74
+
75
+ appIcons: Record<number, string> | undefined,
76
+
77
+ appNames: Record<number, string> | undefined,
78
+
79
+ wallpapers: string[],
80
+
81
+ defaultWallpaper: string,
82
+
83
+ fileIcons: {
84
+ generic: string;
85
+ info: string | undefined;
86
+ text: string | undefined;
87
+ code: string | undefined;
88
+ },
89
+
90
+ folderIcons: {
91
+ generic: string;
92
+ images: string | undefined;
93
+ text: string | undefined;
94
+ link: string | undefined;
95
+ },
96
+
97
+ loadStyleSheet: () => void | undefined
98
+
99
+ })
100
+
101
+ config: {
102
+ apps: new AppsConfig({
103
+
104
+ apps: App[]
105
+
106
+ }),
107
+ desktop: new DesktopConfig({
108
+
109
+ /**
110
+ * @default 1
111
+ */
112
+ defaultIconSize: 0 | 1 | 2,
113
+
114
+ /**
115
+ * 0: vertical, 1: horizontal
116
+ * @default 0
117
+ * */
118
+ defaultIconDirection: 0 | 1
119
+
120
+ }),
121
+ misc: new MiscConfig({
122
+
123
+ /**
124
+ * @default 250
125
+ */
126
+ doubleClickDelay: number
127
+
128
+ })
129
+ modals: new ModalsConfig({
130
+
131
+ /**
132
+ * Default size of a dialog box
133
+ * @default new Vector2(400, 200)
134
+ */
135
+ defaultDialogSize: Vector2,
136
+
137
+ /**
138
+ * Default size of a file selector
139
+ * @default new Vector2(700, 400)
140
+ */
141
+ defaultFileSelectorSize: Vector2
142
+
143
+ }),
144
+ taskbar: new TaskbarConfig({
145
+
146
+ /**
147
+ * Height of the taskbar in CSS pixels
148
+ * @default 3 * 16
149
+ */
150
+ height: number
151
+
152
+ }),
153
+ tracking: new TrackingConfig({
154
+
155
+ /**
156
+ * Enable tracking
157
+ * @default true
158
+ */
159
+ enabled: boolean,
160
+
161
+ /** Google Analytics measurement ID */
162
+ GAMeasurementId: string
163
+
164
+ }),
165
+ windows: new WindowsConfig({
166
+
167
+ /**
168
+ * @default 32
169
+ */
170
+ screenMargin: number,
171
+
172
+ /**
173
+ * @default "-"
174
+ */
175
+ titleSeparator: string,
176
+
177
+ /**
178
+ * If the user's screen is smaller than these values, windows will always be maximized
179
+ * @default new Vector2(350, 350)
180
+ */
181
+ minScreenSize: Vector2
182
+
183
+ })
184
+ }
185
+
186
+ }
187
+ ```
188
+
189
+ ## Links
190
+
191
+ - [Demo][demo]
192
+ - [Docs][docs]
193
+ - [GitHub][github]
194
+ - [npm][npm]
195
+ - [Discord][discord]
196
+ - [Ko-fi][ko-fi]
197
+
198
+ [demo]: https://os.prozilla.dev/
199
+ [docs]: https://os.prozilla.dev/docs/reference/prozilla-os
200
+ [website-source]: https://github.com/prozilla-os/ProzillaOS
201
+ [github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/prozilla-os
202
+ [npm]: https://www.npmjs.com/package/prozilla-os
203
+ [discord]: https://discord.gg/JwbyQP4tdz
204
+ [ko-fi]: https://ko-fi.com/prozilla
205
+ [core]: https://www.npmjs.com/package/@prozilla-os/core
206
+ [file-explorer]: https://www.npmjs.com/package/@prozilla-os/file-explorer
207
+ [terminal]: https://www.npmjs.com/package/@prozilla-os/terminal
208
+ [text-editor]: https://www.npmjs.com/package/@prozilla-os/text-editor
209
+ [settings]: https://www.npmjs.com/package/@prozilla-os/settings
210
+ [media-viewer]: https://www.npmjs.com/package/@prozilla-os/media-viewer
211
+ [browser]: https://www.npmjs.com/package/@prozilla-os/browser
212
+ [calculator]: https://www.npmjs.com/package/@prozilla-os/calculator