@pie-element/charting 7.10.1-next.5 → 7.11.1-next.0

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/CHANGELOG.md CHANGED
@@ -3,6 +3,17 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ # [7.11.0](https://github.com/pie-framework/pie-elements/compare/@pie-element/charting@7.10.0...@pie-element/charting@7.11.0) (2024-04-01)
7
+
8
+
9
+ ### Features
10
+
11
+ * **inline-dropdown:** upgrade pie-toolbox PD-2465 ([828d1c1](https://github.com/pie-framework/pie-elements/commit/828d1c1bc9e9221c1e141baaa8f89a4929ad0eb9))
12
+
13
+
14
+
15
+
16
+
6
17
  # [7.10.0](https://github.com/pie-framework/pie-elements/compare/@pie-element/charting@7.9.1...@pie-element/charting@7.10.0) (2024-04-01)
7
18
 
8
19
 
@@ -3,6 +3,17 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ # [7.10.0](https://github.com/pie-framework/pie-elements/compare/@pie-element/charting-configure@7.9.0...@pie-element/charting-configure@7.10.0) (2024-04-01)
7
+
8
+
9
+ ### Features
10
+
11
+ * **inline-dropdown:** upgrade pie-toolbox PD-2465 ([828d1c1](https://github.com/pie-framework/pie-elements/commit/828d1c1bc9e9221c1e141baaa8f89a4929ad0eb9))
12
+
13
+
14
+
15
+
16
+
6
17
  # [7.9.0](https://github.com/pie-framework/pie-elements/compare/@pie-element/charting-configure@7.8.1...@pie-element/charting-configure@7.9.0) (2024-04-01)
7
18
 
8
19
 
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@pie-element/charting-configure",
3
3
  "private": true,
4
- "version": "7.9.0",
4
+ "version": "7.10.0",
5
5
  "description": "",
6
6
  "main": "lib/index.js",
7
7
  "module": "src/index.js",
@@ -9,7 +9,7 @@
9
9
  "dependencies": {
10
10
  "@material-ui/core": "^3.9.2",
11
11
  "@pie-framework/pie-configure-events": "^1.3.0",
12
- "@pie-lib/pie-toolbox": "1.12.3",
12
+ "@pie-lib/pie-toolbox": "1.13.0",
13
13
  "classnames": "^2.2.5",
14
14
  "debug": "^4.1.1",
15
15
  "prop-types": "^15.6.2",
@@ -3,6 +3,17 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ # [4.8.0](https://github.com/pie-framework/pie-elements/compare/@pie-element/charting-controller@4.7.0...@pie-element/charting-controller@4.8.0) (2024-04-01)
7
+
8
+
9
+ ### Features
10
+
11
+ * **inline-dropdown:** upgrade pie-toolbox PD-2465 ([828d1c1](https://github.com/pie-framework/pie-elements/commit/828d1c1bc9e9221c1e141baaa8f89a4929ad0eb9))
12
+
13
+
14
+
15
+
16
+
6
17
  # [4.7.0](https://github.com/pie-framework/pie-elements/compare/@pie-element/charting-controller@4.6.2...@pie-element/charting-controller@4.7.0) (2024-04-01)
7
18
 
8
19
 
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@pie-element/charting-controller",
3
3
  "private": true,
4
- "version": "4.7.0",
4
+ "version": "4.8.0",
5
5
  "description": "",
6
6
  "main": "lib/index.js",
7
7
  "module": "src/index.js",
@@ -9,7 +9,7 @@
9
9
  "test": "./node_modules/.bin/jest"
10
10
  },
11
11
  "dependencies": {
12
- "@pie-lib/pie-toolbox": "1.12.3",
12
+ "@pie-lib/pie-toolbox": "1.13.0",
13
13
  "debug": "^4.1.1",
14
14
  "lodash": "^4.17.15"
15
15
  },
@@ -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
  },
@@ -175,6 +249,43 @@
175
249
  "title": "disabled"
176
250
  }
177
251
  }
252
+ },
253
+ "customPlugins": {
254
+ "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.",
255
+ "type": "array",
256
+ "items": {
257
+ "title": "CustomPlugin",
258
+ "type": "object",
259
+ "properties": {
260
+ "event": {
261
+ "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\"",
262
+ "type": "string",
263
+ "title": "event"
264
+ },
265
+ "iconAlt": {
266
+ "description": "The alt for the custom button icon",
267
+ "type": "string",
268
+ "title": "iconAlt"
269
+ },
270
+ "iconType": {
271
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
272
+ "type": "string",
273
+ "title": "iconType"
274
+ },
275
+ "icon": {
276
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
277
+ "type": "string",
278
+ "title": "icon"
279
+ }
280
+ },
281
+ "required": [
282
+ "event",
283
+ "icon",
284
+ "iconAlt",
285
+ "iconType"
286
+ ]
287
+ },
288
+ "title": "customPlugins"
178
289
  }
179
290
  }
180
291
  },
