@scaleflex/widget-box 4.0.7 → 4.1.0

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/LICENSE CHANGED
@@ -1,21 +1,21 @@
1
- MIT License
2
-
3
- Copyright (c) 2022 scaleflex
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
1
+ MIT License
2
+
3
+ Copyright (c) 2022 scaleflex
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,83 +1,83 @@
1
- # @scaleflex/widget-box
2
-
3
- [![Plugins][plugins-image]](#plugins)
4
- [![Website][filerobot-image]][sfx-url]
5
- [![Version][filerobot-version]][version-url]
6
- [![Scaleflex team][made-by-image]][sfx-url]
7
- [![License][license-image]][license-url]
8
- [![CodeSandbox][codeSandbox-image]][codeSandbox-url]
9
-
10
-
11
- <div align='center'>
12
- <img title="Scaleflex Widget logo" alt="Scaleflex Widget logo" src="https://assets.scaleflex.com/Corporate+Branding/%5B2025%5D+ALL+LOGOS+%2B+ICONS/SCALEFLEX/VXP+logo/Horizontal+White/VXP+logo+WHITE.png?vh=663932" width="140"/>
13
- </div>
14
-
15
- The Box plugin for [Scaleflex Media Asset Widget](https://www.npmjs.com/package/@scaleflex/widget-core) lets users import files from their Box account.
16
-
17
- ## Usage
18
-
19
- ### NPM
20
-
21
- ```bash
22
- npm install --save @scaleflex/widget-box
23
- ```
24
- ### YARN
25
-
26
- ```bash
27
- yarn add @scaleflex/widget-box
28
- ```
29
- then
30
-
31
- ```js
32
- import Box from '@scaleflex/widget-box'
33
- ...
34
- ...
35
- ...
36
- scaleflexWidget.use(Box, propertiesObject)
37
- ```
38
-
39
- ### CDN
40
-
41
- The plugin from CDN is found inside `Scaleflex` global object `Scaleflex.Box`
42
-
43
- ```js
44
- const box = window.ScaleflexWidget.Box
45
- ...
46
- ...
47
- ...
48
- scaleflexWidget.use(box, propertiesObject)
49
- ```
50
-
51
- ## Properties
52
- ### `title`
53
-
54
- <u>Type:</u> `string`.
55
-
56
- <u>Default:</u> `Box`
57
-
58
- The title/label that would be shown & used for the plugin.
59
-
60
- ### `companionHeaders`
61
-
62
- <u>Type:</u> `null` | `object`.
63
-
64
- <u>Default:</u> `null`
65
-
66
- If you need to pass additional headers for in companion requests then pass them in this property.
67
-
68
- <!-- Variables -->
69
-
70
- [npm-url]: https://www.npmjs.com/package/@scaleflex/widget-box
71
- [license-url]: https://opensource.org/licenses/MIT
72
- [sfx-url]: https://www.scaleflex.com/
73
- [version-url]: https://www.npmjs.com/package/@scaleflex/widget-box
74
- [codeSandbox-url]: https://codesandbox.io/p/sandbox/scalelfex-widget-v4-sandbox-dtp6l3?file=%2Fsrc%2Findex.js
75
-
76
-
77
- [npm-image]: https://img.shields.io/npm/v/@telus/remark-config.svg?style=for-the-badge&logo=npm
78
- [license-image]: https://img.shields.io/badge/license-MIT-blue.svg?style=for-the-badge
79
- [made-by-image]: https://img.shields.io/badge/%3C%2F%3E%20with%20%E2%99%A5%20by-the%20Scaleflex%20team-6986fa.svg?style=for-the-badge
80
- [plugins-image]: https://img.shields.io/static/v1?label=Scaleflex&message=Plugins&color=yellow&style=for-the-badge
81
- [filerobot-image]: https://img.shields.io/static/v1?label=Scaleflex&message=website&color=orange&style=for-the-badge
82
- [filerobot-version]: https://img.shields.io/npm/v/@scaleflex/widget-box?label=Version&style=for-the-badge&logo=npm
83
- [codeSandbox-image]: https://img.shields.io/badge/CodeSandbox-black?style=for-the-badge&logo=CodeSandbox
1
+ # @scaleflex/widget-box
2
+
3
+ [![Plugins][plugins-image]](#plugins)
4
+ [![Website][filerobot-image]][sfx-url]
5
+ [![Version][filerobot-version]][version-url]
6
+ [![Scaleflex team][made-by-image]][sfx-url]
7
+ [![License][license-image]][license-url]
8
+ [![CodeSandbox][codeSandbox-image]][codeSandbox-url]
9
+
10
+
11
+ <div align='center'>
12
+ <img title="Scaleflex Widget logo" alt="Scaleflex Widget logo" src="https://assets.scaleflex.com/Corporate+Branding/%5B2025%5D+ALL+LOGOS+%2B+ICONS/SCALEFLEX/VXP+logo/Horizontal+White/VXP+logo+WHITE.png?vh=663932" width="140"/>
13
+ </div>
14
+
15
+ The Box plugin for [Scaleflex Media Asset Widget](https://www.npmjs.com/package/@scaleflex/widget-core) lets users import files from their Box account.
16
+
17
+ ## Usage
18
+
19
+ ### NPM
20
+
21
+ ```bash
22
+ npm install --save @scaleflex/widget-box
23
+ ```
24
+ ### YARN
25
+
26
+ ```bash
27
+ yarn add @scaleflex/widget-box
28
+ ```
29
+ then
30
+
31
+ ```js
32
+ import Box from '@scaleflex/widget-box'
33
+ ...
34
+ ...
35
+ ...
36
+ scaleflexWidget.use(Box, propertiesObject)
37
+ ```
38
+
39
+ ### CDN
40
+
41
+ The plugin from CDN is found inside `Scaleflex` global object `Scaleflex.Box`
42
+
43
+ ```js
44
+ const box = window.ScaleflexWidget.Box
45
+ ...
46
+ ...
47
+ ...
48
+ scaleflexWidget.use(box, propertiesObject)
49
+ ```
50
+
51
+ ## Properties
52
+ ### `title`
53
+
54
+ <u>Type:</u> `string`.
55
+
56
+ <u>Default:</u> `Box`
57
+
58
+ The title/label that would be shown & used for the plugin.
59
+
60
+ ### `companionHeaders`
61
+
62
+ <u>Type:</u> `null` | `object`.
63
+
64
+ <u>Default:</u> `null`
65
+
66
+ If you need to pass additional headers for in companion requests then pass them in this property.
67
+
68
+ <!-- Variables -->
69
+
70
+ [npm-url]: https://www.npmjs.com/package/@scaleflex/widget-box
71
+ [license-url]: https://opensource.org/licenses/MIT
72
+ [sfx-url]: https://www.scaleflex.com/
73
+ [version-url]: https://www.npmjs.com/package/@scaleflex/widget-box
74
+ [codeSandbox-url]: https://codesandbox.io/p/sandbox/scalelfex-widget-v4-sandbox-dtp6l3?file=%2Fsrc%2Findex.js
75
+
76
+
77
+ [npm-image]: https://img.shields.io/npm/v/@telus/remark-config.svg?style=for-the-badge&logo=npm
78
+ [license-image]: https://img.shields.io/badge/license-MIT-blue.svg?style=for-the-badge
79
+ [made-by-image]: https://img.shields.io/badge/%3C%2F%3E%20with%20%E2%99%A5%20by-the%20Scaleflex%20team-6986fa.svg?style=for-the-badge
80
+ [plugins-image]: https://img.shields.io/static/v1?label=Scaleflex&message=Plugins&color=yellow&style=for-the-badge
81
+ [filerobot-image]: https://img.shields.io/static/v1?label=Scaleflex&message=website&color=orange&style=for-the-badge
82
+ [filerobot-version]: https://img.shields.io/npm/v/@scaleflex/widget-box?label=Version&style=for-the-badge&logo=npm
83
+ [codeSandbox-image]: https://img.shields.io/badge/CodeSandbox-black?style=for-the-badge&logo=CodeSandbox
package/package.json CHANGED
@@ -1,15 +1,15 @@
1
1
  {
2
2
  "name": "@scaleflex/widget-box",
3
3
  "description": "Import files from Box, into Scaleflex.",
4
- "version": "4.0.7",
4
+ "version": "4.1.0",
5
5
  "license": "MIT",
6
6
  "main": "lib/index.js",
7
7
  "types": "types/index.d.ts",
8
8
  "dependencies": {
9
- "@scaleflex/widget-companion-client": "^4.0.7",
10
- "@scaleflex/widget-icons": "^4.0.7",
11
- "@scaleflex/widget-provider-views": "^4.0.7",
12
- "@scaleflex/widget-utils": "^4.0.7"
9
+ "@scaleflex/widget-companion-client": "^4.1.0",
10
+ "@scaleflex/widget-icons": "^4.1.0",
11
+ "@scaleflex/widget-provider-views": "^4.1.0",
12
+ "@scaleflex/widget-utils": "^4.1.0"
13
13
  },
14
14
  "devDependencies": {
15
15
  "react": "^19.0.0",
@@ -31,5 +31,5 @@
31
31
  "publishConfig": {
32
32
  "access": "public"
33
33
  },
34
- "gitHead": "a940492ab76142f7041379f9a8a1d0bc8367214f"
34
+ "gitHead": "471120d67066617a0d8824eae11b07d1f2259473"
35
35
  }
package/types/index.d.ts CHANGED
@@ -1,17 +1,17 @@
1
- import Filerobot = require("@scaleflex/widget-core");
2
- import CompanionClient = require("@scaleflex/widget-companion-client");
3
-
4
- declare module Box {
5
- interface BoxOptions
6
- extends Filerobot.PluginOptions,
7
- CompanionClient.PublicProviderOptions {
8
- replaceTargetContent?: boolean;
9
- target?: Filerobot.PluginTarget;
10
- title?: string;
11
- storage?: CompanionClient.TokenStorage;
12
- }
13
- }
14
-
15
- declare class Box extends Filerobot.Plugin<Box.BoxOptions> {}
16
-
17
- export = Box;
1
+ import Filerobot = require("@scaleflex/widget-core");
2
+ import CompanionClient = require("@scaleflex/widget-companion-client");
3
+
4
+ declare module Box {
5
+ interface BoxOptions
6
+ extends Filerobot.PluginOptions,
7
+ CompanionClient.PublicProviderOptions {
8
+ replaceTargetContent?: boolean;
9
+ target?: Filerobot.PluginTarget;
10
+ title?: string;
11
+ storage?: CompanionClient.TokenStorage;
12
+ }
13
+ }
14
+
15
+ declare class Box extends Filerobot.Plugin<Box.BoxOptions> {}
16
+
17
+ export = Box;