@pie-element/placement-ordering 9.9.0 → 9.9.1-next.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/config-schema.json +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 +2 -2
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
|
},
|
|
@@ -104,6 +141,43 @@
|
|
|
104
141
|
"title": "disabled"
|
|
105
142
|
}
|
|
106
143
|
}
|
|
144
|
+
},
|
|
145
|
+
"customPlugins": {
|
|
146
|
+
"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.",
|
|
147
|
+
"type": "array",
|
|
148
|
+
"items": {
|
|
149
|
+
"title": "CustomPlugin",
|
|
150
|
+
"type": "object",
|
|
151
|
+
"properties": {
|
|
152
|
+
"event": {
|
|
153
|
+
"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\"",
|
|
154
|
+
"type": "string",
|
|
155
|
+
"title": "event"
|
|
156
|
+
},
|
|
157
|
+
"iconAlt": {
|
|
158
|
+
"description": "The alt for the custom button icon",
|
|
159
|
+
"type": "string",
|
|
160
|
+
"title": "iconAlt"
|
|
161
|
+
},
|
|
162
|
+
"iconType": {
|
|
163
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
164
|
+
"type": "string",
|
|
165
|
+
"title": "iconType"
|
|
166
|
+
},
|
|
167
|
+
"icon": {
|
|
168
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
169
|
+
"type": "string",
|
|
170
|
+
"title": "icon"
|
|
171
|
+
}
|
|
172
|
+
},
|
|
173
|
+
"required": [
|
|
174
|
+
"event",
|
|
175
|
+
"icon",
|
|
176
|
+
"iconAlt",
|
|
177
|
+
"iconType"
|
|
178
|
+
]
|
|
179
|
+
},
|
|
180
|
+
"title": "customPlugins"
|
|
107
181
|
}
|
|
108
182
|
}
|
|
109
183
|
},
|
|
@@ -170,6 +244,43 @@
|
|
|
170
244
|
"title": "disabled"
|
|
171
245
|
}
|
|
172
246
|
}
|
|
247
|
+
},
|
|
248
|
+
"customPlugins": {
|
|
249
|
+
"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.",
|
|
250
|
+
"type": "array",
|
|
251
|
+
"items": {
|
|
252
|
+
"title": "CustomPlugin",
|
|
253
|
+
"type": "object",
|
|
254
|
+
"properties": {
|
|
255
|
+
"event": {
|
|
256
|
+
"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\"",
|
|
257
|
+
"type": "string",
|
|
258
|
+
"title": "event"
|
|
259
|
+
},
|
|
260
|
+
"iconAlt": {
|
|
261
|
+
"description": "The alt for the custom button icon",
|
|
262
|
+
"type": "string",
|
|
263
|
+
"title": "iconAlt"
|
|
264
|
+
},
|
|
265
|
+
"iconType": {
|
|
266
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
267
|
+
"type": "string",
|
|
268
|
+
"title": "iconType"
|
|
269
|
+
},
|
|
270
|
+
"icon": {
|
|
271
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
272
|
+
"type": "string",
|
|
273
|
+
"title": "icon"
|
|
274
|
+
}
|
|
275
|
+
},
|
|
276
|
+
"required": [
|
|
277
|
+
"event",
|
|
278
|
+
"icon",
|
|
279
|
+
"iconAlt",
|
|
280
|
+
"iconType"
|
|
281
|
+
]
|
|
282
|
+
},
|
|
283
|
+
"title": "customPlugins"
|
|
173
284
|
}
|
|
174
285
|
}
|
|
175
286
|
},
|
|
@@ -268,6 +379,43 @@
|
|
|
268
379
|
"title": "disabled"
|
|
269
380
|
}
|
|
270
381
|
}
|
|
382
|
+
},
|
|
383
|
+
"customPlugins": {
|
|
384
|
+
"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.",
|
|
385
|
+
"type": "array",
|
|
386
|
+
"items": {
|
|
387
|
+
"title": "CustomPlugin",
|
|
388
|
+
"type": "object",
|
|
389
|
+
"properties": {
|
|
390
|
+
"event": {
|
|
391
|
+
"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\"",
|
|
392
|
+
"type": "string",
|
|
393
|
+
"title": "event"
|
|
394
|
+
},
|
|
395
|
+
"iconAlt": {
|
|
396
|
+
"description": "The alt for the custom button icon",
|
|
397
|
+
"type": "string",
|
|
398
|
+
"title": "iconAlt"
|
|
399
|
+
},
|
|
400
|
+
"iconType": {
|
|
401
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
402
|
+
"type": "string",
|
|
403
|
+
"title": "iconType"
|
|
404
|
+
},
|
|
405
|
+
"icon": {
|
|
406
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
407
|
+
"type": "string",
|
|
408
|
+
"title": "icon"
|
|
409
|
+
}
|
|
410
|
+
},
|
|
411
|
+
"required": [
|
|
412
|
+
"event",
|
|
413
|
+
"icon",
|
|
414
|
+
"iconAlt",
|
|
415
|
+
"iconType"
|
|
416
|
+
]
|
|
417
|
+
},
|
|
418
|
+
"title": "customPlugins"
|
|
271
419
|
}
|
|
272
420
|
}
|
|
273
421
|
},
|
|
@@ -414,6 +562,43 @@
|
|
|
414
562
|
"title": "disabled"
|
|
415
563
|
}
|
|
416
564
|
}
|
|
565
|
+
},
|
|
566
|
+
"customPlugins": {
|
|
567
|
+
"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.",
|
|
568
|
+
"type": "array",
|
|
569
|
+
"items": {
|
|
570
|
+
"title": "CustomPlugin",
|
|
571
|
+
"type": "object",
|
|
572
|
+
"properties": {
|
|
573
|
+
"event": {
|
|
574
|
+
"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\"",
|
|
575
|
+
"type": "string",
|
|
576
|
+
"title": "event"
|
|
577
|
+
},
|
|
578
|
+
"iconAlt": {
|
|
579
|
+
"description": "The alt for the custom button icon",
|
|
580
|
+
"type": "string",
|
|
581
|
+
"title": "iconAlt"
|
|
582
|
+
},
|
|
583
|
+
"iconType": {
|
|
584
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
585
|
+
"type": "string",
|
|
586
|
+
"title": "iconType"
|
|
587
|
+
},
|
|
588
|
+
"icon": {
|
|
589
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
590
|
+
"type": "string",
|
|
591
|
+
"title": "icon"
|
|
592
|
+
}
|
|
593
|
+
},
|
|
594
|
+
"required": [
|
|
595
|
+
"event",
|
|
596
|
+
"icon",
|
|
597
|
+
"iconAlt",
|
|
598
|
+
"iconType"
|
|
599
|
+
]
|
|
600
|
+
},
|
|
601
|
+
"title": "customPlugins"
|
|
417
602
|
}
|
|
418
603
|
}
|
|
419
604
|
},
|
|
@@ -570,6 +755,43 @@
|
|
|
570
755
|
"title": "disabled"
|
|
571
756
|
}
|
|
572
757
|
}
|
|
758
|
+
},
|
|
759
|
+
"customPlugins": {
|
|
760
|
+
"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.",
|
|
761
|
+
"type": "array",
|
|
762
|
+
"items": {
|
|
763
|
+
"title": "CustomPlugin",
|
|
764
|
+
"type": "object",
|
|
765
|
+
"properties": {
|
|
766
|
+
"event": {
|
|
767
|
+
"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\"",
|
|
768
|
+
"type": "string",
|
|
769
|
+
"title": "event"
|
|
770
|
+
},
|
|
771
|
+
"iconAlt": {
|
|
772
|
+
"description": "The alt for the custom button icon",
|
|
773
|
+
"type": "string",
|
|
774
|
+
"title": "iconAlt"
|
|
775
|
+
},
|
|
776
|
+
"iconType": {
|
|
777
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
778
|
+
"type": "string",
|
|
779
|
+
"title": "iconType"
|
|
780
|
+
},
|
|
781
|
+
"icon": {
|
|
782
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
783
|
+
"type": "string",
|
|
784
|
+
"title": "icon"
|
|
785
|
+
}
|
|
786
|
+
},
|
|
787
|
+
"required": [
|
|
788
|
+
"event",
|
|
789
|
+
"icon",
|
|
790
|
+
"iconAlt",
|
|
791
|
+
"iconType"
|
|
792
|
+
]
|
|
793
|
+
},
|
|
794
|
+
"title": "customPlugins"
|
|
573
795
|
}
|
|
574
796
|
}
|
|
575
797
|
},
|
|
@@ -865,6 +1087,43 @@
|
|
|
865
1087
|
"title": "disabled"
|
|
866
1088
|
}
|
|
867
1089
|
}
|
|
1090
|
+
},
|
|
1091
|
+
"customPlugins": {
|
|
1092
|
+
"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.",
|
|
1093
|
+
"type": "array",
|
|
1094
|
+
"items": {
|
|
1095
|
+
"title": "CustomPlugin",
|
|
1096
|
+
"type": "object",
|
|
1097
|
+
"properties": {
|
|
1098
|
+
"event": {
|
|
1099
|
+
"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\"",
|
|
1100
|
+
"type": "string",
|
|
1101
|
+
"title": "event"
|
|
1102
|
+
},
|
|
1103
|
+
"iconAlt": {
|
|
1104
|
+
"description": "The alt for the custom button icon",
|
|
1105
|
+
"type": "string",
|
|
1106
|
+
"title": "iconAlt"
|
|
1107
|
+
},
|
|
1108
|
+
"iconType": {
|
|
1109
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
1110
|
+
"type": "string",
|
|
1111
|
+
"title": "iconType"
|
|
1112
|
+
},
|
|
1113
|
+
"icon": {
|
|
1114
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
1115
|
+
"type": "string",
|
|
1116
|
+
"title": "icon"
|
|
1117
|
+
}
|
|
1118
|
+
},
|
|
1119
|
+
"required": [
|
|
1120
|
+
"event",
|
|
1121
|
+
"icon",
|
|
1122
|
+
"iconAlt",
|
|
1123
|
+
"iconType"
|
|
1124
|
+
]
|
|
1125
|
+
},
|
|
1126
|
+
"title": "customPlugins"
|
|
868
1127
|
}
|
|
869
1128
|
}
|
|
870
1129
|
},
|
|
@@ -879,6 +1138,38 @@
|
|
|
879
1138
|
}
|
|
880
1139
|
}
|
|
881
1140
|
},
|
|
1141
|
+
"CustomPlugin": {
|
|
1142
|
+
"title": "CustomPlugin",
|
|
1143
|
+
"type": "object",
|
|
1144
|
+
"properties": {
|
|
1145
|
+
"event": {
|
|
1146
|
+
"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\"",
|
|
1147
|
+
"type": "string",
|
|
1148
|
+
"title": "event"
|
|
1149
|
+
},
|
|
1150
|
+
"iconAlt": {
|
|
1151
|
+
"description": "The alt for the custom button icon",
|
|
1152
|
+
"type": "string",
|
|
1153
|
+
"title": "iconAlt"
|
|
1154
|
+
},
|
|
1155
|
+
"iconType": {
|
|
1156
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
1157
|
+
"type": "string",
|
|
1158
|
+
"title": "iconType"
|
|
1159
|
+
},
|
|
1160
|
+
"icon": {
|
|
1161
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
1162
|
+
"type": "string",
|
|
1163
|
+
"title": "icon"
|
|
1164
|
+
}
|
|
1165
|
+
},
|
|
1166
|
+
"required": [
|
|
1167
|
+
"event",
|
|
1168
|
+
"icon",
|
|
1169
|
+
"iconAlt",
|
|
1170
|
+
"iconType"
|
|
1171
|
+
]
|
|
1172
|
+
},
|
|
882
1173
|
"EditableHtmlPluginConfigure": {
|
|
883
1174
|
"title": "EditableHtmlPluginConfigure",
|
|
884
1175
|
"type": "object",
|
|
@@ -930,6 +1221,43 @@
|
|
|
930
1221
|
"title": "disabled"
|
|
931
1222
|
}
|
|
932
1223
|
}
|
|
1224
|
+
},
|
|
1225
|
+
"customPlugins": {
|
|
1226
|
+
"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.",
|
|
1227
|
+
"type": "array",
|
|
1228
|
+
"items": {
|
|
1229
|
+
"title": "CustomPlugin",
|
|
1230
|
+
"type": "object",
|
|
1231
|
+
"properties": {
|
|
1232
|
+
"event": {
|
|
1233
|
+
"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\"",
|
|
1234
|
+
"type": "string",
|
|
1235
|
+
"title": "event"
|
|
1236
|
+
},
|
|
1237
|
+
"iconAlt": {
|
|
1238
|
+
"description": "The alt for the custom button icon",
|
|
1239
|
+
"type": "string",
|
|
1240
|
+
"title": "iconAlt"
|
|
1241
|
+
},
|
|
1242
|
+
"iconType": {
|
|
1243
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
1244
|
+
"type": "string",
|
|
1245
|
+
"title": "iconType"
|
|
1246
|
+
},
|
|
1247
|
+
"icon": {
|
|
1248
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
1249
|
+
"type": "string",
|
|
1250
|
+
"title": "icon"
|
|
1251
|
+
}
|
|
1252
|
+
},
|
|
1253
|
+
"required": [
|
|
1254
|
+
"event",
|
|
1255
|
+
"icon",
|
|
1256
|
+
"iconAlt",
|
|
1257
|
+
"iconType"
|
|
1258
|
+
]
|
|
1259
|
+
},
|
|
1260
|
+
"title": "customPlugins"
|
|
933
1261
|
}
|
|
934
1262
|
}
|
|
935
1263
|
},
|
|
@@ -1012,6 +1340,43 @@
|
|
|
1012
1340
|
"title": "disabled"
|
|
1013
1341
|
}
|
|
1014
1342
|
}
|
|
1343
|
+
},
|
|
1344
|
+
"customPlugins": {
|
|
1345
|
+
"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.",
|
|
1346
|
+
"type": "array",
|
|
1347
|
+
"items": {
|
|
1348
|
+
"title": "CustomPlugin",
|
|
1349
|
+
"type": "object",
|
|
1350
|
+
"properties": {
|
|
1351
|
+
"event": {
|
|
1352
|
+
"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\"",
|
|
1353
|
+
"type": "string",
|
|
1354
|
+
"title": "event"
|
|
1355
|
+
},
|
|
1356
|
+
"iconAlt": {
|
|
1357
|
+
"description": "The alt for the custom button icon",
|
|
1358
|
+
"type": "string",
|
|
1359
|
+
"title": "iconAlt"
|
|
1360
|
+
},
|
|
1361
|
+
"iconType": {
|
|
1362
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
1363
|
+
"type": "string",
|
|
1364
|
+
"title": "iconType"
|
|
1365
|
+
},
|
|
1366
|
+
"icon": {
|
|
1367
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
1368
|
+
"type": "string",
|
|
1369
|
+
"title": "icon"
|
|
1370
|
+
}
|
|
1371
|
+
},
|
|
1372
|
+
"required": [
|
|
1373
|
+
"event",
|
|
1374
|
+
"icon",
|
|
1375
|
+
"iconAlt",
|
|
1376
|
+
"iconType"
|
|
1377
|
+
]
|
|
1378
|
+
},
|
|
1379
|
+
"title": "customPlugins"
|
|
1015
1380
|
}
|
|
1016
1381
|
}
|
|
1017
1382
|
},
|
|
@@ -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
|
# `choiceLabel` (object)
|
|
42
71
|
|
|
43
72
|
Properties of the `choiceLabel` object:
|
|
@@ -78,6 +107,35 @@ Properties of the `image` object:
|
|
|
78
107
|
|
|
79
108
|
Indicates if the plugin is disabled or not
|
|
80
109
|
|
|
110
|
+
### `customPlugins` (array)
|
|
111
|
+
|
|
112
|
+
An array of objects that determine custom plugins.
|
|
113
|
+
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).
|
|
114
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
115
|
+
|
|
116
|
+
The object is an array with all elements of the type `object`.
|
|
117
|
+
|
|
118
|
+
The array object has the following properties:
|
|
119
|
+
|
|
120
|
+
#### `event` (string, required)
|
|
121
|
+
|
|
122
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
123
|
+
PIE will emit the event prefixed with "PIE-".
|
|
124
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
125
|
+
|
|
126
|
+
#### `iconAlt` (string, required)
|
|
127
|
+
|
|
128
|
+
The alt for the custom button icon
|
|
129
|
+
|
|
130
|
+
#### `iconType` (string, required)
|
|
131
|
+
|
|
132
|
+
The icon type.
|
|
133
|
+
Currently, only "SVG" is supported.
|
|
134
|
+
|
|
135
|
+
#### `icon` (string, required)
|
|
136
|
+
|
|
137
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
138
|
+
|
|
81
139
|
## `settings` (boolean)
|
|
82
140
|
|
|
83
141
|
Indicates if the item has to be displayed in the Settings Panel
|
|
@@ -126,6 +184,35 @@ Properties of the `image` object:
|
|
|
126
184
|
|
|
127
185
|
Indicates if the plugin is disabled or not
|
|
128
186
|
|
|
187
|
+
### `customPlugins` (array)
|
|
188
|
+
|
|
189
|
+
An array of objects that determine custom plugins.
|
|
190
|
+
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).
|
|
191
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
192
|
+
|
|
193
|
+
The object is an array with all elements of the type `object`.
|
|
194
|
+
|
|
195
|
+
The array object has the following properties:
|
|
196
|
+
|
|
197
|
+
#### `event` (string, required)
|
|
198
|
+
|
|
199
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
200
|
+
PIE will emit the event prefixed with "PIE-".
|
|
201
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
202
|
+
|
|
203
|
+
#### `iconAlt` (string, required)
|
|
204
|
+
|
|
205
|
+
The alt for the custom button icon
|
|
206
|
+
|
|
207
|
+
#### `iconType` (string, required)
|
|
208
|
+
|
|
209
|
+
The icon type.
|
|
210
|
+
Currently, only "SVG" is supported.
|
|
211
|
+
|
|
212
|
+
#### `icon` (string, required)
|
|
213
|
+
|
|
214
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
215
|
+
|
|
129
216
|
## `settings` (boolean)
|
|
130
217
|
|
|
131
218
|
Indicates if the item has to be displayed in the Settings Panel
|
|
@@ -198,6 +285,35 @@ Properties of the `image` object:
|
|
|
198
285
|
|
|
199
286
|
Indicates if the plugin is disabled or not
|
|
200
287
|
|
|
288
|
+
### `customPlugins` (array)
|
|
289
|
+
|
|
290
|
+
An array of objects that determine custom plugins.
|
|
291
|
+
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).
|
|
292
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
293
|
+
|
|
294
|
+
The object is an array with all elements of the type `object`.
|
|
295
|
+
|
|
296
|
+
The array object has the following properties:
|
|
297
|
+
|
|
298
|
+
#### `event` (string, required)
|
|
299
|
+
|
|
300
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
301
|
+
PIE will emit the event prefixed with "PIE-".
|
|
302
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
303
|
+
|
|
304
|
+
#### `iconAlt` (string, required)
|
|
305
|
+
|
|
306
|
+
The alt for the custom button icon
|
|
307
|
+
|
|
308
|
+
#### `iconType` (string, required)
|
|
309
|
+
|
|
310
|
+
The icon type.
|
|
311
|
+
Currently, only "SVG" is supported.
|
|
312
|
+
|
|
313
|
+
#### `icon` (string, required)
|
|
314
|
+
|
|
315
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
316
|
+
|
|
201
317
|
## `settings` (boolean)
|
|
202
318
|
|
|
203
319
|
Indicates if the item has to be displayed in the Settings Panel
|
|
@@ -306,6 +422,35 @@ Properties of the `image` object:
|
|
|
306
422
|
|
|
307
423
|
Indicates if the plugin is disabled or not
|
|
308
424
|
|
|
425
|
+
### `customPlugins` (array)
|
|
426
|
+
|
|
427
|
+
An array of objects that determine custom plugins.
|
|
428
|
+
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).
|
|
429
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
430
|
+
|
|
431
|
+
The object is an array with all elements of the type `object`.
|
|
432
|
+
|
|
433
|
+
The array object has the following properties:
|
|
434
|
+
|
|
435
|
+
#### `event` (string, required)
|
|
436
|
+
|
|
437
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
438
|
+
PIE will emit the event prefixed with "PIE-".
|
|
439
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
440
|
+
|
|
441
|
+
#### `iconAlt` (string, required)
|
|
442
|
+
|
|
443
|
+
The alt for the custom button icon
|
|
444
|
+
|
|
445
|
+
#### `iconType` (string, required)
|
|
446
|
+
|
|
447
|
+
The icon type.
|
|
448
|
+
Currently, only "SVG" is supported.
|
|
449
|
+
|
|
450
|
+
#### `icon` (string, required)
|
|
451
|
+
|
|
452
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
453
|
+
|
|
309
454
|
## `required` (boolean)
|
|
310
455
|
|
|
311
456
|
Indicates if the item is required and the value cannot be empty
|
|
@@ -422,6 +567,35 @@ Properties of the `image` object:
|
|
|
422
567
|
|
|
423
568
|
Indicates if the plugin is disabled or not
|
|
424
569
|
|
|
570
|
+
### `customPlugins` (array)
|
|
571
|
+
|
|
572
|
+
An array of objects that determine custom plugins.
|
|
573
|
+
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).
|
|
574
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
575
|
+
|
|
576
|
+
The object is an array with all elements of the type `object`.
|
|
577
|
+
|
|
578
|
+
The array object has the following properties:
|
|
579
|
+
|
|
580
|
+
#### `event` (string, required)
|
|
581
|
+
|
|
582
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
583
|
+
PIE will emit the event prefixed with "PIE-".
|
|
584
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
585
|
+
|
|
586
|
+
#### `iconAlt` (string, required)
|
|
587
|
+
|
|
588
|
+
The alt for the custom button icon
|
|
589
|
+
|
|
590
|
+
#### `iconType` (string, required)
|
|
591
|
+
|
|
592
|
+
The icon type.
|
|
593
|
+
Currently, only "SVG" is supported.
|
|
594
|
+
|
|
595
|
+
#### `icon` (string, required)
|
|
596
|
+
|
|
597
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
598
|
+
|
|
425
599
|
## `required` (boolean)
|
|
426
600
|
|
|
427
601
|
Indicates if the item is required and the value cannot be empty
|
|
@@ -648,6 +822,35 @@ Properties of the `image` object:
|
|
|
648
822
|
|
|
649
823
|
Indicates if the plugin is disabled or not
|
|
650
824
|
|
|
825
|
+
### `customPlugins` (array)
|
|
826
|
+
|
|
827
|
+
An array of objects that determine custom plugins.
|
|
828
|
+
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).
|
|
829
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
830
|
+
|
|
831
|
+
The object is an array with all elements of the type `object`.
|
|
832
|
+
|
|
833
|
+
The array object has the following properties:
|
|
834
|
+
|
|
835
|
+
#### `event` (string, required)
|
|
836
|
+
|
|
837
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
838
|
+
PIE will emit the event prefixed with "PIE-".
|
|
839
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
840
|
+
|
|
841
|
+
#### `iconAlt` (string, required)
|
|
842
|
+
|
|
843
|
+
The alt for the custom button icon
|
|
844
|
+
|
|
845
|
+
#### `iconType` (string, required)
|
|
846
|
+
|
|
847
|
+
The icon type.
|
|
848
|
+
Currently, only "SVG" is supported.
|
|
849
|
+
|
|
850
|
+
#### `icon` (string, required)
|
|
851
|
+
|
|
852
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
853
|
+
|
|
651
854
|
## `EditableHtmlButtonConfigure` (object)
|
|
652
855
|
|
|
653
856
|
Properties of the `EditableHtmlButtonConfigure` object:
|
|
@@ -656,6 +859,29 @@ Properties of the `EditableHtmlButtonConfigure` object:
|
|
|
656
859
|
|
|
657
860
|
Indicates if the plugin is disabled or not
|
|
658
861
|
|
|
862
|
+
## `CustomPlugin` (object)
|
|
863
|
+
|
|
864
|
+
Properties of the `CustomPlugin` object:
|
|
865
|
+
|
|
866
|
+
### `event` (string, required)
|
|
867
|
+
|
|
868
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
869
|
+
PIE will emit the event prefixed with "PIE-".
|
|
870
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
871
|
+
|
|
872
|
+
### `iconAlt` (string, required)
|
|
873
|
+
|
|
874
|
+
The alt for the custom button icon
|
|
875
|
+
|
|
876
|
+
### `iconType` (string, required)
|
|
877
|
+
|
|
878
|
+
The icon type.
|
|
879
|
+
Currently, only "SVG" is supported.
|
|
880
|
+
|
|
881
|
+
### `icon` (string, required)
|
|
882
|
+
|
|
883
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
884
|
+
|
|
659
885
|
## `EditableHtmlPluginConfigure` (object)
|
|
660
886
|
|
|
661
887
|
Properties of the `EditableHtmlPluginConfigure` object:
|
|
@@ -696,6 +922,35 @@ Properties of the `image` object:
|
|
|
696
922
|
|
|
697
923
|
Indicates if the plugin is disabled or not
|
|
698
924
|
|
|
925
|
+
#### `customPlugins` (array)
|
|
926
|
+
|
|
927
|
+
An array of objects that determine custom plugins.
|
|
928
|
+
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).
|
|
929
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
930
|
+
|
|
931
|
+
The object is an array with all elements of the type `object`.
|
|
932
|
+
|
|
933
|
+
The array object has the following properties:
|
|
934
|
+
|
|
935
|
+
##### `event` (string, required)
|
|
936
|
+
|
|
937
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
938
|
+
PIE will emit the event prefixed with "PIE-".
|
|
939
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
940
|
+
|
|
941
|
+
##### `iconAlt` (string, required)
|
|
942
|
+
|
|
943
|
+
The alt for the custom button icon
|
|
944
|
+
|
|
945
|
+
##### `iconType` (string, required)
|
|
946
|
+
|
|
947
|
+
The icon type.
|
|
948
|
+
Currently, only "SVG" is supported.
|
|
949
|
+
|
|
950
|
+
##### `icon` (string, required)
|
|
951
|
+
|
|
952
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
953
|
+
|
|
699
954
|
### `settings` (boolean)
|
|
700
955
|
|
|
701
956
|
Indicates if the item has to be displayed in the Settings Panel
|
|
@@ -756,6 +1011,35 @@ Properties of the `image` object:
|
|
|
756
1011
|
|
|
757
1012
|
Indicates if the plugin is disabled or not
|
|
758
1013
|
|
|
1014
|
+
#### `customPlugins` (array)
|
|
1015
|
+
|
|
1016
|
+
An array of objects that determine custom plugins.
|
|
1017
|
+
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).
|
|
1018
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
1019
|
+
|
|
1020
|
+
The object is an array with all elements of the type `object`.
|
|
1021
|
+
|
|
1022
|
+
The array object has the following properties:
|
|
1023
|
+
|
|
1024
|
+
##### `event` (string, required)
|
|
1025
|
+
|
|
1026
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
1027
|
+
PIE will emit the event prefixed with "PIE-".
|
|
1028
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
1029
|
+
|
|
1030
|
+
##### `iconAlt` (string, required)
|
|
1031
|
+
|
|
1032
|
+
The alt for the custom button icon
|
|
1033
|
+
|
|
1034
|
+
##### `iconType` (string, required)
|
|
1035
|
+
|
|
1036
|
+
The icon type.
|
|
1037
|
+
Currently, only "SVG" is supported.
|
|
1038
|
+
|
|
1039
|
+
##### `icon` (string, required)
|
|
1040
|
+
|
|
1041
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
1042
|
+
|
|
759
1043
|
### `required` (boolean)
|
|
760
1044
|
|
|
761
1045
|
Indicates if the item is required and the value cannot be empty
|
package/docs/pie-schema.json
CHANGED
|
@@ -448,6 +448,43 @@
|
|
|
448
448
|
"title": "disabled"
|
|
449
449
|
}
|
|
450
450
|
}
|
|
451
|
+
},
|
|
452
|
+
"customPlugins": {
|
|
453
|
+
"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.",
|
|
454
|
+
"type": "array",
|
|
455
|
+
"items": {
|
|
456
|
+
"title": "CustomPlugin",
|
|
457
|
+
"type": "object",
|
|
458
|
+
"properties": {
|
|
459
|
+
"event": {
|
|
460
|
+
"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\"",
|
|
461
|
+
"type": "string",
|
|
462
|
+
"title": "event"
|
|
463
|
+
},
|
|
464
|
+
"iconAlt": {
|
|
465
|
+
"description": "The alt for the custom button icon",
|
|
466
|
+
"type": "string",
|
|
467
|
+
"title": "iconAlt"
|
|
468
|
+
},
|
|
469
|
+
"iconType": {
|
|
470
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
471
|
+
"type": "string",
|
|
472
|
+
"title": "iconType"
|
|
473
|
+
},
|
|
474
|
+
"icon": {
|
|
475
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
476
|
+
"type": "string",
|
|
477
|
+
"title": "icon"
|
|
478
|
+
}
|
|
479
|
+
},
|
|
480
|
+
"required": [
|
|
481
|
+
"event",
|
|
482
|
+
"icon",
|
|
483
|
+
"iconAlt",
|
|
484
|
+
"iconType"
|
|
485
|
+
]
|
|
486
|
+
},
|
|
487
|
+
"title": "customPlugins"
|
|
451
488
|
}
|
|
452
489
|
}
|
|
453
490
|
},
|
|
@@ -462,6 +499,38 @@
|
|
|
462
499
|
}
|
|
463
500
|
}
|
|
464
501
|
},
|
|
502
|
+
"CustomPlugin": {
|
|
503
|
+
"title": "CustomPlugin",
|
|
504
|
+
"type": "object",
|
|
505
|
+
"properties": {
|
|
506
|
+
"event": {
|
|
507
|
+
"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\"",
|
|
508
|
+
"type": "string",
|
|
509
|
+
"title": "event"
|
|
510
|
+
},
|
|
511
|
+
"iconAlt": {
|
|
512
|
+
"description": "The alt for the custom button icon",
|
|
513
|
+
"type": "string",
|
|
514
|
+
"title": "iconAlt"
|
|
515
|
+
},
|
|
516
|
+
"iconType": {
|
|
517
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
518
|
+
"type": "string",
|
|
519
|
+
"title": "iconType"
|
|
520
|
+
},
|
|
521
|
+
"icon": {
|
|
522
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
523
|
+
"type": "string",
|
|
524
|
+
"title": "icon"
|
|
525
|
+
}
|
|
526
|
+
},
|
|
527
|
+
"required": [
|
|
528
|
+
"event",
|
|
529
|
+
"icon",
|
|
530
|
+
"iconAlt",
|
|
531
|
+
"iconType"
|
|
532
|
+
]
|
|
533
|
+
},
|
|
465
534
|
"EditableHtmlPluginConfigure": {
|
|
466
535
|
"title": "EditableHtmlPluginConfigure",
|
|
467
536
|
"type": "object",
|
|
@@ -513,6 +582,43 @@
|
|
|
513
582
|
"title": "disabled"
|
|
514
583
|
}
|
|
515
584
|
}
|
|
585
|
+
},
|
|
586
|
+
"customPlugins": {
|
|
587
|
+
"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.",
|
|
588
|
+
"type": "array",
|
|
589
|
+
"items": {
|
|
590
|
+
"title": "CustomPlugin",
|
|
591
|
+
"type": "object",
|
|
592
|
+
"properties": {
|
|
593
|
+
"event": {
|
|
594
|
+
"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\"",
|
|
595
|
+
"type": "string",
|
|
596
|
+
"title": "event"
|
|
597
|
+
},
|
|
598
|
+
"iconAlt": {
|
|
599
|
+
"description": "The alt for the custom button icon",
|
|
600
|
+
"type": "string",
|
|
601
|
+
"title": "iconAlt"
|
|
602
|
+
},
|
|
603
|
+
"iconType": {
|
|
604
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
605
|
+
"type": "string",
|
|
606
|
+
"title": "iconType"
|
|
607
|
+
},
|
|
608
|
+
"icon": {
|
|
609
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
610
|
+
"type": "string",
|
|
611
|
+
"title": "icon"
|
|
612
|
+
}
|
|
613
|
+
},
|
|
614
|
+
"required": [
|
|
615
|
+
"event",
|
|
616
|
+
"icon",
|
|
617
|
+
"iconAlt",
|
|
618
|
+
"iconType"
|
|
619
|
+
]
|
|
620
|
+
},
|
|
621
|
+
"title": "customPlugins"
|
|
516
622
|
}
|
|
517
623
|
}
|
|
518
624
|
},
|
|
@@ -595,6 +701,43 @@
|
|
|
595
701
|
"title": "disabled"
|
|
596
702
|
}
|
|
597
703
|
}
|
|
704
|
+
},
|
|
705
|
+
"customPlugins": {
|
|
706
|
+
"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.",
|
|
707
|
+
"type": "array",
|
|
708
|
+
"items": {
|
|
709
|
+
"title": "CustomPlugin",
|
|
710
|
+
"type": "object",
|
|
711
|
+
"properties": {
|
|
712
|
+
"event": {
|
|
713
|
+
"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\"",
|
|
714
|
+
"type": "string",
|
|
715
|
+
"title": "event"
|
|
716
|
+
},
|
|
717
|
+
"iconAlt": {
|
|
718
|
+
"description": "The alt for the custom button icon",
|
|
719
|
+
"type": "string",
|
|
720
|
+
"title": "iconAlt"
|
|
721
|
+
},
|
|
722
|
+
"iconType": {
|
|
723
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
724
|
+
"type": "string",
|
|
725
|
+
"title": "iconType"
|
|
726
|
+
},
|
|
727
|
+
"icon": {
|
|
728
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
729
|
+
"type": "string",
|
|
730
|
+
"title": "icon"
|
|
731
|
+
}
|
|
732
|
+
},
|
|
733
|
+
"required": [
|
|
734
|
+
"event",
|
|
735
|
+
"icon",
|
|
736
|
+
"iconAlt",
|
|
737
|
+
"iconType"
|
|
738
|
+
]
|
|
739
|
+
},
|
|
740
|
+
"title": "customPlugins"
|
|
598
741
|
}
|
|
599
742
|
}
|
|
600
743
|
},
|
package/docs/pie-schema.json.md
CHANGED
|
@@ -233,6 +233,35 @@ Properties of the `image` object:
|
|
|
233
233
|
|
|
234
234
|
Indicates if the plugin is disabled or not
|
|
235
235
|
|
|
236
|
+
### `customPlugins` (array)
|
|
237
|
+
|
|
238
|
+
An array of objects that determine custom plugins.
|
|
239
|
+
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).
|
|
240
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
241
|
+
|
|
242
|
+
The object is an array with all elements of the type `object`.
|
|
243
|
+
|
|
244
|
+
The array object has the following properties:
|
|
245
|
+
|
|
246
|
+
#### `event` (string, required)
|
|
247
|
+
|
|
248
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
249
|
+
PIE will emit the event prefixed with "PIE-".
|
|
250
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
251
|
+
|
|
252
|
+
#### `iconAlt` (string, required)
|
|
253
|
+
|
|
254
|
+
The alt for the custom button icon
|
|
255
|
+
|
|
256
|
+
#### `iconType` (string, required)
|
|
257
|
+
|
|
258
|
+
The icon type.
|
|
259
|
+
Currently, only "SVG" is supported.
|
|
260
|
+
|
|
261
|
+
#### `icon` (string, required)
|
|
262
|
+
|
|
263
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
264
|
+
|
|
236
265
|
## `EditableHtmlButtonConfigure` (object)
|
|
237
266
|
|
|
238
267
|
Properties of the `EditableHtmlButtonConfigure` object:
|
|
@@ -241,6 +270,29 @@ Properties of the `EditableHtmlButtonConfigure` object:
|
|
|
241
270
|
|
|
242
271
|
Indicates if the plugin is disabled or not
|
|
243
272
|
|
|
273
|
+
## `CustomPlugin` (object)
|
|
274
|
+
|
|
275
|
+
Properties of the `CustomPlugin` object:
|
|
276
|
+
|
|
277
|
+
### `event` (string, required)
|
|
278
|
+
|
|
279
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
280
|
+
PIE will emit the event prefixed with "PIE-".
|
|
281
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
282
|
+
|
|
283
|
+
### `iconAlt` (string, required)
|
|
284
|
+
|
|
285
|
+
The alt for the custom button icon
|
|
286
|
+
|
|
287
|
+
### `iconType` (string, required)
|
|
288
|
+
|
|
289
|
+
The icon type.
|
|
290
|
+
Currently, only "SVG" is supported.
|
|
291
|
+
|
|
292
|
+
### `icon` (string, required)
|
|
293
|
+
|
|
294
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
295
|
+
|
|
244
296
|
## `EditableHtmlPluginConfigure` (object)
|
|
245
297
|
|
|
246
298
|
Properties of the `EditableHtmlPluginConfigure` object:
|
|
@@ -281,6 +333,35 @@ Properties of the `image` object:
|
|
|
281
333
|
|
|
282
334
|
Indicates if the plugin is disabled or not
|
|
283
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
|
+
|
|
284
365
|
### `settings` (boolean)
|
|
285
366
|
|
|
286
367
|
Indicates if the item has to be displayed in the Settings Panel
|
|
@@ -341,6 +422,35 @@ Properties of the `image` object:
|
|
|
341
422
|
|
|
342
423
|
Indicates if the plugin is disabled or not
|
|
343
424
|
|
|
425
|
+
#### `customPlugins` (array)
|
|
426
|
+
|
|
427
|
+
An array of objects that determine custom plugins.
|
|
428
|
+
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).
|
|
429
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
430
|
+
|
|
431
|
+
The object is an array with all elements of the type `object`.
|
|
432
|
+
|
|
433
|
+
The array object has the following properties:
|
|
434
|
+
|
|
435
|
+
##### `event` (string, required)
|
|
436
|
+
|
|
437
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
438
|
+
PIE will emit the event prefixed with "PIE-".
|
|
439
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
440
|
+
|
|
441
|
+
##### `iconAlt` (string, required)
|
|
442
|
+
|
|
443
|
+
The alt for the custom button icon
|
|
444
|
+
|
|
445
|
+
##### `iconType` (string, required)
|
|
446
|
+
|
|
447
|
+
The icon type.
|
|
448
|
+
Currently, only "SVG" is supported.
|
|
449
|
+
|
|
450
|
+
##### `icon` (string, required)
|
|
451
|
+
|
|
452
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
453
|
+
|
|
344
454
|
### `required` (boolean)
|
|
345
455
|
|
|
346
456
|
Indicates if the item is required and the value cannot be empty
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@pie-element/placement-ordering",
|
|
3
|
-
"version": "9.9.
|
|
3
|
+
"version": "9.9.1-next.4+44cb8eb36",
|
|
4
4
|
"description": "",
|
|
5
5
|
"repository": "pie-framework/pie-elements",
|
|
6
6
|
"publishConfig": {
|
|
@@ -22,7 +22,7 @@
|
|
|
22
22
|
},
|
|
23
23
|
"author": "",
|
|
24
24
|
"license": "ISC",
|
|
25
|
-
"gitHead": "
|
|
25
|
+
"gitHead": "44cb8eb36e997cd5218007c604c8d94137022f6e",
|
|
26
26
|
"scripts": {
|
|
27
27
|
"postpublish": "../../scripts/postpublish"
|
|
28
28
|
},
|