@pie-element/explicit-constructed-response 6.9.1-next.0 → 6.9.1-next.16

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.
@@ -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
  },
@@ -120,6 +157,43 @@
120
157
  "title": "disabled"
121
158
  }
122
159
  }
160
+ },
161
+ "customPlugins": {
162
+ "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.",
163
+ "type": "array",
164
+ "items": {
165
+ "title": "CustomPlugin",
166
+ "type": "object",
167
+ "properties": {
168
+ "event": {
169
+ "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\"",
170
+ "type": "string",
171
+ "title": "event"
172
+ },
173
+ "iconAlt": {
174
+ "description": "The alt for the custom button icon",
175
+ "type": "string",
176
+ "title": "iconAlt"
177
+ },
178
+ "iconType": {
179
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
180
+ "type": "string",
181
+ "title": "iconType"
182
+ },
183
+ "icon": {
184
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
185
+ "type": "string",
186
+ "title": "icon"
187
+ }
188
+ },
189
+ "required": [
190
+ "event",
191
+ "icon",
192
+ "iconAlt",
193
+ "iconType"
194
+ ]
195
+ },
196
+ "title": "customPlugins"
123
197
  }
124
198
  }
125
199
  },
@@ -191,6 +265,43 @@
191
265
  "title": "disabled"
192
266
  }
193
267
  }
268
+ },
269
+ "customPlugins": {
270
+ "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.",
271
+ "type": "array",
272
+ "items": {
273
+ "title": "CustomPlugin",
274
+ "type": "object",
275
+ "properties": {
276
+ "event": {
277
+ "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\"",
278
+ "type": "string",
279
+ "title": "event"
280
+ },
281
+ "iconAlt": {
282
+ "description": "The alt for the custom button icon",
283
+ "type": "string",
284
+ "title": "iconAlt"
285
+ },
286
+ "iconType": {
287
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
288
+ "type": "string",
289
+ "title": "iconType"
290
+ },
291
+ "icon": {
292
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
293
+ "type": "string",
294
+ "title": "icon"
295
+ }
296
+ },
297
+ "required": [
298
+ "event",
299
+ "icon",
300
+ "iconAlt",
301
+ "iconType"
302
+ ]
303
+ },
304
+ "title": "customPlugins"
194
305
  }
195
306
  }
196
307
  },
@@ -331,6 +442,43 @@
331
442
  "title": "disabled"
332
443
  }
333
444
  }
445
+ },
446
+ "customPlugins": {
447
+ "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.",
448
+ "type": "array",
449
+ "items": {
450
+ "title": "CustomPlugin",
451
+ "type": "object",
452
+ "properties": {
453
+ "event": {
454
+ "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\"",
455
+ "type": "string",
456
+ "title": "event"
457
+ },
458
+ "iconAlt": {
459
+ "description": "The alt for the custom button icon",
460
+ "type": "string",
461
+ "title": "iconAlt"
462
+ },
463
+ "iconType": {
464
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
465
+ "type": "string",
466
+ "title": "iconType"
467
+ },
468
+ "icon": {
469
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
470
+ "type": "string",
471
+ "title": "icon"
472
+ }
473
+ },
474
+ "required": [
475
+ "event",
476
+ "icon",
477
+ "iconAlt",
478
+ "iconType"
479
+ ]
480
+ },
481
+ "title": "customPlugins"
334
482
  }
335
483
  }
336
484
  },
@@ -402,6 +550,43 @@
402
550
  "title": "disabled"
403
551
  }
404
552
  }
553
+ },
554
+ "customPlugins": {
555
+ "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.",
556
+ "type": "array",
557
+ "items": {
558
+ "title": "CustomPlugin",
559
+ "type": "object",
560
+ "properties": {
561
+ "event": {
562
+ "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\"",
563
+ "type": "string",
564
+ "title": "event"
565
+ },
566
+ "iconAlt": {
567
+ "description": "The alt for the custom button icon",
568
+ "type": "string",
569
+ "title": "iconAlt"
570
+ },
571
+ "iconType": {
572
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
573
+ "type": "string",
574
+ "title": "iconType"
575
+ },
576
+ "icon": {
577
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
578
+ "type": "string",
579
+ "title": "icon"
580
+ }
581
+ },
582
+ "required": [
583
+ "event",
584
+ "icon",
585
+ "iconAlt",
586
+ "iconType"
587
+ ]
588
+ },
589
+ "title": "customPlugins"
405
590
  }
