@pie-element/complex-rubric 2.7.0 → 2.7.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.
Files changed (11) hide show
  1. package/docs/config-schema.json +476 -0
  2. package/docs/config-schema.json.md +371 -0
  3. package/docs/pie-schema.json +291 -0
  4. package/docs/pie-schema.json.md +226 -0
  5. package/module/configure.js +1 -1
  6. package/module/element.js +1 -1
  7. package/module/index.html +1 -1
  8. package/module/manifest.json +2 -2
  9. package/module/print.html +1 -1
  10. package/module/print.js +1 -1
  11. package/package.json +4 -4
package/docs/config-schema.json.md CHANGED
@@ -50,6 +50,35 @@ Properties of the `image` object:
50
50
 
51
51
  Indicates if the plugin is disabled or not
52
52
 
53
+ ### `customPlugins` (array)
54
+
55
+ An array of objects that determine custom plugins.
56
+ 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).
57
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
58
+
59
+ The object is an array with all elements of the type `object`.
60
+
61
+ The array object has the following properties:
62
+
63
+ #### `event` (string, required)
64
+
65
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
66
+ PIE will emit the event prefixed with "PIE-".
67
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
68
+
69
+ #### `iconAlt` (string, required)
70
+
71
+ The alt for the custom button icon
72
+
73
+ #### `iconType` (string, required)
74
+
75
+ The icon type.
76
+ Currently, only "SVG" is supported.
77
+
78
+ #### `icon` (string, required)
79
+
80
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
81
+
53
82
  ## `settingsPanelDisabled` (boolean)
54
83
 
55
84
  Indicates if the settings panel is not available
@@ -192,6 +221,35 @@ Properties of the `image` object:
192
221
 
193
222
  Indicates if the plugin is disabled or not
194
223
 
224
+ ### `customPlugins` (array)
225
+
226
+ An array of objects that determine custom plugins.
227
+ 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).
228
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
229
+
230
+ The object is an array with all elements of the type `object`.
231
+
232
+ The array object has the following properties:
233
+
234
+ #### `event` (string, required)
235
+
236
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
237
+ PIE will emit the event prefixed with "PIE-".
238
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
239
+
240
+ #### `iconAlt` (string, required)
241
+
242
+ The alt for the custom button icon
243
+
244
+ #### `iconType` (string, required)
245
+
246
+ The icon type.
247
+ Currently, only "SVG" is supported.
248
+
249
+ #### `icon` (string, required)
250
+
251
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
252
+
195
253
  ## `expandedInput` (object)
196
254
 
197
255
  Properties of the `expandedInput` object:
@@ -232,6 +290,35 @@ Properties of the `image` object:
232
290
 
233
291
  Indicates if the plugin is disabled or not
234
292
 
293
+ #### `customPlugins` (array)
294
+
295
+ An array of objects that determine custom plugins.
296
+ 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).
297
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
298
+
299
+ The object is an array with all elements of the type `object`.
300
+
301
+ The array object has the following properties:
302
+
303
+ ##### `event` (string, required)
304
+
305
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
306
+ PIE will emit the event prefixed with "PIE-".
307
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
308
+
309
+ ##### `iconAlt` (string, required)
310
+
311
+ The alt for the custom button icon
312
+
313
+ ##### `iconType` (string, required)
314
+
315
+ The icon type.
316
+ Currently, only "SVG" is supported.
317
+
318
+ ##### `icon` (string, required)
319
+
320
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
321
+
235
322
  ### `settings` (boolean)
236
323
 
237
324
  Indicates if the item has to be displayed in the Settings Panel
@@ -280,6 +367,35 @@ Properties of the `image` object:
280
367
 
281
368
  Indicates if the plugin is disabled or not
282
369
 
370
+ #### `customPlugins` (array)
371
+
372
+ An array of objects that determine custom plugins.
373
+ 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).
374
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
375
+
376
+ The object is an array with all elements of the type `object`.
377
+
378
+ The array object has the following properties:
379
+
380
+ ##### `event` (string, required)
381
+
382
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
383
+ PIE will emit the event prefixed with "PIE-".
384
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
385
+
386
+ ##### `iconAlt` (string, required)
387
+
388
+ The alt for the custom button icon
389
+
390
+ ##### `iconType` (string, required)
391
+
392
+ The icon type.
393
+ Currently, only "SVG" is supported.
394
+
395
+ ##### `icon` (string, required)
396
+
397
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
398
+
283
399
  ### `settings` (boolean)
284
400
 
285
401
  Indicates if the item has to be displayed in the Settings Panel
@@ -553,6 +669,35 @@ Properties of the `image` object:
553
669
 
