@prozilla-os/file-explorer 1.0.5 → 1.0.7

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 +33 -149
  2. package/package.json +3 -2
package/README.md CHANGED
@@ -1,23 +1,20 @@
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
15
15
 
16
16
  `@prozilla-os/file-explorer` is a standard ProzillaOS application for browsing files.
17
17
 
18
- ## Requirements
19
-
20
-
21
18
  ## Installation
22
19
 
23
20
  `@prozilla-os/core` is required to run this application.
@@ -35,146 +32,33 @@ import { Desktop, ModalsView, ProzillaOS, Taskbar, WindowsView, AppsConfig } fro
35
32
  import { fileExplorer } from "@prozilla-os/file-explorer";
36
33
 
37
34
  function App() {
38
- return (
39
- <ProzillaOS
40
- systemName="Example"
41
- tagLine="Power by ProzillaOS"
42
- config={{
43
- apps: new AppsConfig({
44
- apps: [ fileExplorer ]
45
- })
46
- }}
47
- >
48
- <Taskbar/>
49
- <WindowsView/>
50
- <ModalsView/>
51
- <Desktop/>
52
- </ProzillaOS>
53
- );
54
- }
55
- ```
56
-
57
- <br />
58
-
59
- ### `<ProzillaOS>` props
60
-
61
- ```tsx
62
- {
63
-
64
- systemName: string,
65
-
66
- tagLine: string,
67
-
68
- config: {
69
- apps: {
70
-
71
- apps: App[]
72
-
73
- },
74
- desktop: {
75
-
76
- /** Array of URLs of wallpaper images */
77
- wallpapers: string[];
78
-
79
- /** URL of default wallpaper image */
80
- defaultWallpaper: string;
81
-
82
- /**
83
- * @default 1
84
- */
85
- defaultIconSize: 0 | 1 | 2;
86
-
87
- /**
88
- * 0: vertical, 1: horizontal
89
- * @default 0
90
- * */
91
- defaultIconDirection: 0 | 1;
92
-
93
- },
94
- modals: {
95
-
96
- /**
97
- * Default size of a dialog box
98
- * @default new Vector2(400, 200)
99
- */
100
- defaultDialogSize: Vector2;
101
-
102
- /**
103
- * Default size of a file selector
104
- * @default new Vector2(700, 400)
105
- */
106
- defaultFileSelectorSize: Vector2;
107
-
108
- },
109
- taskbar: {
110
-
111
- /**
112
- * Height of the taskbar in CSS pixels
113
- * @default 3 * 16
114
- */
115
- height: number;
116
-
117
- },
118
- tracking: {
119
-
120
- /**
121
- * Enable tracking
122
- * @default true
123
- */
124
- enabled: boolean;
125
-
126
- /** Google Analytics measurement ID */
127
- GAMeasurementId: string;
128
-
129
- },
130
- virtualDrive: {
131
-
132
- fileIcon: string;
133
- infoFileIcon: string;
134
- textFileIcon: string;
135
- codeFileIcon: string;
136
-
137
- folderIcon: string;
138
- imagesFolderIcon: string;
139
- textFolderIcon: string;
140
- folderLinkIcon: string;
141
-
142
- },
143
- windows: {
144
-
145
- /**
146
- * @default 32
147
- */
148
- screenMargin: number;
149
-
150
- /**
151
- * @default "-"
152
- */
153
- titleSeparator: string;
154
-
155
- /**
156
- * If the user's screen is smaller than these values, windows will always be maximized
157
- * @default new Vector2(350, 350)
158
- */
159
- minScreenSize: Vector2;
160
-
161
- }
162
- }
163
-
35
+ return (
36
+ <ProzillaOS
37
+ systemName="Example"
38
+ tagLine="Powered by ProzillaOS"
39
+ config={{
40
+ apps: new AppsConfig({
41
+ apps: [ fileExplorer ]
42
+ })
43
+ }}
44
+ >
45
+ <Taskbar/>
46
+ <WindowsView/>
47
+ <ModalsView/>
48
+ <Desktop/>
49
+ </ProzillaOS>
50
+ );
164
51
  }
165
52
  ```
166
53
 
167
54
  ## Links
168
55
 
169
- - [Website/demo](website)
170
- - [GitHub](github)
171
- - [npm](npm)
172
- - [Ko-fi](ko-fi)
56
+ - [Website/demo][website]
57
+ - [GitHub][github]
58
+ - [npm][npm]
59
+ - [Ko-fi][ko-fi]
173
60
 
174
61
  [website]: https://os.prozilla.dev/
175
- [github]: https://github.com/prozilla-os/ProzillaOS
176
- [npm]: https://www.npmjs.com/package/prozilla-os
177
- [ko-fi]: https://ko-fi.com/prozilla
178
- [issues]: https://github.com/prozilla-os/ProzillaOS/issues
179
- [boilerplate]: https://github.com/prozilla-os/ProzillaOS-boilerplate
180
- [prozilla]: https://prozilla.dev/
62
+ [github]: https://github.com/prozilla-os/ProzillaOS/tree/convert-to-monorepo/packages/apps/file-explorer
63
+ [npm]: https://www.npmjs.com/package/@prozilla-os/file-explorer
64
+ [ko-fi]: https://ko-fi.com/prozilla
package/package.json CHANGED
@@ -1,6 +1,7 @@
1
1
  {
2
2
  "name": "@prozilla-os/file-explorer",
3
- "version": "1.0.5",
3
+ "description": "A standard ProzillaOS application for browsing files.",
4
+ "version": "1.0.7",
4
5
  "author": {
5
6
  "name": "Prozilla",
6
7
  "email": "business@prozilla.dev",
@@ -19,7 +20,7 @@
19
20
  "@fortawesome/free-solid-svg-icons": "^6.5.2",
20
21
  "@fortawesome/react-fontawesome": "^0.2.2",
21
22
  "react": "^18.3.1",
22
- "@prozilla-os/core": "1.0.8"
23
+ "@prozilla-os/core": "1.0.10"
23
24
  },
24
25
  "devDependencies": {
25
26
  "typescript": "^5.4.5"