406
591
  }
407
592
  },
@@ -715,6 +900,43 @@
715
900
  "title": "disabled"
716
901
  }
717
902
  }
903
+ },
904
+ "customPlugins": {
905
+ "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.",
906
+ "type": "array",
907
+ "items": {
908
+ "title": "CustomPlugin",
909
+ "type": "object",
910
+ "properties": {
911
+ "event": {
912
+ "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\"",
913
+ "type": "string",
914
+ "title": "event"
915
+ },
916
+ "iconAlt": {
917
+ "description": "The alt for the custom button icon",
918
+ "type": "string",
919
+ "title": "iconAlt"
920
+ },
921
+ "iconType": {
922
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
923
+ "type": "string",
924
+ "title": "iconType"
925
+ },
926
+ "icon": {
927
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
928
+ "type": "string",
929
+ "title": "icon"
930
+ }
931
+ },
932
+ "required": [
933
+ "event",
934
+ "icon",
935
+ "iconAlt",
936
+ "iconType"
937
+ ]
938
+ },
939
+ "title": "customPlugins"
718
940
  }
719
941
  }
720
942
  },
@@ -729,6 +951,38 @@
729
951
  }
730
952
  }
731
953
  },
954
+ "CustomPlugin": {
955
+ "title": "CustomPlugin",
956
+ "type": "object",
957
+ "properties": {
958
+ "event": {
959
+ "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\"",
960
+ "type": "string",
961
+ "title": "event"
962
+ },
963
+ "iconAlt": {
964
+ "description": "The alt for the custom button icon",
965
+ "type": "string",
966
+ "title": "iconAlt"
967
+ },
968
+ "iconType": {
969
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
970
+ "type": "string",
971
+ "title": "iconType"
972
+ },
973
+ "icon": {
974
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
975
+ "type": "string",
976
+ "title": "icon"
977
+ }
978
+ },
979
+ "required": [
980
+ "event",
981
+ "icon",
982
+ "iconAlt",
983
+ "iconType"
984
+ ]
985
+ },
732
986
  "ConfigureProp": {
733
987
  "title": "ConfigureProp",
734
988
  "type": "object",
@@ -796,6 +1050,43 @@
796
1050
  "title": "disabled"
797
1051
  }
798
1052
  }
1053
+ },
1054
+ "customPlugins": {
1055
+ "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.",
1056
+ "type": "array",
1057
+ "items": {
1058
+ "title": "CustomPlugin",
1059
+ "type": "object",
1060
+ "properties": {
1061
+ "event": {
1062
+ "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\"",
1063
+ "type": "string",
1064
+ "title": "event"
1065
+ },
1066
+ "iconAlt": {
1067
+ "description": "The alt for the custom button icon",
1068
+ "type": "string",
1069
+ "title": "iconAlt"
1070
+ },
1071
+ "iconType": {
1072
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
1073
+ "type": "string",
1074
+ "title": "iconType"
1075
+ },
1076
+ "icon": {
1077
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
1078
+ "type": "string",
1079
+ "title": "icon"
1080
+ }
1081
+ },
1082
+ "required": [
1083
+ "event",
1084
+ "icon",
1085
+ "iconAlt",
1086
+ "iconType"
1087
+ ]
1088
+ },
1089
+ "title": "customPlugins"
799
1090
  }
800
1091
  }
801
1092
  },
@@ -867,6 +1158,43 @@
867
1158
  "title": "disabled"
868
1159
  }
869
1160
  }