554
670
  Indicates if the plugin is disabled or not
555
671
 
672
+ #### `customPlugins` (array)
673
+
674
+ An array of objects that determine custom plugins.
675
+ 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).
676
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
677
+
678
+ The object is an array with all elements of the type `object`.
679
+
680
+ The array object has the following properties:
681
+
682
+ ##### `event` (string, required)
683
+
684
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
685
+ PIE will emit the event prefixed with "PIE-".
686
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
687
+
688
+ ##### `iconAlt` (string, required)
689
+
690
+ The alt for the custom button icon
691
+
692
+ ##### `iconType` (string, required)
693
+
694
+ The icon type.
695
+ Currently, only "SVG" is supported.
696
+
697
+ ##### `icon` (string, required)
698
+
699
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
700
+
556
701
  ### `settings` (boolean)
557
702
 
558
703
  Indicates if the item has to be displayed in the Settings Panel
@@ -659,6 +804,35 @@ Properties of the `image` object:
659
804
 
660
805
  Indicates if the plugin is disabled or not
661
806
 
807
+ #### `customPlugins` (array)
808
+
809
+ An array of objects that determine custom plugins.
810
+ 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).
811
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
812
+
813
+ The object is an array with all elements of the type `object`.
814
+
815
+ The array object has the following properties:
816
+
817
+ ##### `event` (string, required)
818
+
819
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
820
+ PIE will emit the event prefixed with "PIE-".
821
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
822
+
823
+ ##### `iconAlt` (string, required)
824
+
825
+ The alt for the custom button icon
826
+
827
+ ##### `iconType` (string, required)
828
+
829
+ The icon type.
830
+ Currently, only "SVG" is supported.
831
+
832
+ ##### `icon` (string, required)
833
+
834
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
835
+
662
836
  ### `settingsPanelDisabled` (boolean)
663
837
 
664
838
  Indicates if the settings panel is not available
@@ -795,6 +969,35 @@ Properties of the `image` object:
795
969
 
796
970
  Indicates if the plugin is disabled or not
797
971
 
972
+ ### `customPlugins` (array)
973
+
974
+ An array of objects that determine custom plugins.
975
+ 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).
976
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
977
+
978
+ The object is an array with all elements of the type `object`.
979
+
980
+ The array object has the following properties:
981
+
982
+ #### `event` (string, required)
983
+
984
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
985
+ PIE will emit the event prefixed with "PIE-".
986
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
987
+
988
+ #### `iconAlt` (string, required)
989
+
990
+ The alt for the custom button icon
991
+
992
+ #### `iconType` (string, required)
993
+
994
+ The icon type.
995
+ Currently, only "SVG" is supported.
996
+
997
+ #### `icon` (string, required)
998
+
999
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
1000
+
798
1001
  ## `EditableHtmlButtonConfigure` (object)
799
1002
 
800
1003
  Properties of the `EditableHtmlButtonConfigure` object:
@@ -803,6 +1006,29 @@ Properties of the `EditableHtmlButtonConfigure` object:
803
1006
 
804
1007
  Indicates if the plugin is disabled or not
805
1008
 
1009
+ ## `CustomPlugin` (object)
1010
+
1011
+ Properties of the `CustomPlugin` object:
1012
+
1013
+ ### `event` (string, required)
1014
+
1015
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
1016
+ PIE will emit the event prefixed with "PIE-".
1017
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
1018
+
1019
+ ### `iconAlt` (string, required)
1020
+
1021
+ The alt for the custom button icon
1022
+
1023
+ ### `iconType` (string, required)
1024
+
1025
+ The icon type.
1026
+ Currently, only "SVG" is supported.
1027
+
1028
+ ### `icon` (string, required)
1029
+
1030
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
1031
+
806
1032
  ## `ConfigureProp` (object)
807
1033
 
808
1034
  Properties of the `ConfigureProp` object:
@@ -869,6 +1095,35 @@ Properties of the `image` object:
869
1095
 
870
1096
  Indicates if the plugin is disabled or not
871
1097
 
1098
+ #### `customPlugins` (array)
1099
+
1100
+ An array of objects that determine custom plugins.
1101
+ 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).
1102
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
1103
+
1104
+ The object is an array with all elements of the type `object`.
1105
+
1106
+ The array object has the following properties:
1107
+
1108
+ ##### `event` (string, required)
1109
+
1110
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
1111
+ PIE will emit the event prefixed with "PIE-".
1112
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
1113
+
1114
+ ##### `iconAlt` (string, required)
1115
+
1116
+ The alt for the custom button icon
1117
+
1118
+ ##### `iconType` (string, required)
1119
+
1120
+ The icon type.
1121
+ Currently, only "SVG" is supported.
1122
+
1123
+ ##### `icon` (string, required)
1124
+
1125
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
1126
+
872
1127
  ### `expandedInput` (object)
