@pie-element/multi-trait-rubric 3.7.1-next.5 → 3.8.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
+ # [3.8.0](https://github.com/pie-framework/pie-elements/compare/@pie-element/multi-trait-rubric@3.7.0...@pie-element/multi-trait-rubric@3.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
  # [3.7.0](https://github.com/pie-framework/pie-elements/compare/@pie-element/multi-trait-rubric@3.6.5...@pie-element/multi-trait-rubric@3.7.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
+ # [3.8.0](https://github.com/pie-framework/pie-elements/compare/@pie-element/multi-trait-rubric-configure@3.7.0...@pie-element/multi-trait-rubric-configure@3.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
  # [3.7.0](https://github.com/pie-framework/pie-elements/compare/@pie-element/multi-trait-rubric-configure@3.6.5...@pie-element/multi-trait-rubric-configure@3.7.0) (2024-04-01)
7
18
 
8
19
 
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pie-element/multi-trait-rubric-configure",
3
- "version": "3.7.0",
3
+ "version": "3.8.0",
4
4
  "private": true,
5
5
  "main": "lib/index.js",
6
6
  "module": "src/index.js",
@@ -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.12.3",
11
+ "@pie-lib/pie-toolbox": "1.13.0",
12
12
  "debug": "^3.1.0",
13
13
  "lodash": "^4.17.15",
14
14
  "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
+ # [2.7.0](https://github.com/pie-framework/pie-elements/compare/@pie-element/multi-trait-rubric-controller@2.6.0...@pie-element/multi-trait-rubric-controller@2.7.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
  # [2.6.0](https://github.com/pie-framework/pie-elements/compare/@pie-element/multi-trait-rubric-controller@2.5.4...@pie-element/multi-trait-rubric-controller@2.6.0) (2024-04-01)
7
18
 
8
19
 
@@ -1,14 +1,14 @@
1
1
  {
2
2
  "name": "@pie-element/multi-trait-rubric-controller",
3
3
  "private": true,
4
- "version": "2.6.0",
4
+ "version": "2.7.0",
5
5
  "description": "",
6
6
  "main": "lib/index.js",
7
7
  "module": "src/index.js",
8
8
  "author": "",
9
9
  "license": "ISC",
10
10
  "dependencies": {
11
- "@pie-lib/pie-toolbox": "1.12.3",
11
+ "@pie-lib/pie-toolbox": "1.13.0",
12
12
  "debug": "^3.1.0",
13
13
  "lodash": "^4.17.15"
14
14
  }
@@ -50,6 +50,43 @@
50
50
  "title": "disabled"
51
51
  }
52
52
  }
53
+ },
54
+ "customPlugins": {
55
+ "description": "An array of objects that determine custom plugins.\nA custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).\nExample can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.",
56
+ "type": "array",
57
+ "items": {
58
+ "title": "CustomPlugin",
59
+ "type": "object",
60
+ "properties": {
61
+ "event": {
62
+ "description": "The name of the custom event. It needs to be valid (only letters, numbers and \"_\" can be used).\nPIE will emit the event prefixed with \"PIE-\".\nEg: event = 'client_custom_event_A' => the emitted event will be \"PIE-client_custom_event_A\"",
63
+ "type": "string",
64
+ "title": "event"
65
+ },
66
+ "iconAlt": {
67
+ "description": "The alt for the custom button icon",
68
+ "type": "string",
69
+ "title": "iconAlt"
70
+ },
71
+ "iconType": {
72
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
73
+ "type": "string",
74
+ "title": "iconType"
75
+ },
76
+ "icon": {
77
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
78
+ "type": "string",
79
+ "title": "icon"
80
+ }
81
+ },
82
+ "required": [
83
+ "event",
84
+ "icon",
85
+ "iconAlt",
86
+ "iconType"
87
+ ]
88
+ },
89
+ "title": "customPlugins"
53
90
  }
54
91
  }
55
92
  },
@@ -104,6 +141,43 @@
104
141
  "title": "disabled"
105
142
  }
106
143
  }
