@pie-element/hotspot 6.14.1-next.5 → 6.15.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 CHANGED
@@ -3,6 +3,17 @@
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
+ # [6.15.0](https://github.com/pie-framework/pie-elements/compare/@pie-element/hotspot@6.14.0...@pie-element/hotspot@6.15.0) (2024-04-01)
7
+
8
+
9
+ ### Features
10
+
11
+ * **inline-dropdown:** upgrade pie-toolbox PD-2465 ([828d1c1](https://github.com/pie-framework/pie-elements/commit/828d1c1bc9e9221c1e141baaa8f89a4929ad0eb9))
12
+
13
+
14
+
15
+
16
+
6
17
  # [6.14.0](https://github.com/pie-framework/pie-elements/compare/@pie-element/hotspot@6.13.0...@pie-element/hotspot@6.14.0) (2024-04-01)
7
18
 
8
19
 
@@ -3,6 +3,17 @@
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
+ # [6.14.0](https://github.com/pie-framework/pie-elements/compare/@pie-element/hotspot-configure@6.13.0...@pie-element/hotspot-configure@6.14.0) (2024-04-01)
7
+
8
+
9
+ ### Features
10
+
11
+ * **inline-dropdown:** upgrade pie-toolbox PD-2465 ([828d1c1](https://github.com/pie-framework/pie-elements/commit/828d1c1bc9e9221c1e141baaa8f89a4929ad0eb9))
12
+
13
+
14
+
15
+
16
+
6
17
  # [6.13.0](https://github.com/pie-framework/pie-elements/compare/@pie-element/hotspot-configure@6.12.0...@pie-element/hotspot-configure@6.13.0) (2024-04-01)
7
18
 
8
19
 
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@pie-element/hotspot-configure",
3
3
  "private": true,
4
- "version": "6.13.0",
4
+ "version": "6.14.0",
5
5
  "description": "",
6
6
  "main": "lib/index.js",
7
7
  "module": "src/index.js",
@@ -10,7 +10,7 @@
10
10
  "@material-ui/core": "^3.9.2",
11
11
  "@material-ui/icons": "^3.0.2",
12
12
  "@pie-framework/pie-configure-events": "^1.3.0",
13
- "@pie-lib/pie-toolbox": "1.12.3",
13
+ "@pie-lib/pie-toolbox": "1.13.0",
14
14
  "classnames": "^2.2.6",
15
15
  "debug": "^3.1.0",
16
16
  "konva": "^3.2.4",
@@ -3,6 +3,17 @@
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.9.0](https://github.com/pie-framework/pie-elements/compare/@pie-element/hotspot-controller@4.8.0...@pie-element/hotspot-controller@4.9.0) (2024-04-01)
7
+
8
+
9
+ ### Features
10
+
11
+ * **inline-dropdown:** upgrade pie-toolbox PD-2465 ([828d1c1](https://github.com/pie-framework/pie-elements/commit/828d1c1bc9e9221c1e141baaa8f89a4929ad0eb9))
12
+
13
+
14
+
15
+
16
+
6
17
  # [4.8.0](https://github.com/pie-framework/pie-elements/compare/@pie-element/hotspot-controller@4.7.0...@pie-element/hotspot-controller@4.8.0) (2024-04-01)
7
18
 
8
19
 
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@pie-element/hotspot-controller",
3
3
  "private": true,
4
- "version": "4.8.0",
4
+ "version": "4.9.0",
5
5
  "description": "",
6
6
  "scripts": {
7
7
  "test": "echo \"Error: no test specified\" && exit 1"
@@ -11,7 +11,7 @@
11
11
  "main": "lib/index.js",
12
12
  "module": "src/index.js",
13
13
  "dependencies": {
14
- "@pie-lib/pie-toolbox": "1.12.3",
14
+ "@pie-lib/pie-toolbox": "1.13.0",
15
15
  "debug": "^4.1.1",
16
16
  "lodash": "^4.17.15"
17
17
  }
@@ -50,6 +50,43 @@
50
50
  "title": "disabled"
51
51
  }
52
52
  }
53
+ },
54
+ "customPlugins": {
55
+ "description": "An array of objects that determine custom plugins.\nA custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).\nExample can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.",
56
+ "type": "array",
57
+ "items": {
58
+ "title": "CustomPlugin",
59
+ "type": "object",
60
+ "properties": {
61
+ "event": {
62
+ "description": "The name of the custom event. It needs to be valid (only letters, numbers and \"_\" can be used).\nPIE will emit the event prefixed with \"PIE-\".\nEg: event = 'client_custom_event_A' => the emitted event will be \"PIE-client_custom_event_A\"",
63
+ "type": "string",
64
+ "title": "event"
65
+ },
66
+ "iconAlt": {
67
+ "description": "The alt for the custom button icon",
68
+ "type": "string",
69
+ "title": "iconAlt"
70
+ },
71
+ "iconType": {
72
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
73
+ "type": "string",
74
+ "title": "iconType"
75
+ },
76
+ "icon": {
77
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
78
+ "type": "string",
79
+ "title": "icon"
80
+ }
81
+ },
82
+ "required": [
83
+ "event",
84
+ "icon",
85
+ "iconAlt",
86
+ "iconType"
87
+ ]
88
+ },
89
+ "title": "customPlugins"
53
90
  }
54
91
  }
55
92
  },
@@ -136,6 +173,43 @@
136
173
  "title": "disabled"
137
174
  }
138
175
  }
