@pie-element/ebsr 9.9.1-next.0 → 9.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.
- package/docs/config-schema.json +698 -0
- package/docs/config-schema.json.md +545 -0
- package/docs/pie-schema.json +328 -0
- package/docs/pie-schema.json.md +255 -0
- package/module/configure.js +1 -1
- package/module/element.js +1 -1
- package/module/manifest.json +1 -1
- package/module/print.js +1 -1
- package/package.json +3 -3
|
@@ -118,6 +118,35 @@ Properties of the `image` object:
|
|
|
118
118
|
|
|
119
119
|
Indicates if the plugin is disabled or not
|
|
120
120
|
|
|
121
|
+
#### `customPlugins` (array)
|
|
122
|
+
|
|
123
|
+
An array of objects that determine custom plugins.
|
|
124
|
+
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).
|
|
125
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
126
|
+
|
|
127
|
+
The object is an array with all elements of the type `object`.
|
|
128
|
+
|
|
129
|
+
The array object has the following properties:
|
|
130
|
+
|
|
131
|
+
##### `event` (string, required)
|
|
132
|
+
|
|
133
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
134
|
+
PIE will emit the event prefixed with "PIE-".
|
|
135
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
136
|
+
|
|
137
|
+
##### `iconAlt` (string, required)
|
|
138
|
+
|
|
139
|
+
The alt for the custom button icon
|
|
140
|
+
|
|
141
|
+
##### `iconType` (string, required)
|
|
142
|
+
|
|
143
|
+
The icon type.
|
|
144
|
+
Currently, only "SVG" is supported.
|
|
145
|
+
|
|
146
|
+
##### `icon` (string, required)
|
|
147
|
+
|
|
148
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
149
|
+
|
|
121
150
|
### `required` (boolean)
|
|
122
151
|
|
|
123
152
|
Indicates if the item is required and the value cannot be empty
|
|
@@ -186,6 +215,35 @@ Properties of the `image` object:
|
|
|
186
215
|
|
|
187
216
|
Indicates if the plugin is disabled or not
|
|
188
217
|
|
|
218
|
+
#### `customPlugins` (array)
|
|
219
|
+
|
|
220
|
+
An array of objects that determine custom plugins.
|
|
221
|
+
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).
|
|
222
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
223
|
+
|
|
224
|
+
The object is an array with all elements of the type `object`.
|
|
225
|
+
|
|
226
|
+
The array object has the following properties:
|
|
227
|
+
|
|
228
|
+
##### `event` (string, required)
|
|
229
|
+
|
|
230
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
231
|
+
PIE will emit the event prefixed with "PIE-".
|
|
232
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
233
|
+
|
|
234
|
+
##### `iconAlt` (string, required)
|
|
235
|
+
|
|
236
|
+
The alt for the custom button icon
|
|
237
|
+
|
|
238
|
+
##### `iconType` (string, required)
|
|
239
|
+
|
|
240
|
+
The icon type.
|
|
241
|
+
Currently, only "SVG" is supported.
|
|
242
|
+
|
|
243
|
+
##### `icon` (string, required)
|
|
244
|
+
|
|
245
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
246
|
+
|
|
189
247
|
### `required` (boolean)
|
|
190
248
|
|
|
191
249
|
Indicates if the item is required and the value cannot be empty
|
|
@@ -250,6 +308,35 @@ Properties of the `image` object:
|
|
|
250
308
|
|
|
251
309
|
Indicates if the plugin is disabled or not
|
|
252
310
|
|
|
311
|
+
#### `customPlugins` (array)
|
|
312
|
+
|
|
313
|
+
An array of objects that determine custom plugins.
|
|
314
|
+
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).
|
|
315
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
316
|
+
|
|
317
|
+
The object is an array with all elements of the type `object`.
|
|
318
|
+
|
|
319
|
+
The array object has the following properties:
|
|
320
|
+
|
|
321
|
+
##### `event` (string, required)
|
|
322
|
+
|
|
323
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
324
|
+
PIE will emit the event prefixed with "PIE-".
|
|
325
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
326
|
+
|
|
327
|
+
##### `iconAlt` (string, required)
|
|
328
|
+
|
|
329
|
+
The alt for the custom button icon
|
|
330
|
+
|
|
331
|
+
##### `iconType` (string, required)
|
|
332
|
+
|
|
333
|
+
The icon type.
|
|
334
|
+
Currently, only "SVG" is supported.
|
|
335
|
+
|
|
336
|
+
##### `icon` (string, required)
|
|
337
|
+
|
|
338
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
339
|
+
|
|
253
340
|
### `required` (boolean)
|
|
254
341
|
|
|
255
342
|
Indicates if the item is required and the value cannot be empty
|
|
@@ -382,6 +469,35 @@ Properties of the `image` object:
|
|
|
382
469
|
|
|
383
470
|
Indicates if the plugin is disabled or not
|
|
384
471
|
|
|
472
|
+
### `customPlugins` (array)
|
|
473
|
+
|
|
474
|
+
An array of objects that determine custom plugins.
|
|
475
|
+
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).
|
|
476
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
477
|
+
|
|
478
|
+
The object is an array with all elements of the type `object`.
|
|
479
|
+
|
|
480
|
+
The array object has the following properties:
|
|
481
|
+
|
|
482
|
+
#### `event` (string, required)
|
|
483
|
+
|
|
484
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
485
|
+
PIE will emit the event prefixed with "PIE-".
|
|
486
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
487
|
+
|
|
488
|
+
#### `iconAlt` (string, required)
|
|
489
|
+
|
|
490
|
+
The alt for the custom button icon
|
|
491
|
+
|
|
492
|
+
#### `iconType` (string, required)
|
|
493
|
+
|
|
494
|
+
The icon type.
|
|
495
|
+
Currently, only "SVG" is supported.
|
|
496
|
+
|
|
497
|
+
#### `icon` (string, required)
|
|
498
|
+
|
|
499
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
500
|
+
|
|
385
501
|
## `choices` (object)
|
|
386
502
|
|
|
387
503
|
Properties of the `choices` object:
|
|
@@ -422,6 +538,35 @@ Properties of the `image` object:
|
|
|
422
538
|
|
|
423
539
|
Indicates if the plugin is disabled or not
|
|
424
540
|
|
|
541
|
+
#### `customPlugins` (array)
|
|
542
|
+
|
|
543
|
+
An array of objects that determine custom plugins.
|
|
544
|
+
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).
|
|
545
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
546
|
+
|
|
547
|
+
The object is an array with all elements of the type `object`.
|
|
548
|
+
|
|
549
|
+
The array object has the following properties:
|
|
550
|
+
|
|
551
|
+
##### `event` (string, required)
|
|
552
|
+
|
|
553
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
554
|
+
PIE will emit the event prefixed with "PIE-".
|
|
555
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
556
|
+
|
|
557
|
+
##### `iconAlt` (string, required)
|
|
558
|
+
|
|
559
|
+
The alt for the custom button icon
|
|
560
|
+
|
|
561
|
+
##### `iconType` (string, required)
|
|
562
|
+
|
|
563
|
+
The icon type.
|
|
564
|
+
Currently, only "SVG" is supported.
|
|
565
|
+
|
|
566
|
+
##### `icon` (string, required)
|
|
567
|
+
|
|
568
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
569
|
+
|
|
425
570
|
### `settings` (boolean)
|
|
426
571
|
|
|
427
572
|
Indicates if the item has to be displayed in the Settings Panel
|
|
@@ -546,6 +691,35 @@ Properties of the `image` object:
|
|
|
546
691
|
|
|
547
692
|
Indicates if the plugin is disabled or not
|
|
548
693
|
|
|
694
|
+
#### `customPlugins` (array)
|
|
695
|
+
|
|
696
|
+
An array of objects that determine custom plugins.
|
|
697
|
+
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).
|
|
698
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
699
|
+
|
|
700
|
+
The object is an array with all elements of the type `object`.
|
|
701
|
+
|
|
702
|
+
The array object has the following properties:
|
|
703
|
+
|
|
704
|
+
##### `event` (string, required)
|
|
705
|
+
|
|
706
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
707
|
+
PIE will emit the event prefixed with "PIE-".
|
|
708
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
709
|
+
|
|
710
|
+
##### `iconAlt` (string, required)
|
|
711
|
+
|
|
712
|
+
The alt for the custom button icon
|
|
713
|
+
|
|
714
|
+
##### `iconType` (string, required)
|
|
715
|
+
|
|
716
|
+
The icon type.
|
|
717
|
+
Currently, only "SVG" is supported.
|
|
718
|
+
|
|
719
|
+
##### `icon` (string, required)
|
|
720
|
+
|
|
721
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
722
|
+
|
|
549
723
|
### `required` (boolean)
|
|
550
724
|
|
|
551
725
|
Indicates if the item is required and the value cannot be empty
|
|
@@ -614,6 +788,35 @@ Properties of the `image` object:
|
|
|
614
788
|
|
|
615
789
|
Indicates if the plugin is disabled or not
|
|
616
790
|
|
|
791
|
+
#### `customPlugins` (array)
|
|
792
|
+
|
|
793
|
+
An array of objects that determine custom plugins.
|
|
794
|
+
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).
|
|
795
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
796
|
+
|
|
797
|
+
The object is an array with all elements of the type `object`.
|
|
798
|
+
|
|
799
|
+
The array object has the following properties:
|
|
800
|
+
|
|
801
|
+
##### `event` (string, required)
|
|
802
|
+
|
|
803
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
804
|
+
PIE will emit the event prefixed with "PIE-".
|
|
805
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
806
|
+
|
|
807
|
+
##### `iconAlt` (string, required)
|
|
808
|
+
|
|
809
|
+
The alt for the custom button icon
|
|
810
|
+
|
|
811
|
+
##### `iconType` (string, required)
|
|
812
|
+
|
|
813
|
+
The icon type.
|
|
814
|
+
Currently, only "SVG" is supported.
|
|
815
|
+
|
|
816
|
+
##### `icon` (string, required)
|
|
817
|
+
|
|
818
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
819
|
+
|
|
617
820
|
### `required` (boolean)
|
|
618
821
|
|
|
619
822
|
Indicates if the item is required and the value cannot be empty
|
|
@@ -678,6 +881,35 @@ Properties of the `image` object:
|
|
|
678
881
|
|
|
679
882
|
Indicates if the plugin is disabled or not
|
|
680
883
|
|
|
884
|
+
#### `customPlugins` (array)
|
|
885
|
+
|
|
886
|
+
An array of objects that determine custom plugins.
|
|
887
|
+
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).
|
|
888
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
889
|
+
|
|
890
|
+
The object is an array with all elements of the type `object`.
|
|
891
|
+
|
|
892
|
+
The array object has the following properties:
|
|
893
|
+
|
|
894
|
+
##### `event` (string, required)
|
|
895
|
+
|
|
896
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
897
|
+
PIE will emit the event prefixed with "PIE-".
|
|
898
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
899
|
+
|
|
900
|
+
##### `iconAlt` (string, required)
|
|
901
|
+
|
|
902
|
+
The alt for the custom button icon
|
|
903
|
+
|
|
904
|
+
##### `iconType` (string, required)
|
|
905
|
+
|
|
906
|
+
The icon type.
|
|
907
|
+
Currently, only "SVG" is supported.
|
|
908
|
+
|
|
909
|
+
##### `icon` (string, required)
|
|
910
|
+
|
|
911
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
912
|
+
|
|
681
913
|
### `required` (boolean)
|
|
682
914
|
|
|
683
915
|
Indicates if the item is required and the value cannot be empty
|
|
@@ -810,6 +1042,35 @@ Properties of the `image` object:
|
|
|
810
1042
|
|
|
811
1043
|
Indicates if the plugin is disabled or not
|
|
812
1044
|
|
|
1045
|
+
### `customPlugins` (array)
|
|
1046
|
+
|
|
1047
|
+
An array of objects that determine custom plugins.
|
|
1048
|
+
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).
|
|
1049
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
1050
|
+
|
|
1051
|
+
The object is an array with all elements of the type `object`.
|
|
1052
|
+
|
|
1053
|
+
The array object has the following properties:
|
|
1054
|
+
|
|
1055
|
+
#### `event` (string, required)
|
|
1056
|
+
|
|
1057
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
1058
|
+
PIE will emit the event prefixed with "PIE-".
|
|
1059
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
1060
|
+
|
|
1061
|
+
#### `iconAlt` (string, required)
|
|
1062
|
+
|
|
1063
|
+
The alt for the custom button icon
|
|
1064
|
+
|
|
1065
|
+
#### `iconType` (string, required)
|
|
1066
|
+
|
|
1067
|
+
The icon type.
|
|
1068
|
+
Currently, only "SVG" is supported.
|
|
1069
|
+
|
|
1070
|
+
#### `icon` (string, required)
|
|
1071
|
+
|
|
1072
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
1073
|
+
|
|
813
1074
|
## `choices` (object)
|
|
814
1075
|
|
|
815
1076
|
Properties of the `choices` object:
|
|
@@ -850,6 +1111,35 @@ Properties of the `image` object:
|
|
|
850
1111
|
|
|
851
1112
|
Indicates if the plugin is disabled or not
|
|
852
1113
|
|
|
1114
|
+
#### `customPlugins` (array)
|
|
1115
|
+
|
|
1116
|
+
An array of objects that determine custom plugins.
|
|
1117
|
+
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).
|
|
1118
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
1119
|
+
|
|
1120
|
+
The object is an array with all elements of the type `object`.
|
|
1121
|
+
|
|
1122
|
+
The array object has the following properties:
|
|
1123
|
+
|
|
1124
|
+
##### `event` (string, required)
|
|
1125
|
+
|
|
1126
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
1127
|
+
PIE will emit the event prefixed with "PIE-".
|
|
1128
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
1129
|
+
|
|
1130
|
+
##### `iconAlt` (string, required)
|
|
1131
|
+
|
|
1132
|
+
The alt for the custom button icon
|
|
1133
|
+
|
|
1134
|
+
##### `iconType` (string, required)
|
|
1135
|
+
|
|
1136
|
+
The icon type.
|
|
1137
|
+
Currently, only "SVG" is supported.
|
|
1138
|
+
|
|
1139
|
+
##### `icon` (string, required)
|
|
1140
|
+
|
|
1141
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
1142
|
+
|
|
853
1143
|
### `settings` (boolean)
|
|
854
1144
|
|
|
855
1145
|
Indicates if the item has to be displayed in the Settings Panel
|
|
@@ -1072,6 +1362,35 @@ Properties of the `image` object:
|
|
|
1072
1362
|
|
|
1073
1363
|
Indicates if the plugin is disabled or not
|
|
1074
1364
|
|
|
1365
|
+
##### `customPlugins` (array)
|
|
1366
|
+
|
|
1367
|
+
An array of objects that determine custom plugins.
|
|
1368
|
+
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).
|
|
1369
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
1370
|
+
|
|
1371
|
+
The object is an array with all elements of the type `object`.
|
|
1372
|
+
|
|
1373
|
+
The array object has the following properties:
|
|
1374
|
+
|
|
1375
|
+
###### `event` (string, required)
|
|
1376
|
+
|
|
1377
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
1378
|
+
PIE will emit the event prefixed with "PIE-".
|
|
1379
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
1380
|
+
|
|
1381
|
+
###### `iconAlt` (string, required)
|
|
1382
|
+
|
|
1383
|
+
The alt for the custom button icon
|
|
1384
|
+
|
|
1385
|
+
###### `iconType` (string, required)
|
|
1386
|
+
|
|
1387
|
+
The icon type.
|
|
1388
|
+
Currently, only "SVG" is supported.
|
|
1389
|
+
|
|
1390
|
+
###### `icon` (string, required)
|
|
1391
|
+
|
|
1392
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
1393
|
+
|
|
1075
1394
|
#### `required` (boolean)
|
|
1076
1395
|
|
|
1077
1396
|
Indicates if the item is required and the value cannot be empty
|
|
@@ -1140,6 +1459,35 @@ Properties of the `image` object:
|
|
|
1140
1459
|
|
|
1141
1460
|
Indicates if the plugin is disabled or not
|
|
1142
1461
|
|
|
1462
|
+
##### `customPlugins` (array)
|
|
1463
|
+
|
|
1464
|
+
An array of objects that determine custom plugins.
|
|
1465
|
+
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).
|
|
1466
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
1467
|
+
|
|
1468
|
+
The object is an array with all elements of the type `object`.
|
|
1469
|
+
|
|
1470
|
+
The array object has the following properties:
|
|
1471
|
+
|
|
1472
|
+
###### `event` (string, required)
|
|
1473
|
+
|
|
1474
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
1475
|
+
PIE will emit the event prefixed with "PIE-".
|
|
1476
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
1477
|
+
|
|
1478
|
+
###### `iconAlt` (string, required)
|
|
1479
|
+
|
|
1480
|
+
The alt for the custom button icon
|
|
1481
|
+
|
|
1482
|
+
###### `iconType` (string, required)
|
|
1483
|
+
|
|
1484
|
+
The icon type.
|
|
1485
|
+
Currently, only "SVG" is supported.
|
|
1486
|
+
|
|
1487
|
+
###### `icon` (string, required)
|
|
1488
|
+
|
|
1489
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
1490
|
+
|
|
1143
1491
|
#### `required` (boolean)
|
|
1144
1492
|
|
|
1145
1493
|
Indicates if the item is required and the value cannot be empty
|
|
@@ -1204,6 +1552,35 @@ Properties of the `image` object:
|
|
|
1204
1552
|
|
|
1205
1553
|
Indicates if the plugin is disabled or not
|
|
1206
1554
|
|
|
1555
|
+
##### `customPlugins` (array)
|
|
1556
|
+
|
|
1557
|
+
An array of objects that determine custom plugins.
|
|
1558
|
+
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).
|
|
1559
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
1560
|
+
|
|
1561
|
+
The object is an array with all elements of the type `object`.
|
|
1562
|
+
|
|
1563
|
+
The array object has the following properties:
|
|
1564
|
+
|
|
1565
|
+
###### `event` (string, required)
|
|
1566
|
+
|
|
1567
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
1568
|
+
PIE will emit the event prefixed with "PIE-".
|
|
1569
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
1570
|
+
|
|
1571
|
+
###### `iconAlt` (string, required)
|
|
1572
|
+
|
|
1573
|
+
The alt for the custom button icon
|
|
1574
|
+
|
|
1575
|
+
###### `iconType` (string, required)
|
|
1576
|
+
|
|
1577
|
+
The icon type.
|
|
1578
|
+
Currently, only "SVG" is supported.
|
|
1579
|
+
|
|
1580
|
+
###### `icon` (string, required)
|
|
1581
|
+
|
|
1582
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
1583
|
+
|
|
1207
1584
|
#### `required` (boolean)
|
|
1208
1585
|
|
|
1209
1586
|
Indicates if the item is required and the value cannot be empty
|
|
@@ -1336,6 +1713,35 @@ Properties of the `image` object:
|
|
|
1336
1713
|
|
|
1337
1714
|
Indicates if the plugin is disabled or not
|
|
1338
1715
|
|
|
1716
|
+
#### `customPlugins` (array)
|
|
1717
|
+
|
|
1718
|
+
An array of objects that determine custom plugins.
|
|
1719
|
+
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).
|
|
1720
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
1721
|
+
|
|
1722
|
+
The object is an array with all elements of the type `object`.
|
|
1723
|
+
|
|
1724
|
+
The array object has the following properties:
|
|
1725
|
+
|
|
1726
|
+
##### `event` (string, required)
|
|
1727
|
+
|
|
1728
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
1729
|
+
PIE will emit the event prefixed with "PIE-".
|
|
1730
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
1731
|
+
|
|
1732
|
+
##### `iconAlt` (string, required)
|
|
1733
|
+
|
|
1734
|
+
The alt for the custom button icon
|
|
1735
|
+
|
|
1736
|
+
##### `iconType` (string, required)
|
|
1737
|
+
|
|
1738
|
+
The icon type.
|
|
1739
|
+
Currently, only "SVG" is supported.
|
|
1740
|
+
|
|
1741
|
+
##### `icon` (string, required)
|
|
1742
|
+
|
|
1743
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
1744
|
+
|
|
1339
1745
|
### `choices` (object)
|
|
1340
1746
|
|
|
1341
1747
|
Properties of the `choices` object:
|
|
@@ -1376,6 +1782,35 @@ Properties of the `image` object:
|
|
|
1376
1782
|
|
|
1377
1783
|
Indicates if the plugin is disabled or not
|
|
1378
1784
|
|
|
1785
|
+
##### `customPlugins` (array)
|
|
1786
|
+
|
|
1787
|
+
An array of objects that determine custom plugins.
|
|
1788
|
+
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).
|
|
1789
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
1790
|
+
|
|
1791
|
+
The object is an array with all elements of the type `object`.
|
|
1792
|
+
|
|
1793
|
+
The array object has the following properties:
|
|
1794
|
+
|
|
1795
|
+
###### `event` (string, required)
|
|
1796
|
+
|
|
1797
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
1798
|
+
PIE will emit the event prefixed with "PIE-".
|
|
1799
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
1800
|
+
|
|
1801
|
+
###### `iconAlt` (string, required)
|
|
1802
|
+
|
|
1803
|
+
The alt for the custom button icon
|
|
1804
|
+
|
|
1805
|
+
###### `iconType` (string, required)
|
|
1806
|
+
|
|
1807
|
+
The icon type.
|
|
1808
|
+
Currently, only "SVG" is supported.
|
|
1809
|
+
|
|
1810
|
+
###### `icon` (string, required)
|
|
1811
|
+
|
|
1812
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
1813
|
+
|
|
1379
1814
|
#### `settings` (boolean)
|
|
1380
1815
|
|
|
1381
1816
|
Indicates if the item has to be displayed in the Settings Panel
|
|
@@ -1436,6 +1871,35 @@ Properties of the `image` object:
|
|
|
1436
1871
|
|
|
1437
1872
|
Indicates if the plugin is disabled or not
|
|
1438
1873
|
|
|
1874
|
+
#### `customPlugins` (array)
|
|
1875
|
+
|
|
1876
|
+
An array of objects that determine custom plugins.
|
|
1877
|
+
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).
|
|
1878
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
1879
|
+
|
|
1880
|
+
The object is an array with all elements of the type `object`.
|
|
1881
|
+
|
|
1882
|
+
The array object has the following properties:
|
|
1883
|
+
|
|
1884
|
+
##### `event` (string, required)
|
|
1885
|
+
|
|
1886
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
1887
|
+
PIE will emit the event prefixed with "PIE-".
|
|
1888
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
1889
|
+
|
|
1890
|
+
##### `iconAlt` (string, required)
|
|
1891
|
+
|
|
1892
|
+
The alt for the custom button icon
|
|
1893
|
+
|
|
1894
|
+
##### `iconType` (string, required)
|
|
1895
|
+
|
|
1896
|
+
The icon type.
|
|
1897
|
+
Currently, only "SVG" is supported.
|
|
1898
|
+
|
|
1899
|
+
##### `icon` (string, required)
|
|
1900
|
+
|
|
1901
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
1902
|
+
|
|
1439
1903
|
### `required` (boolean)
|
|
1440
1904
|
|
|
1441
1905
|
Indicates if the item is required and the value cannot be empty
|
|
@@ -1484,6 +1948,35 @@ Properties of the `image` object:
|
|
|
1484
1948
|
|
|
1485
1949
|
Indicates if the plugin is disabled or not
|
|
1486
1950
|
|
|
1951
|
+
### `customPlugins` (array)
|
|
1952
|
+
|
|
1953
|
+
An array of objects that determine custom plugins.
|
|
1954
|
+
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).
|
|
1955
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
1956
|
+
|
|
1957
|
+
The object is an array with all elements of the type `object`.
|
|
1958
|
+
|
|
1959
|
+
The array object has the following properties:
|
|
1960
|
+
|
|
1961
|
+
#### `event` (string, required)
|
|
1962
|
+
|
|
1963
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
1964
|
+
PIE will emit the event prefixed with "PIE-".
|
|
1965
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
1966
|
+
|
|
1967
|
+
#### `iconAlt` (string, required)
|
|
1968
|
+
|
|
1969
|
+
The alt for the custom button icon
|
|
1970
|
+
|
|
1971
|
+
#### `iconType` (string, required)
|
|
1972
|
+
|
|
1973
|
+
The icon type.
|
|
1974
|
+
Currently, only "SVG" is supported.
|
|
1975
|
+
|
|
1976
|
+
#### `icon` (string, required)
|
|
1977
|
+
|
|
1978
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
1979
|
+
|
|
1487
1980
|
## `EditableHtmlButtonConfigure` (object)
|
|
1488
1981
|
|
|
1489
1982
|
Properties of the `EditableHtmlButtonConfigure` object:
|
|
@@ -1492,6 +1985,29 @@ Properties of the `EditableHtmlButtonConfigure` object:
|
|
|
1492
1985
|
|
|
1493
1986
|
Indicates if the plugin is disabled or not
|
|
1494
1987
|
|
|
1988
|
+
## `CustomPlugin` (object)
|
|
1989
|
+
|
|
1990
|
+
Properties of the `CustomPlugin` object:
|
|
1991
|
+
|
|
1992
|
+
### `event` (string, required)
|
|
1993
|
+
|
|
1994
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
1995
|
+
PIE will emit the event prefixed with "PIE-".
|
|
1996
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
1997
|
+
|
|
1998
|
+
### `iconAlt` (string, required)
|
|
1999
|
+
|
|
2000
|
+
The alt for the custom button icon
|
|
2001
|
+
|
|
2002
|
+
### `iconType` (string, required)
|
|
2003
|
+
|
|
2004
|
+
The icon type.
|
|
2005
|
+
Currently, only "SVG" is supported.
|
|
2006
|
+
|
|
2007
|
+
### `icon` (string, required)
|
|
2008
|
+
|
|
2009
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
2010
|
+
|
|
1495
2011
|
## `ConfigureMaxImageDimensionsProp` (object)
|
|
1496
2012
|
|
|
1497
2013
|
Properties of the `ConfigureMaxImageDimensionsProp` object:
|
|
@@ -1564,6 +2080,35 @@ Properties of the `image` object:
|
|
|
1564
2080
|
|
|
1565
2081
|
Indicates if the plugin is disabled or not
|
|
1566
2082
|
|
|
2083
|
+
#### `customPlugins` (array)
|
|
2084
|
+
|
|
2085
|
+
An array of objects that determine custom plugins.
|
|
2086
|
+
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).
|
|
2087
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
2088
|
+
|
|
2089
|
+
The object is an array with all elements of the type `object`.
|
|
2090
|
+
|
|
2091
|
+
The array object has the following properties:
|
|
2092
|
+
|
|
2093
|
+
##### `event` (string, required)
|
|
2094
|
+
|
|
2095
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
2096
|
+
PIE will emit the event prefixed with "PIE-".
|
|
2097
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
2098
|
+
|
|
2099
|
+
##### `iconAlt` (string, required)
|
|
2100
|
+
|
|
2101
|
+
The alt for the custom button icon
|
|
2102
|
+
|
|
2103
|
+
##### `iconType` (string, required)
|
|
2104
|
+
|
|
2105
|
+
The icon type.
|
|
2106
|
+
Currently, only "SVG" is supported.
|
|
2107
|
+
|
|
2108
|
+
##### `icon` (string, required)
|
|
2109
|
+
|
|
2110
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
2111
|
+
|
|
1567
2112
|
### `settings` (boolean)
|
|
1568
2113
|
|
|
1569
2114
|
Indicates if the item has to be displayed in the Settings Panel
|