144
+ },
145
+ "customPlugins": {
146
+ "description": "An array of objects that determine custom plugins.\nA custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).\nExample can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.",
147
+ "type": "array",
148
+ "items": {
149
+ "title": "CustomPlugin",
150
+ "type": "object",
151
+ "properties": {
152
+ "event": {
153
+ "description": "The name of the custom event. It needs to be valid (only letters, numbers and \"_\" can be used).\nPIE will emit the event prefixed with \"PIE-\".\nEg: event = 'client_custom_event_A' => the emitted event will be \"PIE-client_custom_event_A\"",
154
+ "type": "string",
155
+ "title": "event"
156
+ },
157
+ "iconAlt": {
158
+ "description": "The alt for the custom button icon",
159
+ "type": "string",
160
+ "title": "iconAlt"
161
+ },
162
+ "iconType": {
163
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
164
+ "type": "string",
165
+ "title": "iconType"
166
+ },
167
+ "icon": {
168
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
169
+ "type": "string",
170
+ "title": "icon"
171
+ }
172
+ },
173
+ "required": [
174
+ "event",
175
+ "icon",
176
+ "iconAlt",
177
+ "iconType"
178
+ ]
179
+ },
180
+ "title": "customPlugins"
107
181
  }
108
182
  }
109
183
  },
@@ -170,6 +244,43 @@
170
244
  "title": "disabled"
171
245
  }
172
246
  }
247
+ },
248
+ "customPlugins": {
249
+ "description": "An array of objects that determine custom plugins.\nA custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).\nExample can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.",
250
+ "type": "array",
251
+ "items": {
252
+ "title": "CustomPlugin",
253
+ "type": "object",
254
+ "properties": {
255
+ "event": {
256
+ "description": "The name of the custom event. It needs to be valid (only letters, numbers and \"_\" can be used).\nPIE will emit the event prefixed with \"PIE-\".\nEg: event = 'client_custom_event_A' => the emitted event will be \"PIE-client_custom_event_A\"",
257
+ "type": "string",
258
+ "title": "event"
259
+ },
260
+ "iconAlt": {
261
+ "description": "The alt for the custom button icon",
262
+ "type": "string",
263
+ "title": "iconAlt"
264
+ },
265
+ "iconType": {
266
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
267
+ "type": "string",
268
+ "title": "iconType"
269
+ },
270
+ "icon": {
271
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
272
+ "type": "string",
273
+ "title": "icon"
274
+ }
275
+ },
276
+ "required": [
277
+ "event",
278
+ "icon",
279
+ "iconAlt",
280
+ "iconType"
281
+ ]
282
+ },
283
+ "title": "customPlugins"
173
284
  }
174
285
  }
175
286
  },
@@ -453,6 +564,43 @@
453
564
  "title": "disabled"
454
565
  }
455
566
  }
567
+ },
568
+ "customPlugins": {
569
+ "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.",
570
+ "type": "array",
571
+ "items": {
572
+ "title": "CustomPlugin",
573
+ "type": "object",
574
+ "properties": {
575
+ "event": {
576
+ "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\"",
577
+ "type": "string",
578
+ "title": "event"
579
+ },
580
+ "iconAlt": {
581
+ "description": "The alt for the custom button icon",
582
+ "type": "string",
583
+ "title": "iconAlt"
584
+ },
585
+ "iconType": {
586
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
587
+ "type": "string",
588
+ "title": "iconType"
589
+ },
590
+ "icon": {
591
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
592
+ "type": "string",
593
+ "title": "icon"
594
+ }
595
+ },
596
+ "required": [
597
+ "event",
598
+ "icon",
599
+ "iconAlt",
600
+ "iconType"
601
+ ]
602
+ },
603
+ "title": "customPlugins"
456
604
  }
457
605
  }
458
606
  },
@@ -467,6 +615,38 @@
467
615
  }
468
616
  }
469
617
  },
618
+ "CustomPlugin": {
619
+ "title": "CustomPlugin",
620
+ "type": "object",
621
+ "properties": {
622
+ "event": {
623
+ "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\"",
624
+ "type": "string",
625
+ "title": "event"
626
+ },
627
+ "iconAlt": {
628
+ "description": "The alt for the custom button icon",
629
+ "type": "string",
630
+ "title": "iconAlt"
631
+ },
632
+ "iconType": {
633
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
634
+ "type": "string",
635
+ "title": "iconType"
636
+ },
637
+ "icon": {
638
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
639
+ "type": "string",
640
+ "title": "icon"
641
+ }
642
+ },
643
+ "required": [
644
+ "event",
645
+ "icon",
646
+ "iconAlt",
647
+ "iconType"
648
+ ]
649
+ },
470
650
  "EditableHtmlPluginConfigure": {
471
651
  "title": "EditableHtmlPluginConfigure",
472
652
  "type": "object",
@@ -518,6 +698,43 @@
518
698
  "title": "disabled"
519
699
  }