176
+ },
177
+ "customPlugins": {
178
+ "description": "An array of objects that determine custom plugins.\nA custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).\nExample can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.",
179
+ "type": "array",
180
+ "items": {
181
+ "title": "CustomPlugin",
182
+ "type": "object",
183
+ "properties": {
184
+ "event": {
185
+ "description": "The name of the custom event. It needs to be valid (only letters, numbers and \"_\" can be used).\nPIE will emit the event prefixed with \"PIE-\".\nEg: event = 'client_custom_event_A' => the emitted event will be \"PIE-client_custom_event_A\"",
186
+ "type": "string",
187
+ "title": "event"
188
+ },
189
+ "iconAlt": {
190
+ "description": "The alt for the custom button icon",
191
+ "type": "string",
192
+ "title": "iconAlt"
193
+ },
194
+ "iconType": {
195
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
196
+ "type": "string",
197
+ "title": "iconType"
198
+ },
199
+ "icon": {
200
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
201
+ "type": "string",
202
+ "title": "icon"
203
+ }
204
+ },
205
+ "required": [
206
+ "event",
207
+ "icon",
208
+ "iconAlt",
209
+ "iconType"
210
+ ]
211
+ },
212
+ "title": "customPlugins"
139
213
  }
140
214
  }
141
215
  },
@@ -207,6 +281,43 @@
207
281
  "title": "disabled"
208
282
  }
209
283
  }
284
+ },
285
+ "customPlugins": {
286
+ "description": "An array of objects that determine custom plugins.\nA custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).\nExample can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.",
287
+ "type": "array",
288
+ "items": {
289
+ "title": "CustomPlugin",
290
+ "type": "object",
291
+ "properties": {
292
+ "event": {
293
+ "description": "The name of the custom event. It needs to be valid (only letters, numbers and \"_\" can be used).\nPIE will emit the event prefixed with \"PIE-\".\nEg: event = 'client_custom_event_A' => the emitted event will be \"PIE-client_custom_event_A\"",
294
+ "type": "string",
295
+ "title": "event"
296
+ },
297
+ "iconAlt": {
298
+ "description": "The alt for the custom button icon",
299
+ "type": "string",
300
+ "title": "iconAlt"
301
+ },
302
+ "iconType": {
303
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
304
+ "type": "string",
305
+ "title": "iconType"
306
+ },
307
+ "icon": {
308
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
309
+ "type": "string",
310
+ "title": "icon"
311
+ }
312
+ },
313
+ "required": [
314
+ "event",
315
+ "icon",
316
+ "iconAlt",
317
+ "iconType"
318
+ ]
319
+ },
320
+ "title": "customPlugins"
210
321
  }