1161
+ },
1162
+ "customPlugins": {
1163
+ "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.",
1164
+ "type": "array",
1165
+ "items": {
1166
+ "title": "CustomPlugin",
1167
+ "type": "object",
1168
+ "properties": {
1169
+ "event": {
1170
+ "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\"",
1171
+ "type": "string",
1172
+ "title": "event"
1173
+ },
1174
+ "iconAlt": {
1175
+ "description": "The alt for the custom button icon",
1176
+ "type": "string",
1177
+ "title": "iconAlt"
1178
+ },
1179
+ "iconType": {
1180
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
1181
+ "type": "string",
1182
+ "title": "iconType"
1183
+ },
1184
+ "icon": {
1185
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
1186
+ "type": "string",
1187
+ "title": "icon"
1188
+ }
1189
+ },
1190
+ "required": [
1191
+ "event",
1192
+ "icon",
1193
+ "iconAlt",
1194
+ "iconType"
1195
+ ]
1196
+ },
1197
+ "title": "customPlugins"
870
1198
  }
871
1199
  }
872
1200
  },
@@ -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
  # `choices` (object)
42
71
 
43
72
  Properties of the `choices` object:
@@ -90,6 +119,35 @@ Properties of the `image` object:
90
119
 
91
120
  Indicates if the plugin is disabled or not
92
121
 
122
+ ### `customPlugins` (array)
123
+
124
+ An array of objects that determine custom plugins.
125
+ 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).
126
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
127
+
128
+ The object is an array with all elements of the type `object`.
129
+
130
+ The array object has the following properties:
131
+
132
+ #### `event` (string, required)
133
+
134
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
135
+ PIE will emit the event prefixed with "PIE-".
136
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
137
+
138
+ #### `iconAlt` (string, required)
139
+
140
+ The alt for the custom button icon
141
+
142
+ #### `iconType` (string, required)
143
+
144
+ The icon type.
145
+ Currently, only "SVG" is supported.
146
+
147
+ #### `icon` (string, required)
148
+
149
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
150
+
93
151
  ## `required` (boolean)
94
152
 
95
153
  Indicates if the item is required and the value cannot be empty
@@ -142,6 +200,35 @@ Properties of the `image` object:
142
200
 
143
201
  Indicates if the plugin is disabled or not
144
202
 
203
+ ### `customPlugins` (array)
204
+
205
+ An array of objects that determine custom plugins.
206
+ 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).
207
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
208
+
209
+ The object is an array with all elements of the type `object`.
210
+
211
+ The array object has the following properties:
212
+
213
+ #### `event` (string, required)
214
+
215
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
216
+ PIE will emit the event prefixed with "PIE-".
217
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
218
+
219
+ #### `iconAlt` (string, required)
220
+
221
+ The alt for the custom button icon
222
+
223
+ #### `iconType` (string, required)
224
+
225
+ The icon type.
226
+ Currently, only "SVG" is supported.
227
+
228
+ #### `icon` (string, required)
229
+
230
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
231
+
145
232
  ## `required` (boolean)
146
233
 
147
234
  Indicates if the item is required and the value cannot be empty
@@ -246,6 +333,35 @@ Properties of the `image` object:
246
333
 
247
334
  Indicates if the plugin is disabled or not
248
335
 
336
+ ### `customPlugins` (array)
337
+
338
+ An array of objects that determine custom plugins.
339
+ 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).
340
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
341
+
342
+ The object is an array with all elements of the type `object`.
343
+
344
+ The array object has the following properties:
345
+
346
+ #### `event` (string, required)
347
+
348
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
349
+ PIE will emit the event prefixed with "PIE-".
350
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
351
+
352
+ #### `iconAlt` (string, required)
353
+
354
+ The alt for the custom button icon
355
+
356
+ #### `iconType` (string, required)
357
+
358
+ The icon type.
359
+ Currently, only "SVG" is supported.
360
+
361
+ #### `icon` (string, required)
362
+
363
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
364
+
249
365
  ## `required` (boolean)
250
366
 
251
367
  Indicates if the item is required and the value cannot be empty
@@ -298,6 +414,35 @@ Properties of the `image` object:
298
414
 
299
415
  Indicates if the plugin is disabled or not
300
416
 
