@prozilla-os/file-explorer 1.0.4 → 1.0.6

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