520
700
  }
701
+ },
702
+ "customPlugins": {
703
+ "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.",
704
+ "type": "array",
705
+ "items": {
706
+ "title": "CustomPlugin",
707
+ "type": "object",
708
+ "properties": {
709
+ "event": {
710
+ "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\"",
711
+ "type": "string",
712
+ "title": "event"
713
+ },
714
+ "iconAlt": {
715
+ "description": "The alt for the custom button icon",
716
+ "type": "string",
717
+ "title": "iconAlt"
718
+ },
719
+ "iconType": {
720
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
721
+ "type": "string",
722
+ "title": "iconType"
723
+ },
724
+ "icon": {
725
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
726
+ "type": "string",
727
+ "title": "icon"
728
+ }
729
+ },
730
+ "required": [
731
+ "event",
732
+ "icon",
733
+ "iconAlt",
734
+ "iconType"
735
+ ]
736
+ },
737
+ "title": "customPlugins"
521
738
  }
522
739
  }
523
740
  },
@@ -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
  # `expandedInput` (object)
42
71
 
43
72
  Properties of the `expandedInput` object:
@@ -78,6 +107,35 @@ Properties of the `image` object:
78
107
 
79
108
  Indicates if the plugin is disabled or not
80
109
 
110
+ ### `customPlugins` (array)
111
+
112
+ An array of objects that determine custom plugins.
113
+ A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
114
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
115
+
116
+ The object is an array with all elements of the type `object`.
117
+
118
+ The array object has the following properties:
119
+
120
+ #### `event` (string, required)
121
+
122
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
123
+ PIE will emit the event prefixed with "PIE-".
124
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
125
+
126
+ #### `iconAlt` (string, required)
127
+
128
+ The alt for the custom button icon
129
+
130
+ #### `iconType` (string, required)
131
+
132
+ The icon type.
133
+ Currently, only "SVG" is supported.
134
+
135
+ #### `icon` (string, required)
136
+
137
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
138
+
81
139
  ## `settings` (boolean)
82
140
 
83
141
  Indicates if the item has to be displayed in the Settings Panel
@@ -126,6 +184,35 @@ Properties of the `image` object:
126
184
 
127
185
  Indicates if the plugin is disabled or not
128
186
 
187
+ ### `customPlugins` (array)
188
+
189
+ An array of objects that determine custom plugins.
190
+ A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
191
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
192
+
193
+ The object is an array with all elements of the type `object`.
194
+
195
+ The array object has the following properties:
196
+
197
+ #### `event` (string, required)
198
+
199
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
200
+ PIE will emit the event prefixed with "PIE-".
201
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
202
+
203
+ #### `iconAlt` (string, required)
204
+
205
+ The alt for the custom button icon
206
+
207
+ #### `iconType` (string, required)
208
+
209
+ The icon type.
210
+ Currently, only "SVG" is supported.
211
+
212
+ #### `icon` (string, required)
213
+
214
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
215
+
129
216
  ## `settings` (boolean)
130
217
 
131
218
  Indicates if the item has to be displayed in the Settings Panel
@@ -341,6 +428,35 @@ Properties of the `image` object:
341
428
 
342
429
  Indicates if the plugin is disabled or not
343
430
 
431
+ ### `customPlugins` (array)
432
+
433
+ An array of objects that determine custom plugins.
434
+ 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).
435
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
436
+
437
+ The object is an array with all elements of the type `object`.
438
+
439
+ The array object has the following properties:
440
+
441
+ #### `event` (string, required)
442
+
443
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
444
+ PIE will emit the event prefixed with "PIE-".
445
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
446
+
447
+ #### `iconAlt` (string, required)
448
+
449
+ The alt for the custom button icon
450
+
451
+ #### `iconType` (string, required)
452
+
453
+ The icon type.
454
+ Currently, only "SVG" is supported.
455
+
456
+ #### `icon` (string, required)
457
+
458
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
459
+
344
460
  ## `EditableHtmlButtonConfigure` (object)
345
461
 
346
462
  Properties of the `EditableHtmlButtonConfigure` object:
@@ -349,6 +465,29 @@ Properties of the `EditableHtmlButtonConfigure` object:
349
465
 
350
466
  Indicates if the plugin is disabled or not
351
467
 
