@pie-element/inline-dropdown 5.9.1-next.0 → 5.9.1-next.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/configure/package.json +1 -1
- package/controller/package.json +1 -1
- package/docs/config-schema.json +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 +3 -3
package/configure/package.json
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
"@material-ui/core": "^3.9.2",
|
|
9
9
|
"@material-ui/icons": "^3.0.1",
|
|
10
10
|
"@pie-framework/pie-configure-events": "^1.3.0",
|
|
11
|
-
"@pie-lib/pie-toolbox": "1.
|
|
11
|
+
"@pie-lib/pie-toolbox": "1.13.0",
|
|
12
12
|
"classnames": "^2.2.6",
|
|
13
13
|
"debug": "^3.1.0",
|
|
14
14
|
"lodash": "^4.17.15",
|
package/controller/package.json
CHANGED
package/docs/config-schema.json
CHANGED
|
@@ -50,6 +50,43 @@
|
|
|
50
50
|
"title": "disabled"
|
|
51
51
|
}
|
|
52
52
|
}
|
|
53
|
+
},
|
|
54
|
+
"customPlugins": {
|
|
55
|
+
"description": "An array of objects that determine custom plugins.\nA custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).\nExample can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.",
|
|
56
|
+
"type": "array",
|
|
57
|
+
"items": {
|
|
58
|
+
"title": "CustomPlugin",
|
|
59
|
+
"type": "object",
|
|
60
|
+
"properties": {
|
|
61
|
+
"event": {
|
|
62
|
+
"description": "The name of the custom event. It needs to be valid (only letters, numbers and \"_\" can be used).\nPIE will emit the event prefixed with \"PIE-\".\nEg: event = 'client_custom_event_A' => the emitted event will be \"PIE-client_custom_event_A\"",
|
|
63
|
+
"type": "string",
|
|
64
|
+
"title": "event"
|
|
65
|
+
},
|
|
66
|
+
"iconAlt": {
|
|
67
|
+
"description": "The alt for the custom button icon",
|
|
68
|
+
"type": "string",
|
|
69
|
+
"title": "iconAlt"
|
|
70
|
+
},
|
|
71
|
+
"iconType": {
|
|
72
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
73
|
+
"type": "string",
|
|
74
|
+
"title": "iconType"
|
|
75
|
+
},
|
|
76
|
+
"icon": {
|
|
77
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
78
|
+
"type": "string",
|
|
79
|
+
"title": "icon"
|
|
80
|
+
}
|
|
81
|
+
},
|
|
82
|
+
"required": [
|
|
83
|
+
"event",
|
|
84
|
+
"icon",
|
|
85
|
+
"iconAlt",
|
|
86
|
+
"iconType"
|
|
87
|
+
]
|
|
88
|
+
},
|
|
89
|
+
"title": "customPlugins"
|
|
53
90
|
}
|
|
54
91
|
}
|
|
55
92
|
},
|
|
@@ -120,6 +157,43 @@
|
|
|
120
157
|
"title": "disabled"
|
|
121
158
|
}
|
|
122
159
|
}
|
|
160
|
+
},
|
|
161
|
+
"customPlugins": {
|
|
162
|
+
"description": "An array of objects that determine custom plugins.\nA custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).\nExample can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.",
|
|
163
|
+
"type": "array",
|
|
164
|
+
"items": {
|
|
165
|
+
"title": "CustomPlugin",
|
|
166
|
+
"type": "object",
|
|
167
|
+
"properties": {
|
|
168
|
+
"event": {
|
|
169
|
+
"description": "The name of the custom event. It needs to be valid (only letters, numbers and \"_\" can be used).\nPIE will emit the event prefixed with \"PIE-\".\nEg: event = 'client_custom_event_A' => the emitted event will be \"PIE-client_custom_event_A\"",
|
|
170
|
+
"type": "string",
|
|
171
|
+
"title": "event"
|
|
172
|
+
},
|
|
173
|
+
"iconAlt": {
|
|
174
|
+
"description": "The alt for the custom button icon",
|
|
175
|
+
"type": "string",
|
|
176
|
+
"title": "iconAlt"
|
|
177
|
+
},
|
|
178
|
+
"iconType": {
|
|
179
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
180
|
+
"type": "string",
|
|
181
|
+
"title": "iconType"
|
|
182
|
+
},
|
|
183
|
+
"icon": {
|
|
184
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
185
|
+
"type": "string",
|
|
186
|
+
"title": "icon"
|
|
187
|
+
}
|
|
188
|
+
},
|
|
189
|
+
"required": [
|
|
190
|
+
"event",
|
|
191
|
+
"icon",
|
|
192
|
+
"iconAlt",
|
|
193
|
+
"iconType"
|
|
194
|
+
]
|
|
195
|
+
},
|
|
196
|
+
"title": "customPlugins"
|
|
123
197
|
}
|
|
124
198
|
}
|
|
125
199
|
},
|
|
@@ -223,6 +297,43 @@
|
|
|
223
297
|
"title": "disabled"
|
|
224
298
|
}
|
|
225
299
|
}
|
|
300
|
+
},
|
|
301
|
+
"customPlugins": {
|
|
302
|
+
"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.",
|
|
303
|
+
"type": "array",
|
|
304
|
+
"items": {
|
|
305
|
+
"title": "CustomPlugin",
|
|
306
|
+
"type": "object",
|
|
307
|
+
"properties": {
|
|
308
|
+
"event": {
|
|
309
|
+
"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\"",
|
|
310
|
+
"type": "string",
|
|
311
|
+
"title": "event"
|
|
312
|
+
},
|
|
313
|
+
"iconAlt": {
|
|
314
|
+
"description": "The alt for the custom button icon",
|
|
315
|
+
"type": "string",
|
|
316
|
+
"title": "iconAlt"
|
|
317
|
+
},
|
|
318
|
+
"iconType": {
|
|
319
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
320
|
+
"type": "string",
|
|
321
|
+
"title": "iconType"
|
|
322
|
+
},
|
|
323
|
+
"icon": {
|
|
324
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
325
|
+
"type": "string",
|
|
326
|
+
"title": "icon"
|
|
327
|
+
}
|
|
328
|
+
},
|
|
329
|
+
"required": [
|
|
330
|
+
"event",
|
|
331
|
+
"icon",
|
|
332
|
+
"iconAlt",
|
|
333
|
+
"iconType"
|
|
334
|
+
]
|
|
335
|
+
},
|
|
336
|
+
"title": "customPlugins"
|
|
226
337
|
}
|
|
227
338
|
}
|
|
228
339
|
},
|
|
@@ -363,6 +474,43 @@
|
|
|
363
474
|
"title": "disabled"
|
|
364
475
|
}
|
|
365
476
|
}
|
|
477
|
+
},
|
|
478
|
+
"customPlugins": {
|
|
479
|
+
"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.",
|
|
480
|
+
"type": "array",
|
|
481
|
+
"items": {
|
|
482
|
+
"title": "CustomPlugin",
|
|
483
|
+
"type": "object",
|
|
484
|
+
"properties": {
|
|
485
|
+
"event": {
|
|
486
|
+
"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\"",
|
|
487
|
+
"type": "string",
|
|
488
|
+
"title": "event"
|
|
489
|
+
},
|
|
490
|
+
"iconAlt": {
|
|
491
|
+
"description": "The alt for the custom button icon",
|
|
492
|
+
"type": "string",
|
|
493
|
+
"title": "iconAlt"
|
|
494
|
+
},
|
|
495
|
+
"iconType": {
|
|
496
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
497
|
+
"type": "string",
|
|
498
|
+
"title": "iconType"
|
|
499
|
+
},
|
|
500
|
+
"icon": {
|
|
501
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
502
|
+
"type": "string",
|
|
503
|
+
"title": "icon"
|
|
504
|
+
}
|
|
505
|
+
},
|
|
506
|
+
"required": [
|
|
507
|
+
"event",
|
|
508
|
+
"icon",
|
|
509
|
+
"iconAlt",
|
|
510
|
+
"iconType"
|
|
511
|
+
]
|
|
512
|
+
},
|
|
513
|
+
"title": "customPlugins"
|
|
366
514
|
}
|
|
367
515
|
}
|
|
368
516
|
},
|
|
@@ -434,6 +582,43 @@
|
|
|
434
582
|
"title": "disabled"
|
|
435
583
|
}
|
|
436
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"
|
|
437
622
|
}
|
|
438
623
|
}
|
|
439
624
|
},
|
|
@@ -704,6 +889,43 @@
|
|
|
704
889
|
"title": "disabled"
|
|
705
890
|
}
|
|
706
891
|
}
|
|
892
|
+
},
|
|
893
|
+
"customPlugins": {
|
|
894
|
+
"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.",
|
|
895
|
+
"type": "array",
|
|
896
|
+
"items": {
|
|
897
|
+
"title": "CustomPlugin",
|
|
898
|
+
"type": "object",
|
|
899
|
+
"properties": {
|
|
900
|
+
"event": {
|
|
901
|
+
"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\"",
|
|
902
|
+
"type": "string",
|
|
903
|
+
"title": "event"
|
|
904
|
+
},
|
|
905
|
+
"iconAlt": {
|
|
906
|
+
"description": "The alt for the custom button icon",
|
|
907
|
+
"type": "string",
|
|
908
|
+
"title": "iconAlt"
|
|
909
|
+
},
|
|
910
|
+
"iconType": {
|
|
911
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
912
|
+
"type": "string",
|
|
913
|
+
"title": "iconType"
|
|
914
|
+
},
|
|
915
|
+
"icon": {
|
|
916
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
917
|
+
"type": "string",
|
|
918
|
+
"title": "icon"
|
|
919
|
+
}
|
|
920
|
+
},
|
|
921
|
+
"required": [
|
|
922
|
+
"event",
|
|
923
|
+
"icon",
|
|
924
|
+
"iconAlt",
|
|
925
|
+
"iconType"
|
|
926
|
+
]
|
|
927
|
+
},
|
|
928
|
+
"title": "customPlugins"
|
|
707
929
|
}
|
|
708
930
|
}
|
|
709
931
|
},
|
|
@@ -718,6 +940,38 @@
|
|
|
718
940
|
}
|
|
719
941
|
}
|
|
720
942
|
},
|
|
943
|
+
"CustomPlugin": {
|
|
944
|
+
"title": "CustomPlugin",
|
|
945
|
+
"type": "object",
|
|
946
|
+
"properties": {
|
|
947
|
+
"event": {
|
|
948
|
+
"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\"",
|
|
949
|
+
"type": "string",
|
|
950
|
+
"title": "event"
|
|
951
|
+
},
|
|
952
|
+
"iconAlt": {
|
|
953
|
+
"description": "The alt for the custom button icon",
|
|
954
|
+
"type": "string",
|
|
955
|
+
"title": "iconAlt"
|
|
956
|
+
},
|
|
957
|
+
"iconType": {
|
|
958
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
959
|
+
"type": "string",
|
|
960
|
+
"title": "iconType"
|
|
961
|
+
},
|
|
962
|
+
"icon": {
|
|
963
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
964
|
+
"type": "string",
|
|
965
|
+
"title": "icon"
|
|
966
|
+
}
|
|
967
|
+
},
|
|
968
|
+
"required": [
|
|
969
|
+
"event",
|
|
970
|
+
"icon",
|
|
971
|
+
"iconAlt",
|
|
972
|
+
"iconType"
|
|
973
|
+
]
|
|
974
|
+
},
|
|
721
975
|
"ConfigureProp": {
|
|
722
976
|
"title": "ConfigureProp",
|
|
723
977
|
"type": "object",
|
|
@@ -785,6 +1039,43 @@
|
|
|
785
1039
|
"title": "disabled"
|
|
786
1040
|
}
|
|
787
1041
|
}
|
|
1042
|
+
},
|
|
1043
|
+
"customPlugins": {
|
|
1044
|
+
"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.",
|
|
1045
|
+
"type": "array",
|
|
1046
|
+
"items": {
|
|
1047
|
+
"title": "CustomPlugin",
|
|
1048
|
+
"type": "object",
|
|
1049
|
+
"properties": {
|
|
1050
|
+
"event": {
|
|
1051
|
+
"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\"",
|
|
1052
|
+
"type": "string",
|
|
1053
|
+
"title": "event"
|
|
1054
|
+
},
|
|
1055
|
+
"iconAlt": {
|
|
1056
|
+
"description": "The alt for the custom button icon",
|
|
1057
|
+
"type": "string",
|
|
1058
|
+
"title": "iconAlt"
|
|
1059
|
+
},
|
|
1060
|
+
"iconType": {
|
|
1061
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
1062
|
+
"type": "string",
|
|
1063
|
+
"title": "iconType"
|
|
1064
|
+
},
|
|
1065
|
+
"icon": {
|
|
1066
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
1067
|
+
"type": "string",
|
|
1068
|
+
"title": "icon"
|
|
1069
|
+
}
|
|
1070
|
+
},
|
|
1071
|
+
"required": [
|
|
1072
|
+
"event",
|
|
1073
|
+
"icon",
|
|
1074
|
+
"iconAlt",
|
|
1075
|
+
"iconType"
|
|
1076
|
+
]
|
|
1077
|
+
},
|
|
1078
|
+
"title": "customPlugins"
|
|
788
1079
|
}
|
|
789
1080
|
}
|
|
790
1081
|
},
|
|
@@ -856,6 +1147,43 @@
|
|
|
856
1147
|
"title": "disabled"
|
|
857
1148
|
}
|
|
858
1149
|
}
|
|
1150
|
+
},
|
|
1151
|
+
"customPlugins": {
|
|
1152
|
+
"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.",
|
|
1153
|
+
"type": "array",
|
|
1154
|
+
"items": {
|
|
1155
|
+
"title": "CustomPlugin",
|
|
1156
|
+
"type": "object",
|
|
1157
|
+
"properties": {
|
|
1158
|
+
"event": {
|
|
1159
|
+
"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\"",
|
|
1160
|
+
"type": "string",
|
|
1161
|
+
"title": "event"
|
|
1162
|
+
},
|
|
1163
|
+
"iconAlt": {
|
|
1164
|
+
"description": "The alt for the custom button icon",
|
|
1165
|
+
"type": "string",
|
|
1166
|
+
"title": "iconAlt"
|
|
1167
|
+
},
|
|
1168
|
+
"iconType": {
|
|
1169
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
1170
|
+
"type": "string",
|
|
1171
|
+
"title": "iconType"
|
|
1172
|
+
},
|
|
1173
|
+
"icon": {
|
|
1174
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
1175
|
+
"type": "string",
|
|
1176
|
+
"title": "icon"
|
|
1177
|
+
}
|
|
1178
|
+
},
|
|
1179
|
+
"required": [
|
|
1180
|
+
"event",
|
|
1181
|
+
"icon",
|
|
1182
|
+
"iconAlt",
|
|
1183
|
+
"iconType"
|
|
1184
|
+
]
|
|
1185
|
+
},
|
|
1186
|
+
"title": "customPlugins"
|
|
859
1187
|
}
|
|
860
1188
|
}
|
|
861
1189
|
},
|
|
@@ -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:
|
|
@@ -90,6 +119,35 @@ Properties of the `image` object:
|
|
|
90
119
|
|
|
91
120
|
Indicates if the plugin is disabled or not
|
|
92
121
|
|
|
122
|
+
### `customPlugins` (array)
|
|
123
|
+
|
|
124
|
+
An array of objects that determine custom plugins.
|
|
125
|
+
A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
|
|
126
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
127
|
+
|
|
128
|
+
The object is an array with all elements of the type `object`.
|
|
129
|
+
|
|
130
|
+
The array object has the following properties:
|
|
131
|
+
|
|
132
|
+
#### `event` (string, required)
|
|
133
|
+
|
|
134
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
135
|
+
PIE will emit the event prefixed with "PIE-".
|
|
136
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
137
|
+
|
|
138
|
+
#### `iconAlt` (string, required)
|
|
139
|
+
|
|
140
|
+
The alt for the custom button icon
|
|
141
|
+
|
|
142
|
+
#### `iconType` (string, required)
|
|
143
|
+
|
|
144
|
+
The icon type.
|
|
145
|
+
Currently, only "SVG" is supported.
|
|
146
|
+
|
|
147
|
+
#### `icon` (string, required)
|
|
148
|
+
|
|
149
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
150
|
+
|
|
93
151
|
## `required` (boolean)
|
|
94
152
|
|
|
95
153
|
Indicates if the item is required and the value cannot be empty
|
|
@@ -166,6 +224,35 @@ Properties of the `image` object:
|
|
|
166
224
|
|
|
167
225
|
Indicates if the plugin is disabled or not
|
|
168
226
|
|
|
227
|
+
### `customPlugins` (array)
|
|
228
|
+
|
|
229
|
+
An array of objects that determine custom plugins.
|
|
230
|
+
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).
|
|
231
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
232
|
+
|
|
233
|
+
The object is an array with all elements of the type `object`.
|
|
234
|
+
|
|
235
|
+
The array object has the following properties:
|
|
236
|
+
|
|
237
|
+
#### `event` (string, required)
|
|
238
|
+
|
|
239
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
240
|
+
PIE will emit the event prefixed with "PIE-".
|
|
241
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
242
|
+
|
|
243
|
+
#### `iconAlt` (string, required)
|
|
244
|
+
|
|
245
|
+
The alt for the custom button icon
|
|
246
|
+
|
|
247
|
+
#### `iconType` (string, required)
|
|
248
|
+
|
|
249
|
+
The icon type.
|
|
250
|
+
Currently, only "SVG" is supported.
|
|
251
|
+
|
|
252
|
+
#### `icon` (string, required)
|
|
253
|
+
|
|
254
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
255
|
+
|
|
169
256
|
## `required` (boolean)
|
|
170
257
|
|
|
171
258
|
Indicates if the item is required and the value cannot be empty
|
|
@@ -270,6 +357,35 @@ Properties of the `image` object:
|
|
|
270
357
|
|
|
271
358
|
Indicates if the plugin is disabled or not
|
|
272
359
|
|
|
360
|
+
### `customPlugins` (array)
|
|
361
|
+
|
|
362
|
+
An array of objects that determine custom plugins.
|
|
363
|
+
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).
|
|
364
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
365
|
+
|
|
366
|
+
The object is an array with all elements of the type `object`.
|
|
367
|
+
|
|
368
|
+
The array object has the following properties:
|
|
369
|
+
|
|
370
|
+
#### `event` (string, required)
|
|
371
|
+
|
|
372
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
373
|
+
PIE will emit the event prefixed with "PIE-".
|
|
374
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
375
|
+
|
|
376
|
+
#### `iconAlt` (string, required)
|
|
377
|
+
|
|
378
|
+
The alt for the custom button icon
|
|
379
|
+
|
|
380
|
+
#### `iconType` (string, required)
|
|
381
|
+
|
|
382
|
+
The icon type.
|
|
383
|
+
Currently, only "SVG" is supported.
|
|
384
|
+
|
|
385
|
+
#### `icon` (string, required)
|
|
386
|
+
|
|
387
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
388
|
+
|
|
273
389
|
## `required` (boolean)
|
|
274
390
|
|
|
275
391
|
Indicates if the item is required and the value cannot be empty
|
|
@@ -322,6 +438,35 @@ Properties of the `image` object:
|
|
|
322
438
|
|
|
323
439
|
Indicates if the plugin is disabled or not
|
|
324
440
|
|
|
441
|
+
### `customPlugins` (array)
|
|
442
|
+
|
|
443
|
+
An array of objects that determine custom plugins.
|
|
444
|
+
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).
|
|
445
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
446
|
+
|
|
447
|
+
The object is an array with all elements of the type `object`.
|
|
448
|
+
|
|
449
|
+
The array object has the following properties:
|
|
450
|
+
|
|
451
|
+
#### `event` (string, required)
|
|
452
|
+
|
|
453
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
454
|
+
PIE will emit the event prefixed with "PIE-".
|
|
455
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
456
|
+
|
|
457
|
+
#### `iconAlt` (string, required)
|
|
458
|
+
|
|
459
|
+
The alt for the custom button icon
|
|
460
|
+
|
|
461
|
+
#### `iconType` (string, required)
|
|
462
|
+
|
|
463
|
+
The icon type.
|
|
464
|
+
Currently, only "SVG" is supported.
|
|
465
|
+
|
|
466
|
+
#### `icon` (string, required)
|
|
467
|
+
|
|
468
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
469
|
+
|
|
325
470
|
## `settings` (boolean)
|
|
326
471
|
|
|
327
472
|
Indicates if the item has to be displayed in the Settings Panel
|
|
@@ -528,6 +673,35 @@ Properties of the `image` object:
|
|
|
528
673
|
|
|
529
674
|
Indicates if the plugin is disabled or not
|
|
530
675
|
|
|
676
|
+
### `customPlugins` (array)
|
|
677
|
+
|
|
678
|
+
An array of objects that determine custom plugins.
|
|
679
|
+
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).
|
|
680
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
681
|
+
|
|
682
|
+
The object is an array with all elements of the type `object`.
|
|
683
|
+
|
|
684
|
+
The array object has the following properties:
|
|
685
|
+
|
|
686
|
+
#### `event` (string, required)
|
|
687
|
+
|
|
688
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
689
|
+
PIE will emit the event prefixed with "PIE-".
|
|
690
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
691
|
+
|
|
692
|
+
#### `iconAlt` (string, required)
|
|
693
|
+
|
|
694
|
+
The alt for the custom button icon
|
|
695
|
+
|
|
696
|
+
#### `iconType` (string, required)
|
|
697
|
+
|
|
698
|
+
The icon type.
|
|
699
|
+
Currently, only "SVG" is supported.
|
|
700
|
+
|
|
701
|
+
#### `icon` (string, required)
|
|
702
|
+
|
|
703
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
704
|
+
|
|
531
705
|
## `EditableHtmlButtonConfigure` (object)
|
|
532
706
|
|
|
533
707
|
Properties of the `EditableHtmlButtonConfigure` object:
|
|
@@ -536,6 +710,29 @@ Properties of the `EditableHtmlButtonConfigure` object:
|
|
|
536
710
|
|
|
537
711
|
Indicates if the plugin is disabled or not
|
|
538
712
|
|
|
713
|
+
## `CustomPlugin` (object)
|
|
714
|
+
|
|
715
|
+
Properties of the `CustomPlugin` object:
|
|
716
|
+
|
|
717
|
+
### `event` (string, required)
|
|
718
|
+
|
|
719
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
720
|
+
PIE will emit the event prefixed with "PIE-".
|
|
721
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
722
|
+
|
|
723
|
+
### `iconAlt` (string, required)
|
|
724
|
+
|
|
725
|
+
The alt for the custom button icon
|
|
726
|
+
|
|
727
|
+
### `iconType` (string, required)
|
|
728
|
+
|
|
729
|
+
The icon type.
|
|
730
|
+
Currently, only "SVG" is supported.
|
|
731
|
+
|
|
732
|
+
### `icon` (string, required)
|
|
733
|
+
|
|
734
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
735
|
+
|
|
539
736
|
## `ConfigureProp` (object)
|
|
540
737
|
|
|
541
738
|
Properties of the `ConfigureProp` object:
|
|
@@ -588,6 +785,35 @@ Properties of the `image` object:
|
|
|
588
785
|
|
|
589
786
|
Indicates if the plugin is disabled or not
|
|
590
787
|
|
|
788
|
+
#### `customPlugins` (array)
|
|
789
|
+
|
|
790
|
+
An array of objects that determine custom plugins.
|
|
791
|
+
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).
|
|
792
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
793
|
+
|
|
794
|
+
The object is an array with all elements of the type `object`.
|
|
795
|
+
|
|
796
|
+
The array object has the following properties:
|
|
797
|
+
|
|
798
|
+
##### `event` (string, required)
|
|
799
|
+
|
|
800
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
801
|
+
PIE will emit the event prefixed with "PIE-".
|
|
802
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
803
|
+
|
|
804
|
+
##### `iconAlt` (string, required)
|
|
805
|
+
|
|
806
|
+
The alt for the custom button icon
|
|
807
|
+
|
|
808
|
+
##### `iconType` (string, required)
|
|
809
|
+
|
|
810
|
+
The icon type.
|
|
811
|
+
Currently, only "SVG" is supported.
|
|
812
|
+
|
|
813
|
+
##### `icon` (string, required)
|
|
814
|
+
|
|
815
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
816
|
+
|
|
591
817
|
### `required` (boolean)
|
|
592
818
|
|
|
593
819
|
Indicates if the item is required and the value cannot be empty
|
|
@@ -640,6 +866,35 @@ Properties of the `image` object:
|
|
|
640
866
|
|
|
641
867
|
Indicates if the plugin is disabled or not
|
|
642
868
|
|
|
869
|
+
#### `customPlugins` (array)
|
|
870
|
+
|
|
871
|
+
An array of objects that determine custom plugins.
|
|
872
|
+
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).
|
|
873
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
874
|
+
|
|
875
|
+
The object is an array with all elements of the type `object`.
|
|
876
|
+
|
|
877
|
+
The array object has the following properties:
|
|
878
|
+
|
|
879
|
+
##### `event` (string, required)
|
|
880
|
+
|
|
881
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
882
|
+
PIE will emit the event prefixed with "PIE-".
|
|
883
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
884
|
+
|
|
885
|
+
##### `iconAlt` (string, required)
|
|
886
|
+
|
|
887
|
+
The alt for the custom button icon
|
|
888
|
+
|
|
889
|
+
##### `iconType` (string, required)
|
|
890
|
+
|
|
891
|
+
The icon type.
|
|
892
|
+
Currently, only "SVG" is supported.
|
|
893
|
+
|
|
894
|
+
##### `icon` (string, required)
|
|
895
|
+
|
|
896
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
897
|
+
|
|
643
898
|
### `settings` (boolean)
|
|
644
899
|
|
|
645
900
|
Indicates if the item has to be displayed in the Settings Panel
|
package/docs/pie-schema.json
CHANGED
|
@@ -234,6 +234,43 @@
|
|
|
234
234
|
"title": "disabled"
|
|
235
235
|
}
|
|
236
236
|
}
|
|
237
|
+
},
|
|
238
|
+
"customPlugins": {
|
|
239
|
+
"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.",
|
|
240
|
+
"type": "array",
|
|
241
|
+
"items": {
|
|
242
|
+
"title": "CustomPlugin",
|
|
243
|
+
"type": "object",
|
|
244
|
+
"properties": {
|
|
245
|
+
"event": {
|
|
246
|
+
"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\"",
|
|
247
|
+
"type": "string",
|
|
248
|
+
"title": "event"
|
|
249
|
+
},
|
|
250
|
+
"iconAlt": {
|
|
251
|
+
"description": "The alt for the custom button icon",
|
|
252
|
+
"type": "string",
|
|
253
|
+
"title": "iconAlt"
|
|
254
|
+
},
|
|
255
|
+
"iconType": {
|
|
256
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
257
|
+
"type": "string",
|
|
258
|
+
"title": "iconType"
|
|
259
|
+
},
|
|
260
|
+
"icon": {
|
|
261
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
262
|
+
"type": "string",
|
|
263
|
+
"title": "icon"
|
|
264
|
+
}
|
|
265
|
+
},
|
|
266
|
+
"required": [
|
|
267
|
+
"event",
|
|
268
|
+
"icon",
|
|
269
|
+
"iconAlt",
|
|
270
|
+
"iconType"
|
|
271
|
+
]
|
|
272
|
+
},
|
|
273
|
+
"title": "customPlugins"
|
|
237
274
|
}
|
|
238
275
|
}
|
|
239
276
|
},
|
|
@@ -248,6 +285,38 @@
|
|
|
248
285
|
}
|
|
249
286
|
}
|
|
250
287
|
},
|
|
288
|
+
"CustomPlugin": {
|
|
289
|
+
"title": "CustomPlugin",
|
|
290
|
+
"type": "object",
|
|
291
|
+
"properties": {
|
|
292
|
+
"event": {
|
|
293
|
+
"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\"",
|
|
294
|
+
"type": "string",
|
|
295
|
+
"title": "event"
|
|
296
|
+
},
|
|
297
|
+
"iconAlt": {
|
|
298
|
+
"description": "The alt for the custom button icon",
|
|
299
|
+
"type": "string",
|
|
300
|
+
"title": "iconAlt"
|
|
301
|
+
},
|
|
302
|
+
"iconType": {
|
|
303
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
304
|
+
"type": "string",
|
|
305
|
+
"title": "iconType"
|
|
306
|
+
},
|
|
307
|
+
"icon": {
|
|
308
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
309
|
+
"type": "string",
|
|
310
|
+
"title": "icon"
|
|
311
|
+
}
|
|
312
|
+
},
|
|
313
|
+
"required": [
|
|
314
|
+
"event",
|
|
315
|
+
"icon",
|
|
316
|
+
"iconAlt",
|
|
317
|
+
"iconType"
|
|
318
|
+
]
|
|
319
|
+
},
|
|
251
320
|
"ConfigureProp": {
|
|
252
321
|
"title": "ConfigureProp",
|
|
253
322
|
"type": "object",
|
|
@@ -315,6 +384,43 @@
|
|
|
315
384
|
"title": "disabled"
|
|
316
385
|
}
|
|
317
386
|
}
|
|
387
|
+
},
|
|
388
|
+
"customPlugins": {
|
|
389
|
+
"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.",
|
|
390
|
+
"type": "array",
|
|
391
|
+
"items": {
|
|
392
|
+
"title": "CustomPlugin",
|
|
393
|
+
"type": "object",
|
|
394
|
+
"properties": {
|
|
395
|
+
"event": {
|
|
396
|
+
"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\"",
|
|
397
|
+
"type": "string",
|
|
398
|
+
"title": "event"
|
|
399
|
+
},
|
|
400
|
+
"iconAlt": {
|
|
401
|
+
"description": "The alt for the custom button icon",
|
|
402
|
+
"type": "string",
|
|
403
|
+
"title": "iconAlt"
|
|
404
|
+
},
|
|
405
|
+
"iconType": {
|
|
406
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
407
|
+
"type": "string",
|
|
408
|
+
"title": "iconType"
|
|
409
|
+
},
|
|
410
|
+
"icon": {
|
|
411
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
412
|
+
"type": "string",
|
|
413
|
+
"title": "icon"
|
|
414
|
+
}
|
|
415
|
+
},
|
|
416
|
+
"required": [
|
|
417
|
+
"event",
|
|
418
|
+
"icon",
|
|
419
|
+
"iconAlt",
|
|
420
|
+
"iconType"
|
|
421
|
+
]
|
|
422
|
+
},
|
|
423
|
+
"title": "customPlugins"
|
|
318
424
|
}
|
|
319
425
|
}
|
|
320
426
|
},
|
|
@@ -386,6 +492,43 @@
|
|
|
386
492
|
"title": "disabled"
|
|
387
493
|
}
|
|
388
494
|
}
|
|
495
|
+
},
|
|
496
|
+
"customPlugins": {
|
|
497
|
+
"description": "An array of objects that determine custom plugins.\nA custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).\nExample can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.",
|
|
498
|
+
"type": "array",
|
|
499
|
+
"items": {
|
|
500
|
+
"title": "CustomPlugin",
|
|
501
|
+
"type": "object",
|
|
502
|
+
"properties": {
|
|
503
|
+
"event": {
|
|
504
|
+
"description": "The name of the custom event. It needs to be valid (only letters, numbers and \"_\" can be used).\nPIE will emit the event prefixed with \"PIE-\".\nEg: event = 'client_custom_event_A' => the emitted event will be \"PIE-client_custom_event_A\"",
|
|
505
|
+
"type": "string",
|
|
506
|
+
"title": "event"
|
|
507
|
+
},
|
|
508
|
+
"iconAlt": {
|
|
509
|
+
"description": "The alt for the custom button icon",
|
|
510
|
+
"type": "string",
|
|
511
|
+
"title": "iconAlt"
|
|
512
|
+
},
|
|
513
|
+
"iconType": {
|
|
514
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
515
|
+
"type": "string",
|
|
516
|
+
"title": "iconType"
|
|
517
|
+
},
|
|
518
|
+
"icon": {
|
|
519
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
520
|
+
"type": "string",
|
|
521
|
+
"title": "icon"
|
|
522
|
+
}
|
|
523
|
+
},
|
|
524
|
+
"required": [
|
|
525
|
+
"event",
|
|
526
|
+
"icon",
|
|
527
|
+
"iconAlt",
|
|
528
|
+
"iconType"
|
|
529
|
+
]
|
|
530
|
+
},
|
|
531
|
+
"title": "customPlugins"
|
|
389
532
|
}
|
|
390
533
|
}
|
|
391
534
|
},
|
package/docs/pie-schema.json.md
CHANGED
|
@@ -146,6 +146,35 @@ Properties of the `image` object:
|
|
|
146
146
|
|
|
147
147
|
Indicates if the plugin is disabled or not
|
|
148
148
|
|
|
149
|
+
### `customPlugins` (array)
|
|
150
|
+
|
|
151
|
+
An array of objects that determine custom plugins.
|
|
152
|
+
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).
|
|
153
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
154
|
+
|
|
155
|
+
The object is an array with all elements of the type `object`.
|
|
156
|
+
|
|
157
|
+
The array object has the following properties:
|
|
158
|
+
|
|
159
|
+
#### `event` (string, required)
|
|
160
|
+
|
|
161
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
162
|
+
PIE will emit the event prefixed with "PIE-".
|
|
163
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
164
|
+
|
|
165
|
+
#### `iconAlt` (string, required)
|
|
166
|
+
|
|
167
|
+
The alt for the custom button icon
|
|
168
|
+
|
|
169
|
+
#### `iconType` (string, required)
|
|
170
|
+
|
|
171
|
+
The icon type.
|
|
172
|
+
Currently, only "SVG" is supported.
|
|
173
|
+
|
|
174
|
+
#### `icon` (string, required)
|
|
175
|
+
|
|
176
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
177
|
+
|
|
149
178
|
## `EditableHtmlButtonConfigure` (object)
|
|
150
179
|
|
|
151
180
|
Properties of the `EditableHtmlButtonConfigure` object:
|
|
@@ -154,6 +183,29 @@ Properties of the `EditableHtmlButtonConfigure` object:
|
|
|
154
183
|
|
|
155
184
|
Indicates if the plugin is disabled or not
|
|
156
185
|
|
|
186
|
+
## `CustomPlugin` (object)
|
|
187
|
+
|
|
188
|
+
Properties of the `CustomPlugin` object:
|
|
189
|
+
|
|
190
|
+
### `event` (string, required)
|
|
191
|
+
|
|
192
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
193
|
+
PIE will emit the event prefixed with "PIE-".
|
|
194
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
195
|
+
|
|
196
|
+
### `iconAlt` (string, required)
|
|
197
|
+
|
|
198
|
+
The alt for the custom button icon
|
|
199
|
+
|
|
200
|
+
### `iconType` (string, required)
|
|
201
|
+
|
|
202
|
+
The icon type.
|
|
203
|
+
Currently, only "SVG" is supported.
|
|
204
|
+
|
|
205
|
+
### `icon` (string, required)
|
|
206
|
+
|
|
207
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
208
|
+
|
|
157
209
|
## `ConfigureProp` (object)
|
|
158
210
|
|
|
159
211
|
Properties of the `ConfigureProp` object:
|
|
@@ -206,6 +258,35 @@ Properties of the `image` object:
|
|
|
206
258
|
|
|
207
259
|
Indicates if the plugin is disabled or not
|
|
208
260
|
|
|
261
|
+
#### `customPlugins` (array)
|
|
262
|
+
|
|
263
|
+
An array of objects that determine custom plugins.
|
|
264
|
+
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).
|
|
265
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
266
|
+
|
|
267
|
+
The object is an array with all elements of the type `object`.
|
|
268
|
+
|
|
269
|
+
The array object has the following properties:
|
|
270
|
+
|
|
271
|
+
##### `event` (string, required)
|
|
272
|
+
|
|
273
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
274
|
+
PIE will emit the event prefixed with "PIE-".
|
|
275
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
276
|
+
|
|
277
|
+
##### `iconAlt` (string, required)
|
|
278
|
+
|
|
279
|
+
The alt for the custom button icon
|
|
280
|
+
|
|
281
|
+
##### `iconType` (string, required)
|
|
282
|
+
|
|
283
|
+
The icon type.
|
|
284
|
+
Currently, only "SVG" is supported.
|
|
285
|
+
|
|
286
|
+
##### `icon` (string, required)
|
|
287
|
+
|
|
288
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
289
|
+
|
|
209
290
|
### `required` (boolean)
|
|
210
291
|
|
|
211
292
|
Indicates if the item is required and the value cannot be empty
|
|
@@ -258,6 +339,35 @@ Properties of the `image` object:
|
|
|
258
339
|
|
|
259
340
|
Indicates if the plugin is disabled or not
|
|
260
341
|
|
|
342
|
+
#### `customPlugins` (array)
|
|
343
|
+
|
|
344
|
+
An array of objects that determine custom plugins.
|
|
345
|
+
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).
|
|
346
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
347
|
+
|
|
348
|
+
The object is an array with all elements of the type `object`.
|
|
349
|
+
|
|
350
|
+
The array object has the following properties:
|
|
351
|
+
|
|
352
|
+
##### `event` (string, required)
|
|
353
|
+
|
|
354
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
355
|
+
PIE will emit the event prefixed with "PIE-".
|
|
356
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
357
|
+
|
|
358
|
+
##### `iconAlt` (string, required)
|
|
359
|
+
|
|
360
|
+
The alt for the custom button icon
|
|
361
|
+
|
|
362
|
+
##### `iconType` (string, required)
|
|
363
|
+
|
|
364
|
+
The icon type.
|
|
365
|
+
Currently, only "SVG" is supported.
|
|
366
|
+
|
|
367
|
+
##### `icon` (string, required)
|
|
368
|
+
|
|
369
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
370
|
+
|
|
261
371
|
### `settings` (boolean)
|
|
262
372
|
|
|
263
373
|
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.1-next.
|
|
7
|
+
"version": "5.9.1-next.13+867186f22",
|
|
8
8
|
"description": "",
|
|
9
9
|
"scripts": {
|
|
10
10
|
"postpublish": "../../scripts/postpublish"
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
"dependencies": {
|
|
13
13
|
"@material-ui/core": "^3.9.2",
|
|
14
14
|
"@pie-framework/pie-player-events": "^0.1.0",
|
|
15
|
-
"@pie-lib/pie-toolbox": "1.
|
|
15
|
+
"@pie-lib/pie-toolbox": "1.13.0",
|
|
16
16
|
"classnames": "^2.2.5",
|
|
17
17
|
"lodash": "^4.17.10",
|
|
18
18
|
"prop-types": "^15.6.1",
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
},
|
|
22
22
|
"author": "",
|
|
23
23
|
"license": "ISC",
|
|
24
|
-
"gitHead": "
|
|
24
|
+
"gitHead": "867186f22b1b891c92a74e63fbf81f86d6485632",
|
|
25
25
|
"main": "lib/index.js",
|
|
26
26
|
"module": "src/index.js"
|
|
27
27
|
}
|