211
322
  }
212
323
  },
@@ -278,6 +389,43 @@
278
389
  "title": "disabled"
279
390
  }
280
391
  }
392
+ },
393
+ "customPlugins": {
394
+ "description": "An array of objects that determine custom plugins.\nA custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).\nExample can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.",
395
+ "type": "array",
396
+ "items": {
397
+ "title": "CustomPlugin",
398
+ "type": "object",
399
+ "properties": {
400
+ "event": {
401
+ "description": "The name of the custom event. It needs to be valid (only letters, numbers and \"_\" can be used).\nPIE will emit the event prefixed with \"PIE-\".\nEg: event = 'client_custom_event_A' => the emitted event will be \"PIE-client_custom_event_A\"",
402
+ "type": "string",
403
+ "title": "event"
404
+ },
405
+ "iconAlt": {
406
+ "description": "The alt for the custom button icon",
407
+ "type": "string",
408
+ "title": "iconAlt"
409
+ },
410
+ "iconType": {
411
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
412
+ "type": "string",
413
+ "title": "iconType"
414
+ },
415
+ "icon": {
416
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
417
+ "type": "string",
418
+ "title": "icon"
419
+ }
420
+ },
421
+ "required": [
422
+ "event",
423
+ "icon",
424
+ "iconAlt",
425
+ "iconType"
426
+ ]
427
+ },
428
+ "title": "customPlugins"
281
429
  }
282
430
  }
283
431
  },
@@ -595,6 +743,43 @@
595
743
  "title": "disabled"
596
744
  }
597
745
  }
746
+ },
747
+ "customPlugins": {
748
+ "description": "An array of objects that determine custom plugins.\nA custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).\nExample can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.",
749
+ "type": "array",
750
+ "items": {
751
+ "title": "CustomPlugin",
752
+ "type": "object",
753
+ "properties": {
754
+ "event": {
755
+ "description": "The name of the custom event. It needs to be valid (only letters, numbers and \"_\" can be used).\nPIE will emit the event prefixed with \"PIE-\".\nEg: event = 'client_custom_event_A' => the emitted event will be \"PIE-client_custom_event_A\"",
756
+ "type": "string",
757
+ "title": "event"
758
+ },
759
+ "iconAlt": {
760
+ "description": "The alt for the custom button icon",
761
+ "type": "string",
762
+ "title": "iconAlt"
763
+ },
764
+ "iconType": {
765
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
766
+ "type": "string",
767
+ "title": "iconType"
768
+ },
769
+ "icon": {
770
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
771
+ "type": "string",
772
+ "title": "icon"
773
+ }
774
+ },
775
+ "required": [
776
+ "event",
777
+ "icon",
778
+ "iconAlt",
779
+ "iconType"
780
+ ]
781
+ },
782
+ "title": "customPlugins"
598
783
  }
599
784
  }
600
785
  },
@@ -609,6 +794,38 @@
609
794
  }
610
795
  }
611
796
  },
797
+ "CustomPlugin": {
798
+ "title": "CustomPlugin",
799
+ "type": "object",
800
+ "properties": {
801
+ "event": {
802
+ "description": "The name of the custom event. It needs to be valid (only letters, numbers and \"_\" can be used).\nPIE will emit the event prefixed with \"PIE-\".\nEg: event = 'client_custom_event_A' => the emitted event will be \"PIE-client_custom_event_A\"",
803
+ "type": "string",
804
+ "title": "event"
805
+ },
806
+ "iconAlt": {
807
+ "description": "The alt for the custom button icon",
808
+ "type": "string",
809
+ "title": "iconAlt"
810
+ },
811
+ "iconType": {
812
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
813
+ "type": "string",
814
+ "title": "iconType"
815
+ },
816
+ "icon": {
817
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
818
+ "type": "string",
819
+ "title": "icon"
820
+ }
821
+ },
822
+ "required": [
823
+ "event",
824
+ "icon",
825
+ "iconAlt",
826
+ "iconType"
827
+ ]
828
+ },
612
829
  "ConfigureProp": {
613
830
  "title": "ConfigureProp",
614
831
  "type": "object",
@@ -676,6 +893,43 @@
676
893
  "title": "disabled"
677
894
  }
