@scaleflex/widget-explorer 4.0.5 → 4.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.
- package/CHANGELOG.md +12 -0
- package/README.md +116 -149
- package/lib/components/AddFilesPanel/AddFiles.js +1 -1
- package/lib/components/DnD/index.js +3 -2
- package/lib/components/common/TopBarUploadButton/index.js +2 -2
- package/lib/hooks/useAssetsPicker.js +7 -7
- package/lib/index.js +4 -4
- package/lib/slices/views.slice.js +1 -2
- package/package.json +8 -8
- package/types/index.d.ts +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,18 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## [4.0.6](https://code.scaleflex.cloud/scaleflex/widget/compare/v4.0.0...v4.0.6) (2025-09-14)
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
### Bug Fixes
|
|
10
|
+
|
|
11
|
+
* update CodeSandbox links in HTML and README files to point to the new sandbox version for better user access ([cf4f794](https://code.scaleflex.cloud/scaleflex/widget/commits/cf4f7941cc3b79e5bb9ce604ff7a2f25665072a4))
|
|
12
|
+
* update output filename for Scaleflex widget CSS and adjust CDN links for consistency across various components ([244813e](https://code.scaleflex.cloud/scaleflex/widget/commits/244813e3100c606995ec8988484cf7697398f062))
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
|
|
6
18
|
## [4.0.5](https://code.scaleflex.cloud/scaleflex/widget/compare/v4.0.0...v4.0.5) (2025-09-10)
|
|
7
19
|
|
|
8
20
|
|
package/README.md
CHANGED
|
@@ -131,9 +131,26 @@ scaleflexWidget.use(Explorer, {
|
|
|
131
131
|
|
|
132
132
|
The Explorer supports multiple properties to customize the plugin according to your needs. Required attributes are marked with **_(Required)_**.
|
|
133
133
|
|
|
134
|
-
### `config`
|
|
135
134
|
|
|
136
|
-
|
|
135
|
+
### `locale` ![uploader-supported] ![asset-picker-supported] ![asset-manager-supported]
|
|
136
|
+
|
|
137
|
+
<u>Type:</u> `object`.
|
|
138
|
+
|
|
139
|
+
<u>Default:</u> locales from scaleflexWidget's backend then default locale file with all labels is under `lib/defaultLocale.js`.
|
|
140
|
+
|
|
141
|
+
You can override some labels by specifying a translation object here, such as:
|
|
142
|
+
|
|
143
|
+
```js
|
|
144
|
+
{
|
|
145
|
+
strings: {
|
|
146
|
+
baseFolderTitle: "Root"; // overrides the default Home value to Root
|
|
147
|
+
}
|
|
148
|
+
}
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
### `config` ![asset-picker-supported] ![asset-manager-supported]
|
|
152
|
+
|
|
153
|
+
<u>Type:</u> `object`
|
|
137
154
|
|
|
138
155
|
<u>Default:</u>
|
|
139
156
|
|
|
@@ -154,7 +171,7 @@ The Explorer supports multiple properties to customize the plugin according to y
|
|
|
154
171
|
|
|
155
172
|
The config objects contains the main configuration for the plugin to interact with your Scaleflex project:
|
|
156
173
|
|
|
157
|
-
#### `foldersLimit`
|
|
174
|
+
#### `foldersLimit` ![asset-picker-supported] ![asset-manager-supported]
|
|
158
175
|
|
|
159
176
|
<u>Type:</u> `number`.
|
|
160
177
|
|
|
@@ -162,7 +179,7 @@ The config objects contains the main configuration for the plugin to interact wi
|
|
|
162
179
|
|
|
163
180
|
Number of folders to be retrieved with folders initial request.
|
|
164
181
|
|
|
165
|
-
#### `maxCountOfSelectedFiles`
|
|
182
|
+
#### `maxCountOfSelectedFiles` ![asset-picker-supported] ![asset-manager-supported]
|
|
166
183
|
|
|
167
184
|
<u>Type:</u> `number`.
|
|
168
185
|
|
|
@@ -170,7 +187,7 @@ Number of folders to be retrieved with folders initial request.
|
|
|
170
187
|
|
|
171
188
|
Maximum number of files that can be selected.
|
|
172
189
|
|
|
173
|
-
#### `filesLimit`
|
|
190
|
+
#### `filesLimit` ![asset-picker-supported] ![asset-manager-supported]
|
|
174
191
|
|
|
175
192
|
<u>Type:</u> `number`.
|
|
176
193
|
|
|
@@ -178,7 +195,7 @@ Maximum number of files that can be selected.
|
|
|
178
195
|
|
|
179
196
|
Number of files to be retrieved with files initial request.
|
|
180
197
|
|
|
181
|
-
#### `rootFolderPath`
|
|
198
|
+
#### `rootFolderPath` ![uploader-supported] ![asset-picker-supported] ![asset-manager-supported]
|
|
182
199
|
|
|
183
200
|
<u>Type:</u> `string`.
|
|
184
201
|
|
|
@@ -188,7 +205,7 @@ Overrides the root folder path when there is no `list scope` linked with the [se
|
|
|
188
205
|
|
|
189
206
|
> Note: If the [securityTemplateId](..@scaleflex/widget-core/README.md/#securitytemplateid) has 2 folders at least, then the provided folder path must be one of these folders or one of their sub-folders.
|
|
190
207
|
|
|
191
|
-
#### `defaultSort`
|
|
208
|
+
#### `defaultSort` ![asset-picker-supported] ![asset-manager-supported]
|
|
192
209
|
|
|
193
210
|
<u>Type:</u> `object`.
|
|
194
211
|
|
|
@@ -205,7 +222,7 @@ The options available sorting
|
|
|
205
222
|
|
|
206
223
|
> Note: its value is considered only on plugin's install/mount.
|
|
207
224
|
|
|
208
|
-
#### `defaultSearchSort`
|
|
225
|
+
#### `defaultSearchSort` ![asset-picker-supported] ![asset-manager-supported]
|
|
209
226
|
|
|
210
227
|
<u>Type:</u> `object`.
|
|
211
228
|
|
|
@@ -229,7 +246,7 @@ The options available sorting
|
|
|
229
246
|
| **text.`by`** | `string` | `name` | Defines the default search sort by param, should be one of ['relevance', 'name', 'created_at', 'modified_at', 'size', 'type'] |
|
|
230
247
|
| **text.`order`** | `string` | `asc` | Defines the default search sort order param, should be one of ['asc', 'desc'] |
|
|
231
248
|
|
|
232
|
-
#### `tagging`
|
|
249
|
+
#### `tagging` ![asset-manager-supported]
|
|
233
250
|
|
|
234
251
|
<u>Type:</u> `object`.
|
|
235
252
|
|
|
@@ -274,7 +291,7 @@ The options available for tagging
|
|
|
274
291
|
}
|
|
275
292
|
```
|
|
276
293
|
|
|
277
|
-
### `inline`
|
|
294
|
+
### `inline` ![uploader-supported] ![asset-picker-supported] ![asset-manager-supported]
|
|
278
295
|
|
|
279
296
|
<u>Type:</u> `boolean`.
|
|
280
297
|
|
|
@@ -282,7 +299,7 @@ The options available for tagging
|
|
|
282
299
|
|
|
283
300
|
If set to `true`, the plugin will be displayed as inline element in the element referred by the [target](#target) property. Otherwise, it will pop up in a modal upon [trigger](#trigger), see below.
|
|
284
301
|
|
|
285
|
-
### `trigger`
|
|
302
|
+
### `trigger` ![uploader-supported] ![asset-picker-supported] ![asset-manager-supported]
|
|
286
303
|
|
|
287
304
|
<u>Type:</u> `string`.
|
|
288
305
|
|
|
@@ -297,7 +314,7 @@ Multiple triggers are supported as click events.
|
|
|
297
314
|
|
|
298
315
|
> **_Required if_** [inline](#inline): false
|
|
299
316
|
|
|
300
|
-
### `target`
|
|
317
|
+
### `target` ![uploader-supported] ![asset-picker-supported] ![asset-manager-supported]
|
|
301
318
|
|
|
302
319
|
<u>Type:</u> `string`.
|
|
303
320
|
|
|
@@ -310,7 +327,7 @@ The selector used for displaying the plugin, if passed to `querySelector` functi
|
|
|
310
327
|
|
|
311
328
|
> **_Required if_** [inline](#inline): false
|
|
312
329
|
|
|
313
|
-
### `width`
|
|
330
|
+
### `width` ![uploader-supported] ![asset-picker-supported] ![asset-manager-supported]
|
|
314
331
|
|
|
315
332
|
<u>Type:</u> `number`| `string`.
|
|
316
333
|
|
|
@@ -318,7 +335,7 @@ The selector used for displaying the plugin, if passed to `querySelector` functi
|
|
|
318
335
|
|
|
319
336
|
Width of the plugin as a number if specified in pixels or a percentage, eg. `'50%'`
|
|
320
337
|
|
|
321
|
-
### `height`
|
|
338
|
+
### `height` ![uploader-supported] ![asset-picker-supported] ![asset-manager-supported]
|
|
322
339
|
|
|
323
340
|
<u>Type:</u> `number`| `string`.
|
|
324
341
|
|
|
@@ -326,23 +343,23 @@ Width of the plugin as a number if specified in pixels or a percentage, eg. `'50
|
|
|
326
343
|
|
|
327
344
|
Height of the plugin as a number if specified in `px` or a percentage eg. `'35%'`
|
|
328
345
|
|
|
329
|
-
### `thumbnailWidth`
|
|
346
|
+
### `thumbnailWidth` ![uploader-supported] ![asset-picker-supported] ![asset-manager-supported]
|
|
330
347
|
|
|
331
348
|
<u>Type:</u> `number`.
|
|
332
349
|
|
|
333
350
|
<u>Default:</u> `280`
|
|
334
351
|
|
|
335
|
-
Pixel width of the asset thumbnails displayed in the
|
|
352
|
+
Pixel width of the asset thumbnails displayed in the uploads panel. Apect ratio of images is kept in case of image assets.
|
|
336
353
|
|
|
337
|
-
### `thumbnailHeight`
|
|
354
|
+
### `thumbnailHeight` ![uploader-supported] ![asset-picker-supported] ![asset-manager-supported]
|
|
338
355
|
|
|
339
356
|
<u>Type:</u> `number`.
|
|
340
357
|
|
|
341
358
|
<u>Default:</u> `170`
|
|
342
359
|
|
|
343
|
-
Pixel height of the asset thumbnails displayed in the
|
|
360
|
+
Pixel height of the asset thumbnails displayed in the uploads panel. Aspect ratio of images is kept in case of image assets.
|
|
344
361
|
|
|
345
|
-
### `ExploreViewComponent`
|
|
362
|
+
### `ExploreViewComponent` ![uploader-supported] ![asset-picker-supported] ![asset-manager-supported]
|
|
346
363
|
|
|
347
364
|
<u>Type:</u> `ReactComponent`.
|
|
348
365
|
|
|
@@ -352,7 +369,7 @@ Pixel height of the asset thumbnails displayed in the gallery. Aspect ratio of i
|
|
|
352
369
|
|
|
353
370
|
The view component that is responsible about showing the objects (folders/files...etc.) with the possibility to browse them and enable other functionalities.
|
|
354
371
|
|
|
355
|
-
### `mutedFilesUuids`
|
|
372
|
+
### `mutedFilesUuids` ![asset-picker-supported] ![asset-manager-supported]
|
|
356
373
|
|
|
357
374
|
<u>Type:</u> `array`.
|
|
358
375
|
|
|
@@ -360,7 +377,7 @@ The view component that is responsible about showing the objects (folders/files.
|
|
|
360
377
|
|
|
361
378
|
List of file UUIDs with the state "muted". These files cannot be selected or have any actions performed on them.
|
|
362
379
|
|
|
363
|
-
### `views`
|
|
380
|
+
### `views` ![asset-picker-supported] ![asset-manager-supported]
|
|
364
381
|
|
|
365
382
|
<u>Type:</u> `array`.
|
|
366
383
|
|
|
@@ -370,15 +387,7 @@ List of available views.
|
|
|
370
387
|
|
|
371
388
|
> **NOTE** some views can be hidden if you don't have permission provided in [securityTemplateId](..@scaleflex/widget-core/README.md/#securitytemplateid).
|
|
372
389
|
|
|
373
|
-
### `
|
|
374
|
-
|
|
375
|
-
<u>Type:</u> `string`.
|
|
376
|
-
|
|
377
|
-
<u>Default:</u> `'FOLDERS'`
|
|
378
|
-
|
|
379
|
-
View which will be opened by default.
|
|
380
|
-
|
|
381
|
-
### `view`
|
|
390
|
+
### `view` ![asset-picker-supported] ![asset-manager-supported]
|
|
382
391
|
|
|
383
392
|
<u>Type:</u> `string`.
|
|
384
393
|
|
|
@@ -386,7 +395,7 @@ View which will be opened by default.
|
|
|
386
395
|
|
|
387
396
|
View which will be currently opened.
|
|
388
397
|
|
|
389
|
-
### `viewItem`
|
|
398
|
+
### `viewItem` ![asset-picker-supported] ![asset-manager-supported]
|
|
390
399
|
|
|
391
400
|
<u>Type:</u> `string`.
|
|
392
401
|
|
|
@@ -396,7 +405,7 @@ Open the provided view's item/object for ex. (folders view => folder path, label
|
|
|
396
405
|
|
|
397
406
|
> Note: No auto redirect to the view, you have to provide the proper view from [`view prop`](#view).
|
|
398
407
|
|
|
399
|
-
### `viewSubItem`
|
|
408
|
+
### `viewSubItem` ![asset-picker-supported] ![asset-manager-supported]
|
|
400
409
|
|
|
401
410
|
<u>Type:</u> `string`.
|
|
402
411
|
|
|
@@ -406,7 +415,7 @@ A sub item that should be opened inside the provided [`view`](#view) & [`viewIte
|
|
|
406
415
|
|
|
407
416
|
> Note: No auto redirect to the view, you have to provide the proper view from [`view prop`](#view).
|
|
408
417
|
|
|
409
|
-
### `layoutType`
|
|
418
|
+
### `layoutType` ![asset-picker-supported] ![asset-manager-supported]
|
|
410
419
|
|
|
411
420
|
<u>Type:</u> `boolean`.
|
|
412
421
|
|
|
@@ -421,7 +430,7 @@ Specifies the default layout in the view:
|
|
|
421
430
|
|
|
422
431
|
you can switch between layouts from the layout selector button in the right side in header bar.
|
|
423
432
|
|
|
424
|
-
### `waitForThumbnailsBeforeUpload`
|
|
433
|
+
### `waitForThumbnailsBeforeUpload` ![uploader-supported] ![asset-picker-supported] ![asset-manager-supported]
|
|
425
434
|
|
|
426
435
|
<u>Type:</u> `boolean`.
|
|
427
436
|
|
|
@@ -429,7 +438,7 @@ you can switch between layouts from the layout selector button in the right side
|
|
|
429
438
|
|
|
430
439
|
If set to `true`, delays the start of the upload process until the asset thumbnails are generated and displayed in the plugin.
|
|
431
440
|
|
|
432
|
-
### `showBar`
|
|
441
|
+
### `showBar` ![asset-picker-supported] ![asset-manager-supported]
|
|
433
442
|
|
|
434
443
|
<u>Type:</u> `boolean`.
|
|
435
444
|
|
|
@@ -437,7 +446,7 @@ If set to `true`, delays the start of the upload process until the asset thumbna
|
|
|
437
446
|
|
|
438
447
|
If set to `false`, hides the top bar with **Upload** button, searchBar, create folder button and view button.
|
|
439
448
|
|
|
440
|
-
### `showImportFromDamButton`
|
|
449
|
+
### `showImportFromDamButton` ![uploader-supported] ![asset-picker-supported] ![asset-manager-supported]
|
|
441
450
|
|
|
442
451
|
<u>Type:</u> `boolean`.
|
|
443
452
|
|
|
@@ -447,7 +456,7 @@ If set to `true`, shows the **Import from DAM** button in the uploads panel to u
|
|
|
447
456
|
|
|
448
457
|
> Note: this property requires `ExploreViewComponent` to be provided to be able to browse the objects.
|
|
449
458
|
|
|
450
|
-
### `
|
|
459
|
+
### `disableUpload` ![asset-picker-supported] ![asset-manager-supported]
|
|
451
460
|
|
|
452
461
|
<u>Type:</u> `boolean`.
|
|
453
462
|
|
|
@@ -455,7 +464,7 @@ If set to `true`, shows the **Import from DAM** button in the uploads panel to u
|
|
|
455
464
|
|
|
456
465
|
If set to `true`, hides the **Upload** button at the top of the plugin.
|
|
457
466
|
|
|
458
|
-
### `hideSearch`
|
|
467
|
+
### `hideSearch` ![asset-picker-supported] ![asset-manager-supported]
|
|
459
468
|
|
|
460
469
|
<u>Type:</u> `boolean`.
|
|
461
470
|
|
|
@@ -463,7 +472,7 @@ If set to `true`, hides the **Upload** button at the top of the plugin.
|
|
|
463
472
|
|
|
464
473
|
Hides **Search** field at the top of the plugin.
|
|
465
474
|
|
|
466
|
-
### `note`
|
|
475
|
+
### `note` ![uploader-supported] ![asset-picker-supported] ![asset-manager-supported]
|
|
467
476
|
|
|
468
477
|
<u>Type:</u> `string`.
|
|
469
478
|
|
|
@@ -471,7 +480,7 @@ Hides **Search** field at the top of the plugin.
|
|
|
471
480
|
|
|
472
481
|
A custom note displayed in the upload screen for drag&drop.
|
|
473
482
|
|
|
474
|
-
### `hint`
|
|
483
|
+
### `hint` ![uploader-supported] ![asset-picker-supported] ![asset-manager-supported]
|
|
475
484
|
|
|
476
485
|
<u>Type:</u> `string`.
|
|
477
486
|
|
|
@@ -479,7 +488,7 @@ A custom note displayed in the upload screen for drag&drop.
|
|
|
479
488
|
|
|
480
489
|
A custom hint displayed in the upload screen at the bottom.
|
|
481
490
|
|
|
482
|
-
### `closeModalOnClickOutside`
|
|
491
|
+
### `closeModalOnClickOutside` ![uploader-supported] ![asset-picker-supported] ![asset-manager-supported]
|
|
483
492
|
|
|
484
493
|
<u>Type:</u> `boolean`.
|
|
485
494
|
|
|
@@ -489,7 +498,7 @@ Plugin modal will be closed when clicking outside of the modal.
|
|
|
489
498
|
|
|
490
499
|
> **_Only relevant if_** [inline](#inline): false
|
|
491
500
|
|
|
492
|
-
### `preventModalOverlayClickOnUpload`
|
|
501
|
+
### `preventModalOverlayClickOnUpload` ![uploader-supported] ![asset-picker-supported] ![asset-manager-supported]
|
|
493
502
|
|
|
494
503
|
<u>Type:</u> `boolean`.
|
|
495
504
|
|
|
@@ -499,7 +508,7 @@ Plugin modal still opened when click outside of it, if there's selected files to
|
|
|
499
508
|
|
|
500
509
|
> **_Only relevant if_** [closeModalOnClickOutside](#closeModalOnClickOutside): true
|
|
501
510
|
|
|
502
|
-
### `closeAfterFinish`
|
|
511
|
+
### `closeAfterFinish` ![uploader-supported] ![asset-picker-supported] ![asset-manager-supported]
|
|
503
512
|
|
|
504
513
|
<u>Type:</u> `boolean`.
|
|
505
514
|
|
|
@@ -509,7 +518,7 @@ Modal will close after upload is finished.
|
|
|
509
518
|
|
|
510
519
|
> **_Only relevant if_** [inline](#inline): false
|
|
511
520
|
|
|
512
|
-
### `closeAfterUploadStart`
|
|
521
|
+
### `closeAfterUploadStart` ![uploader-supported] ![asset-picker-supported] ![asset-manager-supported]
|
|
513
522
|
|
|
514
523
|
<u>Type:</u> `boolean`.
|
|
515
524
|
|
|
@@ -519,7 +528,7 @@ Modal will close after upload is started.
|
|
|
519
528
|
|
|
520
529
|
> **_Only relevant if_** [inline](#inline): false
|
|
521
530
|
|
|
522
|
-
### `onClickUploadButton`
|
|
531
|
+
### `onClickUploadButton` ![uploader-supported] ![asset-picker-supported] ![asset-manager-supported]
|
|
523
532
|
|
|
524
533
|
<u>Type:</u> `function`.
|
|
525
534
|
|
|
@@ -527,7 +536,7 @@ Modal will close after upload is started.
|
|
|
527
536
|
|
|
528
537
|
A callback function that would be triggered when the user clicks on upload button that is shown in the uploads panel, if returned `true` then the default upload functionality won't be triggered.
|
|
529
538
|
|
|
530
|
-
### `disableInformer`
|
|
539
|
+
### `disableInformer` ![uploader-supported] ![asset-picker-supported] ![asset-manager-supported]
|
|
531
540
|
|
|
532
541
|
<u>Type:</u> `boolean`.
|
|
533
542
|
|
|
@@ -535,7 +544,7 @@ A callback function that would be triggered when the user clicks on upload butto
|
|
|
535
544
|
|
|
536
545
|
Disables the [informer](../@scaleflex/widget-informer/#scaleflexwidget-informer) plugin used to show warnings and errors.
|
|
537
546
|
|
|
538
|
-
### `disableThumbnailGenerator`
|
|
547
|
+
### `disableThumbnailGenerator` ![uploader-supported] ![asset-picker-supported] ![asset-manager-supported]
|
|
539
548
|
|
|
540
549
|
<u>Type:</u> `boolean`.
|
|
541
550
|
|
|
@@ -543,7 +552,7 @@ Disables the [informer](../@scaleflex/widget-informer/#scaleflexwidget-informer)
|
|
|
543
552
|
|
|
544
553
|
Disables the [thumbnail-generator](../@scaleflex/widget-thumbnail-generator/#scaleflexwidget-thumbnail-generator) plugin that generates image thumbnails.
|
|
545
554
|
|
|
546
|
-
### `disablePageScrollWhenModalOpen`
|
|
555
|
+
### `disablePageScrollWhenModalOpen` ![uploader-supported] ![asset-picker-supported] ![asset-manager-supported]
|
|
547
556
|
|
|
548
557
|
<u>Type:</u> `boolean`.
|
|
549
558
|
|
|
@@ -553,7 +562,7 @@ If set to `true`, disables scrolling for the document while the plugin modal is
|
|
|
553
562
|
|
|
554
563
|
> **_Only relevant if_** [inline](#inline): false
|
|
555
564
|
|
|
556
|
-
### `disableDownloadButton`
|
|
565
|
+
### `disableDownloadButton` ![asset-picker-supported] ![asset-manager-supported]
|
|
557
566
|
|
|
558
567
|
<u>Type:</u> `boolean`.
|
|
559
568
|
|
|
@@ -561,7 +570,7 @@ If set to `true`, disables scrolling for the document while the plugin modal is
|
|
|
561
570
|
|
|
562
571
|
Hides the download button shown in the action bar when selecting files.
|
|
563
572
|
|
|
564
|
-
### `preventDownloadDefaultBehavior`
|
|
573
|
+
### `preventDownloadDefaultBehavior` ![asset-picker-supported] ![asset-manager-supported]
|
|
565
574
|
|
|
566
575
|
<u>Type:</u> `boolean`.
|
|
567
576
|
|
|
@@ -569,7 +578,7 @@ Hides the download button shown in the action bar when selecting files.
|
|
|
569
578
|
|
|
570
579
|
Prevent default behavior of download/export.
|
|
571
580
|
|
|
572
|
-
### `hideDownloadVariationsOption`
|
|
581
|
+
### `hideDownloadVariationsOption` ![asset-picker-supported] ![asset-manager-supported]
|
|
573
582
|
|
|
574
583
|
<u>Type:</u> `boolean`.
|
|
575
584
|
|
|
@@ -577,7 +586,7 @@ Prevent default behavior of download/export.
|
|
|
577
586
|
|
|
578
587
|
Hide transformation in download options in context menu and action bar.
|
|
579
588
|
|
|
580
|
-
### `hideDownloadButtonIcon`
|
|
589
|
+
### `hideDownloadButtonIcon` ![asset-picker-supported] ![asset-manager-supported]
|
|
581
590
|
|
|
582
591
|
<u>Type:</u> `boolean`.
|
|
583
592
|
|
|
@@ -585,7 +594,7 @@ Hide transformation in download options in context menu and action bar.
|
|
|
585
594
|
|
|
586
595
|
Hides the download/export button icon.
|
|
587
596
|
|
|
588
|
-
### `hideHeaderBar`
|
|
597
|
+
### `hideHeaderBar` ![asset-picker-supported] ![asset-manager-supported]
|
|
589
598
|
|
|
590
599
|
<u>Type:</u> `boolean`.
|
|
591
600
|
|
|
@@ -593,7 +602,7 @@ Hides the download/export button icon.
|
|
|
593
602
|
|
|
594
603
|
Hides the header bar, header bar contains breadcrumbs and other action buttons.
|
|
595
604
|
|
|
596
|
-
### `hideExportCropPanel`
|
|
605
|
+
### `hideExportCropPanel` ![asset-picker-supported] ![asset-manager-supported]
|
|
597
606
|
|
|
598
607
|
<u>Type:</u> `boolean`.
|
|
599
608
|
|
|
@@ -601,7 +610,7 @@ Hides the header bar, header bar contains breadcrumbs and other action buttons.
|
|
|
601
610
|
|
|
602
611
|
The crop button in the export options modal will be hidden.
|
|
603
612
|
|
|
604
|
-
### `forceDownload`
|
|
613
|
+
### `forceDownload` ![asset-picker-supported] ![asset-manager-supported]
|
|
605
614
|
|
|
606
615
|
<u>Type:</u> `boolean`.
|
|
607
616
|
|
|
@@ -609,23 +618,7 @@ The crop button in the export options modal will be hidden.
|
|
|
609
618
|
|
|
610
619
|
Adds `download=1` param to the CDN download link
|
|
611
620
|
|
|
612
|
-
### `
|
|
613
|
-
|
|
614
|
-
<u>Type:</u> `object`.
|
|
615
|
-
|
|
616
|
-
<u>Default:</u> `null`
|
|
617
|
-
|
|
618
|
-
Apply the provided filters on initial load.
|
|
619
|
-
|
|
620
|
-
### `defaultSearchQuery` _Deprecated_ - use [`search.query`](#search) instead
|
|
621
|
-
|
|
622
|
-
<u>Type:</u> `string`.
|
|
623
|
-
|
|
624
|
-
<u>Default:</u> `''`
|
|
625
|
-
|
|
626
|
-
Apply the provided search query on initial load.
|
|
627
|
-
|
|
628
|
-
### `imageEditorMode`
|
|
621
|
+
### `imageEditorMode` ![asset-manager-supported]
|
|
629
622
|
|
|
630
623
|
<u>Type:</u> `string`.
|
|
631
624
|
|
|
@@ -635,7 +628,7 @@ Possible values: `'default' | 'cloudimage' `
|
|
|
635
628
|
|
|
636
629
|
Set imageEditorMode for the image editor plugin.
|
|
637
630
|
|
|
638
|
-
### `hideModalAfterExport`
|
|
631
|
+
### `hideModalAfterExport` ![asset-picker-supported] ![asset-manager-supported]
|
|
639
632
|
|
|
640
633
|
<u>Type:</u> `boolean`.
|
|
641
634
|
|
|
@@ -643,7 +636,7 @@ Set imageEditorMode for the image editor plugin.
|
|
|
643
636
|
|
|
644
637
|
Hides the modal after finish download/export.
|
|
645
638
|
|
|
646
|
-
### `closeAfterImageEdit`
|
|
639
|
+
### `closeAfterImageEdit` ![asset-manager-supported]
|
|
647
640
|
|
|
648
641
|
<u>Type:</u> `boolean`.
|
|
649
642
|
|
|
@@ -651,7 +644,7 @@ Hides the modal after finish download/export.
|
|
|
651
644
|
|
|
652
645
|
Hides the modal after finish editing image.
|
|
653
646
|
|
|
654
|
-
### `onRequestCloseModal`
|
|
647
|
+
### `onRequestCloseModal` ![uploader-supported] ![asset-picker-supported] ![asset-manager-supported]
|
|
655
648
|
|
|
656
649
|
<u>Type:</u> `() => undefined`.
|
|
657
650
|
|
|
@@ -661,7 +654,7 @@ Specified a custom function to be executed when trying to close the modal. Defau
|
|
|
661
654
|
|
|
662
655
|
> **_Only relevant if_** [inline](#inline): false
|
|
663
656
|
|
|
664
|
-
### `animateOpenClose`
|
|
657
|
+
### `animateOpenClose` ![uploader-supported] ![asset-picker-supported] ![asset-manager-supported]
|
|
665
658
|
|
|
666
659
|
<u>Type:</u> `boolean`.
|
|
667
660
|
|
|
@@ -671,32 +664,7 @@ Disable the modal's opening and closing.
|
|
|
671
664
|
|
|
672
665
|
> **_Only relevant if_** [inline](#inline): false
|
|
673
666
|
|
|
674
|
-
### `
|
|
675
|
-
|
|
676
|
-
<u>Type:</u> `object`.
|
|
677
|
-
|
|
678
|
-
<u>Default:</u> locales from scaleflexWidget's backend then default locale file with all labels is under `lib/defaultLocale.js`.
|
|
679
|
-
|
|
680
|
-
You can override some labels by specifying a translation object here, such as:
|
|
681
|
-
|
|
682
|
-
```js
|
|
683
|
-
{
|
|
684
|
-
strings: {
|
|
685
|
-
baseFolderTitle: "Root"; // overrides the default Home value to Root
|
|
686
|
-
}
|
|
687
|
-
}
|
|
688
|
-
```
|
|
689
|
-
|
|
690
|
-
<!-- not supported yet -->
|
|
691
|
-
<!-- ### `theme: string`
|
|
692
|
-
|
|
693
|
-
<u>Default:</u> `'light'`
|
|
694
|
-
|
|
695
|
-
- **light**: uses the light theme
|
|
696
|
-
- **dark**: uses the dark theme
|
|
697
|
-
- **auto**: respects the user's default mode -->
|
|
698
|
-
|
|
699
|
-
### `browserBackButtonCloseModal`
|
|
667
|
+
### `browserBackButtonCloseModal` ![uploader-supported] ![asset-picker-supported] ![asset-manager-supported]
|
|
700
668
|
|
|
701
669
|
<u>Type:</u> `boolean`.
|
|
702
670
|
|
|
@@ -706,7 +674,7 @@ The browser **Back** button will close the modal, otherwise it will trigger the
|
|
|
706
674
|
|
|
707
675
|
> **_Only relevant if_** [inline](#inline): false
|
|
708
676
|
|
|
709
|
-
### `enableFoldersStatsApiRequest`
|
|
677
|
+
### `enableFoldersStatsApiRequest` ![asset-picker-supported] ![asset-manager-supported]
|
|
710
678
|
|
|
711
679
|
<u>Type:</u> `boolean`.
|
|
712
680
|
|
|
@@ -714,7 +682,7 @@ The browser **Back** button will close the modal, otherwise it will trigger the
|
|
|
714
682
|
|
|
715
683
|
When enabled it will send extra folders/stats API request with the folders request to get folders count.
|
|
716
684
|
|
|
717
|
-
### `isUploadBarAddMoreButtonHidden`
|
|
685
|
+
### `isUploadBarAddMoreButtonHidden` ![uploader-supported] ![asset-picker-supported] ![asset-manager-supported]
|
|
718
686
|
|
|
719
687
|
<u>Type:</u> `boolean`.
|
|
720
688
|
|
|
@@ -722,7 +690,7 @@ When enabled it will send extra folders/stats API request with the folders reque
|
|
|
722
690
|
|
|
723
691
|
The 'Add More' button in upload module is hidden preventing users to upload more item.
|
|
724
692
|
|
|
725
|
-
### `showFoldersTree`
|
|
693
|
+
### `showFoldersTree` ![asset-picker-supported] ![asset-manager-supported]
|
|
726
694
|
|
|
727
695
|
<u>Type:</u> `boolean`.
|
|
728
696
|
|
|
@@ -731,13 +699,8 @@ The 'Add More' button in upload module is hidden preventing users to upload more
|
|
|
731
699
|
Shows/hides on initial load the folder tree as a sidebar at the left of the plugin to navigate folders. The user can shows/hides the folder tree from the tree icon in the breadcrumbs.
|
|
732
700
|
|
|
733
701
|
> **_Only relevant if_** folders view is provided in [views](#views)
|
|
734
|
-
<u>Type:</u> `boolean`.
|
|
735
|
-
|
|
736
|
-
<u>Default:</u> `false`
|
|
737
|
-
|
|
738
|
-
Shows/hides the label tree as a sidebar at the left of the plugin to navigate labels. The user can shows/hides the label tree from the tree icon in the breadcrumbs.
|
|
739
702
|
|
|
740
|
-
### `showDetailsView`
|
|
703
|
+
### `showDetailsView` ![asset-picker-supported] ![asset-manager-supported]
|
|
741
704
|
|
|
742
705
|
<u>Type:</u> `boolean`.
|
|
743
706
|
|
|
@@ -745,7 +708,7 @@ Shows/hides the label tree as a sidebar at the left of the plugin to navigate la
|
|
|
745
708
|
|
|
746
709
|
Shows/hides the asset details view as a sidebar at the right of the plugin to view various details about selected assets. The user can shows/hides the details view from the info icon in the right side of the breadcrumbs.
|
|
747
710
|
|
|
748
|
-
### `hideDetailsViewButton`
|
|
711
|
+
### `hideDetailsViewButton` ![asset-picker-supported] ![asset-manager-supported]
|
|
749
712
|
|
|
750
713
|
<u>Type:</u> `boolean`.
|
|
751
714
|
|
|
@@ -753,7 +716,7 @@ Shows/hides the asset details view as a sidebar at the right of the plugin to vi
|
|
|
753
716
|
|
|
754
717
|
Hides the asset details view button from the info icon in the right side of the breadcrumbs.
|
|
755
718
|
|
|
756
|
-
### `videoTranscoding`
|
|
719
|
+
### `videoTranscoding` ![uploader-supported] ![asset-picker-supported] ![asset-manager-supported]
|
|
757
720
|
|
|
758
721
|
<u>Type:</u> `object`.
|
|
759
722
|
|
|
@@ -773,7 +736,7 @@ Video transcoding options for post-upload video transcoding:
|
|
|
773
736
|
| **`resolution`** | `string` _required_ | `auto` | target resolutions for video transcoding |
|
|
774
737
|
| **`protocol`** | `string` _required_ | `HLS` | which protocol to use while transcoding |
|
|
775
738
|
|
|
776
|
-
### `cropPresets`
|
|
739
|
+
### `cropPresets` ![asset-picker-supported] ![asset-manager-supported]
|
|
777
740
|
|
|
778
741
|
<u>Type:</u> `object`.
|
|
779
742
|
|
|
@@ -805,7 +768,7 @@ Defines additional crop types & presets besides the freehand one and their prese
|
|
|
805
768
|
|
|
806
769
|
> NOTE: The object's keys will be used the label for crop type (it is possible to be label string or i18n key string that is provided through locale object)
|
|
807
770
|
|
|
808
|
-
### `disableMultipleSelect`
|
|
771
|
+
### `disableMultipleSelect` ![asset-picker-supported] ![asset-manager-supported]
|
|
809
772
|
|
|
810
773
|
<u>Type:</u> `boolean`.
|
|
811
774
|
|
|
@@ -813,7 +776,7 @@ Defines additional crop types & presets besides the freehand one and their prese
|
|
|
813
776
|
|
|
814
777
|
Multiple files/folders selections will be disabled and only 1 file/folder possible to be selected.
|
|
815
778
|
|
|
816
|
-
### `dismissUrlPathQueryUpdate`
|
|
779
|
+
### `dismissUrlPathQueryUpdate` ![asset-picker-supported] ![asset-manager-supported]
|
|
817
780
|
|
|
818
781
|
<u>Type:</u> `boolean`.
|
|
819
782
|
|
|
@@ -821,7 +784,7 @@ Multiple files/folders selections will be disabled and only 1 file/folder possib
|
|
|
821
784
|
|
|
822
785
|
The url query `fmaw_path` won't be added/updated to the current url.
|
|
823
786
|
|
|
824
|
-
### `showScaleflexCopyright`
|
|
787
|
+
### `showScaleflexCopyright` ![uploader-supported] ![asset-picker-supported] ![asset-manager-supported]
|
|
825
788
|
|
|
826
789
|
<u>Type:</u> `boolean`.
|
|
827
790
|
|
|
@@ -829,7 +792,7 @@ The url query `fmaw_path` won't be added/updated to the current url.
|
|
|
829
792
|
|
|
830
793
|
Hides Scaleflex copyright at the bottom of the plugin.
|
|
831
794
|
|
|
832
|
-
### `useAssetsPicker`
|
|
795
|
+
### `useAssetsPicker` ![asset-picker-supported]
|
|
833
796
|
|
|
834
797
|
<u>Type:</u> `boolean`.
|
|
835
798
|
|
|
@@ -837,7 +800,7 @@ Hides Scaleflex copyright at the bottom of the plugin.
|
|
|
837
800
|
|
|
838
801
|
If set to `true`, actions like deleting, editing, or downloading assets will not be allowed, explore and insert actions allowed.
|
|
839
802
|
|
|
840
|
-
### `assetsPickerModelTitle`
|
|
803
|
+
### `assetsPickerModelTitle` ![asset-picker-supported]
|
|
841
804
|
|
|
842
805
|
<u>Type:</u> `string`.
|
|
843
806
|
|
|
@@ -845,7 +808,7 @@ If set to `true`, actions like deleting, editing, or downloading assets will not
|
|
|
845
808
|
|
|
846
809
|
changing it's value changes the asset picker's model title
|
|
847
810
|
|
|
848
|
-
### `disableFolderSelection`
|
|
811
|
+
### `disableFolderSelection` ![asset-manager-supported]
|
|
849
812
|
|
|
850
813
|
<u>Type:</u> `boolean`.
|
|
851
814
|
|
|
@@ -853,7 +816,7 @@ changing it's value changes the asset picker's model title
|
|
|
853
816
|
|
|
854
817
|
If set to `true`, disable the possiblity to select folder(s).
|
|
855
818
|
|
|
856
|
-
### `hideFolderOptions`
|
|
819
|
+
### `hideFolderOptions` ![asset-manager-supported]
|
|
857
820
|
|
|
858
821
|
<u>Type:</u> `boolean`.
|
|
859
822
|
|
|
@@ -861,7 +824,7 @@ If set to `true`, disable the possiblity to select folder(s).
|
|
|
861
824
|
|
|
862
825
|
If set to `true`, hide the folder item top options.
|
|
863
826
|
|
|
864
|
-
### `hideDetailsSidebarButton`
|
|
827
|
+
### `hideDetailsSidebarButton` ![asset-picker-supported] ![asset-manager-supported]
|
|
865
828
|
|
|
866
829
|
<u>Type:</u> `boolean`.
|
|
867
830
|
|
|
@@ -869,7 +832,7 @@ If set to `true`, hide the folder item top options.
|
|
|
869
832
|
|
|
870
833
|
If set to `true`, hide toggle details sidebar button.
|
|
871
834
|
|
|
872
|
-
### `hideActionBarSelectionButtons`
|
|
835
|
+
### `hideActionBarSelectionButtons` ![asset-picker-supported] ![asset-manager-supported]
|
|
873
836
|
|
|
874
837
|
<u>Type:</u> `boolean`.
|
|
875
838
|
|
|
@@ -877,7 +840,7 @@ If set to `true`, hide toggle details sidebar button.
|
|
|
877
840
|
|
|
878
841
|
If set to `true`, hide the selection buttons in the action bar.
|
|
879
842
|
|
|
880
|
-
### `disableDnDActions`
|
|
843
|
+
### `disableDnDActions` ![asset-picker-supported] ![asset-manager-supported]
|
|
881
844
|
|
|
882
845
|
<u>Type:</u> `boolean`.
|
|
883
846
|
|
|
@@ -885,7 +848,7 @@ If set to `true`, hide the selection buttons in the action bar.
|
|
|
885
848
|
|
|
886
849
|
If set to `true`, disable the drag and drop actions to move assets/folders or upload
|
|
887
850
|
|
|
888
|
-
### `noImgOperationsAndDownload`
|
|
851
|
+
### `noImgOperationsAndDownload` ![asset-picker-supported] ![asset-manager-supported]
|
|
889
852
|
|
|
890
853
|
<u>Type:</u> `boolean`.
|
|
891
854
|
|
|
@@ -897,7 +860,7 @@ If set to `true`, hides some options in asset contextual menu:
|
|
|
897
860
|
- Transformation (action bar)
|
|
898
861
|
- Edit image (context menu and action bar)
|
|
899
862
|
|
|
900
|
-
### `queryParamPrefix`
|
|
863
|
+
### `queryParamPrefix` ![asset-picker-supported] ![asset-manager-supported]
|
|
901
864
|
|
|
902
865
|
<u>Type:</u> `string`.
|
|
903
866
|
|
|
@@ -905,7 +868,7 @@ If set to `true`, hides some options in asset contextual menu:
|
|
|
905
868
|
|
|
906
869
|
Override the query params
|
|
907
870
|
|
|
908
|
-
### `showDragDropPanel`
|
|
871
|
+
### `showDragDropPanel` ![uploader-supported] ![asset-picker-supported] ![asset-manager-supported]
|
|
909
872
|
|
|
910
873
|
<u>Type:</u> `boolean`.
|
|
911
874
|
|
|
@@ -913,7 +876,7 @@ Override the query params
|
|
|
913
876
|
|
|
914
877
|
Changes the design for the addFiles panel in uploads.
|
|
915
878
|
|
|
916
|
-
### `showSort`
|
|
879
|
+
### `showSort` ![asset-picker-supported] ![asset-manager-supported]
|
|
917
880
|
|
|
918
881
|
<u>Type:</u> `boolean`.
|
|
919
882
|
|
|
@@ -921,7 +884,7 @@ Changes the design for the addFiles panel in uploads.
|
|
|
921
884
|
|
|
922
885
|
shows/hides sort button in Explorer.
|
|
923
886
|
|
|
924
|
-
### `isDownloadUsageRightsEnabled`
|
|
887
|
+
### `isDownloadUsageRightsEnabled` ![asset-picker-supported] ![asset-manager-supported]
|
|
925
888
|
|
|
926
889
|
<u>Type:</u> `boolean`.
|
|
927
890
|
|
|
@@ -929,7 +892,7 @@ shows/hides sort button in Explorer.
|
|
|
929
892
|
|
|
930
893
|
Enables/disables the download of usage rights file with assets.
|
|
931
894
|
|
|
932
|
-
### `useLoginMode`
|
|
895
|
+
### `useLoginMode` ![uploader-supported] ![asset-picker-supported] ![asset-manager-supported]
|
|
933
896
|
|
|
934
897
|
<u>Type:</u> `boolean`.
|
|
935
898
|
|
|
@@ -939,7 +902,7 @@ Enables/disables the login mode which gives the user the possibility to login by
|
|
|
939
902
|
|
|
940
903
|
> Note: Don't provide security template key nor sass key if you need to use enable this feature by providing its value to `true`.
|
|
941
904
|
|
|
942
|
-
### `prefilledLoginModeEmail`
|
|
905
|
+
### `prefilledLoginModeEmail` ![uploader-supported] ![asset-picker-supported] ![asset-manager-supported]
|
|
943
906
|
|
|
944
907
|
<u>Type:</u> `string`.
|
|
945
908
|
|
|
@@ -947,7 +910,7 @@ Enables/disables the login mode which gives the user the possibility to login by
|
|
|
947
910
|
|
|
948
911
|
The property used to add a default email address in the email address field of the login mode form, if not provided the email address will be empty. In both cases, the user will be able to change/add his email address and this property is used by having [`useLoginMode`](#useloginmode) enabled.
|
|
949
912
|
|
|
950
|
-
### `hideAddingComment`
|
|
913
|
+
### `hideAddingComment` ![asset-manager-supported]
|
|
951
914
|
|
|
952
915
|
<u>Type:</u> `boolean`.
|
|
953
916
|
|
|
@@ -955,7 +918,7 @@ The property used to add a default email address in the email address field of t
|
|
|
955
918
|
|
|
956
919
|
Removes the add comment textarea from the comments tab.
|
|
957
920
|
|
|
958
|
-
### `findAssetLocationEnabled`
|
|
921
|
+
### `findAssetLocationEnabled` ![asset-manager-supported]
|
|
959
922
|
|
|
960
923
|
<u>Type:</u> `boolean`.
|
|
961
924
|
|
|
@@ -963,7 +926,7 @@ Removes the add comment textarea from the comments tab.
|
|
|
963
926
|
|
|
964
927
|
Providing `false`, will hide `Open asset location` option in the context menu and file window.
|
|
965
928
|
|
|
966
|
-
### `restrictedSearchContext`
|
|
929
|
+
### `restrictedSearchContext` ![asset-picker-supported] ![asset-manager-supported]
|
|
967
930
|
|
|
968
931
|
<u>Type:</u> `boolean`.
|
|
969
932
|
|
|
@@ -971,7 +934,7 @@ Providing `false`, will hide `Open asset location` option in the context menu an
|
|
|
971
934
|
|
|
972
935
|
Providing `true`, will disable the possibility of selecting other search contexts and always force the user to use the current opened view's context.
|
|
973
936
|
|
|
974
|
-
### `facetedSearchEnabled`
|
|
937
|
+
### `facetedSearchEnabled` ![asset-picker-supported] ![asset-manager-supported]
|
|
975
938
|
|
|
976
939
|
<u>Type:</u> `boolean`.
|
|
977
940
|
|
|
@@ -984,7 +947,7 @@ Faceted search allows users to filter files using metadata filters. When this fe
|
|
|
984
947
|
|
|
985
948
|
_Note_: Faceted search is only active in the assets view.
|
|
986
949
|
|
|
987
|
-
### `facetedSearchSidebarExpanded`
|
|
950
|
+
### `facetedSearchSidebarExpanded` ![asset-picker-supported] ![asset-manager-supported]
|
|
988
951
|
|
|
989
952
|
<u>Type:</u> `boolean`.
|
|
990
953
|
|
|
@@ -994,7 +957,7 @@ expands faceted search sidebar by default.
|
|
|
994
957
|
|
|
995
958
|
_Note_: if `facetedSearchEnabled` is false, this property will be ignored.
|
|
996
959
|
|
|
997
|
-
### `activeFacetedSearchMetadataFields`
|
|
960
|
+
### `activeFacetedSearchMetadataFields` ![asset-picker-supported] ![asset-manager-supported]
|
|
998
961
|
|
|
999
962
|
<u>Type:</u> `array`.
|
|
1000
963
|
|
|
@@ -1004,7 +967,7 @@ Array of metadata fields keys to be shown on faceted search.
|
|
|
1004
967
|
|
|
1005
968
|
_Note_: only exist filters will be shown.
|
|
1006
969
|
|
|
1007
|
-
### `filters`
|
|
970
|
+
### `filters` ![asset-picker-supported] ![asset-manager-supported]
|
|
1008
971
|
|
|
1009
972
|
<u>Type:</u> `object`.
|
|
1010
973
|
|
|
@@ -1116,7 +1079,7 @@ Filters to be applied to the views that accept filters, and will be locked if `d
|
|
|
1116
1079
|
|
|
1117
1080
|
> Note: Operators are allowed to be provided for all the above filters but some of them are not supported on BE.
|
|
1118
1081
|
|
|
1119
|
-
### `search`
|
|
1082
|
+
### `search` ![asset-picker-supported] ![asset-manager-supported]
|
|
1120
1083
|
|
|
1121
1084
|
<u>Type:</u> `object`.
|
|
1122
1085
|
|
|
@@ -1145,7 +1108,7 @@ Search object to be considered in the views have searching enabled and will be l
|
|
|
1145
1108
|
|
|
1146
1109
|
> Note: To lock any of the above properties by using `disabledFiltersAndSearch` then you have to provide a value for the property to be locked at least empty value would be fine.
|
|
1147
1110
|
|
|
1148
|
-
### `disableFiltersAndSearch`
|
|
1111
|
+
### `disableFiltersAndSearch` ![asset-picker-supported] ![asset-manager-supported]
|
|
1149
1112
|
|
|
1150
1113
|
<u>Type:</u> `boolean`.
|
|
1151
1114
|
|
|
@@ -1157,13 +1120,13 @@ If `true` then the only provided `filters` & `search` objects will be used as fi
|
|
|
1157
1120
|
|
|
1158
1121
|
> Note: Enabling this option will dismiss applying the filters & search from the url queries.
|
|
1159
1122
|
|
|
1160
|
-
### `forceFilters`
|
|
1123
|
+
### `forceFilters` ![asset-picker-supported] ![asset-manager-supported]
|
|
1161
1124
|
|
|
1162
1125
|
If `true` then the provided `filters` will always get applied with no possibility to remove from the UI, but the user still has the option to extend with more filters from the UI unless the provided filter accepts 1 value only.
|
|
1163
1126
|
|
|
1164
1127
|
> Note: Enabling this option will dismiss applying the filters from the url queries.
|
|
1165
1128
|
|
|
1166
|
-
### `disableFileResolutionFallback`
|
|
1129
|
+
### `disableFileResolutionFallback` ![asset-picker-supported] ![asset-manager-supported]
|
|
1167
1130
|
|
|
1168
1131
|
<u>Type:</u> `boolean`.
|
|
1169
1132
|
|
|
@@ -1171,7 +1134,7 @@ If `true` then the provided `filters` will always get applied with no possibilit
|
|
|
1171
1134
|
|
|
1172
1135
|
If `true` it will disable fallback request to load resolution info if not found in file details in grid/list layout.
|
|
1173
1136
|
|
|
1174
|
-
### `hideLeftSideBar`
|
|
1137
|
+
### `hideLeftSideBar` ![asset-picker-supported] ![asset-manager-supported]
|
|
1175
1138
|
|
|
1176
1139
|
<u>Type:</u> `boolean`.
|
|
1177
1140
|
|
|
@@ -1179,7 +1142,7 @@ If `true` it will disable fallback request to load resolution info if not found
|
|
|
1179
1142
|
|
|
1180
1143
|
Hide the folders tree sidebar and its toggle icon.
|
|
1181
1144
|
|
|
1182
|
-
### `defaultFieldKeyOfBulkEditPanel
|
|
1145
|
+
### `defaultFieldKeyOfBulkEditPanel`![uploader-supported] ![asset-manager-supported]
|
|
1183
1146
|
|
|
1184
1147
|
<u>Type:</u> `string`.
|
|
1185
1148
|
|
|
@@ -1187,7 +1150,7 @@ Hide the folders tree sidebar and its toggle icon.
|
|
|
1187
1150
|
|
|
1188
1151
|
Assigns the default field of the bulk edit panel to be opened on showing the bulk edit panel as the focused/default field, it should be one of the general field keys (`tags`/`title`/`description`) or any field key -- lowered case -- of the shown file custom metadata fields (depends on the token).
|
|
1189
1152
|
|
|
1190
|
-
### `enableAIDescription`
|
|
1153
|
+
### `enableAIDescription` ![asset-manager-supported]
|
|
1191
1154
|
|
|
1192
1155
|
<u>Type:</u> `boolean`.
|
|
1193
1156
|
|
|
@@ -1195,7 +1158,7 @@ Assigns the default field of the bulk edit panel to be opened on showing the bul
|
|
|
1195
1158
|
|
|
1196
1159
|
Enables the generate description by AI in the description input of file window.
|
|
1197
1160
|
|
|
1198
|
-
### `hideVariationsTab`
|
|
1161
|
+
### `hideVariationsTab` ![asset-manager-supported]
|
|
1199
1162
|
|
|
1200
1163
|
<u>Type:</u> `boolean`.
|
|
1201
1164
|
|
|
@@ -1203,7 +1166,7 @@ Enables the generate description by AI in the description input of file window.
|
|
|
1203
1166
|
|
|
1204
1167
|
If `true` force hides the variations tab in file window panel.
|
|
1205
1168
|
|
|
1206
|
-
### `hideMetadataTab`
|
|
1169
|
+
### `hideMetadataTab` ![asset-manager-supported]
|
|
1207
1170
|
|
|
1208
1171
|
<u>Type:</u> `boolean`.
|
|
1209
1172
|
|
|
@@ -1215,7 +1178,7 @@ If `true` force hides the metadata tab in file window panel.
|
|
|
1215
1178
|
|
|
1216
1179
|
The explorer plugin emits different events that you could subscribe to or add your handler to be called with the provided arguments passed while emitting/firing the event, the events are listed below with examples show the parameters for handler:
|
|
1217
1180
|
|
|
1218
|
-
### `objects-removed`
|
|
1181
|
+
### `objects-removed` ![asset-manager-supported]
|
|
1219
1182
|
|
|
1220
1183
|
Emitted when objects (folders/labels/files) have been removed from the user's side.
|
|
1221
1184
|
|
|
@@ -1236,7 +1199,7 @@ scaleflexWidget.on("objects-removed", (removedObjectsUuids = [], objectsType) =>
|
|
|
1236
1199
|
});
|
|
1237
1200
|
```
|
|
1238
1201
|
|
|
1239
|
-
### `folders-moved`
|
|
1202
|
+
### `folders-moved` ![asset-manager-supported]
|
|
1240
1203
|
|
|
1241
1204
|
Emitted when folder(s) are moved from path to another.
|
|
1242
1205
|
|
|
@@ -1267,3 +1230,7 @@ scaleflexWidget.on('objects-removed', (movedFoldersUuids = [], newPath) => {
|
|
|
1267
1230
|
[filerobot-image]: https://img.shields.io/static/v1?label=Scaleflex&message=website&color=orange&style=for-the-badge
|
|
1268
1231
|
[filerobot-version]: https://img.shields.io/npm/v/@scaleflex/widget-explorer?label=Version&style=for-the-badge&logo=npm
|
|
1269
1232
|
[codeSandbox-image]: https://img.shields.io/badge/CodeSandbox-black?style=for-the-badge&logo=CodeSandbox
|
|
1233
|
+
<!-- Supported modes variables -->
|
|
1234
|
+
[uploader-supported]: https://img.shields.io/badge/Uploader-orange
|
|
1235
|
+
[asset-picker-supported]: https://img.shields.io/badge/Asset%20Picker-green
|
|
1236
|
+
[asset-manager-supported]: https://img.shields.io/badge/Asset%20Manager-blue
|
|
@@ -102,7 +102,7 @@ var AddFiles = function AddFiles() {
|
|
|
102
102
|
var importFromDam = function importFromDam() {
|
|
103
103
|
openAssetsPicker({
|
|
104
104
|
onImport: onImportFromDam,
|
|
105
|
-
|
|
105
|
+
disableUpload: true,
|
|
106
106
|
securityTemplateId: securityTemplateId,
|
|
107
107
|
container: container,
|
|
108
108
|
sassKey: sassKey,
|
|
@@ -35,7 +35,8 @@ var DnD = function DnD(_ref) {
|
|
|
35
35
|
i18n = _useExplorer.i18n,
|
|
36
36
|
addFiles = _useExplorer.addFiles,
|
|
37
37
|
opts = _useExplorer.opts;
|
|
38
|
-
var disableDnDActions = opts.disableDnDActions
|
|
38
|
+
var disableDnDActions = opts.disableDnDActions,
|
|
39
|
+
disableUpload = opts.disableUpload;
|
|
39
40
|
var handleDraggedItem = function handleDraggedItem(id, type) {
|
|
40
41
|
var draggedElement = document.querySelector("[data-filerobot-focusable-uuid=\"".concat(id, "\"]"));
|
|
41
42
|
if (draggedElement) {
|
|
@@ -213,6 +214,6 @@ var DnD = function DnD(_ref) {
|
|
|
213
214
|
onDragOver: handleDragOver,
|
|
214
215
|
onDragLeave: handleDragLeave
|
|
215
216
|
};
|
|
216
|
-
return /*#__PURE__*/cloneElement(children, _objectSpread({}, draggable ? _objectSpread(_objectSpread({}, disableDrag || disableDnDActions ? {} : dragEvents), disableDrop || disableDnDActions ? {} : dropEvents) : {}));
|
|
217
|
+
return /*#__PURE__*/cloneElement(children, _objectSpread({}, draggable ? _objectSpread(_objectSpread({}, disableDrag || disableDnDActions || disableUpload ? {} : dragEvents), disableDrop || disableDnDActions || disableUpload ? {} : dropEvents) : {}));
|
|
217
218
|
};
|
|
218
219
|
export default DnD;
|
|
@@ -21,12 +21,12 @@ var TopBarUploadButton = function TopBarUploadButton() {
|
|
|
21
21
|
var isPermittedToUpload = useSelector(function (state) {
|
|
22
22
|
return selectIsUserPermittedTo(state, PERMISSIONS.UPLOAD);
|
|
23
23
|
});
|
|
24
|
-
var
|
|
24
|
+
var disableUpload = opts.disableUpload;
|
|
25
25
|
var openAddFilesPanel = function openAddFilesPanel() {
|
|
26
26
|
dispatch(showAddFilesPanelUpdated(true));
|
|
27
27
|
dispatch(selectionsCleared());
|
|
28
28
|
};
|
|
29
|
-
return !
|
|
29
|
+
return !disableUpload && isPermittedToUpload && /*#__PURE__*/_jsx(Button, {
|
|
30
30
|
startIcon: function startIcon(props) {
|
|
31
31
|
return /*#__PURE__*/_jsx(Upload, _objectSpread({}, props));
|
|
32
32
|
},
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
var _excluded = ["securityTemplateId", "container", "sassKey", "theme", "language", "onImport", "multiSelect", "maxCountOfSelectedFiles", "mutedFilesUuids", "
|
|
1
|
+
var _excluded = ["securityTemplateId", "container", "sassKey", "theme", "language", "onImport", "multiSelect", "maxCountOfSelectedFiles", "mutedFilesUuids", "disableUpload", "forceFilters", "rootFolderPath", "views", "allowedUploadFileTypes", "onClickUploadButton", "acquirers", "assetsPickerModelTitle", "pluginsToUse", "moreCoreConfig", "moreExplorerConfig", "moreXhrUploadConfig", "moreProgressPanelConfig", "onOpen", "onClose"];
|
|
2
2
|
function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
|
|
3
3
|
function _objectWithoutProperties(e, t) { if (null == e) return {}; var o, r, i = _objectWithoutPropertiesLoose(e, t); if (Object.getOwnPropertySymbols) { var n = Object.getOwnPropertySymbols(e); for (r = 0; r < n.length; r++) o = n[r], -1 === t.indexOf(o) && {}.propertyIsEnumerable.call(e, o) && (i[o] = e[o]); } return i; }
|
|
4
4
|
function _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (-1 !== e.indexOf(n)) continue; t[n] = r[n]; } return t; }
|
|
@@ -31,7 +31,7 @@ var getConfigs = function getConfigs(_ref) {
|
|
|
31
31
|
multiSelect = _ref.multiSelect,
|
|
32
32
|
maxCountOfSelectedFiles = _ref.maxCountOfSelectedFiles,
|
|
33
33
|
mutedFilesUuids = _ref.mutedFilesUuids,
|
|
34
|
-
|
|
34
|
+
disableUpload = _ref.disableUpload,
|
|
35
35
|
_ref$theme = _ref.theme,
|
|
36
36
|
theme = _ref$theme === void 0 ? {} : _ref$theme,
|
|
37
37
|
rootFolderPath = _ref.rootFolderPath,
|
|
@@ -58,7 +58,7 @@ var getConfigs = function getConfigs(_ref) {
|
|
|
58
58
|
}
|
|
59
59
|
}, moreCoreConfig),
|
|
60
60
|
explorer: _objectSpread({
|
|
61
|
-
|
|
61
|
+
disableUpload: disableUpload,
|
|
62
62
|
forceFilters: forceFilters,
|
|
63
63
|
view: VIEW_IDS.ASSETS,
|
|
64
64
|
width: '90vw',
|
|
@@ -134,8 +134,8 @@ var useAssetsPicker = function useAssetsPicker() {
|
|
|
134
134
|
maxCountOfSelectedFiles = _ref5.maxCountOfSelectedFiles,
|
|
135
135
|
_ref5$mutedFilesUuids = _ref5.mutedFilesUuids,
|
|
136
136
|
mutedFilesUuids = _ref5$mutedFilesUuids === void 0 ? [] : _ref5$mutedFilesUuids,
|
|
137
|
-
_ref5$
|
|
138
|
-
|
|
137
|
+
_ref5$disableUpload = _ref5.disableUpload,
|
|
138
|
+
disableUpload = _ref5$disableUpload === void 0 ? false : _ref5$disableUpload,
|
|
139
139
|
_ref5$forceFilters = _ref5.forceFilters,
|
|
140
140
|
forceFilters = _ref5$forceFilters === void 0 ? false : _ref5$forceFilters,
|
|
141
141
|
_ref5$rootFolderPath = _ref5.rootFolderPath,
|
|
@@ -172,7 +172,7 @@ var useAssetsPicker = function useAssetsPicker() {
|
|
|
172
172
|
multiSelect: multiSelect,
|
|
173
173
|
maxCountOfSelectedFiles: maxCountOfSelectedFiles,
|
|
174
174
|
mutedFilesUuids: mutedFilesUuids,
|
|
175
|
-
|
|
175
|
+
disableUpload: disableUpload,
|
|
176
176
|
theme: theme,
|
|
177
177
|
rootFolderPath: rootFolderPath,
|
|
178
178
|
views: views,
|
|
@@ -194,7 +194,7 @@ var useAssetsPicker = function useAssetsPicker() {
|
|
|
194
194
|
config = _ref6$config === void 0 ? {} : _ref6$config;
|
|
195
195
|
filerobot.use(plugin, config);
|
|
196
196
|
});
|
|
197
|
-
if (!
|
|
197
|
+
if (!disableUpload) {
|
|
198
198
|
import('@scaleflex/widget-xhr-upload').then(function (module) {
|
|
199
199
|
var XHRUpload = module["default"];
|
|
200
200
|
filerobot.use(XHRUpload, moreXhrUploadConfig);
|
package/lib/index.js
CHANGED
|
@@ -1226,7 +1226,7 @@ var Explorer = /*#__PURE__*/function (_Plugin) {
|
|
|
1226
1226
|
thumbnailWidth: 280,
|
|
1227
1227
|
thumbnailHeight: 170,
|
|
1228
1228
|
waitForThumbnailsBeforeUpload: false,
|
|
1229
|
-
|
|
1229
|
+
disableUpload: false,
|
|
1230
1230
|
hideSearch: false,
|
|
1231
1231
|
note: null,
|
|
1232
1232
|
hint: null,
|
|
@@ -1400,7 +1400,7 @@ var Explorer = /*#__PURE__*/function (_Plugin) {
|
|
|
1400
1400
|
_this.opts = _objectSpread(_objectSpread(_objectSpread({}, defaultOptions), _opts), {}, {
|
|
1401
1401
|
filters: _opts.filters ? getMappedFilterValues(_opts.filters) : defaultOptions.filters,
|
|
1402
1402
|
views: _opts.views || defaultOptions.views,
|
|
1403
|
-
view: _opts.view ||
|
|
1403
|
+
view: _opts.view || defaultOptions.view,
|
|
1404
1404
|
config: _objectSpread(_objectSpread(_objectSpread({}, defaultOptions.config), _opts.config), {}, {
|
|
1405
1405
|
tagging: _objectSpread(_objectSpread({}, (_defaultOptions$confi = defaultOptions.config) === null || _defaultOptions$confi === void 0 ? void 0 : _defaultOptions$confi.tagging), (_opts$config = _opts.config) === null || _opts$config === void 0 ? void 0 : _opts$config.tagging),
|
|
1406
1406
|
video: _objectSpread(_objectSpread({}, (_defaultOptions$confi2 = defaultOptions.config) === null || _defaultOptions$confi2 === void 0 ? void 0 : _defaultOptions$confi2.video), (_opts$config2 = _opts.config) === null || _opts$config2 === void 0 ? void 0 : _opts$config2.video),
|
|
@@ -1434,7 +1434,7 @@ var Explorer = /*#__PURE__*/function (_Plugin) {
|
|
|
1434
1434
|
key: "_isPasteAndDnDUploadDisabled",
|
|
1435
1435
|
value: function _isPasteAndDnDUploadDisabled() {
|
|
1436
1436
|
var currentView = selectActiveView(this.getGlobalState());
|
|
1437
|
-
return this.opts.disableDnDActions || ![VIEW_IDS.FOLDERS, VIEW_IDS.ASSETS].includes(currentView);
|
|
1437
|
+
return this.opts.disableDnDActions || this.opts.disableUpload || ![VIEW_IDS.FOLDERS, VIEW_IDS.ASSETS].includes(currentView);
|
|
1438
1438
|
}
|
|
1439
1439
|
}, {
|
|
1440
1440
|
key: "getPluginReducer",
|
|
@@ -1479,7 +1479,7 @@ var Explorer = /*#__PURE__*/function (_Plugin) {
|
|
|
1479
1479
|
var config = opts.config || {};
|
|
1480
1480
|
var allViews = Object.values(VIEW_IDS);
|
|
1481
1481
|
var allLayouts = Object.values(LAYOUTS_IDS);
|
|
1482
|
-
var currentView = isInstall && ((_this$getUrlQueryPara = this.getUrlQueryParam(FMAW_URL_QUERY_PARAMS.VIEW, opts.view
|
|
1482
|
+
var currentView = isInstall && ((_this$getUrlQueryPara = this.getUrlQueryParam(FMAW_URL_QUERY_PARAMS.VIEW, opts.view)) === null || _this$getUrlQueryPara === void 0 ? void 0 : _this$getUrlQueryPara.toUpperCase());
|
|
1483
1483
|
var viewState = _objectSpread({
|
|
1484
1484
|
layout: opts.layoutType ? allLayouts.includes(opts.layoutType) && opts.layoutType || LAYOUTS_IDS.GRID : undefined,
|
|
1485
1485
|
list: opts.views ? opts.views.filter(function (viewId) {
|
|
@@ -130,12 +130,11 @@ export var activateViewFromOutside = createThunk(function (_ref2, thunkApi) {
|
|
|
130
130
|
viewItem = opts.viewItem,
|
|
131
131
|
viewSubItem = opts.viewSubItem,
|
|
132
132
|
views = opts.views,
|
|
133
|
-
defaultView = opts.defaultView,
|
|
134
133
|
_opts$isRecursiveFetc = opts.isRecursiveFetch,
|
|
135
134
|
isRecursiveFetch = _opts$isRecursiveFetc === void 0 ? false : _opts$isRecursiveFetc;
|
|
136
135
|
var activeView = selectActiveView(getState());
|
|
137
136
|
var viewOptions = {
|
|
138
|
-
id: view ||
|
|
137
|
+
id: view || activeView,
|
|
139
138
|
itemToOpen: viewItem,
|
|
140
139
|
subItemToOpen: viewSubItem,
|
|
141
140
|
isRecursive: isRecursiveFetch
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@scaleflex/widget-explorer",
|
|
3
|
-
"version": "4.0.
|
|
3
|
+
"version": "4.0.6",
|
|
4
4
|
"description": "Scaleflex explorer for the files uploaded on filerobot, handling them & upload new files.",
|
|
5
5
|
"main": "lib/index.js",
|
|
6
6
|
"style": "dist/style.min.css",
|
|
@@ -18,12 +18,12 @@
|
|
|
18
18
|
"@scaleflex/icons": "^3.0.0-beta.11",
|
|
19
19
|
"@scaleflex/react-url-builder": "^0.0.72",
|
|
20
20
|
"@scaleflex/ui": "^3.0.0-beta.11",
|
|
21
|
-
"@scaleflex/widget-common": "^4.0.
|
|
22
|
-
"@scaleflex/widget-icons": "^4.0.
|
|
23
|
-
"@scaleflex/widget-informer": "^4.0.
|
|
24
|
-
"@scaleflex/widget-provider-views": "^4.0.
|
|
25
|
-
"@scaleflex/widget-thumbnail-generator": "^4.0.
|
|
26
|
-
"@scaleflex/widget-utils": "^4.0.
|
|
21
|
+
"@scaleflex/widget-common": "^4.0.6",
|
|
22
|
+
"@scaleflex/widget-icons": "^4.0.6",
|
|
23
|
+
"@scaleflex/widget-informer": "^4.0.6",
|
|
24
|
+
"@scaleflex/widget-provider-views": "^4.0.6",
|
|
25
|
+
"@scaleflex/widget-thumbnail-generator": "^4.0.6",
|
|
26
|
+
"@scaleflex/widget-utils": "^4.0.6",
|
|
27
27
|
"@transloadit/prettier-bytes": "0.1.0",
|
|
28
28
|
"akamai-filerobot-converter": "^0.1.6",
|
|
29
29
|
"classnames": "^2.2.6",
|
|
@@ -51,5 +51,5 @@
|
|
|
51
51
|
"react-konva": ">=19.0.3"
|
|
52
52
|
},
|
|
53
53
|
"license": "MIT",
|
|
54
|
-
"gitHead": "
|
|
54
|
+
"gitHead": "17ad9b9abc2add9c8b52ab56e3a72108bee20a7a"
|
|
55
55
|
}
|
package/types/index.d.ts
CHANGED
|
@@ -52,7 +52,7 @@ declare module Explorer {
|
|
|
52
52
|
thumbnailWidth?: number;
|
|
53
53
|
thumbnailHeight?: number;
|
|
54
54
|
waitForThumbnailsBeforeUpload?: boolean;
|
|
55
|
-
|
|
55
|
+
disableUpload?: boolean;
|
|
56
56
|
hideSearch?: boolean;
|
|
57
57
|
note?: string;
|
|
58
58
|
closeModalOnClickOutside?: boolean;
|