@pie-element/drag-in-the-blank 5.9.0 → 5.9.1-next.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/config-schema.json +328 -0
- package/docs/config-schema.json.md +255 -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
|
},
|
|
@@ -136,6 +173,43 @@
|
|
|
136
173
|
"title": "disabled"
|
|
137
174
|
}
|
|
138
175
|
}
|
|
176
|
+
},
|
|
177
|
+
"customPlugins": {
|
|
178
|
+
"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.",
|
|
179
|
+
"type": "array",
|
|
180
|
+
"items": {
|
|
181
|
+
"title": "CustomPlugin",
|
|
182
|
+
"type": "object",
|
|
183
|
+
"properties": {
|
|
184
|
+
"event": {
|
|
185
|
+
"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\"",
|
|
186
|
+
"type": "string",
|
|
187
|
+
"title": "event"
|
|
188
|
+
},
|
|
189
|
+
"iconAlt": {
|
|
190
|
+
"description": "The alt for the custom button icon",
|
|
191
|
+
"type": "string",
|
|
192
|
+
"title": "iconAlt"
|
|
193
|
+
},
|
|
194
|
+
"iconType": {
|
|
195
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
196
|
+
"type": "string",
|
|
197
|
+
"title": "iconType"
|
|
198
|
+
},
|
|
199
|
+
"icon": {
|
|
200
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
201
|
+
"type": "string",
|
|
202
|
+
"title": "icon"
|
|
203
|
+
}
|
|
204
|
+
},
|
|
205
|
+
"required": [
|
|
206
|
+
"event",
|
|
207
|
+
"icon",
|
|
208
|
+
"iconAlt",
|
|
209
|
+
"iconType"
|
|
210
|
+
]
|
|
211
|
+
},
|
|
212
|
+
"title": "customPlugins"
|
|
139
213
|
}
|
|
140
214
|
}
|
|
141
215
|
},
|
|
@@ -228,6 +302,43 @@
|
|
|
228
302
|
"title": "disabled"
|
|
229
303
|
}
|
|
230
304
|
}
|
|
305
|
+
},
|
|
306
|
+
"customPlugins": {
|
|
307
|
+
"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.",
|
|
308
|
+
"type": "array",
|
|
309
|
+
"items": {
|
|
310
|
+
"title": "CustomPlugin",
|
|
311
|
+
"type": "object",
|
|
312
|
+
"properties": {
|
|
313
|
+
"event": {
|
|
314
|
+
"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\"",
|
|
315
|
+
"type": "string",
|
|
316
|
+
"title": "event"
|
|
317
|
+
},
|
|
318
|
+
"iconAlt": {
|
|
319
|
+
"description": "The alt for the custom button icon",
|
|
320
|
+
"type": "string",
|
|
321
|
+
"title": "iconAlt"
|
|
322
|
+
},
|
|
323
|
+
"iconType": {
|
|
324
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
325
|
+
"type": "string",
|
|
326
|
+
"title": "iconType"
|
|
327
|
+
},
|
|
328
|
+
"icon": {
|
|
329
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
330
|
+
"type": "string",
|
|
331
|
+
"title": "icon"
|
|
332
|
+
}
|
|
333
|
+
},
|
|
334
|
+
"required": [
|
|
335
|
+
"event",
|
|
336
|
+
"icon",
|
|
337
|
+
"iconAlt",
|
|
338
|
+
"iconType"
|
|
339
|
+
]
|
|
340
|
+
},
|
|
341
|
+
"title": "customPlugins"
|
|
231
342
|
}
|
|
232
343
|
}
|
|
233
344
|
},
|
|
@@ -315,6 +426,43 @@
|
|
|
315
426
|
"title": "disabled"
|
|
316
427
|
}
|
|
317
428
|
}
|
|
429
|
+
},
|
|
430
|
+
"customPlugins": {
|
|
431
|
+
"description": "An array of objects that determine custom plugins.\nA custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).\nExample can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.",
|
|
432
|
+
"type": "array",
|
|
433
|
+
"items": {
|
|
434
|
+
"title": "CustomPlugin",
|
|
435
|
+
"type": "object",
|
|
436
|
+
"properties": {
|
|
437
|
+
"event": {
|
|
438
|
+
"description": "The name of the custom event. It needs to be valid (only letters, numbers and \"_\" can be used).\nPIE will emit the event prefixed with \"PIE-\".\nEg: event = 'client_custom_event_A' => the emitted event will be \"PIE-client_custom_event_A\"",
|
|
439
|
+
"type": "string",
|
|
440
|
+
"title": "event"
|
|
441
|
+
},
|
|
442
|
+
"iconAlt": {
|
|
443
|
+
"description": "The alt for the custom button icon",
|
|
444
|
+
"type": "string",
|
|
445
|
+
"title": "iconAlt"
|
|
446
|
+
},
|
|
447
|
+
"iconType": {
|
|
448
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
449
|
+
"type": "string",
|
|
450
|
+
"title": "iconType"
|
|
451
|
+
},
|
|
452
|
+
"icon": {
|
|
453
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
454
|
+
"type": "string",
|
|
455
|
+
"title": "icon"
|
|
456
|
+
}
|
|
457
|
+
},
|
|
458
|
+
"required": [
|
|
459
|
+
"event",
|
|
460
|
+
"icon",
|
|
461
|
+
"iconAlt",
|
|
462
|
+
"iconType"
|
|
463
|
+
]
|
|
464
|
+
},
|
|
465
|
+
"title": "customPlugins"
|
|
318
466
|
}
|
|
319
467
|
}
|
|
320
468
|
},
|
|
@@ -386,6 +534,43 @@
|
|
|
386
534
|
"title": "disabled"
|
|
387
535
|
}
|
|
388
536
|
}
|
|
537
|
+
},
|
|
538
|
+
"customPlugins": {
|
|
539
|
+
"description": "An array of objects that determine custom plugins.\nA custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).\nExample can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.",
|
|
540
|
+
"type": "array",
|
|
541
|
+
"items": {
|
|
542
|
+
"title": "CustomPlugin",
|
|
543
|
+
"type": "object",
|
|
544
|
+
"properties": {
|
|
545
|
+
"event": {
|
|
546
|
+
"description": "The name of the custom event. It needs to be valid (only letters, numbers and \"_\" can be used).\nPIE will emit the event prefixed with \"PIE-\".\nEg: event = 'client_custom_event_A' => the emitted event will be \"PIE-client_custom_event_A\"",
|
|
547
|
+
"type": "string",
|
|
548
|
+
"title": "event"
|
|
549
|
+
},
|
|
550
|
+
"iconAlt": {
|
|
551
|
+
"description": "The alt for the custom button icon",
|
|
552
|
+
"type": "string",
|
|
553
|
+
"title": "iconAlt"
|
|
554
|
+
},
|
|
555
|
+
"iconType": {
|
|
556
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
557
|
+
"type": "string",
|
|
558
|
+
"title": "iconType"
|
|
559
|
+
},
|
|
560
|
+
"icon": {
|
|
561
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
562
|
+
"type": "string",
|
|
563
|
+
"title": "icon"
|
|
564
|
+
}
|
|
565
|
+
},
|
|
566
|
+
"required": [
|
|
567
|
+
"event",
|
|
568
|
+
"icon",
|
|
569
|
+
"iconAlt",
|
|
570
|
+
"iconType"
|
|
571
|
+
]
|
|
572
|
+
},
|
|
573
|
+
"title": "customPlugins"
|
|
389
574
|
}
|
|
390
575
|
}
|
|
391
576
|
},
|
|
@@ -677,6 +862,43 @@
|
|
|
677
862
|
"title": "disabled"
|
|
678
863
|
}
|
|
679
864
|
}
|
|
865
|
+
},
|
|
866
|
+
"customPlugins": {
|
|
867
|
+
"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.",
|
|
868
|
+
"type": "array",
|
|
869
|
+
"items": {
|
|
870
|
+
"title": "CustomPlugin",
|
|
871
|
+
"type": "object",
|
|
872
|
+
"properties": {
|
|
873
|
+
"event": {
|
|
874
|
+
"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\"",
|
|
875
|
+
"type": "string",
|
|
876
|
+
"title": "event"
|
|
877
|
+
},
|
|
878
|
+
"iconAlt": {
|
|
879
|
+
"description": "The alt for the custom button icon",
|
|
880
|
+
"type": "string",
|
|
881
|
+
"title": "iconAlt"
|
|
882
|
+
},
|
|
883
|
+
"iconType": {
|
|
884
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
885
|
+
"type": "string",
|
|
886
|
+
"title": "iconType"
|
|
887
|
+
},
|
|
888
|
+
"icon": {
|
|
889
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
890
|
+
"type": "string",
|
|
891
|
+
"title": "icon"
|
|
892
|
+
}
|
|
893
|
+
},
|
|
894
|
+
"required": [
|
|
895
|
+
"event",
|
|
896
|
+
"icon",
|
|
897
|
+
"iconAlt",
|
|
898
|
+
"iconType"
|
|
899
|
+
]
|
|
900
|
+
},
|
|
901
|
+
"title": "customPlugins"
|
|
680
902
|
}
|
|
681
903
|
}
|
|
682
904
|
},
|
|
@@ -691,6 +913,38 @@
|
|
|
691
913
|
}
|
|
692
914
|
}
|
|
693
915
|
},
|
|
916
|
+
"CustomPlugin": {
|
|
917
|
+
"title": "CustomPlugin",
|
|
918
|
+
"type": "object",
|
|
919
|
+
"properties": {
|
|
920
|
+
"event": {
|
|
921
|
+
"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\"",
|
|
922
|
+
"type": "string",
|
|
923
|
+
"title": "event"
|
|
924
|
+
},
|
|
925
|
+
"iconAlt": {
|
|
926
|
+
"description": "The alt for the custom button icon",
|
|
927
|
+
"type": "string",
|
|
928
|
+
"title": "iconAlt"
|
|
929
|
+
},
|
|
930
|
+
"iconType": {
|
|
931
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
932
|
+
"type": "string",
|
|
933
|
+
"title": "iconType"
|
|
934
|
+
},
|
|
935
|
+
"icon": {
|
|
936
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
937
|
+
"type": "string",
|
|
938
|
+
"title": "icon"
|
|
939
|
+
}
|
|
940
|
+
},
|
|
941
|
+
"required": [
|
|
942
|
+
"event",
|
|
943
|
+
"icon",
|
|
944
|
+
"iconAlt",
|
|
945
|
+
"iconType"
|
|
946
|
+
]
|
|
947
|
+
},
|
|
694
948
|
"ConfigureProp": {
|
|
695
949
|
"title": "ConfigureProp",
|
|
696
950
|
"type": "object",
|
|
@@ -758,6 +1012,43 @@
|
|
|
758
1012
|
"title": "disabled"
|
|
759
1013
|
}
|
|
760
1014
|
}
|
|
1015
|
+
},
|
|
1016
|
+
"customPlugins": {
|
|
1017
|
+
"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.",
|
|
1018
|
+
"type": "array",
|
|
1019
|
+
"items": {
|
|
1020
|
+
"title": "CustomPlugin",
|
|
1021
|
+
"type": "object",
|
|
1022
|
+
"properties": {
|
|
1023
|
+
"event": {
|
|
1024
|
+
"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\"",
|
|
1025
|
+
"type": "string",
|
|
1026
|
+
"title": "event"
|
|
1027
|
+
},
|
|
1028
|
+
"iconAlt": {
|
|
1029
|
+
"description": "The alt for the custom button icon",
|
|
1030
|
+
"type": "string",
|
|
1031
|
+
"title": "iconAlt"
|
|
1032
|
+
},
|
|
1033
|
+
"iconType": {
|
|
1034
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
1035
|
+
"type": "string",
|
|
1036
|
+
"title": "iconType"
|
|
1037
|
+
},
|
|
1038
|
+
"icon": {
|
|
1039
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
1040
|
+
"type": "string",
|
|
1041
|
+
"title": "icon"
|
|
1042
|
+
}
|
|
1043
|
+
},
|
|
1044
|
+
"required": [
|
|
1045
|
+
"event",
|
|
1046
|
+
"icon",
|
|
1047
|
+
"iconAlt",
|
|
1048
|
+
"iconType"
|
|
1049
|
+
]
|
|
1050
|
+
},
|
|
1051
|
+
"title": "customPlugins"
|
|
761
1052
|
}
|
|
762
1053
|
}
|
|
763
1054
|
},
|
|
@@ -829,6 +1120,43 @@
|
|
|
829
1120
|
"title": "disabled"
|
|
830
1121
|
}
|
|
831
1122
|
}
|
|
1123
|
+
},
|
|
1124
|
+
"customPlugins": {
|
|
1125
|
+
"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.",
|
|
1126
|
+
"type": "array",
|
|
1127
|
+
"items": {
|
|
1128
|
+
"title": "CustomPlugin",
|
|
1129
|
+
"type": "object",
|
|
1130
|
+
"properties": {
|
|
1131
|
+
"event": {
|
|
1132
|
+
"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\"",
|
|
1133
|
+
"type": "string",
|
|
1134
|
+
"title": "event"
|
|
1135
|
+
},
|
|
1136
|
+
"iconAlt": {
|
|
1137
|
+
"description": "The alt for the custom button icon",
|
|
1138
|
+
"type": "string",
|
|
1139
|
+
"title": "iconAlt"
|
|
1140
|
+
},
|
|
1141
|
+
"iconType": {
|
|
1142
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
1143
|
+
"type": "string",
|
|
1144
|
+
"title": "iconType"
|
|
1145
|
+
},
|
|
1146
|
+
"icon": {
|
|
1147
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
1148
|
+
"type": "string",
|
|
1149
|
+
"title": "icon"
|
|
1150
|
+
}
|
|
1151
|
+
},
|
|
1152
|
+
"required": [
|
|
1153
|
+
"event",
|
|
1154
|
+
"icon",
|
|
1155
|
+
"iconAlt",
|
|
1156
|
+
"iconType"
|
|
1157
|
+
]
|
|
1158
|
+
},
|
|
1159
|
+
"title": "customPlugins"
|
|
832
1160
|
}
|
|
833
1161
|
}
|
|
834
1162
|
},
|
|
@@ -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
|
# `choices` (object)
|
|
42
71
|
|
|
43
72
|
Properties of the `choices` object:
|
|
@@ -102,6 +131,35 @@ Properties of the `image` object:
|
|
|
102
131
|
|
|
103
132
|
Indicates if the plugin is disabled or not
|
|
104
133
|
|
|
134
|
+
### `customPlugins` (array)
|
|
135
|
+
|
|
136
|
+
An array of objects that determine custom plugins.
|
|
137
|
+
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).
|
|
138
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
139
|
+
|
|
140
|
+
The object is an array with all elements of the type `object`.
|
|
141
|
+
|
|
142
|
+
The array object has the following properties:
|
|
143
|
+
|
|
144
|
+
#### `event` (string, required)
|
|
145
|
+
|
|
146
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
147
|
+
PIE will emit the event prefixed with "PIE-".
|
|
148
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
149
|
+
|
|
150
|
+
#### `iconAlt` (string, required)
|
|
151
|
+
|
|
152
|
+
The alt for the custom button icon
|
|
153
|
+
|
|
154
|
+
#### `iconType` (string, required)
|
|
155
|
+
|
|
156
|
+
The icon type.
|
|
157
|
+
Currently, only "SVG" is supported.
|
|
158
|
+
|
|
159
|
+
#### `icon` (string, required)
|
|
160
|
+
|
|
161
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
162
|
+
|
|
105
163
|
## `required` (boolean)
|
|
106
164
|
|
|
107
165
|
Indicates if the item is required and the value cannot be empty
|
|
@@ -170,6 +228,35 @@ Properties of the `image` object:
|
|
|
170
228
|
|
|
171
229
|
Indicates if the plugin is disabled or not
|
|
172
230
|
|
|
231
|
+
### `customPlugins` (array)
|
|
232
|
+
|
|
233
|
+
An array of objects that determine custom plugins.
|
|
234
|
+
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).
|
|
235
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
236
|
+
|
|
237
|
+
The object is an array with all elements of the type `object`.
|
|
238
|
+
|
|
239
|
+
The array object has the following properties:
|
|
240
|
+
|
|
241
|
+
#### `event` (string, required)
|
|
242
|
+
|
|
243
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
244
|
+
PIE will emit the event prefixed with "PIE-".
|
|
245
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
246
|
+
|
|
247
|
+
#### `iconAlt` (string, required)
|
|
248
|
+
|
|
249
|
+
The alt for the custom button icon
|
|
250
|
+
|
|
251
|
+
#### `iconType` (string, required)
|
|
252
|
+
|
|
253
|
+
The icon type.
|
|
254
|
+
Currently, only "SVG" is supported.
|
|
255
|
+
|
|
256
|
+
#### `icon` (string, required)
|
|
257
|
+
|
|
258
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
259
|
+
|
|
173
260
|
## `required` (boolean)
|
|
174
261
|
|
|
175
262
|
Indicates if the item is required and the value cannot be empty
|
|
@@ -234,6 +321,35 @@ Properties of the `image` object:
|
|
|
234
321
|
|
|
235
322
|
Indicates if the plugin is disabled or not
|
|
236
323
|
|
|
324
|
+
### `customPlugins` (array)
|
|
325
|
+
|
|
326
|
+
An array of objects that determine custom plugins.
|
|
327
|
+
A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
|
|
328
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
329
|
+
|
|
330
|
+
The object is an array with all elements of the type `object`.
|
|
331
|
+
|
|
332
|
+
The array object has the following properties:
|
|
333
|
+
|
|
334
|
+
#### `event` (string, required)
|
|
335
|
+
|
|
336
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
337
|
+
PIE will emit the event prefixed with "PIE-".
|
|
338
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
339
|
+
|
|
340
|
+
#### `iconAlt` (string, required)
|
|
341
|
+
|
|
342
|
+
The alt for the custom button icon
|
|
343
|
+
|
|
344
|
+
#### `iconType` (string, required)
|
|
345
|
+
|
|
346
|
+
The icon type.
|
|
347
|
+
Currently, only "SVG" is supported.
|
|
348
|
+
|
|
349
|
+
#### `icon` (string, required)
|
|
350
|
+
|
|
351
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
352
|
+
|
|
237
353
|
## `required` (boolean)
|
|
238
354
|
|
|
239
355
|
Indicates if the item is required and the value cannot be empty
|
|
@@ -286,6 +402,35 @@ Properties of the `image` object:
|
|
|
286
402
|
|
|
287
403
|
Indicates if the plugin is disabled or not
|
|
288
404
|
|
|
405
|
+
### `customPlugins` (array)
|
|
406
|
+
|
|
407
|
+
An array of objects that determine custom plugins.
|
|
408
|
+
A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
|
|
409
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
410
|
+
|
|
411
|
+
The object is an array with all elements of the type `object`.
|
|
412
|
+
|
|
413
|
+
The array object has the following properties:
|
|
414
|
+
|
|
415
|
+
#### `event` (string, required)
|
|
416
|
+
|
|
417
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
418
|
+
PIE will emit the event prefixed with "PIE-".
|
|
419
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
420
|
+
|
|
421
|
+
#### `iconAlt` (string, required)
|
|
422
|
+
|
|
423
|
+
The alt for the custom button icon
|
|
424
|
+
|
|
425
|
+
#### `iconType` (string, required)
|
|
426
|
+
|
|
427
|
+
The icon type.
|
|
428
|
+
Currently, only "SVG" is supported.
|
|
429
|
+
|
|
430
|
+
#### `icon` (string, required)
|
|
431
|
+
|
|
432
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
433
|
+
|
|
289
434
|
## `settings` (boolean)
|
|
290
435
|
|
|
291
436
|
Indicates if the item has to be displayed in the Settings Panel
|
|
@@ -508,6 +653,35 @@ Properties of the `image` object:
|
|
|
508
653
|
|
|
509
654
|
Indicates if the plugin is disabled or not
|
|
510
655
|
|
|
656
|
+
### `customPlugins` (array)
|
|
657
|
+
|
|
658
|
+
An array of objects that determine custom plugins.
|
|
659
|
+
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).
|
|
660
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
661
|
+
|
|
662
|
+
The object is an array with all elements of the type `object`.
|
|
663
|
+
|
|
664
|
+
The array object has the following properties:
|
|
665
|
+
|
|
666
|
+
#### `event` (string, required)
|
|
667
|
+
|
|
668
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
669
|
+
PIE will emit the event prefixed with "PIE-".
|
|
670
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
671
|
+
|
|
672
|
+
#### `iconAlt` (string, required)
|
|
673
|
+
|
|
674
|
+
The alt for the custom button icon
|
|
675
|
+
|
|
676
|
+
#### `iconType` (string, required)
|
|
677
|
+
|
|
678
|
+
The icon type.
|
|
679
|
+
Currently, only "SVG" is supported.
|
|
680
|
+
|
|
681
|
+
#### `icon` (string, required)
|
|
682
|
+
|
|
683
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
684
|
+
|
|
511
685
|
## `EditableHtmlButtonConfigure` (object)
|
|
512
686
|
|
|
513
687
|
Properties of the `EditableHtmlButtonConfigure` object:
|
|
@@ -516,6 +690,29 @@ Properties of the `EditableHtmlButtonConfigure` object:
|
|
|
516
690
|
|
|
517
691
|
Indicates if the plugin is disabled or not
|
|
518
692
|
|
|
693
|
+
## `CustomPlugin` (object)
|
|
694
|
+
|
|
695
|
+
Properties of the `CustomPlugin` object:
|
|
696
|
+
|
|
697
|
+
### `event` (string, required)
|
|
698
|
+
|
|
699
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
700
|
+
PIE will emit the event prefixed with "PIE-".
|
|
701
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
702
|
+
|
|
703
|
+
### `iconAlt` (string, required)
|
|
704
|
+
|
|
705
|
+
The alt for the custom button icon
|
|
706
|
+
|
|
707
|
+
### `iconType` (string, required)
|
|
708
|
+
|
|
709
|
+
The icon type.
|
|
710
|
+
Currently, only "SVG" is supported.
|
|
711
|
+
|
|
712
|
+
### `icon` (string, required)
|
|
713
|
+
|
|
714
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
715
|
+
|
|
519
716
|
## `ConfigureProp` (object)
|
|
520
717
|
|
|
521
718
|
Properties of the `ConfigureProp` object:
|
|
@@ -568,6 +765,35 @@ Properties of the `image` object:
|
|
|
568
765
|
|
|
569
766
|
Indicates if the plugin is disabled or not
|
|
570
767
|
|
|
768
|
+
#### `customPlugins` (array)
|
|
769
|
+
|
|
770
|
+
An array of objects that determine custom plugins.
|
|
771
|
+
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).
|
|
772
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
773
|
+
|
|
774
|
+
The object is an array with all elements of the type `object`.
|
|
775
|
+
|
|
776
|
+
The array object has the following properties:
|
|
777
|
+
|
|
778
|
+
##### `event` (string, required)
|
|
779
|
+
|
|
780
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
781
|
+
PIE will emit the event prefixed with "PIE-".
|
|
782
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
783
|
+
|
|
784
|
+
##### `iconAlt` (string, required)
|
|
785
|
+
|
|
786
|
+
The alt for the custom button icon
|
|
787
|
+
|
|
788
|
+
##### `iconType` (string, required)
|
|
789
|
+
|
|
790
|
+
The icon type.
|
|
791
|
+
Currently, only "SVG" is supported.
|
|
792
|
+
|
|
793
|
+
##### `icon` (string, required)
|
|
794
|
+
|
|
795
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
796
|
+
|
|
571
797
|
### `required` (boolean)
|
|
572
798
|
|
|
573
799
|
Indicates if the item is required and the value cannot be empty
|
|
@@ -620,6 +846,35 @@ Properties of the `image` object:
|
|
|
620
846
|
|
|
621
847
|
Indicates if the plugin is disabled or not
|
|
622
848
|
|
|
849
|
+
#### `customPlugins` (array)
|
|
850
|
+
|
|
851
|
+
An array of objects that determine custom plugins.
|
|
852
|
+
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).
|
|
853
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
854
|
+
|
|
855
|
+
The object is an array with all elements of the type `object`.
|
|
856
|
+
|
|
857
|
+
The array object has the following properties:
|
|
858
|
+
|
|
859
|
+
##### `event` (string, required)
|
|
860
|
+
|
|
861
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
862
|
+
PIE will emit the event prefixed with "PIE-".
|
|
863
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
864
|
+
|
|
865
|
+
##### `iconAlt` (string, required)
|
|
866
|
+
|
|
867
|
+
The alt for the custom button icon
|
|
868
|
+
|
|
869
|
+
##### `iconType` (string, required)
|
|
870
|
+
|
|
871
|
+
The icon type.
|
|
872
|
+
Currently, only "SVG" is supported.
|
|
873
|
+
|
|
874
|
+
##### `icon` (string, required)
|
|
875
|
+
|
|
876
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
877
|
+
|
|
623
878
|
### `settings` (boolean)
|
|
624
879
|
|
|
625
880
|
Indicates if the item has to be displayed in the Settings Panel
|
package/docs/pie-schema.json
CHANGED
|
@@ -224,6 +224,43 @@
|
|
|
224
224
|
"title": "disabled"
|
|
225
225
|
}
|
|
226
226
|
}
|
|
227
|
+
},
|
|
228
|
+
"customPlugins": {
|
|
229
|
+
"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.",
|
|
230
|
+
"type": "array",
|
|
231
|
+
"items": {
|
|
232
|
+
"title": "CustomPlugin",
|
|
233
|
+
"type": "object",
|
|
234
|
+
"properties": {
|
|
235
|
+
"event": {
|
|
236
|
+
"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\"",
|
|
237
|
+
"type": "string",
|
|
238
|
+
"title": "event"
|
|
239
|
+
},
|
|
240
|
+
"iconAlt": {
|
|
241
|
+
"description": "The alt for the custom button icon",
|
|
242
|
+
"type": "string",
|
|
243
|
+
"title": "iconAlt"
|
|
244
|
+
},
|
|
245
|
+
"iconType": {
|
|
246
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
247
|
+
"type": "string",
|
|
248
|
+
"title": "iconType"
|
|
249
|
+
},
|
|
250
|
+
"icon": {
|
|
251
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
252
|
+
"type": "string",
|
|
253
|
+
"title": "icon"
|
|
254
|
+
}
|
|
255
|
+
},
|
|
256
|
+
"required": [
|
|
257
|
+
"event",
|
|
258
|
+
"icon",
|
|
259
|
+
"iconAlt",
|
|
260
|
+
"iconType"
|
|
261
|
+
]
|
|
262
|
+
},
|
|
263
|
+
"title": "customPlugins"
|
|
227
264
|
}
|
|
228
265
|
}
|
|
229
266
|
},
|
|
@@ -238,6 +275,38 @@
|
|
|
238
275
|
}
|
|
239
276
|
}
|
|
240
277
|
},
|
|
278
|
+
"CustomPlugin": {
|
|
279
|
+
"title": "CustomPlugin",
|
|
280
|
+
"type": "object",
|
|
281
|
+
"properties": {
|
|
282
|
+
"event": {
|
|
283
|
+
"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\"",
|
|
284
|
+
"type": "string",
|
|
285
|
+
"title": "event"
|
|
286
|
+
},
|
|
287
|
+
"iconAlt": {
|
|
288
|
+
"description": "The alt for the custom button icon",
|
|
289
|
+
"type": "string",
|
|
290
|
+
"title": "iconAlt"
|
|
291
|
+
},
|
|
292
|
+
"iconType": {
|
|
293
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
294
|
+
"type": "string",
|
|
295
|
+
"title": "iconType"
|
|
296
|
+
},
|
|
297
|
+
"icon": {
|
|
298
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
299
|
+
"type": "string",
|
|
300
|
+
"title": "icon"
|
|
301
|
+
}
|
|
302
|
+
},
|
|
303
|
+
"required": [
|
|
304
|
+
"event",
|
|
305
|
+
"icon",
|
|
306
|
+
"iconAlt",
|
|
307
|
+
"iconType"
|
|
308
|
+
]
|
|
309
|
+
},
|
|
241
310
|
"ConfigureProp": {
|
|
242
311
|
"title": "ConfigureProp",
|
|
243
312
|
"type": "object",
|
|
@@ -305,6 +374,43 @@
|
|
|
305
374
|
"title": "disabled"
|
|
306
375
|
}
|
|
307
376
|
}
|
|
377
|
+
},
|
|
378
|
+
"customPlugins": {
|
|
379
|
+
"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.",
|
|
380
|
+
"type": "array",
|
|
381
|
+
"items": {
|
|
382
|
+
"title": "CustomPlugin",
|
|
383
|
+
"type": "object",
|
|
384
|
+
"properties": {
|
|
385
|
+
"event": {
|
|
386
|
+
"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\"",
|
|
387
|
+
"type": "string",
|
|
388
|
+
"title": "event"
|
|
389
|
+
},
|
|
390
|
+
"iconAlt": {
|
|
391
|
+
"description": "The alt for the custom button icon",
|
|
392
|
+
"type": "string",
|
|
393
|
+
"title": "iconAlt"
|
|
394
|
+
},
|
|
395
|
+
"iconType": {
|
|
396
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
397
|
+
"type": "string",
|
|
398
|
+
"title": "iconType"
|
|
399
|
+
},
|
|
400
|
+
"icon": {
|
|
401
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
402
|
+
"type": "string",
|
|
403
|
+
"title": "icon"
|
|
404
|
+
}
|
|
405
|
+
},
|
|
406
|
+
"required": [
|
|
407
|
+
"event",
|
|
408
|
+
"icon",
|
|
409
|
+
"iconAlt",
|
|
410
|
+
"iconType"
|
|
411
|
+
]
|
|
412
|
+
},
|
|
413
|
+
"title": "customPlugins"
|
|
308
414
|
}
|
|
309
415
|
}
|
|
310
416
|
},
|
|
@@ -376,6 +482,43 @@
|
|
|
376
482
|
"title": "disabled"
|
|
377
483
|
}
|
|
378
484
|
}
|
|
485
|
+
},
|
|
486
|
+
"customPlugins": {
|
|
487
|
+
"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.",
|
|
488
|
+
"type": "array",
|
|
489
|
+
"items": {
|
|
490
|
+
"title": "CustomPlugin",
|
|
491
|
+
"type": "object",
|
|
492
|
+
"properties": {
|
|
493
|
+
"event": {
|
|
494
|
+
"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\"",
|
|
495
|
+
"type": "string",
|
|
496
|
+
"title": "event"
|
|
497
|
+
},
|
|
498
|
+
"iconAlt": {
|
|
499
|
+
"description": "The alt for the custom button icon",
|
|
500
|
+
"type": "string",
|
|
501
|
+
"title": "iconAlt"
|
|
502
|
+
},
|
|
503
|
+
"iconType": {
|
|
504
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
505
|
+
"type": "string",
|
|
506
|
+
"title": "iconType"
|
|
507
|
+
},
|
|
508
|
+
"icon": {
|
|
509
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
510
|
+
"type": "string",
|
|
511
|
+
"title": "icon"
|
|
512
|
+
}
|
|
513
|
+
},
|
|
514
|
+
"required": [
|
|
515
|
+
"event",
|
|
516
|
+
"icon",
|
|
517
|
+
"iconAlt",
|
|
518
|
+
"iconType"
|
|
519
|
+
]
|
|
520
|
+
},
|
|
521
|
+
"title": "customPlugins"
|
|
379
522
|
}
|
|
380
523
|
}
|
|
381
524
|
},
|
package/docs/pie-schema.json.md
CHANGED
|
@@ -163,6 +163,35 @@ Properties of the `image` object:
|
|
|
163
163
|
|
|
164
164
|
Indicates if the plugin is disabled or not
|
|
165
165
|
|
|
166
|
+
### `customPlugins` (array)
|
|
167
|
+
|
|
168
|
+
An array of objects that determine custom plugins.
|
|
169
|
+
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).
|
|
170
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
171
|
+
|
|
172
|
+
The object is an array with all elements of the type `object`.
|
|
173
|
+
|
|
174
|
+
The array object has the following properties:
|
|
175
|
+
|
|
176
|
+
#### `event` (string, required)
|
|
177
|
+
|
|
178
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
179
|
+
PIE will emit the event prefixed with "PIE-".
|
|
180
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
181
|
+
|
|
182
|
+
#### `iconAlt` (string, required)
|
|
183
|
+
|
|
184
|
+
The alt for the custom button icon
|
|
185
|
+
|
|
186
|
+
#### `iconType` (string, required)
|
|
187
|
+
|
|
188
|
+
The icon type.
|
|
189
|
+
Currently, only "SVG" is supported.
|
|
190
|
+
|
|
191
|
+
#### `icon` (string, required)
|
|
192
|
+
|
|
193
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
194
|
+
|
|
166
195
|
## `EditableHtmlButtonConfigure` (object)
|
|
167
196
|
|
|
168
197
|
Properties of the `EditableHtmlButtonConfigure` object:
|
|
@@ -171,6 +200,29 @@ Properties of the `EditableHtmlButtonConfigure` object:
|
|
|
171
200
|
|
|
172
201
|
Indicates if the plugin is disabled or not
|
|
173
202
|
|
|
203
|
+
## `CustomPlugin` (object)
|
|
204
|
+
|
|
205
|
+
Properties of the `CustomPlugin` object:
|
|
206
|
+
|
|
207
|
+
### `event` (string, required)
|
|
208
|
+
|
|
209
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
210
|
+
PIE will emit the event prefixed with "PIE-".
|
|
211
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
212
|
+
|
|
213
|
+
### `iconAlt` (string, required)
|
|
214
|
+
|
|
215
|
+
The alt for the custom button icon
|
|
216
|
+
|
|
217
|
+
### `iconType` (string, required)
|
|
218
|
+
|
|
219
|
+
The icon type.
|
|
220
|
+
Currently, only "SVG" is supported.
|
|
221
|
+
|
|
222
|
+
### `icon` (string, required)
|
|
223
|
+
|
|
224
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
225
|
+
|
|
174
226
|
## `ConfigureProp` (object)
|
|
175
227
|
|
|
176
228
|
Properties of the `ConfigureProp` object:
|
|
@@ -223,6 +275,35 @@ Properties of the `image` object:
|
|
|
223
275
|
|
|
224
276
|
Indicates if the plugin is disabled or not
|
|
225
277
|
|
|
278
|
+
#### `customPlugins` (array)
|
|
279
|
+
|
|
280
|
+
An array of objects that determine custom plugins.
|
|
281
|
+
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).
|
|
282
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
283
|
+
|
|
284
|
+
The object is an array with all elements of the type `object`.
|
|
285
|
+
|
|
286
|
+
The array object has the following properties:
|
|
287
|
+
|
|
288
|
+
##### `event` (string, required)
|
|
289
|
+
|
|
290
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
291
|
+
PIE will emit the event prefixed with "PIE-".
|
|
292
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
293
|
+
|
|
294
|
+
##### `iconAlt` (string, required)
|
|
295
|
+
|
|
296
|
+
The alt for the custom button icon
|
|
297
|
+
|
|
298
|
+
##### `iconType` (string, required)
|
|
299
|
+
|
|
300
|
+
The icon type.
|
|
301
|
+
Currently, only "SVG" is supported.
|
|
302
|
+
|
|
303
|
+
##### `icon` (string, required)
|
|
304
|
+
|
|
305
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
306
|
+
|
|
226
307
|
### `required` (boolean)
|
|
227
308
|
|
|
228
309
|
Indicates if the item is required and the value cannot be empty
|
|
@@ -275,6 +356,35 @@ Properties of the `image` object:
|
|
|
275
356
|
|
|
276
357
|
Indicates if the plugin is disabled or not
|
|
277
358
|
|
|
359
|
+
#### `customPlugins` (array)
|
|
360
|
+
|
|
361
|
+
An array of objects that determine custom plugins.
|
|
362
|
+
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).
|
|
363
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
364
|
+
|
|
365
|
+
The object is an array with all elements of the type `object`.
|
|
366
|
+
|
|
367
|
+
The array object has the following properties:
|
|
368
|
+
|
|
369
|
+
##### `event` (string, required)
|
|
370
|
+
|
|
371
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
372
|
+
PIE will emit the event prefixed with "PIE-".
|
|
373
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
374
|
+
|
|
375
|
+
##### `iconAlt` (string, required)
|
|
376
|
+
|
|
377
|
+
The alt for the custom button icon
|
|
378
|
+
|
|
379
|
+
##### `iconType` (string, required)
|
|
380
|
+
|
|
381
|
+
The icon type.
|
|
382
|
+
Currently, only "SVG" is supported.
|
|
383
|
+
|
|
384
|
+
##### `icon` (string, required)
|
|
385
|
+
|
|
386
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
387
|
+
|
|
278
388
|
### `settings` (boolean)
|
|
279
389
|
|
|
280
390
|
Indicates if the item has to be displayed in the Settings Panel
|
package/package.json
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
"access": "public"
|
|
5
5
|
},
|
|
6
6
|
"repository": "pie-framework/pie-elements",
|
|
7
|
-
"version": "5.9.
|
|
7
|
+
"version": "5.9.1-next.16+44cb8eb36",
|
|
8
8
|
"description": "",
|
|
9
9
|
"scripts": {
|
|
10
10
|
"postpublish": "../../scripts/postpublish"
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
},
|
|
22
22
|
"author": "",
|
|
23
23
|
"license": "ISC",
|
|
24
|
-
"gitHead": "
|
|
24
|
+
"gitHead": "44cb8eb36e997cd5218007c604c8d94137022f6e",
|
|
25
25
|
"main": "lib/index.js",
|
|
26
26
|
"module": "src/index.js"
|
|
27
27
|
}
|