678
895
  }
896
+ },
897
+ "customPlugins": {
898
+ "description": "An array of objects that determine custom plugins.\nA custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).\nExample can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.",
899
+ "type": "array",
900
+ "items": {
901
+ "title": "CustomPlugin",
902
+ "type": "object",
903
+ "properties": {
904
+ "event": {
905
+ "description": "The name of the custom event. It needs to be valid (only letters, numbers and \"_\" can be used).\nPIE will emit the event prefixed with \"PIE-\".\nEg: event = 'client_custom_event_A' => the emitted event will be \"PIE-client_custom_event_A\"",
906
+ "type": "string",
907
+ "title": "event"
908
+ },
909
+ "iconAlt": {
910
+ "description": "The alt for the custom button icon",
911
+ "type": "string",
912
+ "title": "iconAlt"
913
+ },
914
+ "iconType": {
915
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
916
+ "type": "string",
917
+ "title": "iconType"
918
+ },
919
+ "icon": {
920
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
921
+ "type": "string",
922
+ "title": "icon"
923
+ }
924
+ },
925
+ "required": [
926
+ "event",
927
+ "icon",
928
+ "iconAlt",
929
+ "iconType"
930
+ ]
931
+ },
932
+ "title": "customPlugins"
679
933
  }
680
934
  }
681
935
  },
@@ -38,6 +38,35 @@ Properties of the `image` object:
38
38
 
39
39
  Indicates if the plugin is disabled or not
40
40
 
41
+ ## `customPlugins` (array)
42
+
43
+ An array of objects that determine custom plugins.
44
+ A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
45
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
46
+
47
+ The object is an array with all elements of the type `object`.
48
+
49
+ The array object has the following properties:
50
+
51
+ ### `event` (string, required)
52
+
53
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
54
+ PIE will emit the event prefixed with "PIE-".
55
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
56
+
57
+ ### `iconAlt` (string, required)
58
+
59
+ The alt for the custom button icon
60
+
61
+ ### `iconType` (string, required)
62
+
63
+ The icon type.
64
+ Currently, only "SVG" is supported.
65
+
66
+ ### `icon` (string, required)
67
+
68
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
69
+
41
70
  # `multipleCorrect` (object)
42
71
 
43
72
  Properties of the `multipleCorrect` object:
@@ -102,6 +131,35 @@ Properties of the `image` object:
102
131
 
103
132
  Indicates if the plugin is disabled or not
104
133
 
134
+ ### `customPlugins` (array)
135
+
136
+ An array of objects that determine custom plugins.
137
+ A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
138
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
139
+
140
+ The object is an array with all elements of the type `object`.
141
+
142
+ The array object has the following properties:
143
+
144
+ #### `event` (string, required)
145
+
146
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
147
+ PIE will emit the event prefixed with "PIE-".
148
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
149
+
150
+ #### `iconAlt` (string, required)
151
+
152
+ The alt for the custom button icon
153
+
154
+ #### `iconType` (string, required)
155
+
156
+ The icon type.
157
+ Currently, only "SVG" is supported.
158
+
159
+ #### `icon` (string, required)
160
+
161
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
162
+
105
163
  ## `required` (boolean)
106
164
 
107
165
  Indicates if the item is required and the value cannot be empty
@@ -154,6 +212,35 @@ Properties of the `image` object:
154
212
 
155
213
  Indicates if the plugin is disabled or not
156
214
 
215
+ ### `customPlugins` (array)
216
+
217
+ An array of objects that determine custom plugins.
218
+ A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
219
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
220
+
221
+ The object is an array with all elements of the type `object`.
222
+
223
+ The array object has the following properties:
224
+
225
+ #### `event` (string, required)
226
+
227
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
228
+ PIE will emit the event prefixed with "PIE-".
229
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
230
+
231
+ #### `iconAlt` (string, required)
232
+
233
+ The alt for the custom button icon
234
+
235
+ #### `iconType` (string, required)
236
+
237
+ The icon type.
238
+ Currently, only "SVG" is supported.
239
+
240
+ #### `icon` (string, required)
241
+
242
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
243
+
157
244
  ## `required` (boolean)
