@scaleflex/widget-canva 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/CHANGELOG.md +7506 -7494
- package/LICENSE +21 -21
- package/README.md +124 -124
- package/package.json +6 -6
package/LICENSE
CHANGED
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
MIT License
|
|
2
|
-
|
|
3
|
-
Copyright (c) 2019 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) 2019 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,124 +1,124 @@
|
|
|
1
|
-
# @scaleflex/widget-canva
|
|
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
|
-
Create your own design & customize it then upload it on the go by integrating this plugin inside [Scaleflex Media Asset Widget](https://www.npmjs.com/package/@scaleflex/widget-core).
|
|
16
|
-
|
|
17
|
-
## Usage
|
|
18
|
-
|
|
19
|
-
### NPM
|
|
20
|
-
|
|
21
|
-
```bash
|
|
22
|
-
npm install --save @scaleflex/widget-canva
|
|
23
|
-
```
|
|
24
|
-
### YARN
|
|
25
|
-
|
|
26
|
-
```bash
|
|
27
|
-
yarn add @scaleflex/widget-canva
|
|
28
|
-
```
|
|
29
|
-
then
|
|
30
|
-
|
|
31
|
-
```js
|
|
32
|
-
import Canva from '@scaleflex/widget-canva'
|
|
33
|
-
...
|
|
34
|
-
...
|
|
35
|
-
...
|
|
36
|
-
scaleflexWidget.use(Canva, propertiesObject)
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
### CDN
|
|
40
|
-
|
|
41
|
-
The plugin from CDN is found inside `Scaleflex` global object `Scaleflex.Canva`
|
|
42
|
-
|
|
43
|
-
```js
|
|
44
|
-
const Canva = window.ScaleflexWidget.Canva
|
|
45
|
-
...
|
|
46
|
-
...
|
|
47
|
-
...
|
|
48
|
-
scaleflexWidget.use(Canva, propertiesObject)
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
## Properties
|
|
52
|
-
|
|
53
|
-
### `title`
|
|
54
|
-
|
|
55
|
-
<u>Type:</u> `string`.
|
|
56
|
-
|
|
57
|
-
<u>Default:</u> `'Canva (Design & Upload)'`
|
|
58
|
-
|
|
59
|
-
The title/label that would be shown & used for the plugin.
|
|
60
|
-
|
|
61
|
-
### `apiKey`
|
|
62
|
-
|
|
63
|
-
<u>Type:</u> `string`.
|
|
64
|
-
|
|
65
|
-
<u>Default:</u> `'scaleflexWidget's canva api key'`
|
|
66
|
-
|
|
67
|
-
The API key used in initializing canva & creating the design through their SDK.
|
|
68
|
-
|
|
69
|
-
### `designType`
|
|
70
|
-
|
|
71
|
-
<u>Type:</u> `string`.
|
|
72
|
-
|
|
73
|
-
<u>Default:</u> `'A4Document'`
|
|
74
|
-
|
|
75
|
-
The design type of the design workspace that would be opened to create the design, visit [Canva's design types](https://docs.developer.canva.com/button/reference/design-types) for all available types.
|
|
76
|
-
|
|
77
|
-
### `fileType: string`
|
|
78
|
-
|
|
79
|
-
<u>Type:</u> `string`.
|
|
80
|
-
|
|
81
|
-
<u>Default:</u> `'png'`
|
|
82
|
-
|
|
83
|
-
The type of the final created design's to be saved & uploaded with it.
|
|
84
|
-
|
|
85
|
-
### `companionHeaders`
|
|
86
|
-
|
|
87
|
-
<u>Type:</u> `null` | `object`.
|
|
88
|
-
|
|
89
|
-
<u>Default:</u> `null`
|
|
90
|
-
|
|
91
|
-
If you need to pass additonal headers in companion requests then pass them in this property (used in retrieving the metadata of the design file).
|
|
92
|
-
|
|
93
|
-
### `locale`
|
|
94
|
-
|
|
95
|
-
<u>Type:</u> `object`.
|
|
96
|
-
|
|
97
|
-
<u>Default:</u> locales from scaleflexWidget's backend then default locale file with all labels is under `lib/defaultLocale.js`.
|
|
98
|
-
|
|
99
|
-
You can override some labels by specifying a translation object here, such as:
|
|
100
|
-
|
|
101
|
-
```js
|
|
102
|
-
{
|
|
103
|
-
strings: {
|
|
104
|
-
canvaPluginTitle: 'Canva (Design & upload)' // overrides the default Standard portraits value to standard verticals
|
|
105
|
-
}
|
|
106
|
-
}
|
|
107
|
-
```
|
|
108
|
-
|
|
109
|
-
<!-- Variables -->
|
|
110
|
-
|
|
111
|
-
[npm-url]: https://www.npmjs.com/package/@scaleflex/widget-canva
|
|
112
|
-
[license-url]: https://opensource.org/licenses/MIT
|
|
113
|
-
[sfx-url]: https://www.scaleflex.com/
|
|
114
|
-
[version-url]: https://www.npmjs.com/package/@scaleflex/widget-canva
|
|
115
|
-
[codeSandbox-url]: https://codesandbox.io/p/sandbox/scalelfex-widget-v4-sandbox-dtp6l3?file=%2Fsrc%2Findex.js
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
[npm-image]: https://img.shields.io/npm/v/@telus/remark-config.svg?style=for-the-badge&logo=npm
|
|
119
|
-
[license-image]: https://img.shields.io/badge/license-MIT-blue.svg?style=for-the-badge
|
|
120
|
-
[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
|
|
121
|
-
[plugins-image]: https://img.shields.io/static/v1?label=Scaleflex&message=Plugins&color=yellow&style=for-the-badge
|
|
122
|
-
[filerobot-image]: https://img.shields.io/static/v1?label=Scaleflex&message=website&color=orange&style=for-the-badge
|
|
123
|
-
[filerobot-version]: https://img.shields.io/npm/v/@scaleflex/widget-canva?label=Version&style=for-the-badge&logo=npm
|
|
124
|
-
[codeSandbox-image]: https://img.shields.io/badge/CodeSandbox-black?style=for-the-badge&logo=CodeSandbox
|
|
1
|
+
# @scaleflex/widget-canva
|
|
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
|
+
Create your own design & customize it then upload it on the go by integrating this plugin inside [Scaleflex Media Asset Widget](https://www.npmjs.com/package/@scaleflex/widget-core).
|
|
16
|
+
|
|
17
|
+
## Usage
|
|
18
|
+
|
|
19
|
+
### NPM
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
npm install --save @scaleflex/widget-canva
|
|
23
|
+
```
|
|
24
|
+
### YARN
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
yarn add @scaleflex/widget-canva
|
|
28
|
+
```
|
|
29
|
+
then
|
|
30
|
+
|
|
31
|
+
```js
|
|
32
|
+
import Canva from '@scaleflex/widget-canva'
|
|
33
|
+
...
|
|
34
|
+
...
|
|
35
|
+
...
|
|
36
|
+
scaleflexWidget.use(Canva, propertiesObject)
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### CDN
|
|
40
|
+
|
|
41
|
+
The plugin from CDN is found inside `Scaleflex` global object `Scaleflex.Canva`
|
|
42
|
+
|
|
43
|
+
```js
|
|
44
|
+
const Canva = window.ScaleflexWidget.Canva
|
|
45
|
+
...
|
|
46
|
+
...
|
|
47
|
+
...
|
|
48
|
+
scaleflexWidget.use(Canva, propertiesObject)
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
## Properties
|
|
52
|
+
|
|
53
|
+
### `title`
|
|
54
|
+
|
|
55
|
+
<u>Type:</u> `string`.
|
|
56
|
+
|
|
57
|
+
<u>Default:</u> `'Canva (Design & Upload)'`
|
|
58
|
+
|
|
59
|
+
The title/label that would be shown & used for the plugin.
|
|
60
|
+
|
|
61
|
+
### `apiKey`
|
|
62
|
+
|
|
63
|
+
<u>Type:</u> `string`.
|
|
64
|
+
|
|
65
|
+
<u>Default:</u> `'scaleflexWidget's canva api key'`
|
|
66
|
+
|
|
67
|
+
The API key used in initializing canva & creating the design through their SDK.
|
|
68
|
+
|
|
69
|
+
### `designType`
|
|
70
|
+
|
|
71
|
+
<u>Type:</u> `string`.
|
|
72
|
+
|
|
73
|
+
<u>Default:</u> `'A4Document'`
|
|
74
|
+
|
|
75
|
+
The design type of the design workspace that would be opened to create the design, visit [Canva's design types](https://docs.developer.canva.com/button/reference/design-types) for all available types.
|
|
76
|
+
|
|
77
|
+
### `fileType: string`
|
|
78
|
+
|
|
79
|
+
<u>Type:</u> `string`.
|
|
80
|
+
|
|
81
|
+
<u>Default:</u> `'png'`
|
|
82
|
+
|
|
83
|
+
The type of the final created design's to be saved & uploaded with it.
|
|
84
|
+
|
|
85
|
+
### `companionHeaders`
|
|
86
|
+
|
|
87
|
+
<u>Type:</u> `null` | `object`.
|
|
88
|
+
|
|
89
|
+
<u>Default:</u> `null`
|
|
90
|
+
|
|
91
|
+
If you need to pass additonal headers in companion requests then pass them in this property (used in retrieving the metadata of the design file).
|
|
92
|
+
|
|
93
|
+
### `locale`
|
|
94
|
+
|
|
95
|
+
<u>Type:</u> `object`.
|
|
96
|
+
|
|
97
|
+
<u>Default:</u> locales from scaleflexWidget's backend then default locale file with all labels is under `lib/defaultLocale.js`.
|
|
98
|
+
|
|
99
|
+
You can override some labels by specifying a translation object here, such as:
|
|
100
|
+
|
|
101
|
+
```js
|
|
102
|
+
{
|
|
103
|
+
strings: {
|
|
104
|
+
canvaPluginTitle: 'Canva (Design & upload)' // overrides the default Standard portraits value to standard verticals
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
<!-- Variables -->
|
|
110
|
+
|
|
111
|
+
[npm-url]: https://www.npmjs.com/package/@scaleflex/widget-canva
|
|
112
|
+
[license-url]: https://opensource.org/licenses/MIT
|
|
113
|
+
[sfx-url]: https://www.scaleflex.com/
|
|
114
|
+
[version-url]: https://www.npmjs.com/package/@scaleflex/widget-canva
|
|
115
|
+
[codeSandbox-url]: https://codesandbox.io/p/sandbox/scalelfex-widget-v4-sandbox-dtp6l3?file=%2Fsrc%2Findex.js
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
[npm-image]: https://img.shields.io/npm/v/@telus/remark-config.svg?style=for-the-badge&logo=npm
|
|
119
|
+
[license-image]: https://img.shields.io/badge/license-MIT-blue.svg?style=for-the-badge
|
|
120
|
+
[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
|
|
121
|
+
[plugins-image]: https://img.shields.io/static/v1?label=Scaleflex&message=Plugins&color=yellow&style=for-the-badge
|
|
122
|
+
[filerobot-image]: https://img.shields.io/static/v1?label=Scaleflex&message=website&color=orange&style=for-the-badge
|
|
123
|
+
[filerobot-version]: https://img.shields.io/npm/v/@scaleflex/widget-canva?label=Version&style=for-the-badge&logo=npm
|
|
124
|
+
[codeSandbox-image]: https://img.shields.io/badge/CodeSandbox-black?style=for-the-badge&logo=CodeSandbox
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@scaleflex/widget-canva",
|
|
3
3
|
"description": "Create your own design & customize it then upload it through the widget on the go.",
|
|
4
|
-
"version": "4.0
|
|
4
|
+
"version": "4.1.0",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"main": "lib/index.js",
|
|
7
7
|
"types": "types/index.d.ts",
|
|
@@ -9,10 +9,10 @@
|
|
|
9
9
|
"access": "public"
|
|
10
10
|
},
|
|
11
11
|
"dependencies": {
|
|
12
|
-
"@scaleflex/widget-common": "^4.0
|
|
13
|
-
"@scaleflex/widget-companion-client": "^4.0
|
|
14
|
-
"@scaleflex/widget-icons": "^4.0
|
|
15
|
-
"@scaleflex/widget-utils": "^4.0
|
|
12
|
+
"@scaleflex/widget-common": "^4.1.0",
|
|
13
|
+
"@scaleflex/widget-companion-client": "^4.1.0",
|
|
14
|
+
"@scaleflex/widget-icons": "^4.1.0",
|
|
15
|
+
"@scaleflex/widget-utils": "^4.1.0"
|
|
16
16
|
},
|
|
17
17
|
"devDependencies": {
|
|
18
18
|
"react": "^19.0.0",
|
|
@@ -29,5 +29,5 @@
|
|
|
29
29
|
"/lib",
|
|
30
30
|
"/types"
|
|
31
31
|
],
|
|
32
|
-
"gitHead": "
|
|
32
|
+
"gitHead": "471120d67066617a0d8824eae11b07d1f2259473"
|
|
33
33
|
}
|