@files-preview-app/preview-file 1.1.0 → 1.1.2
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 +12 -12
- package/THIRD_PARTY_LICENSES.md +1 -1
- package/dist/angular.cjs.map +1 -1
- package/dist/angular.js.map +1 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.js.map +1 -1
- package/dist/react.cjs.map +1 -1
- package/dist/react.js.map +1 -1
- package/dist/vue.cjs.map +1 -1
- package/dist/vue.js.map +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
# @files-preview-app/preview-file
|
|
2
2
|
|
|
3
3
|
> **Universal, all-in-one client-side file preview package for React, Angular, Vue, and Vanilla JS.**
|
|
4
4
|
> Preview **PDF, Word (.docx), Excel (.xlsx), CSV, Images, Video, Audio, and Code/Text** with a built-in toolbar (zoom, rotate, thumbnails, page jump, download, print). 100% free, permissive open-source, and client-side (no cloud or server needed).
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
---
|
|
10
10
|
|
|
11
|
-
##
|
|
11
|
+
## 📦 Installation
|
|
12
12
|
|
|
13
13
|
Just install this **single package** in your project:
|
|
14
14
|
|
|
@@ -30,7 +30,7 @@ import '@files-preview-app/preview-file/styles.css';
|
|
|
30
30
|
|
|
31
31
|
---
|
|
32
32
|
|
|
33
|
-
##
|
|
33
|
+
## 🚀 Quick Start by Framework
|
|
34
34
|
|
|
35
35
|
### 1. React (`@files-preview-app/preview-file/react`)
|
|
36
36
|
|
|
@@ -183,7 +183,7 @@ function handleError(err: unknown) {
|
|
|
183
183
|
|
|
184
184
|
---
|
|
185
185
|
|
|
186
|
-
##
|
|
186
|
+
## 📂 Supported Extensions & Built-in Controls
|
|
187
187
|
|
|
188
188
|
The viewer automatically recognizes the file extension and magic binary bytes, activating the corresponding renderer and controls:
|
|
189
189
|
|
|
@@ -197,14 +197,14 @@ The viewer automatically recognizes the file extension and magic binary bytes, a
|
|
|
197
197
|
| **ZIP Archives** | `.zip` | File Tree & Table Explorer, Compression Stats, Search Filter, Individual File Download, Download Zip |
|
|
198
198
|
| **Rich Markdown** | `.md`, `.markdown` | Rendered GitHub Markdown (Tables, Checklists, Blockquotes), Syntax Highlighted Code, Font Zoom, Download, Print |
|
|
199
199
|
| **3D Models** | `.stl`, `.obj` | 360° Orbit Mouse Controls, Perspective Camera, Lighting, Wireframe Toggle, Zoom, Reset View, Download |
|
|
200
|
-
| **Images** | `.png`, `.jpg`, `.jpeg`, `.gif`, `.webp`, `.bmp`, `.svg`, `.ico`, `.tiff` | Pan & Zoom, Reset / Fit, Rotate 90
|
|
200
|
+
| **Images** | `.png`, `.jpg`, `.jpeg`, `.gif`, `.webp`, `.bmp`, `.svg`, `.ico`, `.tiff` | Pan & Zoom, Reset / Fit, Rotate 90°, Download, Print |
|
|
201
201
|
| **Video** | `.mp4`, `.webm`, `.ogg`, `.mov` | Play / Pause, Rotate, Fullscreen, Download |
|
|
202
202
|
| **Audio** | `.mp3`, `.wav`, `.ogg`, `.flac`, `.aac` | Play / Pause, Volume, Seek, Download |
|
|
203
203
|
| **Code & Text** | `.js`, `.ts`, `.jsx`, `.tsx`, `.html`, `.css`, `.json`, `.xml`, `.yaml`, `.py`, `.java`, `.cpp`, `.sql`, `.md`, `.txt`, `.sh`, etc. (190+ languages) | Syntax Highlighting via highlight.js, Font Scaling Zoom In/Out, Download, Print |
|
|
204
204
|
|
|
205
205
|
---
|
|
206
206
|
|
|
207
|
-
##
|
|
207
|
+
## 📥 How to Pass Values (`src` prop)
|
|
208
208
|
|
|
209
209
|
You can pass the file source in **any** of the following formats:
|
|
210
210
|
|
|
@@ -238,7 +238,7 @@ const buffer = await response.arrayBuffer();
|
|
|
238
238
|
|
|
239
239
|
---
|
|
240
240
|
|
|
241
|
-
##
|
|
241
|
+
## 🎛️ Toolbar Features Matrix
|
|
242
242
|
|
|
243
243
|
| Control | How it Works |
|
|
244
244
|
|---|---|
|
|
@@ -253,7 +253,7 @@ const buffer = await response.arrayBuffer();
|
|
|
253
253
|
|
|
254
254
|
---
|
|
255
255
|
|
|
256
|
-
##
|
|
256
|
+
## 🎨 Viewer Options
|
|
257
257
|
|
|
258
258
|
Pass configuration via the `options` object:
|
|
259
259
|
|
|
@@ -276,7 +276,7 @@ interface PreviewViewerOptions {
|
|
|
276
276
|
|
|
277
277
|
---
|
|
278
278
|
|
|
279
|
-
##
|
|
279
|
+
## 🛡️ Security & Licensing
|
|
280
280
|
|
|
281
281
|
- **100% Client-Side**: No document or file data is ever sent to any remote server or third-party cloud.
|
|
282
282
|
- **XSS Protection**: HTML and SVG previews are sanitized with `DOMPurify`.
|
|
@@ -286,7 +286,7 @@ See [THIRD_PARTY_LICENSES.md](THIRD_PARTY_LICENSES.md) for full licensing detail
|
|
|
286
286
|
|
|
287
287
|
---
|
|
288
288
|
|
|
289
|
-
##
|
|
289
|
+
## 👨💻 Author
|
|
290
290
|
|
|
291
291
|
**Sumit Patel**
|
|
292
292
|
- GitHub: [@patelsumit5192](https://github.com/patelsumit5192)
|
|
@@ -295,6 +295,6 @@ See [THIRD_PARTY_LICENSES.md](THIRD_PARTY_LICENSES.md) for full licensing detail
|
|
|
295
295
|
|
|
296
296
|
---
|
|
297
297
|
|
|
298
|
-
##
|
|
298
|
+
## 📄 License
|
|
299
299
|
|
|
300
|
-
MIT
|
|
300
|
+
MIT © 2026 Sumit Patel
|
package/THIRD_PARTY_LICENSES.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
# Third-Party Licenses
|
|
2
2
|
|
|
3
3
|
This project uses the following open-source libraries. All dependencies use strictly permissive licenses (MIT, Apache-2.0, or BSD) that allow free commercial and personal use with zero copyright claims or restrictions.
|
|
4
4
|
|