@@ -356,6 +467,43 @@
356
467
  "title": "disabled"
357
468
  }
358
469
  }
470
+ },
471
+ "customPlugins": {
472
+ "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.",
473
+ "type": "array",
474
+ "items": {
475
+ "title": "CustomPlugin",
476
+ "type": "object",
477
+ "properties": {
478
+ "event": {
479
+ "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\"",
480
+ "type": "string",
481
+ "title": "event"
482
+ },
483
+ "iconAlt": {
484
+ "description": "The alt for the custom button icon",
485
+ "type": "string",
486
+ "title": "iconAlt"
487
+ },
488
+ "iconType": {
489
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
490
+ "type": "string",
491
+ "title": "iconType"
492
+ },
493
+ "icon": {
494
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
495
+ "type": "string",
496
+ "title": "icon"
497
+ }
498
+ },
499
+ "required": [
500
+ "event",
501
+ "icon",
502
+ "iconAlt",
503
+ "iconType"
504
+ ]
505
+ },
506
+ "title": "customPlugins"
359
507
  }
360
508
  }
361
509
  },
@@ -806,6 +954,43 @@
806
954
  "title": "disabled"
807
955
  }
808
956
  }
957
+ },
958
+ "customPlugins": {
959
+ "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.",
960
+ "type": "array",
961
+ "items": {
962
+ "title": "CustomPlugin",
963
+ "type": "object",
964
+ "properties": {
965
+ "event": {
966
+ "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\"",
967
+ "type": "string",
968
+ "title": "event"
969
+ },
970
+ "iconAlt": {
971
+ "description": "The alt for the custom button icon",
972
+ "type": "string",
973
+ "title": "iconAlt"
974
+ },
975
+ "iconType": {
976
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
977
+ "type": "string",
978
+ "title": "iconType"
979
+ },
980
+ "icon": {
981
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
982
+ "type": "string",
983
+ "title": "icon"
984
+ }
985
+ },
986
+ "required": [
987
+ "event",
988
+ "icon",
989
+ "iconAlt",
990
+ "iconType"
991
+ ]
992
+ },
993
+ "title": "customPlugins"
809
994
  }
810
995
  }
811
996
  },
@@ -820,6 +1005,38 @@
820
1005
  }
821
1006
  }
822
1007
  },
1008
+ "CustomPlugin": {
1009
+ "title": "CustomPlugin",
1010
+ "type": "object",
1011
+ "properties": {
1012
+ "event": {
1013
+ "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\"",
1014
+ "type": "string",
1015
+ "title": "event"
1016
+ },
1017
+ "iconAlt": {
1018
+ "description": "The alt for the custom button icon",
1019
+ "type": "string",
1020
+ "title": "iconAlt"
1021
+ },
1022
+ "iconType": {
1023
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
1024
+ "type": "string",
1025
+ "title": "iconType"
1026
+ },
1027
+ "icon": {
1028
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
1029
+ "type": "string",
1030
+ "title": "icon"
1031
+ }
1032
+ },
1033
+ "required": [
1034
+ "event",
1035
+ "icon",
1036
+ "iconAlt",
1037
+ "iconType"
1038
+ ]
1039
+ },
823
1040
  "EditableHtmlPluginConfigureRequired": {
824
1041
  "title": "EditableHtmlPluginConfigureRequired",
825
1042
  "type": "object",
@@ -871,6 +1088,43 @@
871
1088
  "title": "disabled"
872
1089
  }
873
1090
  }