158
245
 
159
246
  Indicates if the item is required and the value cannot be empty
@@ -206,6 +293,35 @@ Properties of the `image` object:
206
293
 
207
294
  Indicates if the plugin is disabled or not
208
295
 
296
+ ### `customPlugins` (array)
297
+
298
+ An array of objects that determine custom plugins.
299
+ A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
300
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
301
+
302
+ The object is an array with all elements of the type `object`.
303
+
304
+ The array object has the following properties:
305
+
306
+ #### `event` (string, required)
307
+
308
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
309
+ PIE will emit the event prefixed with "PIE-".
310
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
311
+
312
+ #### `iconAlt` (string, required)
313
+
314
+ The alt for the custom button icon
315
+
316
+ #### `iconType` (string, required)
317
+
318
+ The icon type.
319
+ Currently, only "SVG" is supported.
320
+
321
+ #### `icon` (string, required)
322
+
323
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
324
+
209
325
  ## `required` (boolean)
210
326
 
211
327
  Indicates if the item is required and the value cannot be empty
@@ -448,6 +564,35 @@ Properties of the `image` object:
448
564
 
449
565
  Indicates if the plugin is disabled or not
450
566
 
567
+ ### `customPlugins` (array)
568
+
569
+ An array of objects that determine custom plugins.
570
+ A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
571
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
572
+
573
+ The object is an array with all elements of the type `object`.
574
+
575
+ The array object has the following properties:
576
+
577
+ #### `event` (string, required)
578
+
579
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
580
+ PIE will emit the event prefixed with "PIE-".
581
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
582
+
583
+ #### `iconAlt` (string, required)
584
+
585
+ The alt for the custom button icon
586
+
587
+ #### `iconType` (string, required)
588
+
589
+ The icon type.
590
+ Currently, only "SVG" is supported.
591
+
592
+ #### `icon` (string, required)
593
+
594
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
595
+
451
596
  ## `EditableHtmlButtonConfigure` (object)
452
597
 
453
598
  Properties of the `EditableHtmlButtonConfigure` object:
@@ -456,6 +601,29 @@ Properties of the `EditableHtmlButtonConfigure` object:
456
601
 
457
602
  Indicates if the plugin is disabled or not
458
603
 
604
+ ## `CustomPlugin` (object)
605
+
606
+ Properties of the `CustomPlugin` object:
607
+
608
+ ### `event` (string, required)
609
+
610
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
611
+ PIE will emit the event prefixed with "PIE-".
612
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
613
+
614
+ ### `iconAlt` (string, required)
615
+
616
+ The alt for the custom button icon
617
+
618
+ ### `iconType` (string, required)
619
+
620
+ The icon type.
621
+ Currently, only "SVG" is supported.
622
+
623
+ ### `icon` (string, required)
624
+
625
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
626
+
459
627
  ## `ConfigureProp` (object)
460
628
 
461
629
  Properties of the `ConfigureProp` object:
@@ -508,6 +676,35 @@ Properties of the `image` object:
508
676
 
509
677
  Indicates if the plugin is disabled or not
510
678
 
679
+ #### `customPlugins` (array)
680
+
681
+ An array of objects that determine custom plugins.
682
+ A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
683
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
684
+
685
+ The object is an array with all elements of the type `object`.
686
+
687
+ The array object has the following properties:
688
+
689
+ ##### `event` (string, required)
690
+
691
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
692
+ PIE will emit the event prefixed with "PIE-".
693
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
694
+
695
+ ##### `iconAlt` (string, required)
696
+
697
+ The alt for the custom button icon
698
+
699
+ ##### `iconType` (string, required)
700
+
701
+ The icon type.
702
+ Currently, only "SVG" is supported.
703
+
704
+ ##### `icon` (string, required)
705
+
706
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
707
+
511
708
  ### `required` (boolean)
512
709
 