468
+ ## `CustomPlugin` (object)
469
+
470
+ Properties of the `CustomPlugin` object:
471
+
472
+ ### `event` (string, required)
473
+
474
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
475
+ PIE will emit the event prefixed with "PIE-".
476
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
477
+
478
+ ### `iconAlt` (string, required)
479
+
480
+ The alt for the custom button icon
481
+
482
+ ### `iconType` (string, required)
483
+
484
+ The icon type.
485
+ Currently, only "SVG" is supported.
486
+
487
+ ### `icon` (string, required)
488
+
489
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
490
+
352
491
  ## `EditableHtmlPluginConfigure` (object)
353
492
 
354
493
  Properties of the `EditableHtmlPluginConfigure` object:
@@ -389,6 +528,35 @@ Properties of the `image` object:
389
528
 
390
529
  Indicates if the plugin is disabled or not
391
530
 
531
+ #### `customPlugins` (array)
532
+
533
+ An array of objects that determine custom plugins.
534
+ 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).
535
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
536
+
537
+ The object is an array with all elements of the type `object`.
538
+
539
+ The array object has the following properties:
540
+
541
+ ##### `event` (string, required)
542
+
543
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
544
+ PIE will emit the event prefixed with "PIE-".
545
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
546
+
547
+ ##### `iconAlt` (string, required)
548
+
549
+ The alt for the custom button icon
550
+
551
+ ##### `iconType` (string, required)
552
+
553
+ The icon type.
554
+ Currently, only "SVG" is supported.
555
+
556
+ ##### `icon` (string, required)
557
+
558
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
559
+
392
560
  ### `settings` (boolean)
393
561
 
394
562
  Indicates if the item has to be displayed in the Settings Panel
@@ -181,6 +181,43 @@
181
181
  "title": "disabled"
182
182
  }
183
183
  }
184
+ },
185
+ "customPlugins": {
186
+ "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.",
187
+ "type": "array",
188
+ "items": {
189
+ "title": "CustomPlugin",
190
+ "type": "object",
191
+ "properties": {
192
+ "event": {
193
+ "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\"",
194
+ "type": "string",
195
+ "title": "event"
196
+ },
197
+ "iconAlt": {
198
+ "description": "The alt for the custom button icon",
199
+ "type": "string",
200
+ "title": "iconAlt"
201
+ },
202
+ "iconType": {
203
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
204
+ "type": "string",
205
+ "title": "iconType"
206
+ },
207
+ "icon": {
208
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
209
+ "type": "string",
210
+ "title": "icon"
211
+ }
212
+ },
213
+ "required": [
214
+ "event",
215
+ "icon",
216
+ "iconAlt",
217
+ "iconType"
218
+ ]
219
+ },
220
+ "title": "customPlugins"
184
221
  }
185
222
  }
186
223
  },
@@ -195,6 +232,38 @@
195
232
  }
196
233
  }
197
234
  },
235
+ "CustomPlugin": {
236
+ "title": "CustomPlugin",
237
+ "type": "object",
238
+ "properties": {
239
+ "event": {
240
+ "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\"",
241
+ "type": "string",
242
+ "title": "event"
243
+ },
244
+ "iconAlt": {
245
+ "description": "The alt for the custom button icon",
246
+ "type": "string",
247
+ "title": "iconAlt"
248
+ },
249
+ "iconType": {
250
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
251
+ "type": "string",
252
+ "title": "iconType"
253
+ },
254
+ "icon": {
255
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
256
+ "type": "string",
257
+ "title": "icon"
258
+ }
259
+ },
260
+ "required": [
261
+ "event",
262
+ "icon",
263
+ "iconAlt",
264
+ "iconType"
265
+ ]
266
+ },
198
267
  "EditableHtmlPluginConfigure": {
199
268
  "title": "EditableHtmlPluginConfigure",
200
269
  "type": "object",
@@ -246,6 +315,43 @@
246
315
  "title": "disabled"
247
316
  }
248
317
  }
318
+ },
319
+ "customPlugins": {
320
+ "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.",
321
+ "type": "array",
322
+ "items": {
323
+ "title": "CustomPlugin",
324
+ "type": "object",
325
+ "properties": {
326
+ "event": {
327
+ "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\"",
328
+ "type": "string",
329
+ "title": "event"
330
+ },
331
+ "iconAlt": {
332
+ "description": "The alt for the custom button icon",
333
+ "type": "string",
334
+ "title": "iconAlt"
335
+ },
336
+ "iconType": {
337
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
338
+ "type": "string",
339
+ "title": "iconType"
340
+ },
341
+ "icon": {
342
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
343
+ "type": "string",
344
+ "title": "icon"
345
+ }
346
+ },
347
+ "required": [
348
+ "event",
349
+ "icon",
350
+ "iconAlt",
351
+ "iconType"
352
+ ]
353
+ },
354
+ "title": "customPlugins"
249
355
  }