1091
+ },
1092
+ "customPlugins": {
1093
+ "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.",
1094
+ "type": "array",
1095
+ "items": {
1096
+ "title": "CustomPlugin",
1097
+ "type": "object",
1098
+ "properties": {
1099
+ "event": {
1100
+ "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\"",
1101
+ "type": "string",
1102
+ "title": "event"
1103
+ },
1104
+ "iconAlt": {
1105
+ "description": "The alt for the custom button icon",
1106
+ "type": "string",
1107
+ "title": "iconAlt"
1108
+ },
1109
+ "iconType": {
1110
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
1111
+ "type": "string",
1112
+ "title": "iconType"
1113
+ },
1114
+ "icon": {
1115
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
1116
+ "type": "string",
1117
+ "title": "icon"
1118
+ }
1119
+ },
1120
+ "required": [
1121
+ "event",
1122
+ "icon",
1123
+ "iconAlt",
1124
+ "iconType"
1125
+ ]
1126
+ },
1127
+ "title": "customPlugins"
874
1128
  }
875
1129
  }
876
1130
  },
@@ -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
  # `prompt` (object)
42
71
 
43
72
  Properties of the `prompt` 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
  ## `required` (boolean)
82
140
 
83
141
  Indicates if the item is required and the value cannot be empty
@@ -130,6 +188,35 @@ Properties of the `image` object:
130
188
 
131
189
  Indicates if the plugin is disabled or not
132
190
 
191
+ ### `customPlugins` (array)
192
+
193
+ An array of objects that determine custom plugins.
194
+ 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).
195
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
196
+
197
+ The object is an array with all elements of the type `object`.
198
+
199
+ The array object has the following properties:
200
+
201
+ #### `event` (string, required)
202
+
203
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
204
+ PIE will emit the event prefixed with "PIE-".
205
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
206
+
207
+ #### `iconAlt` (string, required)
208
+
209
+ The alt for the custom button icon
210
+
211
+ #### `iconType` (string, required)
212
+
213
+ The icon type.
214
+ Currently, only "SVG" is supported.
215
+
216
+ #### `icon` (string, required)
217
+
218
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
219
+
133
220
  ## `required` (boolean)
134
221
 
135
222
  Indicates if the item is required and the value cannot be empty
@@ -267,6 +354,35 @@ Properties of the `image` object:
267
354
 
268
355
  Indicates if the plugin is disabled or not
269
356
 
357
+ ### `customPlugins` (array)
358
+
359
+ An array of objects that determine custom plugins.
360
+ 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).
361
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
362
+
363
+ The object is an array with all elements of the type `object`.
364
+
365
+ The array object has the following properties:
366
+
367
+ #### `event` (string, required)
368
+
369
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
370
+ PIE will emit the event prefixed with "PIE-".
371
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
372
+
373
+ #### `iconAlt` (string, required)
374
+
375
+ The alt for the custom button icon
376
+
377
+ #### `iconType` (string, required)
378
+
379
+ The icon type.
380
+ Currently, only "SVG" is supported.
381
+
382
+ #### `icon` (string, required)
383
+
384
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
385
+
270
386
  ## `required` (boolean)
271
387
 
272
388
  Indicates if the item is required and the value cannot be empty
@@ -602,6 +718,35 @@ Properties of the `image` object:
602
718
 
603
719
  Indicates if the plugin is disabled or not
604
720
 
721
+ ### `customPlugins` (array)
722
+
723
+ An array of objects that determine custom plugins.
724
+ 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).
725
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
726
+
727
+ The object is an array with all elements of the type `object`.
728
+
729
+ The array object has the following properties:
730
+
731
+ #### `event` (string, required)
732
+
733
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
734
+ PIE will emit the event prefixed with "PIE-".
735
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
736
+
737
+ #### `iconAlt` (string, required)
738
+
739
+ The alt for the custom button icon
740
+
741
+ #### `iconType` (string, required)
742
+
743
+ The icon type.
744
+ Currently, only "SVG" is supported.
745
+
746
+ #### `icon` (string, required)
747
+
748
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
749
+
605
750
  ## `EditableHtmlButtonConfigure` (object)
606
751
 
607
752
  Properties of the `EditableHtmlButtonConfigure` object:
@@ -610,6 +755,29 @@ Properties of the `EditableHtmlButtonConfigure` object:
610
755
 
611
756
  Indicates if the plugin is disabled or not
612
757
 
