@pie-element/placement-ordering 9.8.1-next.5 → 9.9.1-next.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +11 -0
- package/configure/CHANGELOG.md +11 -0
- package/configure/lib/choice-editor.js +3 -3
- package/configure/lib/choice-editor.js.map +1 -1
- package/configure/lib/choice-tile.js +3 -14
- package/configure/lib/choice-tile.js.map +1 -1
- package/configure/lib/defaults.js +71 -5
- package/configure/lib/defaults.js.map +1 -1
- package/configure/lib/design.js +17 -1
- package/configure/lib/design.js.map +1 -1
- package/configure/package.json +1 -1
- package/docs/config-schema.json +848 -11
- package/docs/config-schema.json.md +628 -4
- package/docs/pie-schema.json +322 -2
- package/docs/pie-schema.json.md +240 -2
- package/package.json +2 -2
|
@@ -2,10 +2,140 @@ Config Object for @pie-elements/placement-ordering
|
|
|
2
2
|
|
|
3
3
|
The schema defines the following properties:
|
|
4
4
|
|
|
5
|
+
# `baseInputConfiguration` (object)
|
|
6
|
+
|
|
7
|
+
Properties of the `baseInputConfiguration` object:
|
|
8
|
+
|
|
9
|
+
## `math` (object)
|
|
10
|
+
|
|
11
|
+
Properties of the `math` object:
|
|
12
|
+
|
|
13
|
+
### `disabled` (boolean)
|
|
14
|
+
|
|
15
|
+
Indicates if the plugin is disabled or not
|
|
16
|
+
|
|
17
|
+
## `audio` (object)
|
|
18
|
+
|
|
19
|
+
Properties of the `audio` object:
|
|
20
|
+
|
|
21
|
+
### `disabled` (boolean)
|
|
22
|
+
|
|
23
|
+
Indicates if the plugin is disabled or not
|
|
24
|
+
|
|
25
|
+
## `video` (object)
|
|
26
|
+
|
|
27
|
+
Properties of the `video` object:
|
|
28
|
+
|
|
29
|
+
### `disabled` (boolean)
|
|
30
|
+
|
|
31
|
+
Indicates if the plugin is disabled or not
|
|
32
|
+
|
|
33
|
+
## `image` (object)
|
|
34
|
+
|
|
35
|
+
Properties of the `image` object:
|
|
36
|
+
|
|
37
|
+
### `disabled` (boolean)
|
|
38
|
+
|
|
39
|
+
Indicates if the plugin is disabled or not
|
|
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
|
+
|
|
5
70
|
# `choiceLabel` (object)
|
|
6
71
|
|
|
7
72
|
Properties of the `choiceLabel` object:
|
|
8
73
|
|
|
74
|
+
## `inputConfiguration` (object)
|
|
75
|
+
|
|
76
|
+
Properties of the `inputConfiguration` object:
|
|
77
|
+
|
|
78
|
+
### `math` (object)
|
|
79
|
+
|
|
80
|
+
Properties of the `math` object:
|
|
81
|
+
|
|
82
|
+
#### `disabled` (boolean)
|
|
83
|
+
|
|
84
|
+
Indicates if the plugin is disabled or not
|
|
85
|
+
|
|
86
|
+
### `audio` (object)
|
|
87
|
+
|
|
88
|
+
Properties of the `audio` object:
|
|
89
|
+
|
|
90
|
+
#### `disabled` (boolean)
|
|
91
|
+
|
|
92
|
+
Indicates if the plugin is disabled or not
|
|
93
|
+
|
|
94
|
+
### `video` (object)
|
|
95
|
+
|
|
96
|
+
Properties of the `video` object:
|
|
97
|
+
|
|
98
|
+
#### `disabled` (boolean)
|
|
99
|
+
|
|
100
|
+
Indicates if the plugin is disabled or not
|
|
101
|
+
|
|
102
|
+
### `image` (object)
|
|
103
|
+
|
|
104
|
+
Properties of the `image` object:
|
|
105
|
+
|
|
106
|
+
#### `disabled` (boolean)
|
|
107
|
+
|
|
108
|
+
Indicates if the plugin is disabled or not
|
|
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
|
+
|
|
9
139
|
## `settings` (boolean)
|
|
10
140
|
|
|
11
141
|
Indicates if the item has to be displayed in the Settings Panel
|
|
@@ -18,6 +148,71 @@ Indicates the label for the item that has to be displayed in the Settings Panel
|
|
|
18
148
|
|
|
19
149
|
Properties of the `choices` object:
|
|
20
150
|
|
|
151
|
+
## `inputConfiguration` (object)
|
|
152
|
+
|
|
153
|
+
Properties of the `inputConfiguration` object:
|
|
154
|
+
|
|
155
|
+
### `math` (object)
|
|
156
|
+
|
|
157
|
+
Properties of the `math` object:
|
|
158
|
+
|
|
159
|
+
#### `disabled` (boolean)
|
|
160
|
+
|
|
161
|
+
Indicates if the plugin is disabled or not
|
|
162
|
+
|
|
163
|
+
### `audio` (object)
|
|
164
|
+
|
|
165
|
+
Properties of the `audio` object:
|
|
166
|
+
|
|
167
|
+
#### `disabled` (boolean)
|
|
168
|
+
|
|
169
|
+
Indicates if the plugin is disabled or not
|
|
170
|
+
|
|
171
|
+
### `video` (object)
|
|
172
|
+
|
|
173
|
+
Properties of the `video` object:
|
|
174
|
+
|
|
175
|
+
#### `disabled` (boolean)
|
|
176
|
+
|
|
177
|
+
Indicates if the plugin is disabled or not
|
|
178
|
+
|
|
179
|
+
### `image` (object)
|
|
180
|
+
|
|
181
|
+
Properties of the `image` object:
|
|
182
|
+
|
|
183
|
+
#### `disabled` (boolean)
|
|
184
|
+
|
|
185
|
+
Indicates if the plugin is disabled or not
|
|
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
|
+
|
|
21
216
|
## `settings` (boolean)
|
|
22
217
|
|
|
23
218
|
Indicates if the item has to be displayed in the Settings Panel
|
|
@@ -54,9 +249,70 @@ Indicates the label for the item that has to be displayed in the Settings Panel
|
|
|
54
249
|
|
|
55
250
|
Properties of the `prompt` object:
|
|
56
251
|
|
|
57
|
-
## `
|
|
252
|
+
## `inputConfiguration` (object)
|
|
58
253
|
|
|
59
|
-
|
|
254
|
+
Properties of the `inputConfiguration` object:
|
|
255
|
+
|
|
256
|
+
### `math` (object)
|
|
257
|
+
|
|
258
|
+
Properties of the `math` object:
|
|
259
|
+
|
|
260
|
+
#### `disabled` (boolean)
|
|
261
|
+
|
|
262
|
+
Indicates if the plugin is disabled or not
|
|
263
|
+
|
|
264
|
+
### `audio` (object)
|
|
265
|
+
|
|
266
|
+
Properties of the `audio` object:
|
|
267
|
+
|
|
268
|
+
#### `disabled` (boolean)
|
|
269
|
+
|
|
270
|
+
Indicates if the plugin is disabled or not
|
|
271
|
+
|
|
272
|
+
### `video` (object)
|
|
273
|
+
|
|
274
|
+
Properties of the `video` object:
|
|
275
|
+
|
|
276
|
+
#### `disabled` (boolean)
|
|
277
|
+
|
|
278
|
+
Indicates if the plugin is disabled or not
|
|
279
|
+
|
|
280
|
+
### `image` (object)
|
|
281
|
+
|
|
282
|
+
Properties of the `image` object:
|
|
283
|
+
|
|
284
|
+
#### `disabled` (boolean)
|
|
285
|
+
|
|
286
|
+
Indicates if the plugin is disabled or not
|
|
287
|
+
|
|
288
|
+
### `customPlugins` (array)
|
|
289
|
+
|
|
290
|
+
An array of objects that determine custom plugins.
|
|
291
|
+
A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
|
|
292
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
293
|
+
|
|
294
|
+
The object is an array with all elements of the type `object`.
|
|
295
|
+
|
|
296
|
+
The array object has the following properties:
|
|
297
|
+
|
|
298
|
+
#### `event` (string, required)
|
|
299
|
+
|
|
300
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
301
|
+
PIE will emit the event prefixed with "PIE-".
|
|
302
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
303
|
+
|
|
304
|
+
#### `iconAlt` (string, required)
|
|
305
|
+
|
|
306
|
+
The alt for the custom button icon
|
|
307
|
+
|
|
308
|
+
#### `iconType` (string, required)
|
|
309
|
+
|
|
310
|
+
The icon type.
|
|
311
|
+
Currently, only "SVG" is supported.
|
|
312
|
+
|
|
313
|
+
#### `icon` (string, required)
|
|
314
|
+
|
|
315
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
60
316
|
|
|
61
317
|
## `settings` (boolean)
|
|
62
318
|
|
|
@@ -130,6 +386,71 @@ Indicates the label for the item that has to be displayed in the Settings Panel
|
|
|
130
386
|
|
|
131
387
|
Properties of the `rationale` object:
|
|
132
388
|
|
|
389
|
+
## `inputConfiguration` (object)
|
|
390
|
+
|
|
391
|
+
Properties of the `inputConfiguration` object:
|
|
392
|
+
|
|
393
|
+
### `math` (object)
|
|
394
|
+
|
|
395
|
+
Properties of the `math` object:
|
|
396
|
+
|
|
397
|
+
#### `disabled` (boolean)
|
|
398
|
+
|
|
399
|
+
Indicates if the plugin is disabled or not
|
|
400
|
+
|
|
401
|
+
### `audio` (object)
|
|
402
|
+
|
|
403
|
+
Properties of the `audio` object:
|
|
404
|
+
|
|
405
|
+
#### `disabled` (boolean)
|
|
406
|
+
|
|
407
|
+
Indicates if the plugin is disabled or not
|
|
408
|
+
|
|
409
|
+
### `video` (object)
|
|
410
|
+
|
|
411
|
+
Properties of the `video` object:
|
|
412
|
+
|
|
413
|
+
#### `disabled` (boolean)
|
|
414
|
+
|
|
415
|
+
Indicates if the plugin is disabled or not
|
|
416
|
+
|
|
417
|
+
### `image` (object)
|
|
418
|
+
|
|
419
|
+
Properties of the `image` object:
|
|
420
|
+
|
|
421
|
+
#### `disabled` (boolean)
|
|
422
|
+
|
|
423
|
+
Indicates if the plugin is disabled or not
|
|
424
|
+
|
|
425
|
+
### `customPlugins` (array)
|
|
426
|
+
|
|
427
|
+
An array of objects that determine custom plugins.
|
|
428
|
+
A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
|
|
429
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
430
|
+
|
|
431
|
+
The object is an array with all elements of the type `object`.
|
|
432
|
+
|
|
433
|
+
The array object has the following properties:
|
|
434
|
+
|
|
435
|
+
#### `event` (string, required)
|
|
436
|
+
|
|
437
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
438
|
+
PIE will emit the event prefixed with "PIE-".
|
|
439
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
440
|
+
|
|
441
|
+
#### `iconAlt` (string, required)
|
|
442
|
+
|
|
443
|
+
The alt for the custom button icon
|
|
444
|
+
|
|
445
|
+
#### `iconType` (string, required)
|
|
446
|
+
|
|
447
|
+
The icon type.
|
|
448
|
+
Currently, only "SVG" is supported.
|
|
449
|
+
|
|
450
|
+
#### `icon` (string, required)
|
|
451
|
+
|
|
452
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
453
|
+
|
|
133
454
|
## `required` (boolean)
|
|
134
455
|
|
|
135
456
|
Indicates if the item is required and the value cannot be empty
|
|
@@ -210,6 +531,71 @@ Indicates the label for the item that has to be displayed in the Settings Panel
|
|
|
210
531
|
|
|
211
532
|
Properties of the `teacherInstructions` object:
|
|
212
533
|
|
|
534
|
+
## `inputConfiguration` (object)
|
|
535
|
+
|
|
536
|
+
Properties of the `inputConfiguration` object:
|
|
537
|
+
|
|
538
|
+
### `math` (object)
|
|
539
|
+
|
|
540
|
+
Properties of the `math` object:
|
|
541
|
+
|
|
542
|
+
#### `disabled` (boolean)
|
|
543
|
+
|
|
544
|
+
Indicates if the plugin is disabled or not
|
|
545
|
+
|
|
546
|
+
### `audio` (object)
|
|
547
|
+
|
|
548
|
+
Properties of the `audio` object:
|
|
549
|
+
|
|
550
|
+
#### `disabled` (boolean)
|
|
551
|
+
|
|
552
|
+
Indicates if the plugin is disabled or not
|
|
553
|
+
|
|
554
|
+
### `video` (object)
|
|
555
|
+
|
|
556
|
+
Properties of the `video` object:
|
|
557
|
+
|
|
558
|
+
#### `disabled` (boolean)
|
|
559
|
+
|
|
560
|
+
Indicates if the plugin is disabled or not
|
|
561
|
+
|
|
562
|
+
### `image` (object)
|
|
563
|
+
|
|
564
|
+
Properties of the `image` object:
|
|
565
|
+
|
|
566
|
+
#### `disabled` (boolean)
|
|
567
|
+
|
|
568
|
+
Indicates if the plugin is disabled or not
|
|
569
|
+
|
|
570
|
+
### `customPlugins` (array)
|
|
571
|
+
|
|
572
|
+
An array of objects that determine custom plugins.
|
|
573
|
+
A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
|
|
574
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
575
|
+
|
|
576
|
+
The object is an array with all elements of the type `object`.
|
|
577
|
+
|
|
578
|
+
The array object has the following properties:
|
|
579
|
+
|
|
580
|
+
#### `event` (string, required)
|
|
581
|
+
|
|
582
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
583
|
+
PIE will emit the event prefixed with "PIE-".
|
|
584
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
585
|
+
|
|
586
|
+
#### `iconAlt` (string, required)
|
|
587
|
+
|
|
588
|
+
The alt for the custom button icon
|
|
589
|
+
|
|
590
|
+
#### `iconType` (string, required)
|
|
591
|
+
|
|
592
|
+
The icon type.
|
|
593
|
+
Currently, only "SVG" is supported.
|
|
594
|
+
|
|
595
|
+
#### `icon` (string, required)
|
|
596
|
+
|
|
597
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
598
|
+
|
|
213
599
|
## `required` (boolean)
|
|
214
600
|
|
|
215
601
|
Indicates if the item is required and the value cannot be empty
|
|
@@ -400,6 +786,179 @@ Default: `true`
|
|
|
400
786
|
|
|
401
787
|
The schema defines the following additional types:
|
|
402
788
|
|
|
789
|
+
## `EditableHtmlConfigureProp` (object)
|
|
790
|
+
|
|
791
|
+
Properties of the `EditableHtmlConfigureProp` object:
|
|
792
|
+
|
|
793
|
+
### `math` (object)
|
|
794
|
+
|
|
795
|
+
Properties of the `math` object:
|
|
796
|
+
|
|
797
|
+
#### `disabled` (boolean)
|
|
798
|
+
|
|
799
|
+
Indicates if the plugin is disabled or not
|
|
800
|
+
|
|
801
|
+
### `audio` (object)
|
|
802
|
+
|
|
803
|
+
Properties of the `audio` object:
|
|
804
|
+
|
|
805
|
+
#### `disabled` (boolean)
|
|
806
|
+
|
|
807
|
+
Indicates if the plugin is disabled or not
|
|
808
|
+
|
|
809
|
+
### `video` (object)
|
|
810
|
+
|
|
811
|
+
Properties of the `video` object:
|
|
812
|
+
|
|
813
|
+
#### `disabled` (boolean)
|
|
814
|
+
|
|
815
|
+
Indicates if the plugin is disabled or not
|
|
816
|
+
|
|
817
|
+
### `image` (object)
|
|
818
|
+
|
|
819
|
+
Properties of the `image` object:
|
|
820
|
+
|
|
821
|
+
#### `disabled` (boolean)
|
|
822
|
+
|
|
823
|
+
Indicates if the plugin is disabled or not
|
|
824
|
+
|
|
825
|
+
### `customPlugins` (array)
|
|
826
|
+
|
|
827
|
+
An array of objects that determine custom plugins.
|
|
828
|
+
A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
|
|
829
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
830
|
+
|
|
831
|
+
The object is an array with all elements of the type `object`.
|
|
832
|
+
|
|
833
|
+
The array object has the following properties:
|
|
834
|
+
|
|
835
|
+
#### `event` (string, required)
|
|
836
|
+
|
|
837
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
838
|
+
PIE will emit the event prefixed with "PIE-".
|
|
839
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
840
|
+
|
|
841
|
+
#### `iconAlt` (string, required)
|
|
842
|
+
|
|
843
|
+
The alt for the custom button icon
|
|
844
|
+
|
|
845
|
+
#### `iconType` (string, required)
|
|
846
|
+
|
|
847
|
+
The icon type.
|
|
848
|
+
Currently, only "SVG" is supported.
|
|
849
|
+
|
|
850
|
+
#### `icon` (string, required)
|
|
851
|
+
|
|
852
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
853
|
+
|
|
854
|
+
## `EditableHtmlButtonConfigure` (object)
|
|
855
|
+
|
|
856
|
+
Properties of the `EditableHtmlButtonConfigure` object:
|
|
857
|
+
|
|
858
|
+
### `disabled` (boolean)
|
|
859
|
+
|
|
860
|
+
Indicates if the plugin is disabled or not
|
|
861
|
+
|
|
862
|
+
## `CustomPlugin` (object)
|
|
863
|
+
|
|
864
|
+
Properties of the `CustomPlugin` object:
|
|
865
|
+
|
|
866
|
+
### `event` (string, required)
|
|
867
|
+
|
|
868
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
869
|
+
PIE will emit the event prefixed with "PIE-".
|
|
870
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
871
|
+
|
|
872
|
+
### `iconAlt` (string, required)
|
|
873
|
+
|
|
874
|
+
The alt for the custom button icon
|
|
875
|
+
|
|
876
|
+
### `iconType` (string, required)
|
|
877
|
+
|
|
878
|
+
The icon type.
|
|
879
|
+
Currently, only "SVG" is supported.
|
|
880
|
+
|
|
881
|
+
### `icon` (string, required)
|
|
882
|
+
|
|
883
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
884
|
+
|
|
885
|
+
## `EditableHtmlPluginConfigure` (object)
|
|
886
|
+
|
|
887
|
+
Properties of the `EditableHtmlPluginConfigure` object:
|
|
888
|
+
|
|
889
|
+
### `inputConfiguration` (object)
|
|
890
|
+
|
|
891
|
+
Properties of the `inputConfiguration` object:
|
|
892
|
+
|
|
893
|
+
#### `math` (object)
|
|
894
|
+
|
|
895
|
+
Properties of the `math` object:
|
|
896
|
+
|
|
897
|
+
##### `disabled` (boolean)
|
|
898
|
+
|
|
899
|
+
Indicates if the plugin is disabled or not
|
|
900
|
+
|
|
901
|
+
#### `audio` (object)
|
|
902
|
+
|
|
903
|
+
Properties of the `audio` object:
|
|
904
|
+
|
|
905
|
+
##### `disabled` (boolean)
|
|
906
|
+
|
|
907
|
+
Indicates if the plugin is disabled or not
|
|
908
|
+
|
|
909
|
+
#### `video` (object)
|
|
910
|
+
|
|
911
|
+
Properties of the `video` object:
|
|
912
|
+
|
|
913
|
+
##### `disabled` (boolean)
|
|
914
|
+
|
|
915
|
+
Indicates if the plugin is disabled or not
|
|
916
|
+
|
|
917
|
+
#### `image` (object)
|
|
918
|
+
|
|
919
|
+
Properties of the `image` object:
|
|
920
|
+
|
|
921
|
+
##### `disabled` (boolean)
|
|
922
|
+
|
|
923
|
+
Indicates if the plugin is disabled or not
|
|
924
|
+
|
|
925
|
+
#### `customPlugins` (array)
|
|
926
|
+
|
|
927
|
+
An array of objects that determine custom plugins.
|
|
928
|
+
A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
|
|
929
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
930
|
+
|
|
931
|
+
The object is an array with all elements of the type `object`.
|
|
932
|
+
|
|
933
|
+
The array object has the following properties:
|
|
934
|
+
|
|
935
|
+
##### `event` (string, required)
|
|
936
|
+
|
|
937
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
938
|
+
PIE will emit the event prefixed with "PIE-".
|
|
939
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
940
|
+
|
|
941
|
+
##### `iconAlt` (string, required)
|
|
942
|
+
|
|
943
|
+
The alt for the custom button icon
|
|
944
|
+
|
|
945
|
+
##### `iconType` (string, required)
|
|
946
|
+
|
|
947
|
+
The icon type.
|
|
948
|
+
Currently, only "SVG" is supported.
|
|
949
|
+
|
|
950
|
+
##### `icon` (string, required)
|
|
951
|
+
|
|
952
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
953
|
+
|
|
954
|
+
### `settings` (boolean)
|
|
955
|
+
|
|
956
|
+
Indicates if the item has to be displayed in the Settings Panel
|
|
957
|
+
|
|
958
|
+
### `label` (string)
|
|
959
|
+
|
|
960
|
+
Indicates the label for the item that has to be displayed in the Settings Panel
|
|
961
|
+
|
|
403
962
|
## `ConfigureProp` (object)
|
|
404
963
|
|
|
405
964
|
Properties of the `ConfigureProp` object:
|
|
@@ -412,9 +971,74 @@ Indicates if the item has to be displayed in the Settings Panel
|
|
|
412
971
|
|
|
413
972
|
Indicates the label for the item that has to be displayed in the Settings Panel
|
|
414
973
|
|
|
415
|
-
## `
|
|
974
|
+
## `EditableHtmlPluginConfigureRequired` (object)
|
|
975
|
+
|
|
976
|
+
Properties of the `EditableHtmlPluginConfigureRequired` object:
|
|
977
|
+
|
|
978
|
+
### `inputConfiguration` (object)
|
|
979
|
+
|
|
980
|
+
Properties of the `inputConfiguration` object:
|
|
981
|
+
|
|
982
|
+
#### `math` (object)
|
|
983
|
+
|
|
984
|
+
Properties of the `math` object:
|
|
985
|
+
|
|
986
|
+
##### `disabled` (boolean)
|
|
987
|
+
|
|
988
|
+
Indicates if the plugin is disabled or not
|
|
989
|
+
|
|
990
|
+
#### `audio` (object)
|
|
991
|
+
|
|
992
|
+
Properties of the `audio` object:
|
|
993
|
+
|
|
994
|
+
##### `disabled` (boolean)
|
|
995
|
+
|
|
996
|
+
Indicates if the plugin is disabled or not
|
|
997
|
+
|
|
998
|
+
#### `video` (object)
|
|
999
|
+
|
|
1000
|
+
Properties of the `video` object:
|
|
1001
|
+
|
|
1002
|
+
##### `disabled` (boolean)
|
|
1003
|
+
|
|
1004
|
+
Indicates if the plugin is disabled or not
|
|
1005
|
+
|
|
1006
|
+
#### `image` (object)
|
|
1007
|
+
|
|
1008
|
+
Properties of the `image` object:
|
|
1009
|
+
|
|
1010
|
+
##### `disabled` (boolean)
|
|
1011
|
+
|
|
1012
|
+
Indicates if the plugin is disabled or not
|
|
1013
|
+
|
|
1014
|
+
#### `customPlugins` (array)
|
|
1015
|
+
|
|
1016
|
+
An array of objects that determine custom plugins.
|
|
1017
|
+
A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
|
|
1018
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
1019
|
+
|
|
1020
|
+
The object is an array with all elements of the type `object`.
|
|
1021
|
+
|
|
1022
|
+
The array object has the following properties:
|
|
1023
|
+
|
|
1024
|
+
##### `event` (string, required)
|
|
1025
|
+
|
|
1026
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
1027
|
+
PIE will emit the event prefixed with "PIE-".
|
|
1028
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
1029
|
+
|
|
1030
|
+
##### `iconAlt` (string, required)
|
|
1031
|
+
|
|
1032
|
+
The alt for the custom button icon
|
|
1033
|
+
|
|
1034
|
+
##### `iconType` (string, required)
|
|
1035
|
+
|
|
1036
|
+
The icon type.
|
|
1037
|
+
Currently, only "SVG" is supported.
|
|
1038
|
+
|
|
1039
|
+
##### `icon` (string, required)
|
|
416
1040
|
|
|
417
|
-
|
|
1041
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
418
1042
|
|
|
419
1043
|
### `required` (boolean)
|
|
420
1044
|
|