417
+ ### `customPlugins` (array)
418
+
419
+ An array of objects that determine custom plugins.
420
+ 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).
421
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
422
+
423
+ The object is an array with all elements of the type `object`.
424
+
425
+ The array object has the following properties:
426
+
427
+ #### `event` (string, required)
428
+
429
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
430
+ PIE will emit the event prefixed with "PIE-".
431
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
432
+
433
+ #### `iconAlt` (string, required)
434
+
435
+ The alt for the custom button icon
436
+
437
+ #### `iconType` (string, required)
438
+
439
+ The icon type.
440
+ Currently, only "SVG" is supported.
441
+
442
+ #### `icon` (string, required)
443
+
444
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
445
+
301
446
  ## `settings` (boolean)
302
447
 
303
448
  Indicates if the item has to be displayed in the Settings Panel
@@ -536,6 +681,35 @@ Properties of the `image` object:
536
681
 
537
682
  Indicates if the plugin is disabled or not
538
683
 
684
+ ### `customPlugins` (array)
685
+
686
+ An array of objects that determine custom plugins.
687
+ 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).
688
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
689
+
690
+ The object is an array with all elements of the type `object`.
691
+
692
+ The array object has the following properties:
693
+
694
+ #### `event` (string, required)
695
+
696
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
697
+ PIE will emit the event prefixed with "PIE-".
698
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
699
+
700
+ #### `iconAlt` (string, required)
701
+
702
+ The alt for the custom button icon
703
+
704
+ #### `iconType` (string, required)
705
+
706
+ The icon type.
707
+ Currently, only "SVG" is supported.
708
+
709
+ #### `icon` (string, required)
710
+
711
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
712
+
539
713
  ## `EditableHtmlButtonConfigure` (object)
540
714
 
541
715
  Properties of the `EditableHtmlButtonConfigure` object:
@@ -544,6 +718,29 @@ Properties of the `EditableHtmlButtonConfigure` object:
544
718
 
545
719
  Indicates if the plugin is disabled or not
546
720
 
721
+ ## `CustomPlugin` (object)
722
+
723
+ Properties of the `CustomPlugin` object:
724
+
725
+ ### `event` (string, required)
726
+
727
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
728
+ PIE will emit the event prefixed with "PIE-".
729
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
730
+
731
+ ### `iconAlt` (string, required)
732
+
733
+ The alt for the custom button icon
734
+
735
+ ### `iconType` (string, required)
736
+
737
+ The icon type.
738
+ Currently, only "SVG" is supported.
739
+
740
+ ### `icon` (string, required)
741
+
742
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
743
+
547
744
  ## `ConfigureProp` (object)
548
745
 
549
746
  Properties of the `ConfigureProp` object:
@@ -596,6 +793,35 @@ Properties of the `image` object:
596
793
 
597
794
  Indicates if the plugin is disabled or not
598
795
 
796
+ #### `customPlugins` (array)
797
+
798
+ An array of objects that determine custom plugins.
799
+ 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).
800
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
801
+
802
+ The object is an array with all elements of the type `object`.
803
+
804
+ The array object has the following properties:
805
+
806
+ ##### `event` (string, required)
807
+
808
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
809
+ PIE will emit the event prefixed with "PIE-".
810
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
811
+
812
+ ##### `iconAlt` (string, required)
813
+
814
+ The alt for the custom button icon
815
+
816
+ ##### `iconType` (string, required)
817
+
818
+ The icon type.
819
+ Currently, only "SVG" is supported.
820
+
821
+ ##### `icon` (string, required)
822
+
823
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
824
+
599
825
  ### `required` (boolean)
600
826
 
601
827
  Indicates if the item is required and the value cannot be empty
@@ -648,6 +874,35 @@ Properties of the `image` object:
648
874
 
649
875
  Indicates if the plugin is disabled or not
650
876
 
877
+ #### `customPlugins` (array)
878
+
879
+ An array of objects that determine custom plugins.
880
+ 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).
881
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
882
+
883
+ The object is an array with all elements of the type `object`.
884
+
885
+ The array object has the following properties:
886
+
887
+ ##### `event` (string, required)
888
+
889
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
890
+ PIE will emit the event prefixed with "PIE-".
891
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
892
+
893
+ ##### `iconAlt` (string, required)
894
+
895
+ The alt for the custom button icon
896
+
897
+ ##### `iconType` (string, required)
898
+
899
+ The icon type.
900
+ Currently, only "SVG" is supported.
901
+
902
+ ##### `icon` (string, required)
903
+
904
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
905
+
651
906
  ### `settings` (boolean)