758
+ ## `CustomPlugin` (object)
759
+
760
+ Properties of the `CustomPlugin` object:
761
+
762
+ ### `event` (string, required)
763
+
764
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
765
+ PIE will emit the event prefixed with "PIE-".
766
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
767
+
768
+ ### `iconAlt` (string, required)
769
+
770
+ The alt for the custom button icon
771
+
772
+ ### `iconType` (string, required)
773
+
774
+ The icon type.
775
+ Currently, only "SVG" is supported.
776
+
777
+ ### `icon` (string, required)
778
+
779
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
780
+
613
781
  ## `EditableHtmlPluginConfigureRequired` (object)
614
782
 
615
783
  Properties of the `EditableHtmlPluginConfigureRequired` object:
@@ -650,6 +818,35 @@ Properties of the `image` object:
650
818
 
651
819
  Indicates if the plugin is disabled or not
652
820
 
821
+ #### `customPlugins` (array)
822
+
823
+ An array of objects that determine custom plugins.
824
+ 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).
825
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
826
+
827
+ The object is an array with all elements of the type `object`.
828
+
829
+ The array object has the following properties:
830
+
831
+ ##### `event` (string, required)
832
+
833
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
834
+ PIE will emit the event prefixed with "PIE-".
835
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
836
+
837
+ ##### `iconAlt` (string, required)
838
+
839
+ The alt for the custom button icon
840
+
841
+ ##### `iconType` (string, required)
842
+
843
+ The icon type.
844
+ Currently, only "SVG" is supported.
845
+
846
+ ##### `icon` (string, required)
847
+
848
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
849
+
653
850
  ### `required` (boolean)
654
851
 
655
852
  Indicates if the item is required and the value cannot be empty
@@ -607,6 +607,43 @@
607
607
  "title": "disabled"
608
608
  }
609
609
  }
610
+ },
611
+ "customPlugins": {
612
+ "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.",
613
+ "type": "array",
614
+ "items": {
615
+ "title": "CustomPlugin",
616
+ "type": "object",
617
+ "properties": {
618
+ "event": {
619
+ "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\"",
620
+ "type": "string",
621
+ "title": "event"
622
+ },
623
+ "iconAlt": {
624
+ "description": "The alt for the custom button icon",
625
+ "type": "string",
626
+ "title": "iconAlt"
627
+ },
628
+ "iconType": {
629
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
630
+ "type": "string",
631
+ "title": "iconType"
632
+ },
633
+ "icon": {
634
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
635
+ "type": "string",
636
+ "title": "icon"
637
+ }
638
+ },
639
+ "required": [
640
+ "event",
641
+ "icon",
642
+ "iconAlt",
643
+ "iconType"
644
+ ]
645
+ },
646
+ "title": "customPlugins"
610
647
  }
611
648
  }
612
649
  },
@@ -621,6 +658,38 @@
621
658
  }
622
659
  }
623
660
  },
661
+ "CustomPlugin": {
662
+ "title": "CustomPlugin",
663
+ "type": "object",
664
+ "properties": {
665
+ "event": {
666
+ "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\"",
667
+ "type": "string",
668
+ "title": "event"
669
+ },
670
+ "iconAlt": {
671
+ "description": "The alt for the custom button icon",
672
+ "type": "string",
673
+ "title": "iconAlt"
674
+ },
675
+ "iconType": {
676
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
677
+ "type": "string",
678
+ "title": "iconType"
679
+ },
680
+ "icon": {
681
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
682
+ "type": "string",
683
+ "title": "icon"
684
+ }
685
+ },
686
+ "required": [
687
+ "event",
688
+ "icon",
689
+ "iconAlt",
690
+ "iconType"
691
+ ]
692
+ },
624
693
  "EditableHtmlPluginConfigureRequired": {
625
694
  "title": "EditableHtmlPluginConfigureRequired",
626
695
  "type": "object",
@@ -672,6 +741,43 @@
672
741
  "title": "disabled"
673
742
  }
674
743
  }
744
+ },
745
+ "customPlugins": {
746
+ "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.",
747
+ "type": "array",
748
+ "items": {
749
+ "title": "CustomPlugin",
750
+ "type": "object",
751
+ "properties": {
752
+ "event": {
753
+ "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\"",
754
+ "type": "string",
755
+ "title": "event"
756
+ },
757
+ "iconAlt": {
758
+ "description": "The alt for the custom button icon",
759
+ "type": "string",
760
+ "title": "iconAlt"
761
+ },
762
+ "iconType": {
763
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
764
+ "type": "string",
765
+ "title": "iconType"
766
+ },
767
+ "icon": {
768
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
769
+ "type": "string",
770
+ "title": "icon"
771
+ }
772
+ },
773
+ "required": [
774
+ "event",
775
+ "icon",
776
+ "iconAlt",
777
+ "iconType"
778
+ ]
779
+ },
780
+ "title": "customPlugins"
675
781
  }
