@pie-element/match 7.6.1-next.0 → 7.6.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
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
"@material-ui/core": "^3.9.2",
|
|
11
11
|
"@material-ui/icons": "^3.0.1",
|
|
12
12
|
"@pie-framework/pie-configure-events": "^1.3.0",
|
|
13
|
-
"@pie-lib/pie-toolbox": "1.
|
|
13
|
+
"@pie-lib/pie-toolbox": "1.13.0",
|
|
14
14
|
"classnames": "^2.2.5",
|
|
15
15
|
"debug": "^3.1.0",
|
|
16
16
|
"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
|
},
|
|
@@ -202,6 +276,43 @@
|
|
|
202
276
|
"title": "disabled"
|
|
203
277
|
}
|
|
204
278
|
}
|
|
279
|
+
},
|
|
280
|
+
"customPlugins": {
|
|
281
|
+
"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.",
|
|
282
|
+
"type": "array",
|
|
283
|
+
"items": {
|
|
284
|
+
"title": "CustomPlugin",
|
|
285
|
+
"type": "object",
|
|
286
|
+
"properties": {
|
|
287
|
+
"event": {
|
|
288
|
+
"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\"",
|
|
289
|
+
"type": "string",
|
|
290
|
+
"title": "event"
|
|
291
|
+
},
|
|
292
|
+
"iconAlt": {
|
|
293
|
+
"description": "The alt for the custom button icon",
|
|
294
|
+
"type": "string",
|
|
295
|
+
"title": "iconAlt"
|
|
296
|
+
},
|
|
297
|
+
"iconType": {
|
|
298
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
299
|
+
"type": "string",
|
|
300
|
+
"title": "iconType"
|
|
301
|
+
},
|
|
302
|
+
"icon": {
|
|
303
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
304
|
+
"type": "string",
|
|
305
|
+
"title": "icon"
|
|
306
|
+
}
|
|
307
|
+
},
|
|
308
|
+
"required": [
|
|
309
|
+
"event",
|
|
310
|
+
"icon",
|
|
311
|
+
"iconAlt",
|
|
312
|
+
"iconType"
|
|
313
|
+
]
|
|
314
|
+
},
|
|
315
|
+
"title": "customPlugins"
|
|
205
316
|
}
|
|
206
317
|
}
|
|
207
318
|
},
|
|
@@ -332,6 +443,43 @@
|
|
|
332
443
|
"title": "disabled"
|
|
333
444
|
}
|
|
334
445
|
}
|
|
446
|
+
},
|
|
447
|
+
"customPlugins": {
|
|
448
|
+
"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.",
|
|
449
|
+
"type": "array",
|
|
450
|
+
"items": {
|
|
451
|
+
"title": "CustomPlugin",
|
|
452
|
+
"type": "object",
|
|
453
|
+
"properties": {
|
|
454
|
+
"event": {
|
|
455
|
+
"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\"",
|
|
456
|
+
"type": "string",
|
|
457
|
+
"title": "event"
|
|
458
|
+
},
|
|
459
|
+
"iconAlt": {
|
|
460
|
+
"description": "The alt for the custom button icon",
|
|
461
|
+
"type": "string",
|
|
462
|
+
"title": "iconAlt"
|
|
463
|
+
},
|
|
464
|
+
"iconType": {
|
|
465
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
466
|
+
"type": "string",
|
|
467
|
+
"title": "iconType"
|
|
468
|
+
},
|
|
469
|
+
"icon": {
|
|
470
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
471
|
+
"type": "string",
|
|
472
|
+
"title": "icon"
|
|
473
|
+
}
|
|
474
|
+
},
|
|
475
|
+
"required": [
|
|
476
|
+
"event",
|
|
477
|
+
"icon",
|
|
478
|
+
"iconAlt",
|
|
479
|
+
"iconType"
|
|
480
|
+
]
|
|
481
|
+
},
|
|
482
|
+
"title": "customPlugins"
|
|
335
483
|
}
|
|
336
484
|
}
|
|
337
485
|
},
|
|
@@ -424,6 +572,43 @@
|
|
|
424
572
|
"title": "disabled"
|
|
425
573
|
}
|
|
426
574
|
}
|
|
575
|
+
},
|
|
576
|
+
"customPlugins": {
|
|
577
|
+
"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.",
|
|
578
|
+
"type": "array",
|
|
579
|
+
"items": {
|
|
580
|
+
"title": "CustomPlugin",
|
|
581
|
+
"type": "object",
|
|
582
|
+
"properties": {
|
|
583
|
+
"event": {
|
|
584
|
+
"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\"",
|
|
585
|
+
"type": "string",
|
|
586
|
+
"title": "event"
|
|
587
|
+
},
|
|
588
|
+
"iconAlt": {
|
|
589
|
+
"description": "The alt for the custom button icon",
|
|
590
|
+
"type": "string",
|
|
591
|
+
"title": "iconAlt"
|
|
592
|
+
},
|
|
593
|
+
"iconType": {
|
|
594
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
595
|
+
"type": "string",
|
|
596
|
+
"title": "iconType"
|
|
597
|
+
},
|
|
598
|
+
"icon": {
|
|
599
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
600
|
+
"type": "string",
|
|
601
|
+
"title": "icon"
|
|
602
|
+
}
|
|
603
|
+
},
|
|
604
|
+
"required": [
|
|
605
|
+
"event",
|
|
606
|
+
"icon",
|
|
607
|
+
"iconAlt",
|
|
608
|
+
"iconType"
|
|
609
|
+
]
|
|
610
|
+
},
|
|
611
|
+
"title": "customPlugins"
|
|
427
612
|
}
|
|
428
613
|
}
|
|
429
614
|
},
|
|
@@ -527,6 +712,43 @@
|
|
|
527
712
|
"title": "disabled"
|
|
528
713
|
}
|
|
529
714
|
}
|
|
715
|
+
},
|
|
716
|
+
"customPlugins": {
|
|
717
|
+
"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.",
|
|
718
|
+
"type": "array",
|
|
719
|
+
"items": {
|
|
720
|
+
"title": "CustomPlugin",
|
|
721
|
+
"type": "object",
|
|
722
|
+
"properties": {
|
|
723
|
+
"event": {
|
|
724
|
+
"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\"",
|
|
725
|
+
"type": "string",
|
|
726
|
+
"title": "event"
|
|
727
|
+
},
|
|
728
|
+
"iconAlt": {
|
|
729
|
+
"description": "The alt for the custom button icon",
|
|
730
|
+
"type": "string",
|
|
731
|
+
"title": "iconAlt"
|
|
732
|
+
},
|
|
733
|
+
"iconType": {
|
|
734
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
735
|
+
"type": "string",
|
|
736
|
+
"title": "iconType"
|
|
737
|
+
},
|
|
738
|
+
"icon": {
|
|
739
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
740
|
+
"type": "string",
|
|
741
|
+
"title": "icon"
|
|
742
|
+
}
|
|
743
|
+
},
|
|
744
|
+
"required": [
|
|
745
|
+
"event",
|
|
746
|
+
"icon",
|
|
747
|
+
"iconAlt",
|
|
748
|
+
"iconType"
|
|
749
|
+
]
|
|
750
|
+
},
|
|
751
|
+
"title": "customPlugins"
|
|
530
752
|
}
|
|
531
753
|
}
|
|
532
754
|
},
|
|
@@ -840,6 +1062,43 @@
|
|
|
840
1062
|
"title": "disabled"
|
|
841
1063
|
}
|
|
842
1064
|
}
|
|
1065
|
+
},
|
|
1066
|
+
"customPlugins": {
|
|
1067
|
+
"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.",
|
|
1068
|
+
"type": "array",
|
|
1069
|
+
"items": {
|
|
1070
|
+
"title": "CustomPlugin",
|
|
1071
|
+
"type": "object",
|
|
1072
|
+
"properties": {
|
|
1073
|
+
"event": {
|
|
1074
|
+
"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\"",
|
|
1075
|
+
"type": "string",
|
|
1076
|
+
"title": "event"
|
|
1077
|
+
},
|
|
1078
|
+
"iconAlt": {
|
|
1079
|
+
"description": "The alt for the custom button icon",
|
|
1080
|
+
"type": "string",
|
|
1081
|
+
"title": "iconAlt"
|
|
1082
|
+
},
|
|
1083
|
+
"iconType": {
|
|
1084
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
1085
|
+
"type": "string",
|
|
1086
|
+
"title": "iconType"
|
|
1087
|
+
},
|
|
1088
|
+
"icon": {
|
|
1089
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
1090
|
+
"type": "string",
|
|
1091
|
+
"title": "icon"
|
|
1092
|
+
}
|
|
1093
|
+
},
|
|
1094
|
+
"required": [
|
|
1095
|
+
"event",
|
|
1096
|
+
"icon",
|
|
1097
|
+
"iconAlt",
|
|
1098
|
+
"iconType"
|
|
1099
|
+
]
|
|
1100
|
+
},
|
|
1101
|
+
"title": "customPlugins"
|
|
843
1102
|
}
|
|
844
1103
|
}
|
|
845
1104
|
},
|
|
@@ -854,6 +1113,38 @@
|
|
|
854
1113
|
}
|
|
855
1114
|
}
|
|
856
1115
|
},
|
|
1116
|
+
"CustomPlugin": {
|
|
1117
|
+
"title": "CustomPlugin",
|
|
1118
|
+
"type": "object",
|
|
1119
|
+
"properties": {
|
|
1120
|
+
"event": {
|
|
1121
|
+
"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\"",
|
|
1122
|
+
"type": "string",
|
|
1123
|
+
"title": "event"
|
|
1124
|
+
},
|
|
1125
|
+
"iconAlt": {
|
|
1126
|
+
"description": "The alt for the custom button icon",
|
|
1127
|
+
"type": "string",
|
|
1128
|
+
"title": "iconAlt"
|
|
1129
|
+
},
|
|
1130
|
+
"iconType": {
|
|
1131
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
1132
|
+
"type": "string",
|
|
1133
|
+
"title": "iconType"
|
|
1134
|
+
},
|
|
1135
|
+
"icon": {
|
|
1136
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
1137
|
+
"type": "string",
|
|
1138
|
+
"title": "icon"
|
|
1139
|
+
}
|
|
1140
|
+
},
|
|
1141
|
+
"required": [
|
|
1142
|
+
"event",
|
|
1143
|
+
"icon",
|
|
1144
|
+
"iconAlt",
|
|
1145
|
+
"iconType"
|
|
1146
|
+
]
|
|
1147
|
+
},
|
|
857
1148
|
"ConfigureProp": {
|
|
858
1149
|
"title": "ConfigureProp",
|
|
859
1150
|
"type": "object",
|
|
@@ -921,6 +1212,43 @@
|
|
|
921
1212
|
"title": "disabled"
|
|
922
1213
|
}
|
|
923
1214
|
}
|
|
1215
|
+
},
|
|
1216
|
+
"customPlugins": {
|
|
1217
|
+
"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.",
|
|
1218
|
+
"type": "array",
|
|
1219
|
+
"items": {
|
|
1220
|
+
"title": "CustomPlugin",
|
|
1221
|
+
"type": "object",
|
|
1222
|
+
"properties": {
|
|
1223
|
+
"event": {
|
|
1224
|
+
"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\"",
|
|
1225
|
+
"type": "string",
|
|
1226
|
+
"title": "event"
|
|
1227
|
+
},
|
|
1228
|
+
"iconAlt": {
|
|
1229
|
+
"description": "The alt for the custom button icon",
|
|
1230
|
+
"type": "string",
|
|
1231
|
+
"title": "iconAlt"
|
|
1232
|
+
},
|
|
1233
|
+
"iconType": {
|
|
1234
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
1235
|
+
"type": "string",
|
|
1236
|
+
"title": "iconType"
|
|
1237
|
+
},
|
|
1238
|
+
"icon": {
|
|
1239
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
1240
|
+
"type": "string",
|
|
1241
|
+
"title": "icon"
|
|
1242
|
+
}
|
|
1243
|
+
},
|
|
1244
|
+
"required": [
|
|
1245
|
+
"event",
|
|
1246
|
+
"icon",
|
|
1247
|
+
"iconAlt",
|
|
1248
|
+
"iconType"
|
|
1249
|
+
]
|
|
1250
|
+
},
|
|
1251
|
+
"title": "customPlugins"
|
|
924
1252
|
}
|
|
925
1253
|
}
|
|
926
1254
|
},
|
|
@@ -987,6 +1315,43 @@
|
|
|
987
1315
|
"title": "disabled"
|
|
988
1316
|
}
|
|
989
1317
|
}
|
|
1318
|
+
},
|
|
1319
|
+
"customPlugins": {
|
|
1320
|
+
"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.",
|
|
1321
|
+
"type": "array",
|
|
1322
|
+
"items": {
|
|
1323
|
+
"title": "CustomPlugin",
|
|
1324
|
+
"type": "object",
|
|
1325
|
+
"properties": {
|
|
1326
|
+
"event": {
|
|
1327
|
+
"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\"",
|
|
1328
|
+
"type": "string",
|
|
1329
|
+
"title": "event"
|
|
1330
|
+
},
|
|
1331
|
+
"iconAlt": {
|
|
1332
|
+
"description": "The alt for the custom button icon",
|
|
1333
|
+
"type": "string",
|
|
1334
|
+
"title": "iconAlt"
|
|
1335
|
+
},
|
|
1336
|
+
"iconType": {
|
|
1337
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
1338
|
+
"type": "string",
|
|
1339
|
+
"title": "iconType"
|
|
1340
|
+
},
|
|
1341
|
+
"icon": {
|
|
1342
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
1343
|
+
"type": "string",
|
|
1344
|
+
"title": "icon"
|
|
1345
|
+
}
|
|
1346
|
+
},
|
|
1347
|
+
"required": [
|
|
1348
|
+
"event",
|
|
1349
|
+
"icon",
|
|
1350
|
+
"iconAlt",
|
|
1351
|
+
"iconType"
|
|
1352
|
+
]
|
|
1353
|
+
},
|
|
1354
|
+
"title": "customPlugins"
|
|
990
1355
|
}
|
|
991
1356
|
}
|
|
992
1357
|
},
|
|
@@ -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
|
# `enableImages` (object)
|
|
42
71
|
|
|
43
72
|
Properties of the `enableImages` 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
|
## `settings` (boolean)
|
|
94
152
|
|
|
95
153
|
Indicates if the item has to be displayed in the Settings Panel
|
|
@@ -150,6 +208,35 @@ Properties of the `image` object:
|
|
|
150
208
|
|
|
151
209
|
Indicates if the plugin is disabled or not
|
|
152
210
|
|
|
211
|
+
### `customPlugins` (array)
|
|
212
|
+
|
|
213
|
+
An array of objects that determine custom plugins.
|
|
214
|
+
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).
|
|
215
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
216
|
+
|
|
217
|
+
The object is an array with all elements of the type `object`.
|
|
218
|
+
|
|
219
|
+
The array object has the following properties:
|
|
220
|
+
|
|
221
|
+
#### `event` (string, required)
|
|
222
|
+
|
|
223
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
224
|
+
PIE will emit the event prefixed with "PIE-".
|
|
225
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
226
|
+
|
|
227
|
+
#### `iconAlt` (string, required)
|
|
228
|
+
|
|
229
|
+
The alt for the custom button icon
|
|
230
|
+
|
|
231
|
+
#### `iconType` (string, required)
|
|
232
|
+
|
|
233
|
+
The icon type.
|
|
234
|
+
Currently, only "SVG" is supported.
|
|
235
|
+
|
|
236
|
+
#### `icon` (string, required)
|
|
237
|
+
|
|
238
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
239
|
+
|
|
153
240
|
## `settings` (boolean)
|
|
154
241
|
|
|
155
242
|
Indicates if the item has to be displayed in the Settings Panel
|
|
@@ -246,6 +333,35 @@ Properties of the `image` object:
|
|
|
246
333
|
|
|
247
334
|
Indicates if the plugin is disabled or not
|
|
248
335
|
|
|
336
|
+
### `customPlugins` (array)
|
|
337
|
+
|
|
338
|
+
An array of objects that determine custom plugins.
|
|
339
|
+
A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
|
|
340
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
341
|
+
|
|
342
|
+
The object is an array with all elements of the type `object`.
|
|
343
|
+
|
|
344
|
+
The array object has the following properties:
|
|
345
|
+
|
|
346
|
+
#### `event` (string, required)
|
|
347
|
+
|
|
348
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
349
|
+
PIE will emit the event prefixed with "PIE-".
|
|
350
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
351
|
+
|
|
352
|
+
#### `iconAlt` (string, required)
|
|
353
|
+
|
|
354
|
+
The alt for the custom button icon
|
|
355
|
+
|
|
356
|
+
#### `iconType` (string, required)
|
|
357
|
+
|
|
358
|
+
The icon type.
|
|
359
|
+
Currently, only "SVG" is supported.
|
|
360
|
+
|
|
361
|
+
#### `icon` (string, required)
|
|
362
|
+
|
|
363
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
364
|
+
|
|
249
365
|
## `required` (boolean)
|
|
250
366
|
|
|
251
367
|
Indicates if the item is required and the value cannot be empty
|
|
@@ -314,6 +430,35 @@ Properties of the `image` object:
|
|
|
314
430
|
|
|
315
431
|
Indicates if the plugin is disabled or not
|
|
316
432
|
|
|
433
|
+
### `customPlugins` (array)
|
|
434
|
+
|
|
435
|
+
An array of objects that determine custom plugins.
|
|
436
|
+
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).
|
|
437
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
438
|
+
|
|
439
|
+
The object is an array with all elements of the type `object`.
|
|
440
|
+
|
|
441
|
+
The array object has the following properties:
|
|
442
|
+
|
|
443
|
+
#### `event` (string, required)
|
|
444
|
+
|
|
445
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
446
|
+
PIE will emit the event prefixed with "PIE-".
|
|
447
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
448
|
+
|
|
449
|
+
#### `iconAlt` (string, required)
|
|
450
|
+
|
|
451
|
+
The alt for the custom button icon
|
|
452
|
+
|
|
453
|
+
#### `iconType` (string, required)
|
|
454
|
+
|
|
455
|
+
The icon type.
|
|
456
|
+
Currently, only "SVG" is supported.
|
|
457
|
+
|
|
458
|
+
#### `icon` (string, required)
|
|
459
|
+
|
|
460
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
461
|
+
|
|
317
462
|
## `required` (boolean)
|
|
318
463
|
|
|
319
464
|
Indicates if the item is required and the value cannot be empty
|
|
@@ -390,6 +535,35 @@ Properties of the `image` object:
|
|
|
390
535
|
|
|
391
536
|
Indicates if the plugin is disabled or not
|
|
392
537
|
|
|
538
|
+
### `customPlugins` (array)
|
|
539
|
+
|
|
540
|
+
An array of objects that determine custom plugins.
|
|
541
|
+
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).
|
|
542
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
543
|
+
|
|
544
|
+
The object is an array with all elements of the type `object`.
|
|
545
|
+
|
|
546
|
+
The array object has the following properties:
|
|
547
|
+
|
|
548
|
+
#### `event` (string, required)
|
|
549
|
+
|
|
550
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
551
|
+
PIE will emit the event prefixed with "PIE-".
|
|
552
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
553
|
+
|
|
554
|
+
#### `iconAlt` (string, required)
|
|
555
|
+
|
|
556
|
+
The alt for the custom button icon
|
|
557
|
+
|
|
558
|
+
#### `iconType` (string, required)
|
|
559
|
+
|
|
560
|
+
The icon type.
|
|
561
|
+
Currently, only "SVG" is supported.
|
|
562
|
+
|
|
563
|
+
#### `icon` (string, required)
|
|
564
|
+
|
|
565
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
566
|
+
|
|
393
567
|
## `required` (boolean)
|
|
394
568
|
|
|
395
569
|
Indicates if the item is required and the value cannot be empty
|
|
@@ -628,6 +802,35 @@ Properties of the `image` object:
|
|
|
628
802
|
|
|
629
803
|
Indicates if the plugin is disabled or not
|
|
630
804
|
|
|
805
|
+
### `customPlugins` (array)
|
|
806
|
+
|
|
807
|
+
An array of objects that determine custom plugins.
|
|
808
|
+
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).
|
|
809
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
810
|
+
|
|
811
|
+
The object is an array with all elements of the type `object`.
|
|
812
|
+
|
|
813
|
+
The array object has the following properties:
|
|
814
|
+
|
|
815
|
+
#### `event` (string, required)
|
|
816
|
+
|
|
817
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
818
|
+
PIE will emit the event prefixed with "PIE-".
|
|
819
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
820
|
+
|
|
821
|
+
#### `iconAlt` (string, required)
|
|
822
|
+
|
|
823
|
+
The alt for the custom button icon
|
|
824
|
+
|
|
825
|
+
#### `iconType` (string, required)
|
|
826
|
+
|
|
827
|
+
The icon type.
|
|
828
|
+
Currently, only "SVG" is supported.
|
|
829
|
+
|
|
830
|
+
#### `icon` (string, required)
|
|
831
|
+
|
|
832
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
833
|
+
|
|
631
834
|
## `EditableHtmlButtonConfigure` (object)
|
|
632
835
|
|
|
633
836
|
Properties of the `EditableHtmlButtonConfigure` object:
|
|
@@ -636,6 +839,29 @@ Properties of the `EditableHtmlButtonConfigure` object:
|
|
|
636
839
|
|
|
637
840
|
Indicates if the plugin is disabled or not
|
|
638
841
|
|
|
842
|
+
## `CustomPlugin` (object)
|
|
843
|
+
|
|
844
|
+
Properties of the `CustomPlugin` object:
|
|
845
|
+
|
|
846
|
+
### `event` (string, required)
|
|
847
|
+
|
|
848
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
849
|
+
PIE will emit the event prefixed with "PIE-".
|
|
850
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
851
|
+
|
|
852
|
+
### `iconAlt` (string, required)
|
|
853
|
+
|
|
854
|
+
The alt for the custom button icon
|
|
855
|
+
|
|
856
|
+
### `iconType` (string, required)
|
|
857
|
+
|
|
858
|
+
The icon type.
|
|
859
|
+
Currently, only "SVG" is supported.
|
|
860
|
+
|
|
861
|
+
### `icon` (string, required)
|
|
862
|
+
|
|
863
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
864
|
+
|
|
639
865
|
## `ConfigureProp` (object)
|
|
640
866
|
|
|
641
867
|
Properties of the `ConfigureProp` object:
|
|
@@ -688,6 +914,35 @@ Properties of the `image` object:
|
|
|
688
914
|
|
|
689
915
|
Indicates if the plugin is disabled or not
|
|
690
916
|
|
|
917
|
+
#### `customPlugins` (array)
|
|
918
|
+
|
|
919
|
+
An array of objects that determine custom plugins.
|
|
920
|
+
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).
|
|
921
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
922
|
+
|
|
923
|
+
The object is an array with all elements of the type `object`.
|
|
924
|
+
|
|
925
|
+
The array object has the following properties:
|
|
926
|
+
|
|
927
|
+
##### `event` (string, required)
|
|
928
|
+
|
|
929
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
930
|
+
PIE will emit the event prefixed with "PIE-".
|
|
931
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
932
|
+
|
|
933
|
+
##### `iconAlt` (string, required)
|
|
934
|
+
|
|
935
|
+
The alt for the custom button icon
|
|
936
|
+
|
|
937
|
+
##### `iconType` (string, required)
|
|
938
|
+
|
|
939
|
+
The icon type.
|
|
940
|
+
Currently, only "SVG" is supported.
|
|
941
|
+
|
|
942
|
+
##### `icon` (string, required)
|
|
943
|
+
|
|
944
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
945
|
+
|
|
691
946
|
### `settings` (boolean)
|
|
692
947
|
|
|
693
948
|
Indicates if the item has to be displayed in the Settings Panel
|
|
@@ -736,6 +991,35 @@ Properties of the `image` object:
|
|
|
736
991
|
|
|
737
992
|
Indicates if the plugin is disabled or not
|
|
738
993
|
|
|
994
|
+
#### `customPlugins` (array)
|
|
995
|
+
|
|
996
|
+
An array of objects that determine custom plugins.
|
|
997
|
+
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).
|
|
998
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
999
|
+
|
|
1000
|
+
The object is an array with all elements of the type `object`.
|
|
1001
|
+
|
|
1002
|
+
The array object has the following properties:
|
|
1003
|
+
|
|
1004
|
+
##### `event` (string, required)
|
|
1005
|
+
|
|
1006
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
1007
|
+
PIE will emit the event prefixed with "PIE-".
|
|
1008
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
1009
|
+
|
|
1010
|
+
##### `iconAlt` (string, required)
|
|
1011
|
+
|
|
1012
|
+
The alt for the custom button icon
|
|
1013
|
+
|
|
1014
|
+
##### `iconType` (string, required)
|
|
1015
|
+
|
|
1016
|
+
The icon type.
|
|
1017
|
+
Currently, only "SVG" is supported.
|
|
1018
|
+
|
|
1019
|
+
##### `icon` (string, required)
|
|
1020
|
+
|
|
1021
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
1022
|
+
|
|
739
1023
|
### `required` (boolean)
|
|
740
1024
|
|
|
741
1025
|
Indicates if the item is required and the value cannot be empty
|
package/docs/pie-schema.json
CHANGED
|
@@ -397,6 +397,43 @@
|
|
|
397
397
|
"title": "disabled"
|
|
398
398
|
}
|
|
399
399
|
}
|
|
400
|
+
},
|
|
401
|
+
"customPlugins": {
|
|
402
|
+
"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.",
|
|
403
|
+
"type": "array",
|
|
404
|
+
"items": {
|
|
405
|
+
"title": "CustomPlugin",
|
|
406
|
+
"type": "object",
|
|
407
|
+
"properties": {
|
|
408
|
+
"event": {
|
|
409
|
+
"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\"",
|
|
410
|
+
"type": "string",
|
|
411
|
+
"title": "event"
|
|
412
|
+
},
|
|
413
|
+
"iconAlt": {
|
|
414
|
+
"description": "The alt for the custom button icon",
|
|
415
|
+
"type": "string",
|
|
416
|
+
"title": "iconAlt"
|
|
417
|
+
},
|
|
418
|
+
"iconType": {
|
|
419
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
420
|
+
"type": "string",
|
|
421
|
+
"title": "iconType"
|
|
422
|
+
},
|
|
423
|
+
"icon": {
|
|
424
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
425
|
+
"type": "string",
|
|
426
|
+
"title": "icon"
|
|
427
|
+
}
|
|
428
|
+
},
|
|
429
|
+
"required": [
|
|
430
|
+
"event",
|
|
431
|
+
"icon",
|
|
432
|
+
"iconAlt",
|
|
433
|
+
"iconType"
|
|
434
|
+
]
|
|
435
|
+
},
|
|
436
|
+
"title": "customPlugins"
|
|
400
437
|
}
|
|
401
438
|
}
|
|
402
439
|
},
|
|
@@ -411,6 +448,38 @@
|
|
|
411
448
|
}
|
|
412
449
|
}
|
|
413
450
|
},
|
|
451
|
+
"CustomPlugin": {
|
|
452
|
+
"title": "CustomPlugin",
|
|
453
|
+
"type": "object",
|
|
454
|
+
"properties": {
|
|
455
|
+
"event": {
|
|
456
|
+
"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\"",
|
|
457
|
+
"type": "string",
|
|
458
|
+
"title": "event"
|
|
459
|
+
},
|
|
460
|
+
"iconAlt": {
|
|
461
|
+
"description": "The alt for the custom button icon",
|
|
462
|
+
"type": "string",
|
|
463
|
+
"title": "iconAlt"
|
|
464
|
+
},
|
|
465
|
+
"iconType": {
|
|
466
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
467
|
+
"type": "string",
|
|
468
|
+
"title": "iconType"
|
|
469
|
+
},
|
|
470
|
+
"icon": {
|
|
471
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
472
|
+
"type": "string",
|
|
473
|
+
"title": "icon"
|
|
474
|
+
}
|
|
475
|
+
},
|
|
476
|
+
"required": [
|
|
477
|
+
"event",
|
|
478
|
+
"icon",
|
|
479
|
+
"iconAlt",
|
|
480
|
+
"iconType"
|
|
481
|
+
]
|
|
482
|
+
},
|
|
414
483
|
"ConfigureProp": {
|
|
415
484
|
"title": "ConfigureProp",
|
|
416
485
|
"type": "object",
|
|
@@ -478,6 +547,43 @@
|
|
|
478
547
|
"title": "disabled"
|
|
479
548
|
}
|
|
480
549
|
}
|
|
550
|
+
},
|
|
551
|
+
"customPlugins": {
|
|
552
|
+
"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.",
|
|
553
|
+
"type": "array",
|
|
554
|
+
"items": {
|
|
555
|
+
"title": "CustomPlugin",
|
|
556
|
+
"type": "object",
|
|
557
|
+
"properties": {
|
|
558
|
+
"event": {
|
|
559
|
+
"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\"",
|
|
560
|
+
"type": "string",
|
|
561
|
+
"title": "event"
|
|
562
|
+
},
|
|
563
|
+
"iconAlt": {
|
|
564
|
+
"description": "The alt for the custom button icon",
|
|
565
|
+
"type": "string",
|
|
566
|
+
"title": "iconAlt"
|
|
567
|
+
},
|
|
568
|
+
"iconType": {
|
|
569
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
570
|
+
"type": "string",
|
|
571
|
+
"title": "iconType"
|
|
572
|
+
},
|
|
573
|
+
"icon": {
|
|
574
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
575
|
+
"type": "string",
|
|
576
|
+
"title": "icon"
|
|
577
|
+
}
|
|
578
|
+
},
|
|
579
|
+
"required": [
|
|
580
|
+
"event",
|
|
581
|
+
"icon",
|
|
582
|
+
"iconAlt",
|
|
583
|
+
"iconType"
|
|
584
|
+
]
|
|
585
|
+
},
|
|
586
|
+
"title": "customPlugins"
|
|
481
587
|
}
|
|
482
588
|
}
|
|
483
589
|
},
|
|
@@ -544,6 +650,43 @@
|
|
|
544
650
|
"title": "disabled"
|
|
545
651
|
}
|
|
546
652
|
}
|
|
653
|
+
},
|
|
654
|
+
"customPlugins": {
|
|
655
|
+
"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.",
|
|
656
|
+
"type": "array",
|
|
657
|
+
"items": {
|
|
658
|
+
"title": "CustomPlugin",
|
|
659
|
+
"type": "object",
|
|
660
|
+
"properties": {
|
|
661
|
+
"event": {
|
|
662
|
+
"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\"",
|
|
663
|
+
"type": "string",
|
|
664
|
+
"title": "event"
|
|
665
|
+
},
|
|
666
|
+
"iconAlt": {
|
|
667
|
+
"description": "The alt for the custom button icon",
|
|
668
|
+
"type": "string",
|
|
669
|
+
"title": "iconAlt"
|
|
670
|
+
},
|
|
671
|
+
"iconType": {
|
|
672
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
673
|
+
"type": "string",
|
|
674
|
+
"title": "iconType"
|
|
675
|
+
},
|
|
676
|
+
"icon": {
|
|
677
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
678
|
+
"type": "string",
|
|
679
|
+
"title": "icon"
|
|
680
|
+
}
|
|
681
|
+
},
|
|
682
|
+
"required": [
|
|
683
|
+
"event",
|
|
684
|
+
"icon",
|
|
685
|
+
"iconAlt",
|
|
686
|
+
"iconType"
|
|
687
|
+
]
|
|
688
|
+
},
|
|
689
|
+
"title": "customPlugins"
|
|
547
690
|
}
|
|
548
691
|
}
|
|
549
692
|
},
|
package/docs/pie-schema.json.md
CHANGED
|
@@ -190,6 +190,35 @@ Properties of the `image` object:
|
|
|
190
190
|
|
|
191
191
|
Indicates if the plugin is disabled or not
|
|
192
192
|
|
|
193
|
+
### `customPlugins` (array)
|
|
194
|
+
|
|
195
|
+
An array of objects that determine custom plugins.
|
|
196
|
+
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).
|
|
197
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
198
|
+
|
|
199
|
+
The object is an array with all elements of the type `object`.
|
|
200
|
+
|
|
201
|
+
The array object has the following properties:
|
|
202
|
+
|
|
203
|
+
#### `event` (string, required)
|
|
204
|
+
|
|
205
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
206
|
+
PIE will emit the event prefixed with "PIE-".
|
|
207
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
208
|
+
|
|
209
|
+
#### `iconAlt` (string, required)
|
|
210
|
+
|
|
211
|
+
The alt for the custom button icon
|
|
212
|
+
|
|
213
|
+
#### `iconType` (string, required)
|
|
214
|
+
|
|
215
|
+
The icon type.
|
|
216
|
+
Currently, only "SVG" is supported.
|
|
217
|
+
|
|
218
|
+
#### `icon` (string, required)
|
|
219
|
+
|
|
220
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
221
|
+
|
|
193
222
|
## `EditableHtmlButtonConfigure` (object)
|
|
194
223
|
|
|
195
224
|
Properties of the `EditableHtmlButtonConfigure` object:
|
|
@@ -198,6 +227,29 @@ Properties of the `EditableHtmlButtonConfigure` object:
|
|
|
198
227
|
|
|
199
228
|
Indicates if the plugin is disabled or not
|
|
200
229
|
|
|
230
|
+
## `CustomPlugin` (object)
|
|
231
|
+
|
|
232
|
+
Properties of the `CustomPlugin` object:
|
|
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
|
+
|
|
201
253
|
## `ConfigureProp` (object)
|
|
202
254
|
|
|
203
255
|
Properties of the `ConfigureProp` object:
|
|
@@ -250,6 +302,35 @@ Properties of the `image` object:
|
|
|
250
302
|
|
|
251
303
|
Indicates if the plugin is disabled or not
|
|
252
304
|
|
|
305
|
+
#### `customPlugins` (array)
|
|
306
|
+
|
|
307
|
+
An array of objects that determine custom plugins.
|
|
308
|
+
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).
|
|
309
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
310
|
+
|
|
311
|
+
The object is an array with all elements of the type `object`.
|
|
312
|
+
|
|
313
|
+
The array object has the following properties:
|
|
314
|
+
|
|
315
|
+
##### `event` (string, required)
|
|
316
|
+
|
|
317
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
318
|
+
PIE will emit the event prefixed with "PIE-".
|
|
319
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
320
|
+
|
|
321
|
+
##### `iconAlt` (string, required)
|
|
322
|
+
|
|
323
|
+
The alt for the custom button icon
|
|
324
|
+
|
|
325
|
+
##### `iconType` (string, required)
|
|
326
|
+
|
|
327
|
+
The icon type.
|
|
328
|
+
Currently, only "SVG" is supported.
|
|
329
|
+
|
|
330
|
+
##### `icon` (string, required)
|
|
331
|
+
|
|
332
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
333
|
+
|
|
253
334
|
### `settings` (boolean)
|
|
254
335
|
|
|
255
336
|
Indicates if the item has to be displayed in the Settings Panel
|
|
@@ -298,6 +379,35 @@ Properties of the `image` object:
|
|
|
298
379
|
|
|
299
380
|
Indicates if the plugin is disabled or not
|
|
300
381
|
|
|
382
|
+
#### `customPlugins` (array)
|
|
383
|
+
|
|
384
|
+
An array of objects that determine custom plugins.
|
|
385
|
+
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).
|
|
386
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
387
|
+
|
|
388
|
+
The object is an array with all elements of the type `object`.
|
|
389
|
+
|
|
390
|
+
The array object has the following properties:
|
|
391
|
+
|
|
392
|
+
##### `event` (string, required)
|
|
393
|
+
|
|
394
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
395
|
+
PIE will emit the event prefixed with "PIE-".
|
|
396
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
397
|
+
|
|
398
|
+
##### `iconAlt` (string, required)
|
|
399
|
+
|
|
400
|
+
The alt for the custom button icon
|
|
401
|
+
|
|
402
|
+
##### `iconType` (string, required)
|
|
403
|
+
|
|
404
|
+
The icon type.
|
|
405
|
+
Currently, only "SVG" is supported.
|
|
406
|
+
|
|
407
|
+
##### `icon` (string, required)
|
|
408
|
+
|
|
409
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
410
|
+
|
|
301
411
|
### `required` (boolean)
|
|
302
412
|
|
|
303
413
|
Indicates if the item is required and the value cannot be empty
|
package/package.json
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
"access": "public"
|
|
5
5
|
},
|
|
6
6
|
"repository": "pie-framework/pie-elements",
|
|
7
|
-
"version": "7.6.1-next.
|
|
7
|
+
"version": "7.6.1-next.18+867186f22",
|
|
8
8
|
"main": "lib/index.js",
|
|
9
9
|
"description": "",
|
|
10
10
|
"scripts": {
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
"dependencies": {
|
|
14
14
|
"@material-ui/core": "^3.9.2",
|
|
15
15
|
"@pie-framework/pie-player-events": "^0.1.0",
|
|
16
|
-
"@pie-lib/pie-toolbox": "1.
|
|
16
|
+
"@pie-lib/pie-toolbox": "1.13.0",
|
|
17
17
|
"classnames": "^2.2.5",
|
|
18
18
|
"debug": "^4.1.1",
|
|
19
19
|
"lodash": "^4.17.10",
|
|
@@ -23,6 +23,6 @@
|
|
|
23
23
|
},
|
|
24
24
|
"author": "",
|
|
25
25
|
"license": "ISC",
|
|
26
|
-
"gitHead": "
|
|
26
|
+
"gitHead": "867186f22b1b891c92a74e63fbf81f86d6485632",
|
|
27
27
|
"module": "src/index.js"
|
|
28
28
|
}
|