@pie-element/drawing-response 7.10.1-next.0 → 7.10.1-next.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/config-schema.json +217 -0
- package/docs/config-schema.json.md +168 -0
- package/docs/pie-schema.json +106 -0
- package/docs/pie-schema.json.md +81 -0
- package/package.json +2 -2
package/docs/config-schema.json
CHANGED
|
@@ -50,6 +50,43 @@
|
|
|
50
50
|
"title": "disabled"
|
|
51
51
|
}
|
|
52
52
|
}
|
|
53
|
+
},
|
|
54
|
+
"customPlugins": {
|
|
55
|
+
"description": "An array of objects that determine custom plugins.\nA custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).\nExample can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.",
|
|
56
|
+
"type": "array",
|
|
57
|
+
"items": {
|
|
58
|
+
"title": "CustomPlugin",
|
|
59
|
+
"type": "object",
|
|
60
|
+
"properties": {
|
|
61
|
+
"event": {
|
|
62
|
+
"description": "The name of the custom event. It needs to be valid (only letters, numbers and \"_\" can be used).\nPIE will emit the event prefixed with \"PIE-\".\nEg: event = 'client_custom_event_A' => the emitted event will be \"PIE-client_custom_event_A\"",
|
|
63
|
+
"type": "string",
|
|
64
|
+
"title": "event"
|
|
65
|
+
},
|
|
66
|
+
"iconAlt": {
|
|
67
|
+
"description": "The alt for the custom button icon",
|
|
68
|
+
"type": "string",
|
|
69
|
+
"title": "iconAlt"
|
|
70
|
+
},
|
|
71
|
+
"iconType": {
|
|
72
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
73
|
+
"type": "string",
|
|
74
|
+
"title": "iconType"
|
|
75
|
+
},
|
|
76
|
+
"icon": {
|
|
77
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
78
|
+
"type": "string",
|
|
79
|
+
"title": "icon"
|
|
80
|
+
}
|
|
81
|
+
},
|
|
82
|
+
"required": [
|
|
83
|
+
"event",
|
|
84
|
+
"icon",
|
|
85
|
+
"iconAlt",
|
|
86
|
+
"iconType"
|
|
87
|
+
]
|
|
88
|
+
},
|
|
89
|
+
"title": "customPlugins"
|
|
53
90
|
}
|
|
54
91
|
}
|
|
55
92
|
},
|
|
@@ -178,6 +215,43 @@
|
|
|
178
215
|
"title": "disabled"
|
|
179
216
|
}
|
|
180
217
|
}
|
|
218
|
+
},
|
|
219
|
+
"customPlugins": {
|
|
220
|
+
"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.",
|
|
221
|
+
"type": "array",
|
|
222
|
+
"items": {
|
|
223
|
+
"title": "CustomPlugin",
|
|
224
|
+
"type": "object",
|
|
225
|
+
"properties": {
|
|
226
|
+
"event": {
|
|
227
|
+
"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\"",
|
|
228
|
+
"type": "string",
|
|
229
|
+
"title": "event"
|
|
230
|
+
},
|
|
231
|
+
"iconAlt": {
|
|
232
|
+
"description": "The alt for the custom button icon",
|
|
233
|
+
"type": "string",
|
|
234
|
+
"title": "iconAlt"
|
|
235
|
+
},
|
|
236
|
+
"iconType": {
|
|
237
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
238
|
+
"type": "string",
|
|
239
|
+
"title": "iconType"
|
|
240
|
+
},
|
|
241
|
+
"icon": {
|
|
242
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
243
|
+
"type": "string",
|
|
244
|
+
"title": "icon"
|
|
245
|
+
}
|
|
246
|
+
},
|
|
247
|
+
"required": [
|
|
248
|
+
"event",
|
|
249
|
+
"icon",
|
|
250
|
+
"iconAlt",
|
|
251
|
+
"iconType"
|
|
252
|
+
]
|
|
253
|
+
},
|
|
254
|
+
"title": "customPlugins"
|
|
181
255
|
}
|
|
182
256
|
}
|
|
183
257
|
},
|
|
@@ -249,6 +323,43 @@
|
|
|
249
323
|
"title": "disabled"
|
|
250
324
|
}
|
|
251
325
|
}
|
|
326
|
+
},
|
|
327
|
+
"customPlugins": {
|
|
328
|
+
"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.",
|
|
329
|
+
"type": "array",
|
|
330
|
+
"items": {
|
|
331
|
+
"title": "CustomPlugin",
|
|
332
|
+
"type": "object",
|
|
333
|
+
"properties": {
|
|
334
|
+
"event": {
|
|
335
|
+
"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\"",
|
|
336
|
+
"type": "string",
|
|
337
|
+
"title": "event"
|
|
338
|
+
},
|
|
339
|
+
"iconAlt": {
|
|
340
|
+
"description": "The alt for the custom button icon",
|
|
341
|
+
"type": "string",
|
|
342
|
+
"title": "iconAlt"
|
|
343
|
+
},
|
|
344
|
+
"iconType": {
|
|
345
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
346
|
+
"type": "string",
|
|
347
|
+
"title": "iconType"
|
|
348
|
+
},
|
|
349
|
+
"icon": {
|
|
350
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
351
|
+
"type": "string",
|
|
352
|
+
"title": "icon"
|
|
353
|
+
}
|
|
354
|
+
},
|
|
355
|
+
"required": [
|
|
356
|
+
"event",
|
|
357
|
+
"icon",
|
|
358
|
+
"iconAlt",
|
|
359
|
+
"iconType"
|
|
360
|
+
]
|
|
361
|
+
},
|
|
362
|
+
"title": "customPlugins"
|
|
252
363
|
}
|
|
253
364
|
}
|
|
254
365
|
},
|
|
@@ -519,6 +630,43 @@
|
|
|
519
630
|
"title": "disabled"
|
|
520
631
|
}
|
|
521
632
|
}
|
|
633
|
+
},
|
|
634
|
+
"customPlugins": {
|
|
635
|
+
"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.",
|
|
636
|
+
"type": "array",
|
|
637
|
+
"items": {
|
|
638
|
+
"title": "CustomPlugin",
|
|
639
|
+
"type": "object",
|
|
640
|
+
"properties": {
|
|
641
|
+
"event": {
|
|
642
|
+
"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\"",
|
|
643
|
+
"type": "string",
|
|
644
|
+
"title": "event"
|
|
645
|
+
},
|
|
646
|
+
"iconAlt": {
|
|
647
|
+
"description": "The alt for the custom button icon",
|
|
648
|
+
"type": "string",
|
|
649
|
+
"title": "iconAlt"
|
|
650
|
+
},
|
|
651
|
+
"iconType": {
|
|
652
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
653
|
+
"type": "string",
|
|
654
|
+
"title": "iconType"
|
|
655
|
+
},
|
|
656
|
+
"icon": {
|
|
657
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
658
|
+
"type": "string",
|
|
659
|
+
"title": "icon"
|
|
660
|
+
}
|
|
661
|
+
},
|
|
662
|
+
"required": [
|
|
663
|
+
"event",
|
|
664
|
+
"icon",
|
|
665
|
+
"iconAlt",
|
|
666
|
+
"iconType"
|
|
667
|
+
]
|
|
668
|
+
},
|
|
669
|
+
"title": "customPlugins"
|
|
522
670
|
}
|
|
523
671
|
}
|
|
524
672
|
},
|
|
@@ -533,6 +681,38 @@
|
|
|
533
681
|
}
|
|
534
682
|
}
|
|
535
683
|
},
|
|
684
|
+
"CustomPlugin": {
|
|
685
|
+
"title": "CustomPlugin",
|
|
686
|
+
"type": "object",
|
|
687
|
+
"properties": {
|
|
688
|
+
"event": {
|
|
689
|
+
"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\"",
|
|
690
|
+
"type": "string",
|
|
691
|
+
"title": "event"
|
|
692
|
+
},
|
|
693
|
+
"iconAlt": {
|
|
694
|
+
"description": "The alt for the custom button icon",
|
|
695
|
+
"type": "string",
|
|
696
|
+
"title": "iconAlt"
|
|
697
|
+
},
|
|
698
|
+
"iconType": {
|
|
699
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
700
|
+
"type": "string",
|
|
701
|
+
"title": "iconType"
|
|
702
|
+
},
|
|
703
|
+
"icon": {
|
|
704
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
705
|
+
"type": "string",
|
|
706
|
+
"title": "icon"
|
|
707
|
+
}
|
|
708
|
+
},
|
|
709
|
+
"required": [
|
|
710
|
+
"event",
|
|
711
|
+
"icon",
|
|
712
|
+
"iconAlt",
|
|
713
|
+
"iconType"
|
|
714
|
+
]
|
|
715
|
+
},
|
|
536
716
|
"ConfigurePropWithEnabled": {
|
|
537
717
|
"title": "ConfigurePropWithEnabled",
|
|
538
718
|
"type": "object",
|
|
@@ -621,6 +801,43 @@
|
|
|
621
801
|
"title": "disabled"
|
|
622
802
|
}
|
|
623
803
|
}
|
|
804
|
+
},
|
|
805
|
+
"customPlugins": {
|
|
806
|
+
"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.",
|
|
807
|
+
"type": "array",
|
|
808
|
+
"items": {
|
|
809
|
+
"title": "CustomPlugin",
|
|
810
|
+
"type": "object",
|
|
811
|
+
"properties": {
|
|
812
|
+
"event": {
|
|
813
|
+
"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\"",
|
|
814
|
+
"type": "string",
|
|
815
|
+
"title": "event"
|
|
816
|
+
},
|
|
817
|
+
"iconAlt": {
|
|
818
|
+
"description": "The alt for the custom button icon",
|
|
819
|
+
"type": "string",
|
|
820
|
+
"title": "iconAlt"
|
|
821
|
+
},
|
|
822
|
+
"iconType": {
|
|
823
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
824
|
+
"type": "string",
|
|
825
|
+
"title": "iconType"
|
|
826
|
+
},
|
|
827
|
+
"icon": {
|
|
828
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
829
|
+
"type": "string",
|
|
830
|
+
"title": "icon"
|
|
831
|
+
}
|
|
832
|
+
},
|
|
833
|
+
"required": [
|
|
834
|
+
"event",
|
|
835
|
+
"icon",
|
|
836
|
+
"iconAlt",
|
|
837
|
+
"iconType"
|
|
838
|
+
]
|
|
839
|
+
},
|
|
840
|
+
"title": "customPlugins"
|
|
624
841
|
}
|
|
625
842
|
}
|
|
626
843
|
},
|
|
@@ -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
|
# `backgroundImage` (object)
|
|
42
71
|
|
|
43
72
|
Properties of the `backgroundImage` object:
|
|
@@ -135,6 +164,35 @@ Properties of the `image` object:
|
|
|
135
164
|
|
|
136
165
|
Indicates if the plugin is disabled or not
|
|
137
166
|
|
|
167
|
+
### `customPlugins` (array)
|
|
168
|
+
|
|
169
|
+
An array of objects that determine custom plugins.
|
|
170
|
+
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).
|
|
171
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
172
|
+
|
|
173
|
+
The object is an array with all elements of the type `object`.
|
|
174
|
+
|
|
175
|
+
The array object has the following properties:
|
|
176
|
+
|
|
177
|
+
#### `event` (string, required)
|
|
178
|
+
|
|
179
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
180
|
+
PIE will emit the event prefixed with "PIE-".
|
|
181
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
182
|
+
|
|
183
|
+
#### `iconAlt` (string, required)
|
|
184
|
+
|
|
185
|
+
The alt for the custom button icon
|
|
186
|
+
|
|
187
|
+
#### `iconType` (string, required)
|
|
188
|
+
|
|
189
|
+
The icon type.
|
|
190
|
+
Currently, only "SVG" is supported.
|
|
191
|
+
|
|
192
|
+
#### `icon` (string, required)
|
|
193
|
+
|
|
194
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
195
|
+
|
|
138
196
|
## `required` (boolean)
|
|
139
197
|
|
|
140
198
|
Indicates if the item is required and the value cannot be empty
|
|
@@ -187,6 +245,35 @@ Properties of the `image` object:
|
|
|
187
245
|
|
|
188
246
|
Indicates if the plugin is disabled or not
|
|
189
247
|
|
|
248
|
+
### `customPlugins` (array)
|
|
249
|
+
|
|
250
|
+
An array of objects that determine custom plugins.
|
|
251
|
+
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).
|
|
252
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
253
|
+
|
|
254
|
+
The object is an array with all elements of the type `object`.
|
|
255
|
+
|
|
256
|
+
The array object has the following properties:
|
|
257
|
+
|
|
258
|
+
#### `event` (string, required)
|
|
259
|
+
|
|
260
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
261
|
+
PIE will emit the event prefixed with "PIE-".
|
|
262
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
263
|
+
|
|
264
|
+
#### `iconAlt` (string, required)
|
|
265
|
+
|
|
266
|
+
The alt for the custom button icon
|
|
267
|
+
|
|
268
|
+
#### `iconType` (string, required)
|
|
269
|
+
|
|
270
|
+
The icon type.
|
|
271
|
+
Currently, only "SVG" is supported.
|
|
272
|
+
|
|
273
|
+
#### `icon` (string, required)
|
|
274
|
+
|
|
275
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
276
|
+
|
|
190
277
|
## `required` (boolean)
|
|
191
278
|
|
|
192
279
|
Indicates if the item is required and the value cannot be empty
|
|
@@ -396,6 +483,35 @@ Properties of the `image` object:
|
|
|
396
483
|
|
|
397
484
|
Indicates if the plugin is disabled or not
|
|
398
485
|
|
|
486
|
+
### `customPlugins` (array)
|
|
487
|
+
|
|
488
|
+
An array of objects that determine custom plugins.
|
|
489
|
+
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).
|
|
490
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
491
|
+
|
|
492
|
+
The object is an array with all elements of the type `object`.
|
|
493
|
+
|
|
494
|
+
The array object has the following properties:
|
|
495
|
+
|
|
496
|
+
#### `event` (string, required)
|
|
497
|
+
|
|
498
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
499
|
+
PIE will emit the event prefixed with "PIE-".
|
|
500
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
501
|
+
|
|
502
|
+
#### `iconAlt` (string, required)
|
|
503
|
+
|
|
504
|
+
The alt for the custom button icon
|
|
505
|
+
|
|
506
|
+
#### `iconType` (string, required)
|
|
507
|
+
|
|
508
|
+
The icon type.
|
|
509
|
+
Currently, only "SVG" is supported.
|
|
510
|
+
|
|
511
|
+
#### `icon` (string, required)
|
|
512
|
+
|
|
513
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
514
|
+
|
|
399
515
|
## `EditableHtmlButtonConfigure` (object)
|
|
400
516
|
|
|
401
517
|
Properties of the `EditableHtmlButtonConfigure` object:
|
|
@@ -404,6 +520,29 @@ Properties of the `EditableHtmlButtonConfigure` object:
|
|
|
404
520
|
|
|
405
521
|
Indicates if the plugin is disabled or not
|
|
406
522
|
|
|
523
|
+
## `CustomPlugin` (object)
|
|
524
|
+
|
|
525
|
+
Properties of the `CustomPlugin` object:
|
|
526
|
+
|
|
527
|
+
### `event` (string, required)
|
|
528
|
+
|
|
529
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
530
|
+
PIE will emit the event prefixed with "PIE-".
|
|
531
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
532
|
+
|
|
533
|
+
### `iconAlt` (string, required)
|
|
534
|
+
|
|
535
|
+
The alt for the custom button icon
|
|
536
|
+
|
|
537
|
+
### `iconType` (string, required)
|
|
538
|
+
|
|
539
|
+
The icon type.
|
|
540
|
+
Currently, only "SVG" is supported.
|
|
541
|
+
|
|
542
|
+
### `icon` (string, required)
|
|
543
|
+
|
|
544
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
545
|
+
|
|
407
546
|
## `ConfigurePropWithEnabled` (object)
|
|
408
547
|
|
|
409
548
|
Properties of the `ConfigurePropWithEnabled` object:
|
|
@@ -473,6 +612,35 @@ Properties of the `image` object:
|
|
|
473
612
|
|
|
474
613
|
Indicates if the plugin is disabled or not
|
|
475
614
|
|
|
615
|
+
#### `customPlugins` (array)
|
|
616
|
+
|
|
617
|
+
An array of objects that determine custom plugins.
|
|
618
|
+
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).
|
|
619
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
620
|
+
|
|
621
|
+
The object is an array with all elements of the type `object`.
|
|
622
|
+
|
|
623
|
+
The array object has the following properties:
|
|
624
|
+
|
|
625
|
+
##### `event` (string, required)
|
|
626
|
+
|
|
627
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
628
|
+
PIE will emit the event prefixed with "PIE-".
|
|
629
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
630
|
+
|
|
631
|
+
##### `iconAlt` (string, required)
|
|
632
|
+
|
|
633
|
+
The alt for the custom button icon
|
|
634
|
+
|
|
635
|
+
##### `iconType` (string, required)
|
|
636
|
+
|
|
637
|
+
The icon type.
|
|
638
|
+
Currently, only "SVG" is supported.
|
|
639
|
+
|
|
640
|
+
##### `icon` (string, required)
|
|
641
|
+
|
|
642
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
643
|
+
|
|
476
644
|
### `required` (boolean)
|
|
477
645
|
|
|
478
646
|
Indicates if the item is required and the value cannot be empty
|
package/docs/pie-schema.json
CHANGED
|
@@ -162,6 +162,43 @@
|
|
|
162
162
|
"title": "disabled"
|
|
163
163
|
}
|
|
164
164
|
}
|
|
165
|
+
},
|
|
166
|
+
"customPlugins": {
|
|
167
|
+
"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.",
|
|
168
|
+
"type": "array",
|
|
169
|
+
"items": {
|
|
170
|
+
"title": "CustomPlugin",
|
|
171
|
+
"type": "object",
|
|
172
|
+
"properties": {
|
|
173
|
+
"event": {
|
|
174
|
+
"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\"",
|
|
175
|
+
"type": "string",
|
|
176
|
+
"title": "event"
|
|
177
|
+
},
|
|
178
|
+
"iconAlt": {
|
|
179
|
+
"description": "The alt for the custom button icon",
|
|
180
|
+
"type": "string",
|
|
181
|
+
"title": "iconAlt"
|
|
182
|
+
},
|
|
183
|
+
"iconType": {
|
|
184
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
185
|
+
"type": "string",
|
|
186
|
+
"title": "iconType"
|
|
187
|
+
},
|
|
188
|
+
"icon": {
|
|
189
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
190
|
+
"type": "string",
|
|
191
|
+
"title": "icon"
|
|
192
|
+
}
|
|
193
|
+
},
|
|
194
|
+
"required": [
|
|
195
|
+
"event",
|
|
196
|
+
"icon",
|
|
197
|
+
"iconAlt",
|
|
198
|
+
"iconType"
|
|
199
|
+
]
|
|
200
|
+
},
|
|
201
|
+
"title": "customPlugins"
|
|
165
202
|
}
|
|
166
203
|
}
|
|
167
204
|
},
|
|
@@ -176,6 +213,38 @@
|
|
|
176
213
|
}
|
|
177
214
|
}
|
|
178
215
|
},
|
|
216
|
+
"CustomPlugin": {
|
|
217
|
+
"title": "CustomPlugin",
|
|
218
|
+
"type": "object",
|
|
219
|
+
"properties": {
|
|
220
|
+
"event": {
|
|
221
|
+
"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\"",
|
|
222
|
+
"type": "string",
|
|
223
|
+
"title": "event"
|
|
224
|
+
},
|
|
225
|
+
"iconAlt": {
|
|
226
|
+
"description": "The alt for the custom button icon",
|
|
227
|
+
"type": "string",
|
|
228
|
+
"title": "iconAlt"
|
|
229
|
+
},
|
|
230
|
+
"iconType": {
|
|
231
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
232
|
+
"type": "string",
|
|
233
|
+
"title": "iconType"
|
|
234
|
+
},
|
|
235
|
+
"icon": {
|
|
236
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
237
|
+
"type": "string",
|
|
238
|
+
"title": "icon"
|
|
239
|
+
}
|
|
240
|
+
},
|
|
241
|
+
"required": [
|
|
242
|
+
"event",
|
|
243
|
+
"icon",
|
|
244
|
+
"iconAlt",
|
|
245
|
+
"iconType"
|
|
246
|
+
]
|
|
247
|
+
},
|
|
179
248
|
"ConfigurePropWithEnabled": {
|
|
180
249
|
"title": "ConfigurePropWithEnabled",
|
|
181
250
|
"type": "object",
|
|
@@ -264,6 +333,43 @@
|
|
|
264
333
|
"title": "disabled"
|
|
265
334
|
}
|
|
266
335
|
}
|
|
336
|
+
},
|
|
337
|
+
"customPlugins": {
|
|
338
|
+
"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.",
|
|
339
|
+
"type": "array",
|
|
340
|
+
"items": {
|
|
341
|
+
"title": "CustomPlugin",
|
|
342
|
+
"type": "object",
|
|
343
|
+
"properties": {
|
|
344
|
+
"event": {
|
|
345
|
+
"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\"",
|
|
346
|
+
"type": "string",
|
|
347
|
+
"title": "event"
|
|
348
|
+
},
|
|
349
|
+
"iconAlt": {
|
|
350
|
+
"description": "The alt for the custom button icon",
|
|
351
|
+
"type": "string",
|
|
352
|
+
"title": "iconAlt"
|
|
353
|
+
},
|
|
354
|
+
"iconType": {
|
|
355
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
356
|
+
"type": "string",
|
|
357
|
+
"title": "iconType"
|
|
358
|
+
},
|
|
359
|
+
"icon": {
|
|
360
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
361
|
+
"type": "string",
|
|
362
|
+
"title": "icon"
|
|
363
|
+
}
|
|
364
|
+
},
|
|
365
|
+
"required": [
|
|
366
|
+
"event",
|
|
367
|
+
"icon",
|
|
368
|
+
"iconAlt",
|
|
369
|
+
"iconType"
|
|
370
|
+
]
|
|
371
|
+
},
|
|
372
|
+
"title": "customPlugins"
|
|
267
373
|
}
|
|
268
374
|
}
|
|
269
375
|
},
|
package/docs/pie-schema.json.md
CHANGED
|
@@ -124,6 +124,35 @@ Properties of the `image` object:
|
|
|
124
124
|
|
|
125
125
|
Indicates if the plugin is disabled or not
|
|
126
126
|
|
|
127
|
+
### `customPlugins` (array)
|
|
128
|
+
|
|
129
|
+
An array of objects that determine custom plugins.
|
|
130
|
+
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).
|
|
131
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
132
|
+
|
|
133
|
+
The object is an array with all elements of the type `object`.
|
|
134
|
+
|
|
135
|
+
The array object has the following properties:
|
|
136
|
+
|
|
137
|
+
#### `event` (string, required)
|
|
138
|
+
|
|
139
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
140
|
+
PIE will emit the event prefixed with "PIE-".
|
|
141
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
142
|
+
|
|
143
|
+
#### `iconAlt` (string, required)
|
|
144
|
+
|
|
145
|
+
The alt for the custom button icon
|
|
146
|
+
|
|
147
|
+
#### `iconType` (string, required)
|
|
148
|
+
|
|
149
|
+
The icon type.
|
|
150
|
+
Currently, only "SVG" is supported.
|
|
151
|
+
|
|
152
|
+
#### `icon` (string, required)
|
|
153
|
+
|
|
154
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
155
|
+
|
|
127
156
|
## `EditableHtmlButtonConfigure` (object)
|
|
128
157
|
|
|
129
158
|
Properties of the `EditableHtmlButtonConfigure` object:
|
|
@@ -132,6 +161,29 @@ Properties of the `EditableHtmlButtonConfigure` object:
|
|
|
132
161
|
|
|
133
162
|
Indicates if the plugin is disabled or not
|
|
134
163
|
|
|
164
|
+
## `CustomPlugin` (object)
|
|
165
|
+
|
|
166
|
+
Properties of the `CustomPlugin` object:
|
|
167
|
+
|
|
168
|
+
### `event` (string, required)
|
|
169
|
+
|
|
170
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
171
|
+
PIE will emit the event prefixed with "PIE-".
|
|
172
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
173
|
+
|
|
174
|
+
### `iconAlt` (string, required)
|
|
175
|
+
|
|
176
|
+
The alt for the custom button icon
|
|
177
|
+
|
|
178
|
+
### `iconType` (string, required)
|
|
179
|
+
|
|
180
|
+
The icon type.
|
|
181
|
+
Currently, only "SVG" is supported.
|
|
182
|
+
|
|
183
|
+
### `icon` (string, required)
|
|
184
|
+
|
|
185
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
186
|
+
|
|
135
187
|
## `ConfigurePropWithEnabled` (object)
|
|
136
188
|
|
|
137
189
|
Properties of the `ConfigurePropWithEnabled` object:
|
|
@@ -201,6 +253,35 @@ Properties of the `image` object:
|
|
|
201
253
|
|
|
202
254
|
Indicates if the plugin is disabled or not
|
|
203
255
|
|
|
256
|
+
#### `customPlugins` (array)
|
|
257
|
+
|
|
258
|
+
An array of objects that determine custom plugins.
|
|
259
|
+
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).
|
|
260
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
261
|
+
|
|
262
|
+
The object is an array with all elements of the type `object`.
|
|
263
|
+
|
|
264
|
+
The array object has the following properties:
|
|
265
|
+
|
|
266
|
+
##### `event` (string, required)
|
|
267
|
+
|
|
268
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
269
|
+
PIE will emit the event prefixed with "PIE-".
|
|
270
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
271
|
+
|
|
272
|
+
##### `iconAlt` (string, required)
|
|
273
|
+
|
|
274
|
+
The alt for the custom button icon
|
|
275
|
+
|
|
276
|
+
##### `iconType` (string, required)
|
|
277
|
+
|
|
278
|
+
The icon type.
|
|
279
|
+
Currently, only "SVG" is supported.
|
|
280
|
+
|
|
281
|
+
##### `icon` (string, required)
|
|
282
|
+
|
|
283
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
284
|
+
|
|
204
285
|
### `required` (boolean)
|
|
205
286
|
|
|
206
287
|
Indicates if the item is required and the value cannot be empty
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@pie-element/drawing-response",
|
|
3
|
-
"version": "7.10.1-next.
|
|
3
|
+
"version": "7.10.1-next.16+44cb8eb36",
|
|
4
4
|
"description": "",
|
|
5
5
|
"repository": "pie-framework/pie-elements",
|
|
6
6
|
"publishConfig": {
|
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
},
|
|
24
24
|
"author": "pie framework developers",
|
|
25
25
|
"license": "ISC",
|
|
26
|
-
"gitHead": "
|
|
26
|
+
"gitHead": "44cb8eb36e997cd5218007c604c8d94137022f6e",
|
|
27
27
|
"scripts": {
|
|
28
28
|
"postpublish": "../../scripts/postpublish"
|
|
29
29
|
},
|