676
782
  }
677
783
  },
@@ -237,6 +237,35 @@ Properties of the `image` object:
237
237
 
238
238
  Indicates if the plugin is disabled or not
239
239
 
240
+ ### `customPlugins` (array)
241
+
242
+ An array of objects that determine custom plugins.
243
+ 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).
244
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
245
+
246
+ The object is an array with all elements of the type `object`.
247
+
248
+ The array object has the following properties:
249
+
250
+ #### `event` (string, required)
251
+
252
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
253
+ PIE will emit the event prefixed with "PIE-".
254
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
255
+
256
+ #### `iconAlt` (string, required)
257
+
258
+ The alt for the custom button icon
259
+
260
+ #### `iconType` (string, required)
261
+
262
+ The icon type.
263
+ Currently, only "SVG" is supported.
264
+
265
+ #### `icon` (string, required)
266
+
267
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
268
+
240
269
  ## `EditableHtmlButtonConfigure` (object)
241
270
 
242
271
  Properties of the `EditableHtmlButtonConfigure` object:
@@ -245,6 +274,29 @@ Properties of the `EditableHtmlButtonConfigure` object:
245
274
 
246
275
  Indicates if the plugin is disabled or not
247
276
 
277
+ ## `CustomPlugin` (object)
278
+
279
+ Properties of the `CustomPlugin` object:
280
+
281
+ ### `event` (string, required)
282
+
283
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
284
+ PIE will emit the event prefixed with "PIE-".
285
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
286
+
287
+ ### `iconAlt` (string, required)
288
+
289
+ The alt for the custom button icon
290
+
291
+ ### `iconType` (string, required)
292
+
293
+ The icon type.
294
+ Currently, only "SVG" is supported.
295
+
296
+ ### `icon` (string, required)
297
+
298
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
299
+
248
300
  ## `EditableHtmlPluginConfigureRequired` (object)
249
301
 
250
302
  Properties of the `EditableHtmlPluginConfigureRequired` object:
@@ -285,6 +337,35 @@ Properties of the `image` object:
285
337
 
286
338
  Indicates if the plugin is disabled or not
287
339
 
340
+ #### `customPlugins` (array)
341
+
342
+ An array of objects that determine custom plugins.
343
+ 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).
344
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
345
+
346
+ The object is an array with all elements of the type `object`.
347
+
348
+ The array object has the following properties:
349
+
350
+ ##### `event` (string, required)
351
+
352
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
353
+ PIE will emit the event prefixed with "PIE-".
354
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
355
+
356
+ ##### `iconAlt` (string, required)
357
+
358
+ The alt for the custom button icon
359
+
360
+ ##### `iconType` (string, required)
361
+
362
+ The icon type.
363
+ Currently, only "SVG" is supported.
364
+
365
+ ##### `icon` (string, required)
366
+
367
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
368
+
288
369
  ### `required` (boolean)
289
370
 
290
371
  Indicates if the item is required and the value cannot be empty
package/package.json CHANGED
@@ -4,7 +4,7 @@
4
4
  "access": "public"
5
5
  },
6
6
  "repository": "pie-framework/pie-elements",
7
- "version": "7.10.1-next.5+579694d54",
7
+ "version": "7.11.1-next.0+7612cee2d",
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.12.3",
15
+ "@pie-lib/pie-toolbox": "1.13.0",
16
16
  "classnames": "^2.2.5",
17
17
  "debug": "^4.1.1",
18
18
  "lodash": "^4.17.15",
@@ -21,7 +21,7 @@
21
21
  },
22
22
  "author": "",
23
23
  "license": "ISC",
24
- "gitHead": "579694d5468995065657b651f06ec9513d0476b6",
24
+ "gitHead": "7612cee2d409a408cd06a40d0c1190ab9ec70e3c",
25
25
  "main": "lib/index.js",
26
26
  "module": "src/index.js"
27
27
  }