250
356
  }
251
357
  },
@@ -130,6 +130,35 @@ Properties of the `image` object:
130
130
 
131
131
  Indicates if the plugin is disabled or not
132
132
 
133
+ ### `customPlugins` (array)
134
+
135
+ An array of objects that determine custom plugins.
136
+ 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).
137
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
138
+
139
+ The object is an array with all elements of the type `object`.
140
+
141
+ The array object has the following properties:
142
+
143
+ #### `event` (string, required)
144
+
145
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
146
+ PIE will emit the event prefixed with "PIE-".
147
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
148
+
149
+ #### `iconAlt` (string, required)
150
+
151
+ The alt for the custom button icon
152
+
153
+ #### `iconType` (string, required)
154
+
155
+ The icon type.
156
+ Currently, only "SVG" is supported.
157
+
158
+ #### `icon` (string, required)
159
+
160
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
161
+
133
162
  ## `EditableHtmlButtonConfigure` (object)
134
163
 
135
164
  Properties of the `EditableHtmlButtonConfigure` object:
@@ -138,6 +167,29 @@ Properties of the `EditableHtmlButtonConfigure` object:
138
167
 
139
168
  Indicates if the plugin is disabled or not
140
169
 
170
+ ## `CustomPlugin` (object)
171
+
172
+ Properties of the `CustomPlugin` object:
173
+
174
+ ### `event` (string, required)
175
+
176
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
177
+ PIE will emit the event prefixed with "PIE-".
178
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
179
+
180
+ ### `iconAlt` (string, required)
181
+
182
+ The alt for the custom button icon
183
+
184
+ ### `iconType` (string, required)
185
+
186
+ The icon type.
187
+ Currently, only "SVG" is supported.
188
+
189
+ ### `icon` (string, required)
190
+
191
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
192
+
141
193
  ## `EditableHtmlPluginConfigure` (object)
142
194
 
143
195
  Properties of the `EditableHtmlPluginConfigure` object:
@@ -178,6 +230,35 @@ Properties of the `image` object:
178
230
 
179
231
  Indicates if the plugin is disabled or not
180
232
 
233
+ #### `customPlugins` (array)
234
+
235
+ An array of objects that determine custom plugins.
236
+ 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).
237
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
238
+
239
+ The object is an array with all elements of the type `object`.
240
+
241
+ The array object has the following properties:
242
+
243
+ ##### `event` (string, required)
244
+
245
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
246
+ PIE will emit the event prefixed with "PIE-".
247
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
248
+
249
+ ##### `iconAlt` (string, required)
250
+
251
+ The alt for the custom button icon
252
+
253
+ ##### `iconType` (string, required)
254
+
255
+ The icon type.
256
+ Currently, only "SVG" is supported.
257
+
258
+ ##### `icon` (string, required)
259
+
260
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
261
+
181
262
  ### `settings` (boolean)
182
263
 
183
264
  Indicates if the item has to be displayed in the Settings Panel
package/package.json CHANGED
@@ -1,21 +1,21 @@
1
1
  {
2
2
  "name": "@pie-element/multi-trait-rubric",
3
3
  "repository": "pie-framework/pie-elements",
4
- "version": "3.7.1-next.5+579694d54",
4
+ "version": "3.8.0",
5
5
  "publishConfig": {
6
6
  "access": "public"
7
7
  },
8
8
  "dependencies": {
9
9
  "@material-ui/core": "^3.9.2",
10
10
  "@pie-framework/pie-player-events": "^0.1.0",
11
- "@pie-lib/pie-toolbox": "1.12.3",
11
+ "@pie-lib/pie-toolbox": "1.13.0",
12
12
  "clsx": "^1.1.1",
13
13
  "enzyme-to-json": "^3.3.5",
14
14
  "prop-types": "^15.6.1",
15
15
  "react": "^16.8.1",
16
16
  "react-dom": "^16.8.1"
17
17
  },
18
- "gitHead": "579694d5468995065657b651f06ec9513d0476b6",
18
+ "gitHead": "8aa41b3cc02c1b22eabc23d971e0b6659e82eee7",
19
19
  "scripts": {
20
20
  "postpublish": "../../scripts/postpublish"
21
21
  },