@cubone/react-file-manager 1.7.0 → 1.7.1
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 +4 -5
- package/dist/react-file-manager.es.js +578 -566
- package/dist/style.css +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -5,7 +5,6 @@
|
|
|
5
5
|
  
|
|
6
6
|
|
|
7
7
|
</div>
|
|
8
|
-
<br>
|
|
9
8
|
|
|
10
9
|
<p>
|
|
11
10
|
An open-source React.js package for easy integration of a file manager into applications. It provides a user-friendly interface for managing files and folders, including viewing, uploading, and deleting, with full UI and backend integration.
|
|
@@ -82,17 +81,16 @@ type File = {
|
|
|
82
81
|
};
|
|
83
82
|
```
|
|
84
83
|
|
|
85
|
-
Here is the updated table with the props sorted in ascending order by name:
|
|
86
|
-
|
|
87
84
|
## ⚙️ Props
|
|
88
85
|
|
|
89
86
|
| Name | Type | Description |
|
|
90
87
|
| ------------------- | ---------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
91
|
-
| `acceptedFileTypes` |
|
|
88
|
+
| `acceptedFileTypes` | string | A comma-separated list of allowed file extensions for uploading files. (e.g.,`.txt, .png, .pdf`). |
|
|
92
89
|
| `enableFilePreview` | boolean | A boolean flag indicating whether to use the default file previewer in the file manager. |
|
|
93
|
-
| `filePreviewPath` |
|
|
90
|
+
| `filePreviewPath` | string | The base URL for file previews e.g.`https://example.com`, file path will be appended automatically to it i.e. `https://example.com/yourFilePath`. |
|
|
94
91
|
| `fileUploadConfig` | { url: string; headers?: { [key: string]: string } } | Configuration object for file uploads. It includes the upload URL (`url`) and an optional `headers` object for setting custom HTTP headers in the upload request. The `headers` object can accept any standard or custom headers required by the server. Example: `{ url: "https://example.com/fileupload", headers: { Authorization: "Bearer" + TOKEN, "X-Custom-Header": "value" } }` |
|
|
95
92
|
| `files` | Array<[File](#-file-structure)> | An array of file and folder objects representing the current directory structure. Each object includes `name`, `isDirectory`, and `path` properties. |
|
|
93
|
+
| `height` | string \| number | The height of the component `default: 600px`. Can be a string (e.g., `'100%'`, `'10rem'`) or a number (in pixels). |
|
|
96
94
|
| `isLoading` | boolean | A boolean state indicating whether the application is currently performing an operation, such as creating, renaming, or deleting a file/folder. Displays a loading state if set `true`. |
|
|
97
95
|
| `layout` | "list" \| "grid" | Specifies the default layout style for the file manager. Can be either "list" or "grid". Default value is "grid". |
|
|
98
96
|
| `maxFileSize` | number | For limiting the maximum upload file size in bytes. |
|
|
@@ -107,6 +105,7 @@ Here is the updated table with the props sorted in ascending order by name:
|
|
|
107
105
|
| `onPaste` | (file: [File](#-file-structure), destinationFolder: [File](#-file-structure), operationType: "copy" \| "move") => void | A callback function triggered when a file or folder is pasted into a new location. Depending on `operationType`, use this to either copy or move the `sourceItem` to the `destinationFolder`, updating the files state accordingly. |
|
|
108
106
|
| `onRefresh` | () => void | A callback function triggered when the file manager is refreshed. Use this to refresh the `files` state to reflect any changes or updates. |
|
|
109
107
|
| `onRename` | (file: [File](#-file-structure), newName: string) => void | A callback function triggered when a file or folder is renamed. |
|
|
108
|
+
| `width` | string \| number | The width of the component `default: 100%`. Can be a string (e.g., `'100%'`, `'10rem'`) or a number (in pixels). |
|
|
110
109
|
|
|
111
110
|
## 🤝 Contributing
|
|
112
111
|
|