513
710
  Indicates if the item is required and the value cannot be empty
@@ -308,6 +308,43 @@
308
308
  "title": "disabled"
309
309
  }
310
310
  }
311
+ },
312
+ "customPlugins": {
313
+ "description": "An array of objects that determine custom plugins.\nA custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).\nExample can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.",
314
+ "type": "array",
315
+ "items": {
316
+ "title": "CustomPlugin",
317
+ "type": "object",
318
+ "properties": {
319
+ "event": {
320
+ "description": "The name of the custom event. It needs to be valid (only letters, numbers and \"_\" can be used).\nPIE will emit the event prefixed with \"PIE-\".\nEg: event = 'client_custom_event_A' => the emitted event will be \"PIE-client_custom_event_A\"",
321
+ "type": "string",
322
+ "title": "event"
323
+ },
324
+ "iconAlt": {
325
+ "description": "The alt for the custom button icon",
326
+ "type": "string",
327
+ "title": "iconAlt"
328
+ },
329
+ "iconType": {
330
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
331
+ "type": "string",
332
+ "title": "iconType"
333
+ },
334
+ "icon": {
335
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
336
+ "type": "string",
337
+ "title": "icon"
338
+ }
339
+ },
340
+ "required": [
341
+ "event",
342
+ "icon",
343
+ "iconAlt",
344
+ "iconType"
345
+ ]
346
+ },
347
+ "title": "customPlugins"
311
348
  }
312
349
  }
313
350
  },
@@ -322,6 +359,38 @@
322
359
  }
323
360
  }
324
361
  },
362
+ "CustomPlugin": {
363
+ "title": "CustomPlugin",
364
+ "type": "object",
365
+ "properties": {
366
+ "event": {
367
+ "description": "The name of the custom event. It needs to be valid (only letters, numbers and \"_\" can be used).\nPIE will emit the event prefixed with \"PIE-\".\nEg: event = 'client_custom_event_A' => the emitted event will be \"PIE-client_custom_event_A\"",
368
+ "type": "string",
369
+ "title": "event"
370
+ },
371
+ "iconAlt": {
372
+ "description": "The alt for the custom button icon",
373
+ "type": "string",
374
+ "title": "iconAlt"
375
+ },
376
+ "iconType": {
377
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
378
+ "type": "string",
379
+ "title": "iconType"
380
+ },
381
+ "icon": {
382
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
383
+ "type": "string",
384
+ "title": "icon"
385
+ }
386
+ },
387
+ "required": [
388
+ "event",
389
+ "icon",
390
+ "iconAlt",
391
+ "iconType"
392
+ ]
393
+ },
325
394
  "ConfigureProp": {
326
395
  "title": "ConfigureProp",
327
396
  "type": "object",
@@ -389,6 +458,43 @@
389
458
  "title": "disabled"
390
459
  }
391
460
  }
461
+ },
462
+ "customPlugins": {
463
+ "description": "An array of objects that determine custom plugins.\nA custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).\nExample can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.",
464
+ "type": "array",
465
+ "items": {
466
+ "title": "CustomPlugin",
467
+ "type": "object",
468
+ "properties": {
469
+ "event": {
470
+ "description": "The name of the custom event. It needs to be valid (only letters, numbers and \"_\" can be used).\nPIE will emit the event prefixed with \"PIE-\".\nEg: event = 'client_custom_event_A' => the emitted event will be \"PIE-client_custom_event_A\"",
471
+ "type": "string",
472
+ "title": "event"
473
+ },
474
+ "iconAlt": {
475
+ "description": "The alt for the custom button icon",
476
+ "type": "string",
477
+ "title": "iconAlt"
478
+ },
479
+ "iconType": {
480
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
481
+ "type": "string",
482
+ "title": "iconType"
483
+ },
484
+ "icon": {
485
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
486
+ "type": "string",
487
+ "title": "icon"
488
+ }
489
+ },
490
+ "required": [
491
+ "event",
492
+ "icon",
493
+ "iconAlt",
494
+ "iconType"
495
+ ]
496
+ },
497
+ "title": "customPlugins"
392
498
  }
