@pie-element/categorize 8.12.1-next.0 → 8.12.1-next.18
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/configure/package.json +1 -1
- package/controller/package.json +1 -1
- package/docs/config-schema.json +365 -0
- package/docs/config-schema.json.md +284 -0
- package/docs/pie-schema.json +143 -0
- package/docs/pie-schema.json.md +110 -0
- package/package.json +3 -3
package/configure/package.json
CHANGED
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
"@material-ui/core": "^3.9.2",
|
|
13
13
|
"@material-ui/icons": "^3.0.1",
|
|
14
14
|
"@pie-framework/pie-configure-events": "^1.3.0",
|
|
15
|
-
"@pie-lib/pie-toolbox": "1.
|
|
15
|
+
"@pie-lib/pie-toolbox": "1.13.0",
|
|
16
16
|
"classnames": "^2.2.5",
|
|
17
17
|
"debug": "^3.1.0",
|
|
18
18
|
"lodash": "^4.17.15",
|
package/controller/package.json
CHANGED
package/docs/config-schema.json
CHANGED
|
@@ -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
|
},
|
|
@@ -244,6 +318,43 @@
|
|
|
244
318
|
"title": "disabled"
|
|
245
319
|
}
|
|
246
320
|
}
|
|
321
|
+
},
|
|
322
|
+
"customPlugins": {
|
|
323
|
+
"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.",
|
|
324
|
+
"type": "array",
|
|
325
|
+
"items": {
|
|
326
|
+
"title": "CustomPlugin",
|
|
327
|
+
"type": "object",
|
|
328
|
+
"properties": {
|
|
329
|
+
"event": {
|
|
330
|
+
"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\"",
|
|
331
|
+
"type": "string",
|
|
332
|
+
"title": "event"
|
|
333
|
+
},
|
|
334
|
+
"iconAlt": {
|
|
335
|
+
"description": "The alt for the custom button icon",
|
|
336
|
+
"type": "string",
|
|
337
|
+
"title": "iconAlt"
|
|
338
|
+
},
|
|
339
|
+
"iconType": {
|
|
340
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
341
|
+
"type": "string",
|
|
342
|
+
"title": "iconType"
|
|
343
|
+
},
|
|
344
|
+
"icon": {
|
|
345
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
346
|
+
"type": "string",
|
|
347
|
+
"title": "icon"
|
|
348
|
+
}
|
|
349
|
+
},
|
|
350
|
+
"required": [
|
|
351
|
+
"event",
|
|
352
|
+
"icon",
|
|
353
|
+
"iconAlt",
|
|
354
|
+
"iconType"
|
|
355
|
+
]
|
|
356
|
+
},
|
|
357
|
+
"title": "customPlugins"
|
|
247
358
|
}
|
|
248
359
|
}
|
|
249
360
|
},
|
|
@@ -315,6 +426,43 @@
|
|
|
315
426
|
"title": "disabled"
|
|
316
427
|
}
|
|
317
428
|
}
|
|
429
|
+
},
|
|
430
|
+
"customPlugins": {
|
|
431
|
+
"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.",
|
|
432
|
+
"type": "array",
|
|
433
|
+
"items": {
|
|
434
|
+
"title": "CustomPlugin",
|
|
435
|
+
"type": "object",
|
|
436
|
+
"properties": {
|
|
437
|
+
"event": {
|
|
438
|
+
"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\"",
|
|
439
|
+
"type": "string",
|
|
440
|
+
"title": "event"
|
|
441
|
+
},
|
|
442
|
+
"iconAlt": {
|
|
443
|
+
"description": "The alt for the custom button icon",
|
|
444
|
+
"type": "string",
|
|
445
|
+
"title": "iconAlt"
|
|
446
|
+
},
|
|
447
|
+
"iconType": {
|
|
448
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
449
|
+
"type": "string",
|
|
450
|
+
"title": "iconType"
|
|
451
|
+
},
|
|
452
|
+
"icon": {
|
|
453
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
454
|
+
"type": "string",
|
|
455
|
+
"title": "icon"
|
|
456
|
+
}
|
|
457
|
+
},
|
|
458
|
+
"required": [
|
|
459
|
+
"event",
|
|
460
|
+
"icon",
|
|
461
|
+
"iconAlt",
|
|
462
|
+
"iconType"
|
|
463
|
+
]
|
|
464
|
+
},
|
|
465
|
+
"title": "customPlugins"
|
|
318
466
|
}
|
|
319
467
|
}
|
|
320
468
|
},
|
|
@@ -386,6 +534,43 @@
|
|
|
386
534
|
"title": "disabled"
|
|
387
535
|
}
|
|
388
536
|
}
|
|
537
|
+
},
|
|
538
|
+
"customPlugins": {
|
|
539
|
+
"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.",
|
|
540
|
+
"type": "array",
|
|
541
|
+
"items": {
|
|
542
|
+
"title": "CustomPlugin",
|
|
543
|
+
"type": "object",
|
|
544
|
+
"properties": {
|
|
545
|
+
"event": {
|
|
546
|
+
"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\"",
|
|
547
|
+
"type": "string",
|
|
548
|
+
"title": "event"
|
|
549
|
+
},
|
|
550
|
+
"iconAlt": {
|
|
551
|
+
"description": "The alt for the custom button icon",
|
|
552
|
+
"type": "string",
|
|
553
|
+
"title": "iconAlt"
|
|
554
|
+
},
|
|
555
|
+
"iconType": {
|
|
556
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
557
|
+
"type": "string",
|
|
558
|
+
"title": "iconType"
|
|
559
|
+
},
|
|
560
|
+
"icon": {
|
|
561
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
562
|
+
"type": "string",
|
|
563
|
+
"title": "icon"
|
|
564
|
+
}
|
|
565
|
+
},
|
|
566
|
+
"required": [
|
|
567
|
+
"event",
|
|
568
|
+
"icon",
|
|
569
|
+
"iconAlt",
|
|
570
|
+
"iconType"
|
|
571
|
+
]
|
|
572
|
+
},
|
|
573
|
+
"title": "customPlugins"
|
|
389
574
|
}
|
|
390
575
|
}
|
|
391
576
|
},
|
|
@@ -452,6 +637,43 @@
|
|
|
452
637
|
"title": "disabled"
|
|
453
638
|
}
|
|
454
639
|
}
|
|
640
|
+
},
|
|
641
|
+
"customPlugins": {
|
|
642
|
+
"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.",
|
|
643
|
+
"type": "array",
|
|
644
|
+
"items": {
|
|
645
|
+
"title": "CustomPlugin",
|
|
646
|
+
"type": "object",
|
|
647
|
+
"properties": {
|
|
648
|
+
"event": {
|
|
649
|
+
"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\"",
|
|
650
|
+
"type": "string",
|
|
651
|
+
"title": "event"
|
|
652
|
+
},
|
|
653
|
+
"iconAlt": {
|
|
654
|
+
"description": "The alt for the custom button icon",
|
|
655
|
+
"type": "string",
|
|
656
|
+
"title": "iconAlt"
|
|
657
|
+
},
|
|
658
|
+
"iconType": {
|
|
659
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
660
|
+
"type": "string",
|
|
661
|
+
"title": "iconType"
|
|
662
|
+
},
|
|
663
|
+
"icon": {
|
|
664
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
665
|
+
"type": "string",
|
|
666
|
+
"title": "icon"
|
|
667
|
+
}
|
|
668
|
+
},
|
|
669
|
+
"required": [
|
|
670
|
+
"event",
|
|
671
|
+
"icon",
|
|
672
|
+
"iconAlt",
|
|
673
|
+
"iconType"
|
|
674
|
+
]
|
|
675
|
+
},
|
|
676
|
+
"title": "customPlugins"
|
|
455
677
|
}
|
|
456
678
|
}
|
|
457
679
|
},
|
|
@@ -766,6 +988,43 @@
|
|
|
766
988
|
"title": "disabled"
|
|
767
989
|
}
|
|
768
990
|
}
|
|
991
|
+
},
|
|
992
|
+
"customPlugins": {
|
|
993
|
+
"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.",
|
|
994
|
+
"type": "array",
|
|
995
|
+
"items": {
|
|
996
|
+
"title": "CustomPlugin",
|
|
997
|
+
"type": "object",
|
|
998
|
+
"properties": {
|
|
999
|
+
"event": {
|
|
1000
|
+
"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\"",
|
|
1001
|
+
"type": "string",
|
|
1002
|
+
"title": "event"
|
|
1003
|
+
},
|
|
1004
|
+
"iconAlt": {
|
|
1005
|
+
"description": "The alt for the custom button icon",
|
|
1006
|
+
"type": "string",
|
|
1007
|
+
"title": "iconAlt"
|
|
1008
|
+
},
|
|
1009
|
+
"iconType": {
|
|
1010
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
1011
|
+
"type": "string",
|
|
1012
|
+
"title": "iconType"
|
|
1013
|
+
},
|
|
1014
|
+
"icon": {
|
|
1015
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
1016
|
+
"type": "string",
|
|
1017
|
+
"title": "icon"
|
|
1018
|
+
}
|
|
1019
|
+
},
|
|
1020
|
+
"required": [
|
|
1021
|
+
"event",
|
|
1022
|
+
"icon",
|
|
1023
|
+
"iconAlt",
|
|
1024
|
+
"iconType"
|
|
1025
|
+
]
|
|
1026
|
+
},
|
|
1027
|
+
"title": "customPlugins"
|
|
769
1028
|
}
|
|
770
1029
|
}
|
|
771
1030
|
},
|
|
@@ -780,6 +1039,38 @@
|
|
|
780
1039
|
}
|
|
781
1040
|
}
|
|
782
1041
|
},
|
|
1042
|
+
"CustomPlugin": {
|
|
1043
|
+
"title": "CustomPlugin",
|
|
1044
|
+
"type": "object",
|
|
1045
|
+
"properties": {
|
|
1046
|
+
"event": {
|
|
1047
|
+
"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\"",
|
|
1048
|
+
"type": "string",
|
|
1049
|
+
"title": "event"
|
|
1050
|
+
},
|
|
1051
|
+
"iconAlt": {
|
|
1052
|
+
"description": "The alt for the custom button icon",
|
|
1053
|
+
"type": "string",
|
|
1054
|
+
"title": "iconAlt"
|
|
1055
|
+
},
|
|
1056
|
+
"iconType": {
|
|
1057
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
1058
|
+
"type": "string",
|
|
1059
|
+
"title": "iconType"
|
|
1060
|
+
},
|
|
1061
|
+
"icon": {
|
|
1062
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
1063
|
+
"type": "string",
|
|
1064
|
+
"title": "icon"
|
|
1065
|
+
}
|
|
1066
|
+
},
|
|
1067
|
+
"required": [
|
|
1068
|
+
"event",
|
|
1069
|
+
"icon",
|
|
1070
|
+
"iconAlt",
|
|
1071
|
+
"iconType"
|
|
1072
|
+
]
|
|
1073
|
+
},
|
|
783
1074
|
"ConfigureProp": {
|
|
784
1075
|
"title": "ConfigureProp",
|
|
785
1076
|
"type": "object",
|
|
@@ -847,6 +1138,43 @@
|
|
|
847
1138
|
"title": "disabled"
|
|
848
1139
|
}
|
|
849
1140
|
}
|
|
1141
|
+
},
|
|
1142
|
+
"customPlugins": {
|
|
1143
|
+
"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.",
|
|
1144
|
+
"type": "array",
|
|
1145
|
+
"items": {
|
|
1146
|
+
"title": "CustomPlugin",
|
|
1147
|
+
"type": "object",
|
|
1148
|
+
"properties": {
|
|
1149
|
+
"event": {
|
|
1150
|
+
"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\"",
|
|
1151
|
+
"type": "string",
|
|
1152
|
+
"title": "event"
|
|
1153
|
+
},
|
|
1154
|
+
"iconAlt": {
|
|
1155
|
+
"description": "The alt for the custom button icon",
|
|
1156
|
+
"type": "string",
|
|
1157
|
+
"title": "iconAlt"
|
|
1158
|
+
},
|
|
1159
|
+
"iconType": {
|
|
1160
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
1161
|
+
"type": "string",
|
|
1162
|
+
"title": "iconType"
|
|
1163
|
+
},
|
|
1164
|
+
"icon": {
|
|
1165
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
1166
|
+
"type": "string",
|
|
1167
|
+
"title": "icon"
|
|
1168
|
+
}
|
|
1169
|
+
},
|
|
1170
|
+
"required": [
|
|
1171
|
+
"event",
|
|
1172
|
+
"icon",
|
|
1173
|
+
"iconAlt",
|
|
1174
|
+
"iconType"
|
|
1175
|
+
]
|
|
1176
|
+
},
|
|
1177
|
+
"title": "customPlugins"
|
|
850
1178
|
}
|
|
851
1179
|
}
|
|
852
1180
|
},
|
|
@@ -918,6 +1246,43 @@
|
|
|
918
1246
|
"title": "disabled"
|
|
919
1247
|
}
|
|
920
1248
|
}
|
|
1249
|
+
},
|
|
1250
|
+
"customPlugins": {
|
|
1251
|
+
"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.",
|
|
1252
|
+
"type": "array",
|
|
1253
|
+
"items": {
|
|
1254
|
+
"title": "CustomPlugin",
|
|
1255
|
+
"type": "object",
|
|
1256
|
+
"properties": {
|
|
1257
|
+
"event": {
|
|
1258
|
+
"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\"",
|
|
1259
|
+
"type": "string",
|
|
1260
|
+
"title": "event"
|
|
1261
|
+
},
|
|
1262
|
+
"iconAlt": {
|
|
1263
|
+
"description": "The alt for the custom button icon",
|
|
1264
|
+
"type": "string",
|
|
1265
|
+
"title": "iconAlt"
|
|
1266
|
+
},
|
|
1267
|
+
"iconType": {
|
|
1268
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
1269
|
+
"type": "string",
|
|
1270
|
+
"title": "iconType"
|
|
1271
|
+
},
|
|
1272
|
+
"icon": {
|
|
1273
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
1274
|
+
"type": "string",
|
|
1275
|
+
"title": "icon"
|
|
1276
|
+
}
|
|
1277
|
+
},
|
|
1278
|
+
"required": [
|
|
1279
|
+
"event",
|
|
1280
|
+
"icon",
|
|
1281
|
+
"iconAlt",
|
|
1282
|
+
"iconType"
|
|
1283
|
+
]
|
|
1284
|
+
},
|
|
1285
|
+
"title": "customPlugins"
|
|
921
1286
|
}
|
|
922
1287
|
}
|
|
923
1288
|
},
|
|
@@ -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
|
# `partialScoring` (object)
|
|
42
71
|
|
|
43
72
|
Properties of the `partialScoring` 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
|
|
@@ -182,6 +240,35 @@ Properties of the `image` object:
|
|
|
182
240
|
|
|
183
241
|
Indicates if the plugin is disabled or not
|
|
184
242
|
|
|
243
|
+
### `customPlugins` (array)
|
|
244
|
+
|
|
245
|
+
An array of objects that determine custom plugins.
|
|
246
|
+
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).
|
|
247
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
248
|
+
|
|
249
|
+
The object is an array with all elements of the type `object`.
|
|
250
|
+
|
|
251
|
+
The array object has the following properties:
|
|
252
|
+
|
|
253
|
+
#### `event` (string, required)
|
|
254
|
+
|
|
255
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
256
|
+
PIE will emit the event prefixed with "PIE-".
|
|
257
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
258
|
+
|
|
259
|
+
#### `iconAlt` (string, required)
|
|
260
|
+
|
|
261
|
+
The alt for the custom button icon
|
|
262
|
+
|
|
263
|
+
#### `iconType` (string, required)
|
|
264
|
+
|
|
265
|
+
The icon type.
|
|
266
|
+
Currently, only "SVG" is supported.
|
|
267
|
+
|
|
268
|
+
#### `icon` (string, required)
|
|
269
|
+
|
|
270
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
271
|
+
|
|
185
272
|
## `required` (boolean)
|
|
186
273
|
|
|
187
274
|
Indicates if the item is required and the value cannot be empty
|
|
@@ -234,6 +321,35 @@ Properties of the `image` object:
|
|
|
234
321
|
|
|
235
322
|
Indicates if the plugin is disabled or not
|
|
236
323
|
|
|
324
|
+
### `customPlugins` (array)
|
|
325
|
+
|
|
326
|
+
An array of objects that determine custom plugins.
|
|
327
|
+
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).
|
|
328
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
329
|
+
|
|
330
|
+
The object is an array with all elements of the type `object`.
|
|
331
|
+
|
|
332
|
+
The array object has the following properties:
|
|
333
|
+
|
|
334
|
+
#### `event` (string, required)
|
|
335
|
+
|
|
336
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
337
|
+
PIE will emit the event prefixed with "PIE-".
|
|
338
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
339
|
+
|
|
340
|
+
#### `iconAlt` (string, required)
|
|
341
|
+
|
|
342
|
+
The alt for the custom button icon
|
|
343
|
+
|
|
344
|
+
#### `iconType` (string, required)
|
|
345
|
+
|
|
346
|
+
The icon type.
|
|
347
|
+
Currently, only "SVG" is supported.
|
|
348
|
+
|
|
349
|
+
#### `icon` (string, required)
|
|
350
|
+
|
|
351
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
352
|
+
|
|
237
353
|
## `required` (boolean)
|
|
238
354
|
|
|
239
355
|
Indicates if the item is required and the value cannot be empty
|
|
@@ -286,6 +402,35 @@ Properties of the `image` object:
|
|
|
286
402
|
|
|
287
403
|
Indicates if the plugin is disabled or not
|
|
288
404
|
|
|
405
|
+
### `customPlugins` (array)
|
|
406
|
+
|
|
407
|
+
An array of objects that determine custom plugins.
|
|
408
|
+
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).
|
|
409
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
410
|
+
|
|
411
|
+
The object is an array with all elements of the type `object`.
|
|
412
|
+
|
|
413
|
+
The array object has the following properties:
|
|
414
|
+
|
|
415
|
+
#### `event` (string, required)
|
|
416
|
+
|
|
417
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
418
|
+
PIE will emit the event prefixed with "PIE-".
|
|
419
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
420
|
+
|
|
421
|
+
#### `iconAlt` (string, required)
|
|
422
|
+
|
|
423
|
+
The alt for the custom button icon
|
|
424
|
+
|
|
425
|
+
#### `iconType` (string, required)
|
|
426
|
+
|
|
427
|
+
The icon type.
|
|
428
|
+
Currently, only "SVG" is supported.
|
|
429
|
+
|
|
430
|
+
#### `icon` (string, required)
|
|
431
|
+
|
|
432
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
433
|
+
|
|
289
434
|
## `settings` (boolean)
|
|
290
435
|
|
|
291
436
|
Indicates if the item has to be displayed in the Settings Panel
|
|
@@ -334,6 +479,35 @@ Properties of the `image` object:
|
|
|
334
479
|
|
|
335
480
|
Indicates if the plugin is disabled or not
|
|
336
481
|
|
|
482
|
+
### `customPlugins` (array)
|
|
483
|
+
|
|
484
|
+
An array of objects that determine custom plugins.
|
|
485
|
+
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).
|
|
486
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
487
|
+
|
|
488
|
+
The object is an array with all elements of the type `object`.
|
|
489
|
+
|
|
490
|
+
The array object has the following properties:
|
|
491
|
+
|
|
492
|
+
#### `event` (string, required)
|
|
493
|
+
|
|
494
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
495
|
+
PIE will emit the event prefixed with "PIE-".
|
|
496
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
497
|
+
|
|
498
|
+
#### `iconAlt` (string, required)
|
|
499
|
+
|
|
500
|
+
The alt for the custom button icon
|
|
501
|
+
|
|
502
|
+
#### `iconType` (string, required)
|
|
503
|
+
|
|
504
|
+
The icon type.
|
|
505
|
+
Currently, only "SVG" is supported.
|
|
506
|
+
|
|
507
|
+
#### `icon` (string, required)
|
|
508
|
+
|
|
509
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
510
|
+
|
|
337
511
|
## `settings` (boolean)
|
|
338
512
|
|
|
339
513
|
Indicates if the item has to be displayed in the Settings Panel
|
|
@@ -572,6 +746,35 @@ Properties of the `image` object:
|
|
|
572
746
|
|
|
573
747
|
Indicates if the plugin is disabled or not
|
|
574
748
|
|
|
749
|
+
### `customPlugins` (array)
|
|
750
|
+
|
|
751
|
+
An array of objects that determine custom plugins.
|
|
752
|
+
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).
|
|
753
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
754
|
+
|
|
755
|
+
The object is an array with all elements of the type `object`.
|
|
756
|
+
|
|
757
|
+
The array object has the following properties:
|
|
758
|
+
|
|
759
|
+
#### `event` (string, required)
|
|
760
|
+
|
|
761
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
762
|
+
PIE will emit the event prefixed with "PIE-".
|
|
763
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
764
|
+
|
|
765
|
+
#### `iconAlt` (string, required)
|
|
766
|
+
|
|
767
|
+
The alt for the custom button icon
|
|
768
|
+
|
|
769
|
+
#### `iconType` (string, required)
|
|
770
|
+
|
|
771
|
+
The icon type.
|
|
772
|
+
Currently, only "SVG" is supported.
|
|
773
|
+
|
|
774
|
+
#### `icon` (string, required)
|
|
775
|
+
|
|
776
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
777
|
+
|
|
575
778
|
## `EditableHtmlButtonConfigure` (object)
|
|
576
779
|
|
|
577
780
|
Properties of the `EditableHtmlButtonConfigure` object:
|
|
@@ -580,6 +783,29 @@ Properties of the `EditableHtmlButtonConfigure` object:
|
|
|
580
783
|
|
|
581
784
|
Indicates if the plugin is disabled or not
|
|
582
785
|
|
|
786
|
+
## `CustomPlugin` (object)
|
|
787
|
+
|
|
788
|
+
Properties of the `CustomPlugin` object:
|
|
789
|
+
|
|
790
|
+
### `event` (string, required)
|
|
791
|
+
|
|
792
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
793
|
+
PIE will emit the event prefixed with "PIE-".
|
|
794
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
795
|
+
|
|
796
|
+
### `iconAlt` (string, required)
|
|
797
|
+
|
|
798
|
+
The alt for the custom button icon
|
|
799
|
+
|
|
800
|
+
### `iconType` (string, required)
|
|
801
|
+
|
|
802
|
+
The icon type.
|
|
803
|
+
Currently, only "SVG" is supported.
|
|
804
|
+
|
|
805
|
+
### `icon` (string, required)
|
|
806
|
+
|
|
807
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
808
|
+
|
|
583
809
|
## `ConfigureProp` (object)
|
|
584
810
|
|
|
585
811
|
Properties of the `ConfigureProp` object:
|
|
@@ -632,6 +858,35 @@ Properties of the `image` object:
|
|
|
632
858
|
|
|
633
859
|
Indicates if the plugin is disabled or not
|
|
634
860
|
|
|
861
|
+
#### `customPlugins` (array)
|
|
862
|
+
|
|
863
|
+
An array of objects that determine custom plugins.
|
|
864
|
+
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).
|
|
865
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
866
|
+
|
|
867
|
+
The object is an array with all elements of the type `object`.
|
|
868
|
+
|
|
869
|
+
The array object has the following properties:
|
|
870
|
+
|
|
871
|
+
##### `event` (string, required)
|
|
872
|
+
|
|
873
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
874
|
+
PIE will emit the event prefixed with "PIE-".
|
|
875
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
876
|
+
|
|
877
|
+
##### `iconAlt` (string, required)
|
|
878
|
+
|
|
879
|
+
The alt for the custom button icon
|
|
880
|
+
|
|
881
|
+
##### `iconType` (string, required)
|
|
882
|
+
|
|
883
|
+
The icon type.
|
|
884
|
+
Currently, only "SVG" is supported.
|
|
885
|
+
|
|
886
|
+
##### `icon` (string, required)
|
|
887
|
+
|
|
888
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
889
|
+
|
|
635
890
|
### `required` (boolean)
|
|
636
891
|
|
|
637
892
|
Indicates if the item is required and the value cannot be empty
|
|
@@ -684,6 +939,35 @@ Properties of the `image` object:
|
|
|
684
939
|
|
|
685
940
|
Indicates if the plugin is disabled or not
|
|
686
941
|
|
|
942
|
+
#### `customPlugins` (array)
|
|
943
|
+
|
|
944
|
+
An array of objects that determine custom plugins.
|
|
945
|
+
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).
|
|
946
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
947
|
+
|
|
948
|
+
The object is an array with all elements of the type `object`.
|
|
949
|
+
|
|
950
|
+
The array object has the following properties:
|
|
951
|
+
|
|
952
|
+
##### `event` (string, required)
|
|
953
|
+
|
|
954
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
955
|
+
PIE will emit the event prefixed with "PIE-".
|
|
956
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
957
|
+
|
|
958
|
+
##### `iconAlt` (string, required)
|
|
959
|
+
|
|
960
|
+
The alt for the custom button icon
|
|
961
|
+
|
|
962
|
+
##### `iconType` (string, required)
|
|
963
|
+
|
|
964
|
+
The icon type.
|
|
965
|
+
Currently, only "SVG" is supported.
|
|
966
|
+
|
|
967
|
+
##### `icon` (string, required)
|
|
968
|
+
|
|
969
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
970
|
+
|
|
687
971
|
### `settings` (boolean)
|
|
688
972
|
|
|
689
973
|
Indicates if the item has to be displayed in the Settings Panel
|
package/docs/pie-schema.json
CHANGED
|
@@ -492,6 +492,43 @@
|
|
|
492
492
|
"title": "disabled"
|
|
493
493
|
}
|
|
494
494
|
}
|
|
495
|
+
},
|
|
496
|
+
"customPlugins": {
|
|
497
|
+
"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.",
|
|
498
|
+
"type": "array",
|
|
499
|
+
"items": {
|
|
500
|
+
"title": "CustomPlugin",
|
|
501
|
+
"type": "object",
|
|
502
|
+
"properties": {
|
|
503
|
+
"event": {
|
|
504
|
+
"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\"",
|
|
505
|
+
"type": "string",
|
|
506
|
+
"title": "event"
|
|
507
|
+
},
|
|
508
|
+
"iconAlt": {
|
|
509
|
+
"description": "The alt for the custom button icon",
|
|
510
|
+
"type": "string",
|
|
511
|
+
"title": "iconAlt"
|
|
512
|
+
},
|
|
513
|
+
"iconType": {
|
|
514
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
515
|
+
"type": "string",
|
|
516
|
+
"title": "iconType"
|
|
517
|
+
},
|
|
518
|
+
"icon": {
|
|
519
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
520
|
+
"type": "string",
|
|
521
|
+
"title": "icon"
|
|
522
|
+
}
|
|
523
|
+
},
|
|
524
|
+
"required": [
|
|
525
|
+
"event",
|
|
526
|
+
"icon",
|
|
527
|
+
"iconAlt",
|
|
528
|
+
"iconType"
|
|
529
|
+
]
|
|
530
|
+
},
|
|
531
|
+
"title": "customPlugins"
|
|
495
532
|
}
|
|
496
533
|
}
|
|
497
534
|
},
|
|
@@ -506,6 +543,38 @@
|
|
|
506
543
|
}
|
|
507
544
|
}
|
|
508
545
|
},
|
|
546
|
+
"CustomPlugin": {
|
|
547
|
+
"title": "CustomPlugin",
|
|
548
|
+
"type": "object",
|
|
549
|
+
"properties": {
|
|
550
|
+
"event": {
|
|
551
|
+
"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\"",
|
|
552
|
+
"type": "string",
|
|
553
|
+
"title": "event"
|
|
554
|
+
},
|
|
555
|
+
"iconAlt": {
|
|
556
|
+
"description": "The alt for the custom button icon",
|
|
557
|
+
"type": "string",
|
|
558
|
+
"title": "iconAlt"
|
|
559
|
+
},
|
|
560
|
+
"iconType": {
|
|
561
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
562
|
+
"type": "string",
|
|
563
|
+
"title": "iconType"
|
|
564
|
+
},
|
|
565
|
+
"icon": {
|
|
566
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
567
|
+
"type": "string",
|
|
568
|
+
"title": "icon"
|
|
569
|
+
}
|
|
570
|
+
},
|
|
571
|
+
"required": [
|
|
572
|
+
"event",
|
|
573
|
+
"icon",
|
|
574
|
+
"iconAlt",
|
|
575
|
+
"iconType"
|
|
576
|
+
]
|
|
577
|
+
},
|
|
509
578
|
"ConfigureProp": {
|
|
510
579
|
"title": "ConfigureProp",
|
|
511
580
|
"type": "object",
|
|
@@ -573,6 +642,43 @@
|
|
|
573
642
|
"title": "disabled"
|
|
574
643
|
}
|
|
575
644
|
}
|
|
645
|
+
},
|
|
646
|
+
"customPlugins": {
|
|
647
|
+
"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.",
|
|
648
|
+
"type": "array",
|
|
649
|
+
"items": {
|
|
650
|
+
"title": "CustomPlugin",
|
|
651
|
+
"type": "object",
|
|
652
|
+
"properties": {
|
|
653
|
+
"event": {
|
|
654
|
+
"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\"",
|
|
655
|
+
"type": "string",
|
|
656
|
+
"title": "event"
|
|
657
|
+
},
|
|
658
|
+
"iconAlt": {
|
|
659
|
+
"description": "The alt for the custom button icon",
|
|
660
|
+
"type": "string",
|
|
661
|
+
"title": "iconAlt"
|
|
662
|
+
},
|
|
663
|
+
"iconType": {
|
|
664
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
665
|
+
"type": "string",
|
|
666
|
+
"title": "iconType"
|
|
667
|
+
},
|
|
668
|
+
"icon": {
|
|
669
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
670
|
+
"type": "string",
|
|
671
|
+
"title": "icon"
|
|
672
|
+
}
|
|
673
|
+
},
|
|
674
|
+
"required": [
|
|
675
|
+
"event",
|
|
676
|
+
"icon",
|
|
677
|
+
"iconAlt",
|
|
678
|
+
"iconType"
|
|
679
|
+
]
|
|
680
|
+
},
|
|
681
|
+
"title": "customPlugins"
|
|
576
682
|
}
|
|
577
683
|
}
|
|
578
684
|
},
|
|
@@ -644,6 +750,43 @@
|
|
|
644
750
|
"title": "disabled"
|
|
645
751
|
}
|
|
646
752
|
}
|
|
753
|
+
},
|
|
754
|
+
"customPlugins": {
|
|
755
|
+
"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.",
|
|
756
|
+
"type": "array",
|
|
757
|
+
"items": {
|
|
758
|
+
"title": "CustomPlugin",
|
|
759
|
+
"type": "object",
|
|
760
|
+
"properties": {
|
|
761
|
+
"event": {
|
|
762
|
+
"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\"",
|
|
763
|
+
"type": "string",
|
|
764
|
+
"title": "event"
|
|
765
|
+
},
|
|
766
|
+
"iconAlt": {
|
|
767
|
+
"description": "The alt for the custom button icon",
|
|
768
|
+
"type": "string",
|
|
769
|
+
"title": "iconAlt"
|
|
770
|
+
},
|
|
771
|
+
"iconType": {
|
|
772
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
773
|
+
"type": "string",
|
|
774
|
+
"title": "iconType"
|
|
775
|
+
},
|
|
776
|
+
"icon": {
|
|
777
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
778
|
+
"type": "string",
|
|
779
|
+
"title": "icon"
|
|
780
|
+
}
|
|
781
|
+
},
|
|
782
|
+
"required": [
|
|
783
|
+
"event",
|
|
784
|
+
"icon",
|
|
785
|
+
"iconAlt",
|
|
786
|
+
"iconType"
|
|
787
|
+
]
|
|
788
|
+
},
|
|
789
|
+
"title": "customPlugins"
|
|
647
790
|
}
|
|
648
791
|
}
|
|
649
792
|
},
|
package/docs/pie-schema.json.md
CHANGED
|
@@ -239,6 +239,35 @@ Properties of the `image` object:
|
|
|
239
239
|
|
|
240
240
|
Indicates if the plugin is disabled or not
|
|
241
241
|
|
|
242
|
+
### `customPlugins` (array)
|
|
243
|
+
|
|
244
|
+
An array of objects that determine custom plugins.
|
|
245
|
+
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).
|
|
246
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
247
|
+
|
|
248
|
+
The object is an array with all elements of the type `object`.
|
|
249
|
+
|
|
250
|
+
The array object has the following properties:
|
|
251
|
+
|
|
252
|
+
#### `event` (string, required)
|
|
253
|
+
|
|
254
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
255
|
+
PIE will emit the event prefixed with "PIE-".
|
|
256
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
257
|
+
|
|
258
|
+
#### `iconAlt` (string, required)
|
|
259
|
+
|
|
260
|
+
The alt for the custom button icon
|
|
261
|
+
|
|
262
|
+
#### `iconType` (string, required)
|
|
263
|
+
|
|
264
|
+
The icon type.
|
|
265
|
+
Currently, only "SVG" is supported.
|
|
266
|
+
|
|
267
|
+
#### `icon` (string, required)
|
|
268
|
+
|
|
269
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
270
|
+
|
|
242
271
|
## `EditableHtmlButtonConfigure` (object)
|
|
243
272
|
|
|
244
273
|
Properties of the `EditableHtmlButtonConfigure` object:
|
|
@@ -247,6 +276,29 @@ Properties of the `EditableHtmlButtonConfigure` object:
|
|
|
247
276
|
|
|
248
277
|
Indicates if the plugin is disabled or not
|
|
249
278
|
|
|
279
|
+
## `CustomPlugin` (object)
|
|
280
|
+
|
|
281
|
+
Properties of the `CustomPlugin` object:
|
|
282
|
+
|
|
283
|
+
### `event` (string, required)
|
|
284
|
+
|
|
285
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
286
|
+
PIE will emit the event prefixed with "PIE-".
|
|
287
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
288
|
+
|
|
289
|
+
### `iconAlt` (string, required)
|
|
290
|
+
|
|
291
|
+
The alt for the custom button icon
|
|
292
|
+
|
|
293
|
+
### `iconType` (string, required)
|
|
294
|
+
|
|
295
|
+
The icon type.
|
|
296
|
+
Currently, only "SVG" is supported.
|
|
297
|
+
|
|
298
|
+
### `icon` (string, required)
|
|
299
|
+
|
|
300
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
301
|
+
|
|
250
302
|
## `ConfigureProp` (object)
|
|
251
303
|
|
|
252
304
|
Properties of the `ConfigureProp` object:
|
|
@@ -299,6 +351,35 @@ Properties of the `image` object:
|
|
|
299
351
|
|
|
300
352
|
Indicates if the plugin is disabled or not
|
|
301
353
|
|
|
354
|
+
#### `customPlugins` (array)
|
|
355
|
+
|
|
356
|
+
An array of objects that determine custom plugins.
|
|
357
|
+
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).
|
|
358
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
359
|
+
|
|
360
|
+
The object is an array with all elements of the type `object`.
|
|
361
|
+
|
|
362
|
+
The array object has the following properties:
|
|
363
|
+
|
|
364
|
+
##### `event` (string, required)
|
|
365
|
+
|
|
366
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
367
|
+
PIE will emit the event prefixed with "PIE-".
|
|
368
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
369
|
+
|
|
370
|
+
##### `iconAlt` (string, required)
|
|
371
|
+
|
|
372
|
+
The alt for the custom button icon
|
|
373
|
+
|
|
374
|
+
##### `iconType` (string, required)
|
|
375
|
+
|
|
376
|
+
The icon type.
|
|
377
|
+
Currently, only "SVG" is supported.
|
|
378
|
+
|
|
379
|
+
##### `icon` (string, required)
|
|
380
|
+
|
|
381
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
382
|
+
|
|
302
383
|
### `required` (boolean)
|
|
303
384
|
|
|
304
385
|
Indicates if the item is required and the value cannot be empty
|
|
@@ -351,6 +432,35 @@ Properties of the `image` object:
|
|
|
351
432
|
|
|
352
433
|
Indicates if the plugin is disabled or not
|
|
353
434
|
|
|
435
|
+
#### `customPlugins` (array)
|
|
436
|
+
|
|
437
|
+
An array of objects that determine custom plugins.
|
|
438
|
+
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).
|
|
439
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
440
|
+
|
|
441
|
+
The object is an array with all elements of the type `object`.
|
|
442
|
+
|
|
443
|
+
The array object has the following properties:
|
|
444
|
+
|
|
445
|
+
##### `event` (string, required)
|
|
446
|
+
|
|
447
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
448
|
+
PIE will emit the event prefixed with "PIE-".
|
|
449
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
450
|
+
|
|
451
|
+
##### `iconAlt` (string, required)
|
|
452
|
+
|
|
453
|
+
The alt for the custom button icon
|
|
454
|
+
|
|
455
|
+
##### `iconType` (string, required)
|
|
456
|
+
|
|
457
|
+
The icon type.
|
|
458
|
+
Currently, only "SVG" is supported.
|
|
459
|
+
|
|
460
|
+
##### `icon` (string, required)
|
|
461
|
+
|
|
462
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
463
|
+
|
|
354
464
|
### `settings` (boolean)
|
|
355
465
|
|
|
356
466
|
Indicates if the item has to be displayed in the Settings Panel
|
package/package.json
CHANGED
|
@@ -4,14 +4,14 @@
|
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public"
|
|
6
6
|
},
|
|
7
|
-
"version": "8.12.1-next.
|
|
7
|
+
"version": "8.12.1-next.18+867186f22",
|
|
8
8
|
"description": "",
|
|
9
9
|
"author": "pie framework developers",
|
|
10
10
|
"license": "ISC",
|
|
11
11
|
"dependencies": {
|
|
12
12
|
"@material-ui/core": "^3.9.2",
|
|
13
13
|
"@pie-framework/pie-player-events": "^0.1.0",
|
|
14
|
-
"@pie-lib/pie-toolbox": "1.
|
|
14
|
+
"@pie-lib/pie-toolbox": "1.13.0",
|
|
15
15
|
"classnames": "^2.2.5",
|
|
16
16
|
"debug": "^4.1.1",
|
|
17
17
|
"lodash": "^4.17.15",
|
|
@@ -20,7 +20,7 @@
|
|
|
20
20
|
"react-dnd": "^14.0.5",
|
|
21
21
|
"react-dom": "^16.8.1"
|
|
22
22
|
},
|
|
23
|
-
"gitHead": "
|
|
23
|
+
"gitHead": "867186f22b1b891c92a74e63fbf81f86d6485632",
|
|
24
24
|
"scripts": {
|
|
25
25
|
"postpublish": "../../scripts/postpublish"
|
|
26
26
|
},
|