873
1128
 
874
1129
  Properties of the `expandedInput` object:
@@ -909,6 +1164,35 @@ Properties of the `image` object:
909
1164
 
910
1165
  Indicates if the plugin is disabled or not
911
1166
 
1167
+ ##### `customPlugins` (array)
1168
+
1169
+ An array of objects that determine custom plugins.
1170
+ 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).
1171
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
1172
+
1173
+ The object is an array with all elements of the type `object`.
1174
+
1175
+ The array object has the following properties:
1176
+
1177
+ ###### `event` (string, required)
1178
+
1179
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
1180
+ PIE will emit the event prefixed with "PIE-".
1181
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
1182
+
1183
+ ###### `iconAlt` (string, required)
1184
+
1185
+ The alt for the custom button icon
1186
+
1187
+ ###### `iconType` (string, required)
1188
+
1189
+ The icon type.
1190
+ Currently, only "SVG" is supported.
1191
+
1192
+ ###### `icon` (string, required)
1193
+
1194
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
1195
+
912
1196
  #### `settings` (boolean)
913
1197
 
914
1198
  Indicates if the item has to be displayed in the Settings Panel
@@ -957,6 +1241,35 @@ Properties of the `image` object:
957
1241
 
958
1242
  Indicates if the plugin is disabled or not
959
1243
 
1244
+ ##### `customPlugins` (array)
1245
+
1246
+ An array of objects that determine custom plugins.
1247
+ 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).
1248
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
1249
+
1250
+ The object is an array with all elements of the type `object`.
1251
+
1252
+ The array object has the following properties:
1253
+
1254
+ ###### `event` (string, required)
1255
+
1256
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
1257
+ PIE will emit the event prefixed with "PIE-".
1258
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
1259
+
1260
+ ###### `iconAlt` (string, required)
1261
+
1262
+ The alt for the custom button icon
1263
+
1264
+ ###### `iconType` (string, required)
1265
+
1266
+ The icon type.
1267
+ Currently, only "SVG" is supported.
1268
+
1269
+ ###### `icon` (string, required)
1270
+
1271
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
1272
+
960
1273
  #### `settings` (boolean)
961
1274
 
962
1275
  Indicates if the item has to be displayed in the Settings Panel
@@ -1170,6 +1483,35 @@ Properties of the `image` object:
1170
1483
 
1171
1484
  Indicates if the plugin is disabled or not
1172
1485
 
1486
+ #### `customPlugins` (array)
1487
+
1488
+ An array of objects that determine custom plugins.
1489
+ 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).
1490
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
1491
+
1492
+ The object is an array with all elements of the type `object`.
1493
+
1494
+ The array object has the following properties:
1495
+
1496
+ ##### `event` (string, required)
1497
+
1498
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
1499
+ PIE will emit the event prefixed with "PIE-".
1500
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
1501
+
1502
+ ##### `iconAlt` (string, required)
1503
+
1504
+ The alt for the custom button icon
1505
+
1506
+ ##### `iconType` (string, required)
1507
+
1508
+ The icon type.
1509
+ Currently, only "SVG" is supported.
1510
+
1511
+ ##### `icon` (string, required)
1512
+
1513
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
1514
+
1173
1515
  ### `settings` (boolean)
1174
1516
 
1175
1517
  Indicates if the item has to be displayed in the Settings Panel
@@ -1290,6 +1632,35 @@ Properties of the `image` object:
1290
1632
 
1291
1633
  Indicates if the plugin is disabled or not
1292
1634
 
1635
+ ##### `customPlugins` (array)
1636
+
1637
+ An array of objects that determine custom plugins.
1638
+ 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).
1639
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
1640
+
1641
+ The object is an array with all elements of the type `object`.
1642
+
1643
+ The array object has the following properties:
1644
+
1645
+ ###### `event` (string, required)
1646
+
1647
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
1648
+ PIE will emit the event prefixed with "PIE-".
1649
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
1650
+
1651
+ ###### `iconAlt` (string, required)
1652
+
1653
+ The alt for the custom button icon
1654
+
1655
+ ###### `iconType` (string, required)
1656
+
1657
+ The icon type.
1658
+ Currently, only "SVG" is supported.
1659
+
1660
+ ###### `icon` (string, required)
1661
+
1662
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
1663
+
1293
1664
  #### `settings` (boolean)
1294
1665
 
1295
1666
  Indicates if the item has to be displayed in the Settings Panel