393
499
  }
394
500
  },
@@ -220,6 +220,35 @@ Properties of the `image` object:
220
220
 
221
221
  Indicates if the plugin is disabled or not
222
222
 
223
+ ### `customPlugins` (array)
224
+
225
+ An array of objects that determine custom plugins.
226
+ A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
227
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
228
+
229
+ The object is an array with all elements of the type `object`.
230
+
231
+ The array object has the following properties:
232
+
233
+ #### `event` (string, required)
234
+
235
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
236
+ PIE will emit the event prefixed with "PIE-".
237
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
238
+
239
+ #### `iconAlt` (string, required)
240
+
241
+ The alt for the custom button icon
242
+
243
+ #### `iconType` (string, required)
244
+
245
+ The icon type.
246
+ Currently, only "SVG" is supported.
247
+
248
+ #### `icon` (string, required)
249
+
250
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
251
+
223
252
  ## `EditableHtmlButtonConfigure` (object)
224
253
 
225
254
  Properties of the `EditableHtmlButtonConfigure` object:
@@ -228,6 +257,29 @@ Properties of the `EditableHtmlButtonConfigure` object:
228
257
 
229
258
  Indicates if the plugin is disabled or not
230
259
 
260
+ ## `CustomPlugin` (object)
261
+
262
+ Properties of the `CustomPlugin` object:
263
+
264
+ ### `event` (string, required)
265
+
266
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
267
+ PIE will emit the event prefixed with "PIE-".
268
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
269
+
270
+ ### `iconAlt` (string, required)
271
+
272
+ The alt for the custom button icon
273
+
274
+ ### `iconType` (string, required)
275
+
276
+ The icon type.
277
+ Currently, only "SVG" is supported.
278
+
279
+ ### `icon` (string, required)
280
+
281
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
282
+
231
283
  ## `ConfigureProp` (object)
232
284
 
233
285
  Properties of the `ConfigureProp` object:
@@ -280,6 +332,35 @@ Properties of the `image` object:
280
332
 
281
333
  Indicates if the plugin is disabled or not
282
334
 
335
+ #### `customPlugins` (array)
336
+
337
+ An array of objects that determine custom plugins.
338
+ A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
339
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
340
+
341
+ The object is an array with all elements of the type `object`.
342
+
343
+ The array object has the following properties:
344
+
345
+ ##### `event` (string, required)
346
+
347
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
348
+ PIE will emit the event prefixed with "PIE-".
349
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
350
+
351
+ ##### `iconAlt` (string, required)
352
+
353
+ The alt for the custom button icon
354
+
355
+ ##### `iconType` (string, required)
356
+
357
+ The icon type.
358
+ Currently, only "SVG" is supported.
359
+
360
+ ##### `icon` (string, required)
361
+
362
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
363
+
283
364
  ### `required` (boolean)
284
365
 
285
366
  Indicates if the item is required and the value cannot be empty
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pie-element/hotspot",
3
- "version": "6.14.1-next.5+579694d54",
3
+ "version": "6.15.0",
4
4
  "description": "",
5
5
  "repository": "pie-framework/pie-elements",
6
6
  "publishConfig": {
@@ -9,7 +9,7 @@
9
9
  "dependencies": {
10
10
  "@material-ui/core": "^3.9.3",
11
11
  "@pie-framework/pie-player-events": "^0.1.0",
12
- "@pie-lib/pie-toolbox": "1.12.3",
12
+ "@pie-lib/pie-toolbox": "1.13.0",
13
13
  "konva": "^3.2.5",
14
14
  "prop-types": "^15.6.1",
15
15
  "react": "^16.8.1",
@@ -18,7 +18,7 @@
18
18
  },
19
19
  "author": "pie framework developers",
20
20
  "license": "ISC",
21
- "gitHead": "579694d5468995065657b651f06ec9513d0476b6",
21
+ "gitHead": "8aa41b3cc02c1b22eabc23d971e0b6659e82eee7",
22
22
  "scripts": {
23
23
  "postpublish": "../../scripts/postpublish"
24
24
  },