652
907
 
653
908
  Indicates if the item has to be displayed in the Settings Panel
@@ -216,6 +216,43 @@
216
216
  "title": "disabled"
217
217
  }
218
218
  }
219
+ },
220
+ "customPlugins": {
221
+ "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.",
222
+ "type": "array",
223
+ "items": {
224
+ "title": "CustomPlugin",
225
+ "type": "object",
226
+ "properties": {
227
+ "event": {
228
+ "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\"",
229
+ "type": "string",
230
+ "title": "event"
231
+ },
232
+ "iconAlt": {
233
+ "description": "The alt for the custom button icon",
234
+ "type": "string",
235
+ "title": "iconAlt"
236
+ },
237
+ "iconType": {
238
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
239
+ "type": "string",
240
+ "title": "iconType"
241
+ },
242
+ "icon": {
243
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
244
+ "type": "string",
245
+ "title": "icon"
246
+ }
247
+ },
248
+ "required": [
249
+ "event",
250
+ "icon",
251
+ "iconAlt",
252
+ "iconType"
253
+ ]
254
+ },
255
+ "title": "customPlugins"
219
256
  }
220
257
  }
221
258
  },
@@ -230,6 +267,38 @@
230
267
  }
231
268
  }
232
269
  },
270
+ "CustomPlugin": {
271
+ "title": "CustomPlugin",
272
+ "type": "object",
273
+ "properties": {
274
+ "event": {
275
+ "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\"",
276
+ "type": "string",
277
+ "title": "event"
278
+ },
279
+ "iconAlt": {
280
+ "description": "The alt for the custom button icon",
281
+ "type": "string",
282
+ "title": "iconAlt"
283
+ },
284
+ "iconType": {
285
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
286
+ "type": "string",
287
+ "title": "iconType"
288
+ },
289
+ "icon": {
290
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
291
+ "type": "string",
292
+ "title": "icon"
293
+ }
294
+ },
295
+ "required": [
296
+ "event",
297
+ "icon",
298
+ "iconAlt",
299
+ "iconType"
300
+ ]
301
+ },
233
302
  "ConfigureProp": {
234
303
  "title": "ConfigureProp",
235
304
  "type": "object",
@@ -297,6 +366,43 @@
297
366
  "title": "disabled"
298
367
  }
299
368
  }
369
+ },
370
+ "customPlugins": {
371
+ "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.",
372
+ "type": "array",
373
+ "items": {
374
+ "title": "CustomPlugin",
375
+ "type": "object",
376
+ "properties": {
377
+ "event": {
378
+ "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\"",
379
+ "type": "string",
380
+ "title": "event"
381
+ },
382
+ "iconAlt": {
383
+ "description": "The alt for the custom button icon",
384
+ "type": "string",
385
+ "title": "iconAlt"
386
+ },
387
+ "iconType": {
388
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
389
+ "type": "string",
390
+ "title": "iconType"
391
+ },
392
+ "icon": {
393
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
394
+ "type": "string",
395
+ "title": "icon"
396
+ }
397
+ },
398
+ "required": [
399
+ "event",
400
+ "icon",
401
+ "iconAlt",
402
+ "iconType"
403
+ ]
404
+ },
405
+ "title": "customPlugins"
300
406
  }
301
407
  }
302
408
  },
@@ -368,6 +474,43 @@
368
474
  "title": "disabled"
369
475
  }
370
476
  }
477
+ },
478
+ "customPlugins": {
479
+ "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.",
480
+ "type": "array",
481
+ "items": {
482
+ "title": "CustomPlugin",
483
+ "type": "object",
484
+ "properties": {
485
+ "event": {
486
+ "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\"",
487
+ "type": "string",
488
+ "title": "event"
489
+ },
490
+ "iconAlt": {
491
+ "description": "The alt for the custom button icon",
492
+ "type": "string",
493
+ "title": "iconAlt"
494
+ },
495
+ "iconType": {
496
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
497
+ "type": "string",
498
+ "title": "iconType"
499
+ },
500
+ "icon": {
501
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
502
+ "type": "string",
503
+ "title": "icon"
504
+ }
505
+ },
506
+ "required": [
507
+ "event",
508
+ "icon",
509
+ "iconAlt",
510
+ "iconType"
511
+ ]
512
+ },
513
+ "title": "customPlugins"
371
514
  }
372
515
  }
373
516
  },
@@ -148,6 +148,35 @@ Properties of the `image` object:
148
148
 
149
149
  Indicates if the plugin is disabled or not
150
150
 
151
+ ### `customPlugins` (array)
152
+
153
+ An array of objects that determine custom plugins.
154
+ 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).
155
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
156
+
157
+ The object is an array with all elements of the type `object`.
158
+
159
+ The array object has the following properties:
160
+
161
+ #### `event` (string, required)
162
+
163
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
164
+ PIE will emit the event prefixed with "PIE-".
165
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
166
+
167
+ #### `iconAlt` (string, required)
168
+
169
+ The alt for the custom button icon
170
+
171
+ #### `iconType` (string, required)
172
+
173
+ The icon type.
174
+ Currently, only "SVG" is supported.
175
+
176
+ #### `icon` (string, required)
177
+
178
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
179
+
151
180
  ## `EditableHtmlButtonConfigure` (object)
152
181
 
153
182
  Properties of the `EditableHtmlButtonConfigure` object:
@@ -156,6 +185,29 @@ Properties of the `EditableHtmlButtonConfigure` object:
156
185
 
157
186
  Indicates if the plugin is disabled or not
158
187
 
188
+ ## `CustomPlugin` (object)
189
+
190
+ Properties of the `CustomPlugin` object:
191
+
192
+ ### `event` (string, required)
193
+
194
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
195
+ PIE will emit the event prefixed with "PIE-".
196
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
197
+
198
+ ### `iconAlt` (string, required)
199
+
200
+ The alt for the custom button icon
201
+
202
+ ### `iconType` (string, required)
203
+
204
+ The icon type.
205
+ Currently, only "SVG" is supported.
206
+
207
+ ### `icon` (string, required)
208
+
209
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
210
+
159
211
  ## `ConfigureProp` (object)
160
212
 
161
213
  Properties of the `ConfigureProp` object:
@@ -208,6 +260,35 @@ Properties of the `image` object:
208
260
 
209
261
  Indicates if the plugin is disabled or not
210
262
 
263
+ #### `customPlugins` (array)
264
+
265
+ An array of objects that determine custom plugins.
266
+ 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).
267
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
268
+
269
+ The object is an array with all elements of the type `object`.
270
+
271
+ The array object has the following properties:
272
+
273
+ ##### `event` (string, required)
274
+
275
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
276
+ PIE will emit the event prefixed with "PIE-".
277
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
278
+
279
+ ##### `iconAlt` (string, required)
280
+
281
+ The alt for the custom button icon
282
+
283
+ ##### `iconType` (string, required)
284
+
285
+ The icon type.
286
+ Currently, only "SVG" is supported.
287
+
288
+ ##### `icon` (string, required)
289
+
290
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
291
+
211
292
  ### `required` (boolean)
212
293
 
213
294
  Indicates if the item is required and the value cannot be empty
@@ -260,6 +341,35 @@ Properties of the `image` object:
260
341
 
261
342
  Indicates if the plugin is disabled or not
262
343
 
344
+ #### `customPlugins` (array)
345
+
346
+ An array of objects that determine custom plugins.
347
+ 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).
348
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
349
+
350
+ The object is an array with all elements of the type `object`.
351
+
352
+ The array object has the following properties:
353
+
354
+ ##### `event` (string, required)
355
+
356
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
357
+ PIE will emit the event prefixed with "PIE-".
358
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
359
+
360
+ ##### `iconAlt` (string, required)
361
+
362
+ The alt for the custom button icon
363
+
364
+ ##### `iconType` (string, required)
365
+
366
+ The icon type.
367
+ Currently, only "SVG" is supported.
368
+
369
+ ##### `icon` (string, required)
370
+
371
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
372
+
263
373
  ### `settings` (boolean)
264
374
 
265
375
  Indicates if the item has to be displayed in the Settings Panel
@@ -1,4 +1,4 @@
1
- import {_dll_react, _dll_prop_types, _dll_classnames, _dll_react_dom, _dll_lodash, _dll_debug} from "../../../@pie-lib/pie-toolbox-math-rendering-module@1.5.2/module/index.js";
1
+ import {_dll_react, _dll_prop_types, _dll_classnames, _dll_react_dom, _dll_lodash, _dll_debug} from "../../../@pie-lib/pie-toolbox-math-rendering-module@1.5.3/module/index.js";
2
2
  import {_dll_pie_lib__pie_toolbox_editable_html, _dll_pie_lib__pie_toolbox_config_ui} from "../../../@pie-lib/pie-toolbox-module@4.0.0/module/index.js";
3
3
  var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
4
4
  function getDefaultExportFromCjs(x) {
package/module/element.js CHANGED
@@ -1,4 +1,4 @@
1
- import {_dll_react, _dll_prop_types, _dll_debug, _dll_lodash, _dll_react_dom_server, _dll_classnames, _dll_react_dom, _dll_pie_lib__pie_toolbox_math_rendering_accessible} from "../../../@pie-lib/pie-toolbox-math-rendering-module@1.5.2/module/index.js";
1
+ import {_dll_react, _dll_prop_types, _dll_debug, _dll_lodash, _dll_react_dom_server, _dll_classnames, _dll_react_dom, _dll_pie_lib__pie_toolbox_math_rendering_accessible} from "../../../@pie-lib/pie-toolbox-math-rendering-module@1.5.3/module/index.js";
2
2
  import {_dll_pie_lib__pie_toolbox_correct_answer_toggle, _dll_pie_lib__pie_toolbox_render_ui} from "../../../@pie-lib/pie-toolbox-module@4.0.0/module/index.js";
3
3
  var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
4
4
  function getDefaultExportFromCjs(x) {
@@ -4,7 +4,7 @@
4
4
  "modules": [
5
5
  {
6
6
  "name": "@pie-lib/pie-toolbox-math-rendering-module",
7
- "version": "1.5.2"
7
+ "version": "1.5.3"
8
8
  },
9
9
  {
10
10
  "name": "@pie-lib/pie-toolbox-module",
package/module/print.js CHANGED
@@ -1,4 +1,4 @@
1
- import {_dll_react, _dll_prop_types, _dll_debug, _dll_lodash, _dll_react_dom_server, _dll_classnames, _dll_react_dom, _dll_pie_lib__pie_toolbox_math_rendering_accessible} from "../../../@pie-lib/pie-toolbox-math-rendering-module@1.5.2/module/index.js";
1
+ import {_dll_react, _dll_prop_types, _dll_debug, _dll_lodash, _dll_react_dom_server, _dll_classnames, _dll_react_dom, _dll_pie_lib__pie_toolbox_math_rendering_accessible} from "../../../@pie-lib/pie-toolbox-math-rendering-module@1.5.3/module/index.js";
2
2
  import {_dll_pie_lib__pie_toolbox_correct_answer_toggle, _dll_pie_lib__pie_toolbox_render_ui} from "../../../@pie-lib/pie-toolbox-module@4.0.0/module/index.js";
3
3
  var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
4
4
  function getDefaultExportFromCjs(x) {
package/package.json CHANGED
@@ -4,7 +4,7 @@
4
4
  "access": "public"
5
5
  },
6
6
  "repository": "pie-framework/pie-elements",
7
- "version": "6.9.1-next.0+6d8f12130",
7
+ "version": "6.9.1-next.16+44cb8eb36",
8
8
  "description": "",
9
9
  "scripts": {
10
10
  "postpublish": "../../scripts/postpublish"
@@ -21,7 +21,7 @@
21
21
  },
22
22
  "author": "",
23
23
  "license": "ISC",
24
- "gitHead": "6d8f121309d801dbe0346ec33a9eed8af766d392",
24
+ "gitHead": "44cb8eb36e997cd5218007c604c8d94137022f6e",
25
25
  "main": "lib/index.js",
26
26
  "module": "src/index.js",
27
27
  "exports": {