@ui5/webcomponents-ai 2.20.0-rc.2 → 2.20.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 +16 -0
- package/dist/.tsbuildinfo +1 -1
- package/dist/Input.d.ts +2 -4
- package/dist/Input.js +2 -2
- package/dist/Input.js.map +1 -1
- package/dist/ToolbarLabel.d.ts +1 -1
- package/dist/ToolbarLabel.js +1 -1
- package/dist/ToolbarLabel.js.map +1 -1
- package/dist/custom-elements-internal.json +1781 -484
- package/dist/custom-elements.json +1484 -356
- package/dist/vscode.html-custom-data.json +97 -46
- package/dist/web-types.json +262 -127
- package/package.json +10 -8
|
@@ -37,86 +37,104 @@
|
|
|
37
37
|
"members": [
|
|
38
38
|
{
|
|
39
39
|
"kind": "field",
|
|
40
|
-
"name": "
|
|
40
|
+
"name": "accessibilityAttributes",
|
|
41
41
|
"type": {
|
|
42
|
-
"text": "
|
|
42
|
+
"text": "AIButtonAccessibilityAttributes",
|
|
43
43
|
"references": [
|
|
44
44
|
{
|
|
45
|
-
"name": "
|
|
46
|
-
"package": "@ui5/webcomponents",
|
|
47
|
-
"module": "dist/
|
|
45
|
+
"name": "AIButtonAccessibilityAttributes",
|
|
46
|
+
"package": "@ui5/webcomponents-ai",
|
|
47
|
+
"module": "dist/Button.js"
|
|
48
48
|
}
|
|
49
49
|
]
|
|
50
50
|
},
|
|
51
|
-
"default": "
|
|
52
|
-
"description": "Defines the component
|
|
51
|
+
"default": "{}",
|
|
52
|
+
"description": "Defines the additional accessibility attributes that will be applied to the component.\n\nThis property allows for fine-tuned control of ARIA attributes for screen reader support.\nIt accepts an object with the following optional fields:\n\n- **root**: Accessibility attributes that will be applied to the root element.\n - **hasPopup**: Indicates the availability and type of interactive popup element (such as a menu or dialog).\n Accepts string values: `\"dialog\"`, `\"grid\"`, `\"listbox\"`, `\"menu\"`, or `\"tree\"`.\n - **roleDescription**: Defines a human-readable description for the button's role.\n Accepts any string value.\n - **title**: Specifies a tooltip or description for screen readers.\n Accepts any string value.\n- **ariaKeyShortcuts**: Defines keyboard shortcuts that activate or focus the button.\n\n- **arrowButton**: Accessibility attributes that will be applied to the arrow (split) button element.\n - **hasPopup**: Indicates the type of popup triggered by the arrow button.\n Accepts string values: `\"dialog\"`, `\"grid\"`, `\"listbox\"`, `\"menu\"`, or `\"tree\"`.\n - **expanded**: Indicates whether the popup controlled by the arrow button is currently expanded.\n Accepts boolean values: `true` or `false`.",
|
|
53
53
|
"privacy": "public"
|
|
54
54
|
},
|
|
55
55
|
{
|
|
56
56
|
"kind": "field",
|
|
57
|
-
"name": "
|
|
57
|
+
"name": "arrowButtonPressed",
|
|
58
58
|
"type": {
|
|
59
59
|
"text": "boolean"
|
|
60
60
|
},
|
|
61
61
|
"default": "false",
|
|
62
|
-
"description": "Defines
|
|
62
|
+
"description": "Defines the active state of the arrow button in split mode.\nSet to true when the button is in split mode and a menu with additional options\nis opened by the arrow button. Set back to false when the menu is closed.",
|
|
63
63
|
"privacy": "public"
|
|
64
64
|
},
|
|
65
65
|
{
|
|
66
66
|
"kind": "field",
|
|
67
|
-
"name": "
|
|
67
|
+
"name": "design",
|
|
68
68
|
"type": {
|
|
69
|
-
"text": "
|
|
69
|
+
"text": "ButtonDesign | undefined",
|
|
70
|
+
"references": [
|
|
71
|
+
{
|
|
72
|
+
"name": "ButtonDesign",
|
|
73
|
+
"package": "@ui5/webcomponents",
|
|
74
|
+
"module": "dist/types/ButtonDesign.js"
|
|
75
|
+
}
|
|
76
|
+
]
|
|
70
77
|
},
|
|
71
|
-
"
|
|
72
|
-
"
|
|
78
|
+
"default": "\"Default\"",
|
|
79
|
+
"description": "Defines the component design.",
|
|
73
80
|
"privacy": "public"
|
|
74
81
|
},
|
|
75
82
|
{
|
|
76
83
|
"kind": "field",
|
|
77
|
-
"name": "
|
|
84
|
+
"name": "disabled",
|
|
78
85
|
"type": {
|
|
79
86
|
"text": "boolean"
|
|
80
87
|
},
|
|
81
88
|
"default": "false",
|
|
82
|
-
"description": "Defines
|
|
89
|
+
"description": "Defines whether the component is disabled.\nA disabled component can't be pressed or\nfocused, and it is not in the tab chain.",
|
|
83
90
|
"privacy": "public"
|
|
84
91
|
},
|
|
85
92
|
{
|
|
86
93
|
"kind": "field",
|
|
87
|
-
"name": "
|
|
94
|
+
"name": "state",
|
|
88
95
|
"type": {
|
|
89
|
-
"text": "
|
|
90
|
-
"references": [
|
|
91
|
-
{
|
|
92
|
-
"name": "AIButtonAccessibilityAttributes",
|
|
93
|
-
"package": "@ui5/webcomponents-ai",
|
|
94
|
-
"module": "dist/Button.js"
|
|
95
|
-
}
|
|
96
|
-
]
|
|
96
|
+
"text": "string | undefined"
|
|
97
97
|
},
|
|
98
|
-
"
|
|
99
|
-
"
|
|
98
|
+
"description": "Defines the current state of the component.",
|
|
99
|
+
"default": "undefined",
|
|
100
100
|
"privacy": "public"
|
|
101
101
|
}
|
|
102
102
|
],
|
|
103
103
|
"events": [
|
|
104
104
|
{
|
|
105
|
-
"name": "click",
|
|
105
|
+
"name": "arrow-button-click",
|
|
106
106
|
"type": {
|
|
107
107
|
"text": "CustomEvent"
|
|
108
108
|
},
|
|
109
|
-
"description": "Fired when the component is activated either
|
|
109
|
+
"description": "Fired when the component is in split mode and after the arrow button\nis activated either by clicking or tapping it or by using the [Arrow Up] / [Arrow Down],\n[Alt] + [Arrow Up]/ [Arrow Down], or [F4] keyboard keys."
|
|
110
110
|
},
|
|
111
111
|
{
|
|
112
|
-
"name": "
|
|
112
|
+
"name": "click",
|
|
113
113
|
"type": {
|
|
114
114
|
"text": "CustomEvent"
|
|
115
115
|
},
|
|
116
|
-
"description": "Fired when the component is
|
|
116
|
+
"description": "Fired when the component is activated either with a\nmouse/tap or by using the Enter or Space key."
|
|
117
117
|
}
|
|
118
118
|
],
|
|
119
119
|
"attributes": [
|
|
120
|
+
{
|
|
121
|
+
"description": "Defines the additional accessibility attributes that will be applied to the component.\n\nThis property allows for fine-tuned control of ARIA attributes for screen reader support.\nIt accepts an object with the following optional fields:\n\n- **root**: Accessibility attributes that will be applied to the root element.\n - **hasPopup**: Indicates the availability and type of interactive popup element (such as a menu or dialog).\n Accepts string values: `\"dialog\"`, `\"grid\"`, `\"listbox\"`, `\"menu\"`, or `\"tree\"`.\n - **roleDescription**: Defines a human-readable description for the button's role.\n Accepts any string value.\n - **title**: Specifies a tooltip or description for screen readers.\n Accepts any string value.\n- **ariaKeyShortcuts**: Defines keyboard shortcuts that activate or focus the button.\n\n- **arrowButton**: Accessibility attributes that will be applied to the arrow (split) button element.\n - **hasPopup**: Indicates the type of popup triggered by the arrow button.\n Accepts string values: `\"dialog\"`, `\"grid\"`, `\"listbox\"`, `\"menu\"`, or `\"tree\"`.\n - **expanded**: Indicates whether the popup controlled by the arrow button is currently expanded.\n Accepts boolean values: `true` or `false`.",
|
|
122
|
+
"name": "accessibility-attributes",
|
|
123
|
+
"default": "{}",
|
|
124
|
+
"fieldName": "accessibilityAttributes",
|
|
125
|
+
"type": {
|
|
126
|
+
"text": "AIButtonAccessibilityAttributes"
|
|
127
|
+
}
|
|
128
|
+
},
|
|
129
|
+
{
|
|
130
|
+
"description": "Defines the active state of the arrow button in split mode.\nSet to true when the button is in split mode and a menu with additional options\nis opened by the arrow button. Set back to false when the menu is closed.",
|
|
131
|
+
"name": "arrow-button-pressed",
|
|
132
|
+
"default": "false",
|
|
133
|
+
"fieldName": "arrowButtonPressed",
|
|
134
|
+
"type": {
|
|
135
|
+
"text": "boolean"
|
|
136
|
+
}
|
|
137
|
+
},
|
|
120
138
|
{
|
|
121
139
|
"description": "Defines the component design.",
|
|
122
140
|
"name": "design",
|
|
@@ -143,24 +161,6 @@
|
|
|
143
161
|
"type": {
|
|
144
162
|
"text": "string | undefined"
|
|
145
163
|
}
|
|
146
|
-
},
|
|
147
|
-
{
|
|
148
|
-
"description": "Defines the active state of the arrow button in split mode.\nSet to true when the button is in split mode and a menu with additional options\nis opened by the arrow button. Set back to false when the menu is closed.",
|
|
149
|
-
"name": "arrow-button-pressed",
|
|
150
|
-
"default": "false",
|
|
151
|
-
"fieldName": "arrowButtonPressed",
|
|
152
|
-
"type": {
|
|
153
|
-
"text": "boolean"
|
|
154
|
-
}
|
|
155
|
-
},
|
|
156
|
-
{
|
|
157
|
-
"description": "Defines the additional accessibility attributes that will be applied to the component.\n\nThis property allows for fine-tuned control of ARIA attributes for screen reader support.\nIt accepts an object with the following optional fields:\n\n- **root**: Accessibility attributes that will be applied to the root element.\n - **hasPopup**: Indicates the availability and type of interactive popup element (such as a menu or dialog).\n Accepts string values: `\"dialog\"`, `\"grid\"`, `\"listbox\"`, `\"menu\"`, or `\"tree\"`.\n - **roleDescription**: Defines a human-readable description for the button's role.\n Accepts any string value.\n - **title**: Specifies a tooltip or description for screen readers.\n Accepts any string value.\n- **ariaKeyShortcuts**: Defines keyboard shortcuts that activate or focus the button.\n\n- **arrowButton**: Accessibility attributes that will be applied to the arrow (split) button element.\n - **hasPopup**: Indicates the type of popup triggered by the arrow button.\n Accepts string values: `\"dialog\"`, `\"grid\"`, `\"listbox\"`, `\"menu\"`, or `\"tree\"`.\n - **expanded**: Indicates whether the popup controlled by the arrow button is currently expanded.\n Accepts boolean values: `true` or `false`.",
|
|
158
|
-
"name": "accessibility-attributes",
|
|
159
|
-
"default": "{}",
|
|
160
|
-
"fieldName": "accessibilityAttributes",
|
|
161
|
-
"type": {
|
|
162
|
-
"text": "AIButtonAccessibilityAttributes"
|
|
163
|
-
}
|
|
164
164
|
}
|
|
165
165
|
],
|
|
166
166
|
"superclass": {
|
|
@@ -202,21 +202,11 @@
|
|
|
202
202
|
"members": [
|
|
203
203
|
{
|
|
204
204
|
"kind": "field",
|
|
205
|
-
"name": "
|
|
206
|
-
"type": {
|
|
207
|
-
"text": "string | undefined"
|
|
208
|
-
},
|
|
209
|
-
"description": "Defines the name of the button state.",
|
|
210
|
-
"default": "undefined",
|
|
211
|
-
"privacy": "public"
|
|
212
|
-
},
|
|
213
|
-
{
|
|
214
|
-
"kind": "field",
|
|
215
|
-
"name": "text",
|
|
205
|
+
"name": "endIcon",
|
|
216
206
|
"type": {
|
|
217
207
|
"text": "string | undefined"
|
|
218
208
|
},
|
|
219
|
-
"description": "Defines the text
|
|
209
|
+
"description": "Defines the icon to be displayed as graphical element within the component after the text.\nThe SAP-icons font provides numerous options.\n\n**Example:**\n\nSee all the available icons in the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).",
|
|
220
210
|
"default": "undefined",
|
|
221
211
|
"privacy": "public"
|
|
222
212
|
},
|
|
@@ -232,11 +222,11 @@
|
|
|
232
222
|
},
|
|
233
223
|
{
|
|
234
224
|
"kind": "field",
|
|
235
|
-
"name": "
|
|
225
|
+
"name": "name",
|
|
236
226
|
"type": {
|
|
237
227
|
"text": "string | undefined"
|
|
238
228
|
},
|
|
239
|
-
"description": "Defines the
|
|
229
|
+
"description": "Defines the name of the button state.",
|
|
240
230
|
"default": "undefined",
|
|
241
231
|
"privacy": "public"
|
|
242
232
|
},
|
|
@@ -249,23 +239,24 @@
|
|
|
249
239
|
"default": "false",
|
|
250
240
|
"description": "Defines if the component is in split button mode.",
|
|
251
241
|
"privacy": "public"
|
|
252
|
-
}
|
|
253
|
-
],
|
|
254
|
-
"attributes": [
|
|
242
|
+
},
|
|
255
243
|
{
|
|
256
|
-
"
|
|
257
|
-
"name": "
|
|
258
|
-
"default": "undefined",
|
|
259
|
-
"fieldName": "name",
|
|
244
|
+
"kind": "field",
|
|
245
|
+
"name": "text",
|
|
260
246
|
"type": {
|
|
261
247
|
"text": "string | undefined"
|
|
262
|
-
}
|
|
263
|
-
},
|
|
264
|
-
{
|
|
248
|
+
},
|
|
265
249
|
"description": "Defines the text of the button in this state.",
|
|
266
|
-
"name": "text",
|
|
267
250
|
"default": "undefined",
|
|
268
|
-
"
|
|
251
|
+
"privacy": "public"
|
|
252
|
+
}
|
|
253
|
+
],
|
|
254
|
+
"attributes": [
|
|
255
|
+
{
|
|
256
|
+
"description": "Defines the icon to be displayed as graphical element within the component after the text.\nThe SAP-icons font provides numerous options.\n\n**Example:**\n\nSee all the available icons in the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).",
|
|
257
|
+
"name": "end-icon",
|
|
258
|
+
"default": "undefined",
|
|
259
|
+
"fieldName": "endIcon",
|
|
269
260
|
"type": {
|
|
270
261
|
"text": "string | undefined"
|
|
271
262
|
}
|
|
@@ -280,10 +271,10 @@
|
|
|
280
271
|
}
|
|
281
272
|
},
|
|
282
273
|
{
|
|
283
|
-
"description": "Defines the
|
|
284
|
-
"name": "
|
|
274
|
+
"description": "Defines the name of the button state.",
|
|
275
|
+
"name": "name",
|
|
285
276
|
"default": "undefined",
|
|
286
|
-
"fieldName": "
|
|
277
|
+
"fieldName": "name",
|
|
287
278
|
"type": {
|
|
288
279
|
"text": "string | undefined"
|
|
289
280
|
}
|
|
@@ -296,6 +287,15 @@
|
|
|
296
287
|
"type": {
|
|
297
288
|
"text": "boolean"
|
|
298
289
|
}
|
|
290
|
+
},
|
|
291
|
+
{
|
|
292
|
+
"description": "Defines the text of the button in this state.",
|
|
293
|
+
"name": "text",
|
|
294
|
+
"default": "undefined",
|
|
295
|
+
"fieldName": "text",
|
|
296
|
+
"type": {
|
|
297
|
+
"text": "string | undefined"
|
|
298
|
+
}
|
|
299
299
|
}
|
|
300
300
|
],
|
|
301
301
|
"superclass": {
|
|
@@ -338,6 +338,18 @@
|
|
|
338
338
|
{
|
|
339
339
|
"name": "actions",
|
|
340
340
|
"description": "Defines the items of the menu for the component."
|
|
341
|
+
},
|
|
342
|
+
{
|
|
343
|
+
"name": "default",
|
|
344
|
+
"description": "Defines the suggestion items.\n\n**Note:** The suggestions would be displayed only if the `showSuggestions`\nproperty is set to `true`.\n\n**Note:** The `<ui5-suggestion-item>`, `<ui5-suggestion-item-group>` and `ui5-suggestion-item-custom` are recommended to be used as suggestion items."
|
|
345
|
+
},
|
|
346
|
+
{
|
|
347
|
+
"name": "icon",
|
|
348
|
+
"description": "Defines the icon to be displayed in the component."
|
|
349
|
+
},
|
|
350
|
+
{
|
|
351
|
+
"name": "valueStateMessage",
|
|
352
|
+
"description": "Defines the value state message that will be displayed as pop up under the component.\nThe value state message slot should contain only one root element.\n\n**Note:** If not specified, a default text (in the respective language) will be displayed.\n\n**Note:** The `valueStateMessage` would be displayed,\nwhen the component is in `Information`, `Critical` or `Negative` value state.\n\n**Note:** If the component has `suggestionItems`,\nthe `valueStateMessage` would be displayed as part of the same popover, if used on desktop, or dialog - on phone."
|
|
341
353
|
}
|
|
342
354
|
],
|
|
343
355
|
"members": [
|
|
@@ -351,6 +363,16 @@
|
|
|
351
363
|
"description": "Indicates the index of the currently displayed version.",
|
|
352
364
|
"privacy": "public"
|
|
353
365
|
},
|
|
366
|
+
{
|
|
367
|
+
"kind": "field",
|
|
368
|
+
"name": "loading",
|
|
369
|
+
"type": {
|
|
370
|
+
"text": "boolean"
|
|
371
|
+
},
|
|
372
|
+
"default": "false",
|
|
373
|
+
"description": "Defines whether the AI Writing Assistant is currently loading.\n\nWhen `true`, indicates that an AI action is in progress.",
|
|
374
|
+
"privacy": "public"
|
|
375
|
+
},
|
|
354
376
|
{
|
|
355
377
|
"kind": "field",
|
|
356
378
|
"name": "totalVersions",
|
|
@@ -363,143 +385,109 @@
|
|
|
363
385
|
},
|
|
364
386
|
{
|
|
365
387
|
"kind": "field",
|
|
366
|
-
"name": "
|
|
388
|
+
"name": "accessibleDescription",
|
|
367
389
|
"type": {
|
|
368
|
-
"text": "
|
|
390
|
+
"text": "string | undefined"
|
|
369
391
|
},
|
|
370
|
-
"
|
|
371
|
-
"
|
|
392
|
+
"description": "Defines the accessible description of the component.",
|
|
393
|
+
"default": "undefined",
|
|
372
394
|
"privacy": "public"
|
|
373
|
-
}
|
|
374
|
-
],
|
|
375
|
-
"events": [
|
|
395
|
+
},
|
|
376
396
|
{
|
|
377
|
-
"
|
|
397
|
+
"kind": "field",
|
|
398
|
+
"name": "accessibleDescriptionRef",
|
|
378
399
|
"type": {
|
|
379
|
-
"text": "
|
|
400
|
+
"text": "string | undefined"
|
|
380
401
|
},
|
|
381
|
-
"description": "
|
|
402
|
+
"description": "Receives id(or many ids) of the elements that describe the input.",
|
|
403
|
+
"default": "undefined",
|
|
404
|
+
"privacy": "public"
|
|
382
405
|
},
|
|
383
406
|
{
|
|
384
|
-
"
|
|
407
|
+
"kind": "field",
|
|
408
|
+
"name": "accessibleName",
|
|
385
409
|
"type": {
|
|
386
|
-
"text": "
|
|
387
|
-
"references": [
|
|
388
|
-
{
|
|
389
|
-
"name": "InputItemClickEventDetail",
|
|
390
|
-
"package": "@ui5/webcomponents-ai",
|
|
391
|
-
"module": "dist/Input.js"
|
|
392
|
-
}
|
|
393
|
-
]
|
|
410
|
+
"text": "string | undefined"
|
|
394
411
|
},
|
|
395
|
-
"description": "
|
|
412
|
+
"description": "Defines the accessible ARIA name of the component.",
|
|
413
|
+
"default": "undefined",
|
|
414
|
+
"privacy": "public"
|
|
396
415
|
},
|
|
397
416
|
{
|
|
398
|
-
"
|
|
417
|
+
"kind": "field",
|
|
418
|
+
"name": "accessibleNameRef",
|
|
399
419
|
"type": {
|
|
400
|
-
"text": "
|
|
420
|
+
"text": "string | undefined"
|
|
401
421
|
},
|
|
402
|
-
"description": "
|
|
422
|
+
"description": "Receives id(or many ids) of the elements that label the input.",
|
|
423
|
+
"default": "undefined",
|
|
424
|
+
"privacy": "public"
|
|
403
425
|
},
|
|
404
426
|
{
|
|
405
|
-
"
|
|
427
|
+
"kind": "field",
|
|
428
|
+
"name": "disabled",
|
|
406
429
|
"type": {
|
|
407
|
-
"text": "
|
|
430
|
+
"text": "boolean"
|
|
431
|
+
},
|
|
432
|
+
"default": "false",
|
|
433
|
+
"description": "Defines whether the component is in disabled state.\n\n**Note:** A disabled component is completely noninteractive.",
|
|
434
|
+
"privacy": "public"
|
|
435
|
+
},
|
|
436
|
+
{
|
|
437
|
+
"kind": "field",
|
|
438
|
+
"name": "filter",
|
|
439
|
+
"type": {
|
|
440
|
+
"text": "InputSuggestionsFilter",
|
|
408
441
|
"references": [
|
|
409
442
|
{
|
|
410
|
-
"name": "
|
|
411
|
-
"package": "@ui5/webcomponents
|
|
412
|
-
"module": "dist/
|
|
443
|
+
"name": "InputSuggestionsFilter",
|
|
444
|
+
"package": "@ui5/webcomponents",
|
|
445
|
+
"module": "dist/types/InputSuggestionsFilter.js"
|
|
413
446
|
}
|
|
414
447
|
]
|
|
415
448
|
},
|
|
416
|
-
"description": "
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
"attributes": [
|
|
420
|
-
{
|
|
421
|
-
"description": "Indicates the index of the currently displayed version.",
|
|
422
|
-
"name": "current-version",
|
|
423
|
-
"default": "0",
|
|
424
|
-
"fieldName": "currentVersion",
|
|
425
|
-
"type": {
|
|
426
|
-
"text": "number"
|
|
427
|
-
}
|
|
449
|
+
"description": "Defines the filter type of the component.",
|
|
450
|
+
"default": "\"None\"",
|
|
451
|
+
"privacy": "public"
|
|
428
452
|
},
|
|
429
453
|
{
|
|
430
|
-
"
|
|
431
|
-
"name": "
|
|
432
|
-
"default": "0",
|
|
433
|
-
"fieldName": "totalVersions",
|
|
454
|
+
"kind": "field",
|
|
455
|
+
"name": "maxlength",
|
|
434
456
|
"type": {
|
|
435
|
-
"text": "number"
|
|
436
|
-
}
|
|
457
|
+
"text": "number | undefined"
|
|
458
|
+
},
|
|
459
|
+
"description": "Sets the maximum number of characters available in the input field.\n\n**Note:** This property is not compatible with the ui5-input type InputType.Number. If the ui5-input type is set to Number, the maxlength value is ignored.",
|
|
460
|
+
"default": "undefined",
|
|
461
|
+
"privacy": "public"
|
|
437
462
|
},
|
|
438
463
|
{
|
|
439
|
-
"
|
|
440
|
-
"name": "
|
|
441
|
-
"default": "false",
|
|
442
|
-
"fieldName": "loading",
|
|
464
|
+
"kind": "field",
|
|
465
|
+
"name": "name",
|
|
443
466
|
"type": {
|
|
444
|
-
"text": "
|
|
445
|
-
}
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
"name": "Input",
|
|
450
|
-
"package": "@ui5/webcomponents",
|
|
451
|
-
"module": "dist/Input.js"
|
|
452
|
-
},
|
|
453
|
-
"tagName": "ui5-ai-input",
|
|
454
|
-
"customElement": true
|
|
455
|
-
}
|
|
456
|
-
],
|
|
457
|
-
"exports": [
|
|
458
|
-
{
|
|
459
|
-
"kind": "js",
|
|
460
|
-
"name": "default",
|
|
461
|
-
"declaration": {
|
|
462
|
-
"name": "Input",
|
|
463
|
-
"module": "dist/Input.js"
|
|
464
|
-
}
|
|
465
|
-
},
|
|
466
|
-
{
|
|
467
|
-
"kind": "custom-element-definition",
|
|
468
|
-
"name": "ui5-ai-input",
|
|
469
|
-
"declaration": {
|
|
470
|
-
"name": "Input",
|
|
471
|
-
"module": "dist/Input.js"
|
|
472
|
-
}
|
|
473
|
-
}
|
|
474
|
-
]
|
|
475
|
-
},
|
|
476
|
-
{
|
|
477
|
-
"kind": "javascript-module",
|
|
478
|
-
"path": "dist/PromptInput.js",
|
|
479
|
-
"declarations": [
|
|
480
|
-
{
|
|
481
|
-
"kind": "class",
|
|
482
|
-
"description": "### Overview\n\nThe `ui5-ai-prompt-input` component allows the user to write custom instructions in natural language, so that AI is guided to generate content tailored to user needs.\n\n**Note:** The web component is in an experimental state\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-ai/dist/PromptInput.js\"`",
|
|
483
|
-
"name": "PromptInput",
|
|
484
|
-
"slots": [
|
|
485
|
-
{
|
|
486
|
-
"name": "default",
|
|
487
|
-
"description": "Defines the suggestion items.\n\n**Note:** The suggestions would be displayed only if the `showSuggestions`\nproperty is set to `true`.\n\n**Note:** The `<ui5-suggestion-item>`, `<ui5-suggestion-item-group>` and `ui5-suggestion-item-custom` are recommended to be used as suggestion items."
|
|
467
|
+
"text": "string | undefined"
|
|
468
|
+
},
|
|
469
|
+
"description": "Determines the name by which the component will be identified upon submission in an HTML form.\n\n**Note:** This property is only applicable within the context of an HTML Form element.",
|
|
470
|
+
"default": "undefined",
|
|
471
|
+
"privacy": "public"
|
|
488
472
|
},
|
|
489
473
|
{
|
|
490
|
-
"
|
|
491
|
-
"
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
474
|
+
"kind": "field",
|
|
475
|
+
"name": "noTypeahead",
|
|
476
|
+
"type": {
|
|
477
|
+
"text": "boolean"
|
|
478
|
+
},
|
|
479
|
+
"default": "false",
|
|
480
|
+
"description": "Defines whether the value will be autcompleted to match an item",
|
|
481
|
+
"privacy": "public"
|
|
482
|
+
},
|
|
495
483
|
{
|
|
496
484
|
"kind": "field",
|
|
497
|
-
"name": "
|
|
485
|
+
"name": "open",
|
|
498
486
|
"type": {
|
|
499
|
-
"text": "
|
|
487
|
+
"text": "boolean"
|
|
500
488
|
},
|
|
501
|
-
"default": "
|
|
502
|
-
"description": "Defines the
|
|
489
|
+
"default": "false",
|
|
490
|
+
"description": "Defines whether the suggestions picker is open.\nThe picker will not open if the `showSuggestions` property is set to `false`, the input is disabled or the input is readonly.\nThe picker will close automatically and `close` event will be fired if the input is not in the viewport.",
|
|
503
491
|
"privacy": "public"
|
|
504
492
|
},
|
|
505
493
|
{
|
|
@@ -514,62 +502,69 @@
|
|
|
514
502
|
},
|
|
515
503
|
{
|
|
516
504
|
"kind": "field",
|
|
517
|
-
"name": "
|
|
505
|
+
"name": "readonly",
|
|
518
506
|
"type": {
|
|
519
|
-
"text": "
|
|
507
|
+
"text": "boolean"
|
|
520
508
|
},
|
|
521
|
-
"
|
|
522
|
-
"
|
|
509
|
+
"default": "false",
|
|
510
|
+
"description": "Defines whether the component is read-only.\n\n**Note:** A read-only component is not editable,\nbut still provides visual feedback upon user interaction.",
|
|
523
511
|
"privacy": "public"
|
|
524
512
|
},
|
|
525
513
|
{
|
|
526
514
|
"kind": "field",
|
|
527
|
-
"name": "
|
|
515
|
+
"name": "required",
|
|
528
516
|
"type": {
|
|
529
517
|
"text": "boolean"
|
|
530
518
|
},
|
|
531
519
|
"default": "false",
|
|
532
|
-
"description": "Defines whether the
|
|
520
|
+
"description": "Defines whether the component is required.",
|
|
533
521
|
"privacy": "public"
|
|
534
522
|
},
|
|
535
523
|
{
|
|
536
524
|
"kind": "field",
|
|
537
|
-
"name": "
|
|
525
|
+
"name": "showClearIcon",
|
|
538
526
|
"type": {
|
|
539
527
|
"text": "boolean"
|
|
540
528
|
},
|
|
541
529
|
"default": "false",
|
|
542
|
-
"description": "
|
|
530
|
+
"description": "Defines whether the clear icon of the input will be shown.",
|
|
543
531
|
"privacy": "public"
|
|
544
532
|
},
|
|
545
533
|
{
|
|
546
534
|
"kind": "field",
|
|
547
|
-
"name": "
|
|
535
|
+
"name": "showSuggestions",
|
|
548
536
|
"type": {
|
|
549
537
|
"text": "boolean"
|
|
550
538
|
},
|
|
551
539
|
"default": "false",
|
|
552
|
-
"description": "Defines whether the component
|
|
540
|
+
"description": "Defines whether the component should show suggestions, if such are present.",
|
|
553
541
|
"privacy": "public"
|
|
554
542
|
},
|
|
555
543
|
{
|
|
556
544
|
"kind": "field",
|
|
557
|
-
"name": "
|
|
545
|
+
"name": "type",
|
|
558
546
|
"type": {
|
|
559
|
-
"text": "
|
|
547
|
+
"text": "InputType",
|
|
548
|
+
"references": [
|
|
549
|
+
{
|
|
550
|
+
"name": "InputType",
|
|
551
|
+
"package": "@ui5/webcomponents",
|
|
552
|
+
"module": "dist/types/InputType.js"
|
|
553
|
+
}
|
|
554
|
+
]
|
|
560
555
|
},
|
|
561
|
-
"default": "
|
|
562
|
-
"description": "Defines
|
|
556
|
+
"default": "\"Text\"",
|
|
557
|
+
"description": "Defines the HTML type of the component.\n\n**Notes:**\n\n- The particular effect of this property differs depending on the browser\nand the current language settings, especially for type `Number`.\n- The property is mostly intended to be used with touch devices\nthat use different soft keyboard layouts depending on the given input type.",
|
|
563
558
|
"privacy": "public"
|
|
564
559
|
},
|
|
565
560
|
{
|
|
566
561
|
"kind": "field",
|
|
567
|
-
"name": "
|
|
562
|
+
"name": "value",
|
|
568
563
|
"type": {
|
|
569
|
-
"text": "
|
|
564
|
+
"text": "string"
|
|
570
565
|
},
|
|
571
|
-
"
|
|
572
|
-
"
|
|
566
|
+
"default": "\"\"",
|
|
567
|
+
"description": "Defines the value of the component.\n\n**Note:** The property is updated upon typing.",
|
|
573
568
|
"privacy": "public"
|
|
574
569
|
},
|
|
575
570
|
{
|
|
@@ -588,25 +583,64 @@
|
|
|
588
583
|
"default": "\"None\"",
|
|
589
584
|
"description": "Defines the value state of the component.",
|
|
590
585
|
"privacy": "public"
|
|
586
|
+
}
|
|
587
|
+
],
|
|
588
|
+
"events": [
|
|
589
|
+
{
|
|
590
|
+
"name": "button-click",
|
|
591
|
+
"type": {
|
|
592
|
+
"text": "CustomEvent"
|
|
593
|
+
},
|
|
594
|
+
"description": "Fired when the user selects the AI button."
|
|
591
595
|
},
|
|
592
596
|
{
|
|
593
|
-
"
|
|
594
|
-
"name": "showSuggestions",
|
|
597
|
+
"name": "item-click",
|
|
595
598
|
"type": {
|
|
596
|
-
"text": "
|
|
599
|
+
"text": "CustomEvent<InputItemClickEventDetail>",
|
|
600
|
+
"references": [
|
|
601
|
+
{
|
|
602
|
+
"name": "InputItemClickEventDetail",
|
|
603
|
+
"package": "@ui5/webcomponents-ai",
|
|
604
|
+
"module": "dist/Input.js"
|
|
605
|
+
}
|
|
606
|
+
]
|
|
597
607
|
},
|
|
598
|
-
"
|
|
599
|
-
|
|
600
|
-
"privacy": "public"
|
|
601
|
-
}
|
|
602
|
-
],
|
|
603
|
-
"events": [
|
|
608
|
+
"description": "Fired when an item from the AI actions menu is clicked."
|
|
609
|
+
},
|
|
604
610
|
{
|
|
605
|
-
"name": "
|
|
611
|
+
"name": "stop-generation",
|
|
606
612
|
"type": {
|
|
607
613
|
"text": "CustomEvent"
|
|
608
614
|
},
|
|
609
|
-
"description": "Fired when the
|
|
615
|
+
"description": "Fired when the user selects the \"Stop\" button to stop ongoing AI text generation."
|
|
616
|
+
},
|
|
617
|
+
{
|
|
618
|
+
"name": "version-change",
|
|
619
|
+
"type": {
|
|
620
|
+
"text": "CustomEvent<InputVersionChangeEventDetail>",
|
|
621
|
+
"references": [
|
|
622
|
+
{
|
|
623
|
+
"name": "InputVersionChangeEventDetail",
|
|
624
|
+
"package": "@ui5/webcomponents-ai",
|
|
625
|
+
"module": "dist/Input.js"
|
|
626
|
+
}
|
|
627
|
+
]
|
|
628
|
+
},
|
|
629
|
+
"description": "Fired when the user selects the version navigation buttons."
|
|
630
|
+
},
|
|
631
|
+
{
|
|
632
|
+
"name": "change",
|
|
633
|
+
"type": {
|
|
634
|
+
"text": "CustomEvent"
|
|
635
|
+
},
|
|
636
|
+
"description": "Fired when the input operation has finished by pressing Enter or on focusout."
|
|
637
|
+
},
|
|
638
|
+
{
|
|
639
|
+
"name": "close",
|
|
640
|
+
"type": {
|
|
641
|
+
"text": "CustomEvent"
|
|
642
|
+
},
|
|
643
|
+
"description": "Fired when the suggestions picker is closed."
|
|
610
644
|
},
|
|
611
645
|
{
|
|
612
646
|
"name": "input",
|
|
@@ -616,57 +650,96 @@
|
|
|
616
650
|
"description": "Fired when the value of the component changes at each keystroke,\nand when a suggestion item has been selected."
|
|
617
651
|
},
|
|
618
652
|
{
|
|
619
|
-
"name": "
|
|
653
|
+
"name": "open",
|
|
620
654
|
"type": {
|
|
621
655
|
"text": "CustomEvent"
|
|
622
656
|
},
|
|
623
|
-
"description": "Fired when the
|
|
657
|
+
"description": "Fired when the suggestions picker is open."
|
|
658
|
+
},
|
|
659
|
+
{
|
|
660
|
+
"name": "select",
|
|
661
|
+
"type": {
|
|
662
|
+
"text": "CustomEvent"
|
|
663
|
+
},
|
|
664
|
+
"description": "Fired when some text has been selected."
|
|
665
|
+
},
|
|
666
|
+
{
|
|
667
|
+
"name": "selection-change",
|
|
668
|
+
"type": {
|
|
669
|
+
"text": "CustomEvent<InputSelectionChangeEventDetail>",
|
|
670
|
+
"references": [
|
|
671
|
+
{
|
|
672
|
+
"name": "InputSelectionChangeEventDetail",
|
|
673
|
+
"package": "@ui5/webcomponents",
|
|
674
|
+
"module": "dist/Input.js"
|
|
675
|
+
}
|
|
676
|
+
]
|
|
677
|
+
},
|
|
678
|
+
"description": "Fired when the user navigates to a suggestion item via the ARROW keys,\nas a preview, before the final selection."
|
|
624
679
|
}
|
|
625
680
|
],
|
|
626
681
|
"attributes": [
|
|
627
682
|
{
|
|
628
|
-
"description": "
|
|
629
|
-
"name": "
|
|
630
|
-
"default": "
|
|
631
|
-
"fieldName": "
|
|
683
|
+
"description": "Indicates the index of the currently displayed version.",
|
|
684
|
+
"name": "current-version",
|
|
685
|
+
"default": "0",
|
|
686
|
+
"fieldName": "currentVersion",
|
|
632
687
|
"type": {
|
|
633
|
-
"text": "
|
|
688
|
+
"text": "number"
|
|
634
689
|
}
|
|
635
690
|
},
|
|
636
691
|
{
|
|
637
|
-
"description": "Defines
|
|
638
|
-
"name": "
|
|
692
|
+
"description": "Defines whether the AI Writing Assistant is currently loading.\n\nWhen `true`, indicates that an AI action is in progress.",
|
|
693
|
+
"name": "loading",
|
|
694
|
+
"default": "false",
|
|
695
|
+
"fieldName": "loading",
|
|
696
|
+
"type": {
|
|
697
|
+
"text": "boolean"
|
|
698
|
+
}
|
|
699
|
+
},
|
|
700
|
+
{
|
|
701
|
+
"description": "Indicates the total number of result versions available.\n\nWhen not set or set to 0, the versioning will be hidden.",
|
|
702
|
+
"name": "total-versions",
|
|
703
|
+
"default": "0",
|
|
704
|
+
"fieldName": "totalVersions",
|
|
705
|
+
"type": {
|
|
706
|
+
"text": "number"
|
|
707
|
+
}
|
|
708
|
+
},
|
|
709
|
+
{
|
|
710
|
+
"description": "Defines the accessible description of the component.",
|
|
711
|
+
"name": "accessible-description",
|
|
639
712
|
"default": "undefined",
|
|
640
|
-
"fieldName": "
|
|
713
|
+
"fieldName": "accessibleDescription",
|
|
641
714
|
"type": {
|
|
642
715
|
"text": "string | undefined"
|
|
643
716
|
}
|
|
644
717
|
},
|
|
645
718
|
{
|
|
646
|
-
"description": "
|
|
647
|
-
"name": "
|
|
719
|
+
"description": "Receives id(or many ids) of the elements that describe the input.",
|
|
720
|
+
"name": "accessible-description-ref",
|
|
648
721
|
"default": "undefined",
|
|
649
|
-
"fieldName": "
|
|
722
|
+
"fieldName": "accessibleDescriptionRef",
|
|
650
723
|
"type": {
|
|
651
724
|
"text": "string | undefined"
|
|
652
725
|
}
|
|
653
726
|
},
|
|
654
727
|
{
|
|
655
|
-
"description": "Defines
|
|
656
|
-
"name": "
|
|
657
|
-
"default": "
|
|
658
|
-
"fieldName": "
|
|
728
|
+
"description": "Defines the accessible ARIA name of the component.",
|
|
729
|
+
"name": "accessible-name",
|
|
730
|
+
"default": "undefined",
|
|
731
|
+
"fieldName": "accessibleName",
|
|
659
732
|
"type": {
|
|
660
|
-
"text": "
|
|
733
|
+
"text": "string | undefined"
|
|
661
734
|
}
|
|
662
735
|
},
|
|
663
736
|
{
|
|
664
|
-
"description": "
|
|
665
|
-
"name": "
|
|
666
|
-
"default": "
|
|
667
|
-
"fieldName": "
|
|
737
|
+
"description": "Receives id(or many ids) of the elements that label the input.",
|
|
738
|
+
"name": "accessible-name-ref",
|
|
739
|
+
"default": "undefined",
|
|
740
|
+
"fieldName": "accessibleNameRef",
|
|
668
741
|
"type": {
|
|
669
|
-
"text": "
|
|
742
|
+
"text": "string | undefined"
|
|
670
743
|
}
|
|
671
744
|
},
|
|
672
745
|
{
|
|
@@ -679,16 +752,16 @@
|
|
|
679
752
|
}
|
|
680
753
|
},
|
|
681
754
|
{
|
|
682
|
-
"description": "Defines
|
|
683
|
-
"name": "
|
|
684
|
-
"default": "
|
|
685
|
-
"fieldName": "
|
|
755
|
+
"description": "Defines the filter type of the component.",
|
|
756
|
+
"name": "filter",
|
|
757
|
+
"default": "\"None\"",
|
|
758
|
+
"fieldName": "filter",
|
|
686
759
|
"type": {
|
|
687
|
-
"text": "
|
|
760
|
+
"text": "\"None\" | \"StartsWithPerTerm\" | \"StartsWith\" | \"Contains\""
|
|
688
761
|
}
|
|
689
762
|
},
|
|
690
763
|
{
|
|
691
|
-
"description": "Sets the maximum number of characters available in the input field.",
|
|
764
|
+
"description": "Sets the maximum number of characters available in the input field.\n\n**Note:** This property is not compatible with the ui5-input type InputType.Number. If the ui5-input type is set to Number, the maxlength value is ignored.",
|
|
692
765
|
"name": "maxlength",
|
|
693
766
|
"default": "undefined",
|
|
694
767
|
"fieldName": "maxlength",
|
|
@@ -697,31 +770,1007 @@
|
|
|
697
770
|
}
|
|
698
771
|
},
|
|
699
772
|
{
|
|
700
|
-
"description": "
|
|
701
|
-
"name": "
|
|
702
|
-
"default": "
|
|
703
|
-
"fieldName": "
|
|
773
|
+
"description": "Determines the name by which the component will be identified upon submission in an HTML form.\n\n**Note:** This property is only applicable within the context of an HTML Form element.",
|
|
774
|
+
"name": "name",
|
|
775
|
+
"default": "undefined",
|
|
776
|
+
"fieldName": "name",
|
|
704
777
|
"type": {
|
|
705
|
-
"text": "
|
|
778
|
+
"text": "string | undefined"
|
|
706
779
|
}
|
|
707
780
|
},
|
|
708
781
|
{
|
|
709
|
-
"description": "Defines whether the
|
|
710
|
-
"name": "
|
|
782
|
+
"description": "Defines whether the value will be autcompleted to match an item",
|
|
783
|
+
"name": "no-typeahead",
|
|
711
784
|
"default": "false",
|
|
712
|
-
"fieldName": "
|
|
785
|
+
"fieldName": "noTypeahead",
|
|
713
786
|
"type": {
|
|
714
787
|
"text": "boolean"
|
|
715
788
|
}
|
|
716
|
-
}
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
789
|
+
},
|
|
790
|
+
{
|
|
791
|
+
"description": "Defines whether the suggestions picker is open.\nThe picker will not open if the `showSuggestions` property is set to `false`, the input is disabled or the input is readonly.\nThe picker will close automatically and `close` event will be fired if the input is not in the viewport.",
|
|
792
|
+
"name": "open",
|
|
793
|
+
"default": "false",
|
|
794
|
+
"fieldName": "open",
|
|
795
|
+
"type": {
|
|
796
|
+
"text": "boolean"
|
|
797
|
+
}
|
|
798
|
+
},
|
|
799
|
+
{
|
|
800
|
+
"description": "Defines a short hint intended to aid the user with data entry when the\ncomponent has no value.",
|
|
801
|
+
"name": "placeholder",
|
|
802
|
+
"default": "undefined",
|
|
803
|
+
"fieldName": "placeholder",
|
|
804
|
+
"type": {
|
|
805
|
+
"text": "string | undefined"
|
|
806
|
+
}
|
|
807
|
+
},
|
|
808
|
+
{
|
|
809
|
+
"description": "Defines whether the component is read-only.\n\n**Note:** A read-only component is not editable,\nbut still provides visual feedback upon user interaction.",
|
|
810
|
+
"name": "readonly",
|
|
811
|
+
"default": "false",
|
|
812
|
+
"fieldName": "readonly",
|
|
813
|
+
"type": {
|
|
814
|
+
"text": "boolean"
|
|
815
|
+
}
|
|
816
|
+
},
|
|
817
|
+
{
|
|
818
|
+
"description": "Defines whether the component is required.",
|
|
819
|
+
"name": "required",
|
|
820
|
+
"default": "false",
|
|
821
|
+
"fieldName": "required",
|
|
822
|
+
"type": {
|
|
823
|
+
"text": "boolean"
|
|
824
|
+
}
|
|
825
|
+
},
|
|
826
|
+
{
|
|
827
|
+
"description": "Defines whether the clear icon of the input will be shown.",
|
|
828
|
+
"name": "show-clear-icon",
|
|
829
|
+
"default": "false",
|
|
830
|
+
"fieldName": "showClearIcon",
|
|
831
|
+
"type": {
|
|
832
|
+
"text": "boolean"
|
|
833
|
+
}
|
|
834
|
+
},
|
|
835
|
+
{
|
|
836
|
+
"description": "Defines whether the component should show suggestions, if such are present.",
|
|
837
|
+
"name": "show-suggestions",
|
|
838
|
+
"default": "false",
|
|
839
|
+
"fieldName": "showSuggestions",
|
|
840
|
+
"type": {
|
|
841
|
+
"text": "boolean"
|
|
842
|
+
}
|
|
843
|
+
},
|
|
844
|
+
{
|
|
845
|
+
"description": "Defines the HTML type of the component.\n\n**Notes:**\n\n- The particular effect of this property differs depending on the browser\nand the current language settings, especially for type `Number`.\n- The property is mostly intended to be used with touch devices\nthat use different soft keyboard layouts depending on the given input type.",
|
|
846
|
+
"name": "type",
|
|
847
|
+
"default": "\"Text\"",
|
|
848
|
+
"fieldName": "type",
|
|
849
|
+
"type": {
|
|
850
|
+
"text": "\"Text\" | \"Email\" | \"Number\" | \"Password\" | \"Tel\" | \"URL\" | \"Search\""
|
|
851
|
+
}
|
|
852
|
+
},
|
|
853
|
+
{
|
|
854
|
+
"description": "Defines the value of the component.\n\n**Note:** The property is updated upon typing.",
|
|
855
|
+
"name": "value",
|
|
856
|
+
"default": "\"\"",
|
|
857
|
+
"fieldName": "value",
|
|
858
|
+
"type": {
|
|
859
|
+
"text": "string"
|
|
860
|
+
}
|
|
861
|
+
},
|
|
862
|
+
{
|
|
863
|
+
"description": "Defines the value state of the component.",
|
|
864
|
+
"name": "value-state",
|
|
865
|
+
"default": "\"None\"",
|
|
866
|
+
"fieldName": "valueState",
|
|
867
|
+
"type": {
|
|
868
|
+
"text": "\"None\" | \"Positive\" | \"Critical\" | \"Negative\" | \"Information\""
|
|
869
|
+
}
|
|
870
|
+
}
|
|
871
|
+
],
|
|
872
|
+
"superclass": {
|
|
873
|
+
"name": "Input",
|
|
874
|
+
"package": "@ui5/webcomponents",
|
|
875
|
+
"module": "dist/Input.js"
|
|
876
|
+
},
|
|
877
|
+
"tagName": "ui5-ai-input",
|
|
878
|
+
"customElement": true,
|
|
879
|
+
"cssParts": [
|
|
880
|
+
{
|
|
881
|
+
"description": "Used to style the clear icon, which can be pressed to clear user input text",
|
|
882
|
+
"name": "clear-icon"
|
|
883
|
+
},
|
|
884
|
+
{
|
|
885
|
+
"description": "Used to style the native input element",
|
|
886
|
+
"name": "input"
|
|
887
|
+
},
|
|
888
|
+
{
|
|
889
|
+
"description": "Used to style the root DOM element of the Input component",
|
|
890
|
+
"name": "root"
|
|
891
|
+
}
|
|
892
|
+
]
|
|
893
|
+
}
|
|
894
|
+
],
|
|
895
|
+
"exports": [
|
|
896
|
+
{
|
|
897
|
+
"kind": "js",
|
|
898
|
+
"name": "default",
|
|
899
|
+
"declaration": {
|
|
900
|
+
"name": "Input",
|
|
901
|
+
"module": "dist/Input.js"
|
|
902
|
+
}
|
|
903
|
+
},
|
|
904
|
+
{
|
|
905
|
+
"kind": "custom-element-definition",
|
|
906
|
+
"name": "ui5-ai-input",
|
|
907
|
+
"declaration": {
|
|
908
|
+
"name": "Input",
|
|
909
|
+
"module": "dist/Input.js"
|
|
910
|
+
}
|
|
911
|
+
}
|
|
912
|
+
]
|
|
913
|
+
},
|
|
914
|
+
{
|
|
915
|
+
"kind": "javascript-module",
|
|
916
|
+
"path": "dist/PromptInput.js",
|
|
917
|
+
"declarations": [
|
|
918
|
+
{
|
|
919
|
+
"kind": "class",
|
|
920
|
+
"description": "### Overview\n\nThe `ui5-ai-prompt-input` component allows the user to write custom instructions in natural language, so that AI is guided to generate content tailored to user needs.\n\n**Note:** The web component is in an experimental state\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-ai/dist/PromptInput.js\"`",
|
|
921
|
+
"name": "PromptInput",
|
|
922
|
+
"slots": [
|
|
923
|
+
{
|
|
924
|
+
"name": "default",
|
|
925
|
+
"description": "Defines the suggestion items.\n\n**Note:** The suggestions would be displayed only if the `showSuggestions`\nproperty is set to `true`.\n\n**Note:** The `<ui5-suggestion-item>`, `<ui5-suggestion-item-group>` and `ui5-suggestion-item-custom` are recommended to be used as suggestion items."
|
|
926
|
+
},
|
|
927
|
+
{
|
|
928
|
+
"name": "valueStateMessage",
|
|
929
|
+
"description": "Defines the value state message that will be displayed as pop up under the component.\nThe value state message slot should contain only one root element.\n\n**Note:** If not specified, a default text (in the respective language) will be displayed.\n\n**Note:** The `valueStateMessage` would be displayed,\nwhen the component is in `Information`, `Critical` or `Negative` value state."
|
|
930
|
+
}
|
|
931
|
+
],
|
|
932
|
+
"members": [
|
|
933
|
+
{
|
|
934
|
+
"kind": "field",
|
|
935
|
+
"name": "disabled",
|
|
936
|
+
"type": {
|
|
937
|
+
"text": "boolean"
|
|
938
|
+
},
|
|
939
|
+
"default": "false",
|
|
940
|
+
"description": "Defines whether the component is in disabled state.\n\n**Note:** A disabled component is completely noninteractive.",
|
|
941
|
+
"privacy": "public"
|
|
942
|
+
},
|
|
943
|
+
{
|
|
944
|
+
"kind": "field",
|
|
945
|
+
"name": "label",
|
|
946
|
+
"type": {
|
|
947
|
+
"text": "string | undefined"
|
|
948
|
+
},
|
|
949
|
+
"description": "Defines the label of the input field.",
|
|
950
|
+
"default": "undefined",
|
|
951
|
+
"privacy": "public"
|
|
952
|
+
},
|
|
953
|
+
{
|
|
954
|
+
"kind": "field",
|
|
955
|
+
"name": "maxlength",
|
|
956
|
+
"type": {
|
|
957
|
+
"text": "number | undefined"
|
|
958
|
+
},
|
|
959
|
+
"description": "Sets the maximum number of characters available in the input field.",
|
|
960
|
+
"default": "undefined",
|
|
961
|
+
"privacy": "public"
|
|
962
|
+
},
|
|
963
|
+
{
|
|
964
|
+
"kind": "field",
|
|
965
|
+
"name": "placeholder",
|
|
966
|
+
"type": {
|
|
967
|
+
"text": "string | undefined"
|
|
968
|
+
},
|
|
969
|
+
"description": "Defines a short hint intended to aid the user with data entry when the\ncomponent has no value.",
|
|
970
|
+
"default": "undefined",
|
|
971
|
+
"privacy": "public"
|
|
972
|
+
},
|
|
973
|
+
{
|
|
974
|
+
"kind": "field",
|
|
975
|
+
"name": "readonly",
|
|
976
|
+
"type": {
|
|
977
|
+
"text": "boolean"
|
|
978
|
+
},
|
|
979
|
+
"default": "false",
|
|
980
|
+
"description": "Defines whether the component is read-only.\n\n**Note:** A read-only component is not editable,\nbut still provides visual feedback upon user interaction.",
|
|
981
|
+
"privacy": "public"
|
|
982
|
+
},
|
|
983
|
+
{
|
|
984
|
+
"kind": "field",
|
|
985
|
+
"name": "showClearIcon",
|
|
986
|
+
"type": {
|
|
987
|
+
"text": "boolean"
|
|
988
|
+
},
|
|
989
|
+
"default": "false",
|
|
990
|
+
"description": "Defines whether the clear icon of the input will be shown.",
|
|
991
|
+
"privacy": "public"
|
|
992
|
+
},
|
|
993
|
+
{
|
|
994
|
+
"kind": "field",
|
|
995
|
+
"name": "showExceededText",
|
|
996
|
+
"type": {
|
|
997
|
+
"text": "boolean"
|
|
998
|
+
},
|
|
999
|
+
"default": "false",
|
|
1000
|
+
"description": "Determines whether the characters exceeding the maximum allowed character count are visible\nin the component.\n\nIf set to `false`, the user is not allowed to enter more characters than what is set in the\n`maxlength` property.\nIf set to `true` the characters exceeding the `maxlength` value are selected on\npaste and the counter below the component displays their number.",
|
|
1001
|
+
"privacy": "public"
|
|
1002
|
+
},
|
|
1003
|
+
{
|
|
1004
|
+
"kind": "field",
|
|
1005
|
+
"name": "showSuggestions",
|
|
1006
|
+
"type": {
|
|
1007
|
+
"text": "boolean"
|
|
1008
|
+
},
|
|
1009
|
+
"default": "false",
|
|
1010
|
+
"description": "Defines whether the component should show suggestions, if such are present.",
|
|
1011
|
+
"privacy": "public"
|
|
1012
|
+
},
|
|
1013
|
+
{
|
|
1014
|
+
"kind": "field",
|
|
1015
|
+
"name": "value",
|
|
1016
|
+
"type": {
|
|
1017
|
+
"text": "string"
|
|
1018
|
+
},
|
|
1019
|
+
"default": "\"\"",
|
|
1020
|
+
"description": "Defines the value of the component.",
|
|
1021
|
+
"privacy": "public"
|
|
1022
|
+
},
|
|
1023
|
+
{
|
|
1024
|
+
"kind": "field",
|
|
1025
|
+
"name": "valueState",
|
|
1026
|
+
"type": {
|
|
1027
|
+
"text": "ValueState",
|
|
1028
|
+
"references": [
|
|
1029
|
+
{
|
|
1030
|
+
"name": "ValueState",
|
|
1031
|
+
"package": "@ui5/webcomponents-base",
|
|
1032
|
+
"module": "dist/types/ValueState.js"
|
|
1033
|
+
}
|
|
1034
|
+
]
|
|
1035
|
+
},
|
|
1036
|
+
"default": "\"None\"",
|
|
1037
|
+
"description": "Defines the value state of the component.",
|
|
1038
|
+
"privacy": "public"
|
|
1039
|
+
}
|
|
1040
|
+
],
|
|
1041
|
+
"events": [
|
|
1042
|
+
{
|
|
1043
|
+
"name": "change",
|
|
1044
|
+
"type": {
|
|
1045
|
+
"text": "CustomEvent"
|
|
1046
|
+
},
|
|
1047
|
+
"description": "Fired when the input operation has finished by pressing Enter\nor on focusout."
|
|
1048
|
+
},
|
|
1049
|
+
{
|
|
1050
|
+
"name": "input",
|
|
1051
|
+
"type": {
|
|
1052
|
+
"text": "CustomEvent"
|
|
1053
|
+
},
|
|
1054
|
+
"description": "Fired when the value of the component changes at each keystroke,\nand when a suggestion item has been selected."
|
|
1055
|
+
},
|
|
1056
|
+
{
|
|
1057
|
+
"name": "submit",
|
|
1058
|
+
"type": {
|
|
1059
|
+
"text": "CustomEvent"
|
|
1060
|
+
},
|
|
1061
|
+
"description": "Fired when the input operation has finished by pressing Enter\nor AI button is clicked."
|
|
1062
|
+
}
|
|
1063
|
+
],
|
|
1064
|
+
"attributes": [
|
|
1065
|
+
{
|
|
1066
|
+
"description": "Defines whether the component is in disabled state.\n\n**Note:** A disabled component is completely noninteractive.",
|
|
1067
|
+
"name": "disabled",
|
|
1068
|
+
"default": "false",
|
|
1069
|
+
"fieldName": "disabled",
|
|
1070
|
+
"type": {
|
|
1071
|
+
"text": "boolean"
|
|
1072
|
+
}
|
|
1073
|
+
},
|
|
1074
|
+
{
|
|
1075
|
+
"description": "Defines the label of the input field.",
|
|
1076
|
+
"name": "label",
|
|
1077
|
+
"default": "undefined",
|
|
1078
|
+
"fieldName": "label",
|
|
1079
|
+
"type": {
|
|
1080
|
+
"text": "string | undefined"
|
|
1081
|
+
}
|
|
1082
|
+
},
|
|
1083
|
+
{
|
|
1084
|
+
"description": "Sets the maximum number of characters available in the input field.",
|
|
1085
|
+
"name": "maxlength",
|
|
1086
|
+
"default": "undefined",
|
|
1087
|
+
"fieldName": "maxlength",
|
|
1088
|
+
"type": {
|
|
1089
|
+
"text": "number | undefined"
|
|
1090
|
+
}
|
|
1091
|
+
},
|
|
1092
|
+
{
|
|
1093
|
+
"description": "Defines a short hint intended to aid the user with data entry when the\ncomponent has no value.",
|
|
1094
|
+
"name": "placeholder",
|
|
1095
|
+
"default": "undefined",
|
|
1096
|
+
"fieldName": "placeholder",
|
|
1097
|
+
"type": {
|
|
1098
|
+
"text": "string | undefined"
|
|
1099
|
+
}
|
|
1100
|
+
},
|
|
1101
|
+
{
|
|
1102
|
+
"description": "Defines whether the component is read-only.\n\n**Note:** A read-only component is not editable,\nbut still provides visual feedback upon user interaction.",
|
|
1103
|
+
"name": "readonly",
|
|
1104
|
+
"default": "false",
|
|
1105
|
+
"fieldName": "readonly",
|
|
1106
|
+
"type": {
|
|
1107
|
+
"text": "boolean"
|
|
1108
|
+
}
|
|
1109
|
+
},
|
|
1110
|
+
{
|
|
1111
|
+
"description": "Defines whether the clear icon of the input will be shown.",
|
|
1112
|
+
"name": "show-clear-icon",
|
|
1113
|
+
"default": "false",
|
|
1114
|
+
"fieldName": "showClearIcon",
|
|
1115
|
+
"type": {
|
|
1116
|
+
"text": "boolean"
|
|
1117
|
+
}
|
|
1118
|
+
},
|
|
1119
|
+
{
|
|
1120
|
+
"description": "Determines whether the characters exceeding the maximum allowed character count are visible\nin the component.\n\nIf set to `false`, the user is not allowed to enter more characters than what is set in the\n`maxlength` property.\nIf set to `true` the characters exceeding the `maxlength` value are selected on\npaste and the counter below the component displays their number.",
|
|
1121
|
+
"name": "show-exceeded-text",
|
|
1122
|
+
"default": "false",
|
|
1123
|
+
"fieldName": "showExceededText",
|
|
1124
|
+
"type": {
|
|
1125
|
+
"text": "boolean"
|
|
1126
|
+
}
|
|
1127
|
+
},
|
|
1128
|
+
{
|
|
1129
|
+
"description": "Defines whether the component should show suggestions, if such are present.",
|
|
1130
|
+
"name": "show-suggestions",
|
|
1131
|
+
"default": "false",
|
|
1132
|
+
"fieldName": "showSuggestions",
|
|
1133
|
+
"type": {
|
|
1134
|
+
"text": "boolean"
|
|
1135
|
+
}
|
|
1136
|
+
},
|
|
1137
|
+
{
|
|
1138
|
+
"description": "Defines the value of the component.",
|
|
1139
|
+
"name": "value",
|
|
1140
|
+
"default": "\"\"",
|
|
1141
|
+
"fieldName": "value",
|
|
1142
|
+
"type": {
|
|
1143
|
+
"text": "string"
|
|
1144
|
+
}
|
|
1145
|
+
},
|
|
1146
|
+
{
|
|
1147
|
+
"description": "Defines the value state of the component.",
|
|
1148
|
+
"name": "value-state",
|
|
1149
|
+
"default": "\"None\"",
|
|
1150
|
+
"fieldName": "valueState",
|
|
1151
|
+
"type": {
|
|
1152
|
+
"text": "\"Positive\" | \"Negative\" | \"None\" | \"Critical\" | \"Information\""
|
|
1153
|
+
}
|
|
1154
|
+
}
|
|
1155
|
+
],
|
|
1156
|
+
"superclass": {
|
|
1157
|
+
"name": "UI5Element",
|
|
1158
|
+
"package": "@ui5/webcomponents-base",
|
|
1159
|
+
"module": "dist/UI5Element.js"
|
|
1160
|
+
},
|
|
1161
|
+
"tagName": "ui5-ai-prompt-input",
|
|
1162
|
+
"customElement": true
|
|
1163
|
+
}
|
|
1164
|
+
],
|
|
1165
|
+
"exports": [
|
|
1166
|
+
{
|
|
1167
|
+
"kind": "js",
|
|
1168
|
+
"name": "default",
|
|
1169
|
+
"declaration": {
|
|
1170
|
+
"name": "PromptInput",
|
|
1171
|
+
"module": "dist/PromptInput.js"
|
|
1172
|
+
}
|
|
1173
|
+
},
|
|
1174
|
+
{
|
|
1175
|
+
"kind": "custom-element-definition",
|
|
1176
|
+
"name": "ui5-ai-prompt-input",
|
|
1177
|
+
"declaration": {
|
|
1178
|
+
"name": "PromptInput",
|
|
1179
|
+
"module": "dist/PromptInput.js"
|
|
1180
|
+
}
|
|
1181
|
+
}
|
|
1182
|
+
]
|
|
1183
|
+
},
|
|
1184
|
+
{
|
|
1185
|
+
"kind": "javascript-module",
|
|
1186
|
+
"path": "dist/TextArea.js",
|
|
1187
|
+
"declarations": [
|
|
1188
|
+
{
|
|
1189
|
+
"kind": "class",
|
|
1190
|
+
"description": "### Overview\n\nThe `ui5-ai-textarea` component extends the standard TextArea with Writing Assistant capabilities.\nIt provides AI-powered text generation, editing suggestions, and version management functionality.\n\n### Structure\nThe `ui5-ai-textarea` consists of the following elements:\n- TextArea: The main text input area with all standard textarea functionality\n- WritingAssistant: Dedicated toolbar containing:\n - Versioning: A component with left/right navigation buttons and a label for browsing AI-generated versions\n - AI Button: Opens a menu that can be extended with custom AI generation options through slotting\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-ai/dist/TextArea.js\";`",
|
|
1191
|
+
"name": "TextArea",
|
|
1192
|
+
"slots": [
|
|
1193
|
+
{
|
|
1194
|
+
"description": "Defines a slot for `ui5-menu` integration. This slot allows you to pass a `ui5-menu` instance that will be associated with the assistant.",
|
|
1195
|
+
"name": "menu"
|
|
1196
|
+
},
|
|
1197
|
+
{
|
|
1198
|
+
"name": "valueStateMessage",
|
|
1199
|
+
"description": "Defines the value state message that will be displayed as pop up under the component.\nThe value state message slot should contain only one root element.\n \n**Note:** If not specified, a default text (in the respective language) will be displayed.\n\n**Note:** The `valueStateMessage` would be displayed if the component has\n`valueState` of type `Information`, `Critical` or `Negative`."
|
|
1200
|
+
}
|
|
1201
|
+
],
|
|
1202
|
+
"members": [
|
|
1203
|
+
{
|
|
1204
|
+
"kind": "field",
|
|
1205
|
+
"name": "currentVersion",
|
|
1206
|
+
"type": {
|
|
1207
|
+
"text": "number"
|
|
1208
|
+
},
|
|
1209
|
+
"default": "0",
|
|
1210
|
+
"description": "Indicates the index of the currently displayed version.",
|
|
1211
|
+
"privacy": "public"
|
|
1212
|
+
},
|
|
1213
|
+
{
|
|
1214
|
+
"kind": "field",
|
|
1215
|
+
"name": "loading",
|
|
1216
|
+
"type": {
|
|
1217
|
+
"text": "boolean"
|
|
1218
|
+
},
|
|
1219
|
+
"default": "false",
|
|
1220
|
+
"description": "Defines whether the `ui5-ai-textarea` is currently in a loading(processing) state.",
|
|
1221
|
+
"privacy": "public"
|
|
1222
|
+
},
|
|
1223
|
+
{
|
|
1224
|
+
"kind": "field",
|
|
1225
|
+
"name": "promptDescription",
|
|
1226
|
+
"type": {
|
|
1227
|
+
"text": "string"
|
|
1228
|
+
},
|
|
1229
|
+
"default": "\"\"",
|
|
1230
|
+
"description": "Defines the prompt description of the current action.",
|
|
1231
|
+
"privacy": "public"
|
|
1232
|
+
},
|
|
1233
|
+
{
|
|
1234
|
+
"kind": "field",
|
|
1235
|
+
"name": "totalVersions",
|
|
1236
|
+
"type": {
|
|
1237
|
+
"text": "number"
|
|
1238
|
+
},
|
|
1239
|
+
"default": "0",
|
|
1240
|
+
"description": "Indicates the total number of result versions available.\n\nNotes:\nVersioning is hidden if the value is `0`",
|
|
1241
|
+
"privacy": "public"
|
|
1242
|
+
},
|
|
1243
|
+
{
|
|
1244
|
+
"kind": "field",
|
|
1245
|
+
"name": "accessibleDescription",
|
|
1246
|
+
"type": {
|
|
1247
|
+
"text": "string | undefined"
|
|
1248
|
+
},
|
|
1249
|
+
"description": "Defines the accessible description of the component.",
|
|
1250
|
+
"default": "undefined",
|
|
1251
|
+
"privacy": "public"
|
|
1252
|
+
},
|
|
1253
|
+
{
|
|
1254
|
+
"kind": "field",
|
|
1255
|
+
"name": "accessibleDescriptionRef",
|
|
1256
|
+
"type": {
|
|
1257
|
+
"text": "string | undefined"
|
|
1258
|
+
},
|
|
1259
|
+
"description": "Receives id(or many ids) of the elements that describe the textarea.",
|
|
1260
|
+
"default": "undefined",
|
|
1261
|
+
"privacy": "public"
|
|
1262
|
+
},
|
|
1263
|
+
{
|
|
1264
|
+
"kind": "field",
|
|
1265
|
+
"name": "accessibleName",
|
|
1266
|
+
"type": {
|
|
1267
|
+
"text": "string | undefined"
|
|
1268
|
+
},
|
|
1269
|
+
"description": "Defines the accessible ARIA name of the component.",
|
|
1270
|
+
"default": "undefined",
|
|
1271
|
+
"privacy": "public"
|
|
1272
|
+
},
|
|
1273
|
+
{
|
|
1274
|
+
"kind": "field",
|
|
1275
|
+
"name": "accessibleNameRef",
|
|
1276
|
+
"type": {
|
|
1277
|
+
"text": "string | undefined"
|
|
1278
|
+
},
|
|
1279
|
+
"description": "Receives id(or many ids) of the elements that label the textarea.",
|
|
1280
|
+
"default": "undefined",
|
|
1281
|
+
"privacy": "public"
|
|
1282
|
+
},
|
|
1283
|
+
{
|
|
1284
|
+
"kind": "field",
|
|
1285
|
+
"name": "disabled",
|
|
1286
|
+
"type": {
|
|
1287
|
+
"text": "boolean"
|
|
1288
|
+
},
|
|
1289
|
+
"default": "false",
|
|
1290
|
+
"description": "Indicates whether the user can interact with the component or not.\n\n**Note:** A disabled component is completely noninteractive.",
|
|
1291
|
+
"privacy": "public"
|
|
1292
|
+
},
|
|
1293
|
+
{
|
|
1294
|
+
"kind": "field",
|
|
1295
|
+
"name": "growing",
|
|
1296
|
+
"type": {
|
|
1297
|
+
"text": "boolean"
|
|
1298
|
+
},
|
|
1299
|
+
"default": "false",
|
|
1300
|
+
"description": "Enables the component to automatically grow and shrink dynamically with its content.",
|
|
1301
|
+
"privacy": "public"
|
|
1302
|
+
},
|
|
1303
|
+
{
|
|
1304
|
+
"kind": "field",
|
|
1305
|
+
"name": "growingMaxRows",
|
|
1306
|
+
"type": {
|
|
1307
|
+
"text": "number"
|
|
1308
|
+
},
|
|
1309
|
+
"default": "0",
|
|
1310
|
+
"description": "Defines the maximum number of rows that the component can grow.",
|
|
1311
|
+
"privacy": "public"
|
|
1312
|
+
},
|
|
1313
|
+
{
|
|
1314
|
+
"kind": "field",
|
|
1315
|
+
"name": "maxlength",
|
|
1316
|
+
"type": {
|
|
1317
|
+
"text": "number | undefined"
|
|
1318
|
+
},
|
|
1319
|
+
"description": "Defines the maximum number of characters that the `value` can have.",
|
|
1320
|
+
"default": "undefined",
|
|
1321
|
+
"privacy": "public"
|
|
1322
|
+
},
|
|
1323
|
+
{
|
|
1324
|
+
"kind": "field",
|
|
1325
|
+
"name": "name",
|
|
1326
|
+
"type": {
|
|
1327
|
+
"text": "string | undefined"
|
|
1328
|
+
},
|
|
1329
|
+
"description": "Determines the name by which the component will be identified upon submission in an HTML form.\n\n**Note:** This property is only applicable within the context of an HTML Form element.",
|
|
1330
|
+
"default": "undefined",
|
|
1331
|
+
"privacy": "public"
|
|
1332
|
+
},
|
|
1333
|
+
{
|
|
1334
|
+
"kind": "field",
|
|
1335
|
+
"name": "placeholder",
|
|
1336
|
+
"type": {
|
|
1337
|
+
"text": "string | undefined"
|
|
1338
|
+
},
|
|
1339
|
+
"description": "Defines a short hint intended to aid the user with data entry when the component has no value.",
|
|
1340
|
+
"default": "undefined",
|
|
1341
|
+
"privacy": "public"
|
|
1342
|
+
},
|
|
1343
|
+
{
|
|
1344
|
+
"kind": "field",
|
|
1345
|
+
"name": "readonly",
|
|
1346
|
+
"type": {
|
|
1347
|
+
"text": "boolean"
|
|
1348
|
+
},
|
|
1349
|
+
"default": "false",
|
|
1350
|
+
"description": "Defines whether the component is read-only.\n\n**Note:** A read-only component is not editable,\nbut still provides visual feedback upon user interaction.",
|
|
1351
|
+
"privacy": "public"
|
|
1352
|
+
},
|
|
1353
|
+
{
|
|
1354
|
+
"kind": "field",
|
|
1355
|
+
"name": "required",
|
|
1356
|
+
"type": {
|
|
1357
|
+
"text": "boolean"
|
|
1358
|
+
},
|
|
1359
|
+
"default": "false",
|
|
1360
|
+
"description": "Defines whether the component is required.",
|
|
1361
|
+
"privacy": "public"
|
|
1362
|
+
},
|
|
1363
|
+
{
|
|
1364
|
+
"kind": "field",
|
|
1365
|
+
"name": "rows",
|
|
1366
|
+
"type": {
|
|
1367
|
+
"text": "number"
|
|
1368
|
+
},
|
|
1369
|
+
"default": "0",
|
|
1370
|
+
"description": "Defines the number of visible text rows for the component.\n\n**Notes:**\n\n- If the `growing` property is enabled, this property defines the minimum rows to be displayed\nin the textarea.\n- The CSS `height` property wins over the `rows` property, if both are set.",
|
|
1371
|
+
"privacy": "public"
|
|
1372
|
+
},
|
|
1373
|
+
{
|
|
1374
|
+
"kind": "field",
|
|
1375
|
+
"name": "showExceededText",
|
|
1376
|
+
"type": {
|
|
1377
|
+
"text": "boolean"
|
|
1378
|
+
},
|
|
1379
|
+
"default": "false",
|
|
1380
|
+
"description": "Determines whether the characters exceeding the maximum allowed character count are visible\nin the component.\n\nIf set to `false`, the user is not allowed to enter more characters than what is set in the\n`maxlength` property.\nIf set to `true` the characters exceeding the `maxlength` value are selected on\npaste and the counter below the component displays their number.",
|
|
1381
|
+
"privacy": "public"
|
|
1382
|
+
},
|
|
1383
|
+
{
|
|
1384
|
+
"kind": "field",
|
|
1385
|
+
"name": "value",
|
|
1386
|
+
"type": {
|
|
1387
|
+
"text": "string"
|
|
1388
|
+
},
|
|
1389
|
+
"default": "\"\"",
|
|
1390
|
+
"description": "Defines the value of the component.",
|
|
1391
|
+
"privacy": "public"
|
|
1392
|
+
},
|
|
1393
|
+
{
|
|
1394
|
+
"kind": "field",
|
|
1395
|
+
"name": "valueState",
|
|
1396
|
+
"type": {
|
|
1397
|
+
"text": "ValueState",
|
|
1398
|
+
"references": [
|
|
1399
|
+
{
|
|
1400
|
+
"name": "ValueState",
|
|
1401
|
+
"package": "@ui5/webcomponents-base",
|
|
1402
|
+
"module": "dist/types/ValueState.js"
|
|
1403
|
+
}
|
|
1404
|
+
]
|
|
1405
|
+
},
|
|
1406
|
+
"default": "\"None\"",
|
|
1407
|
+
"description": "Defines the value state of the component.\n\n**Note:** If `maxlength` property is set,\nthe component turns into \"Critical\" state once the characters exceeds the limit.\nIn this case, only the \"Negative\" state is considered and can be applied.",
|
|
1408
|
+
"privacy": "public"
|
|
1409
|
+
}
|
|
1410
|
+
],
|
|
1411
|
+
"events": [
|
|
1412
|
+
{
|
|
1413
|
+
"name": "stop-generation",
|
|
1414
|
+
"type": {
|
|
1415
|
+
"text": "CustomEvent"
|
|
1416
|
+
},
|
|
1417
|
+
"description": "Fired when the user requests to stop AI text generation."
|
|
1418
|
+
},
|
|
1419
|
+
{
|
|
1420
|
+
"name": "version-change",
|
|
1421
|
+
"type": {
|
|
1422
|
+
"text": "CustomEvent<TextAreaVersionChangeEventDetail>",
|
|
1423
|
+
"references": [
|
|
1424
|
+
{
|
|
1425
|
+
"name": "TextAreaVersionChangeEventDetail",
|
|
1426
|
+
"package": "@ui5/webcomponents-ai",
|
|
1427
|
+
"module": "dist/TextArea.js"
|
|
1428
|
+
}
|
|
1429
|
+
]
|
|
1430
|
+
},
|
|
1431
|
+
"description": "Fired when the user clicks on version navigation buttons."
|
|
1432
|
+
},
|
|
1433
|
+
{
|
|
1434
|
+
"name": "change",
|
|
1435
|
+
"type": {
|
|
1436
|
+
"text": "CustomEvent"
|
|
1437
|
+
},
|
|
1438
|
+
"description": "Fired when the text has changed and the focus leaves the component."
|
|
1439
|
+
},
|
|
1440
|
+
{
|
|
1441
|
+
"name": "input",
|
|
1442
|
+
"type": {
|
|
1443
|
+
"text": "CustomEvent<TextAreaInputEventDetail>",
|
|
1444
|
+
"references": [
|
|
1445
|
+
{
|
|
1446
|
+
"name": "TextAreaInputEventDetail",
|
|
1447
|
+
"package": "@ui5/webcomponents",
|
|
1448
|
+
"module": "dist/TextArea.js"
|
|
1449
|
+
}
|
|
1450
|
+
]
|
|
1451
|
+
},
|
|
1452
|
+
"description": "Fired when the value of the component changes at each keystroke or when\nsomething is pasted."
|
|
1453
|
+
},
|
|
1454
|
+
{
|
|
1455
|
+
"name": "scroll",
|
|
1456
|
+
"type": {
|
|
1457
|
+
"text": "CustomEvent"
|
|
1458
|
+
},
|
|
1459
|
+
"description": "Fired when textarea is scrolled."
|
|
1460
|
+
},
|
|
1461
|
+
{
|
|
1462
|
+
"name": "select",
|
|
1463
|
+
"type": {
|
|
1464
|
+
"text": "CustomEvent"
|
|
1465
|
+
},
|
|
1466
|
+
"description": "Fired when some text has been selected."
|
|
1467
|
+
}
|
|
1468
|
+
],
|
|
1469
|
+
"attributes": [
|
|
1470
|
+
{
|
|
1471
|
+
"description": "Indicates the index of the currently displayed version.",
|
|
1472
|
+
"name": "current-version",
|
|
1473
|
+
"default": "0",
|
|
1474
|
+
"fieldName": "currentVersion",
|
|
1475
|
+
"type": {
|
|
1476
|
+
"text": "number"
|
|
1477
|
+
}
|
|
1478
|
+
},
|
|
1479
|
+
{
|
|
1480
|
+
"description": "Defines whether the `ui5-ai-textarea` is currently in a loading(processing) state.",
|
|
1481
|
+
"name": "loading",
|
|
1482
|
+
"default": "false",
|
|
1483
|
+
"fieldName": "loading",
|
|
1484
|
+
"type": {
|
|
1485
|
+
"text": "boolean"
|
|
1486
|
+
}
|
|
1487
|
+
},
|
|
1488
|
+
{
|
|
1489
|
+
"description": "Defines the prompt description of the current action.",
|
|
1490
|
+
"name": "prompt-description",
|
|
1491
|
+
"default": "\"\"",
|
|
1492
|
+
"fieldName": "promptDescription",
|
|
1493
|
+
"type": {
|
|
1494
|
+
"text": "string"
|
|
1495
|
+
}
|
|
1496
|
+
},
|
|
1497
|
+
{
|
|
1498
|
+
"description": "Indicates the total number of result versions available.\n\nNotes:\nVersioning is hidden if the value is `0`",
|
|
1499
|
+
"name": "total-versions",
|
|
1500
|
+
"default": "0",
|
|
1501
|
+
"fieldName": "totalVersions",
|
|
1502
|
+
"type": {
|
|
1503
|
+
"text": "number"
|
|
1504
|
+
}
|
|
1505
|
+
},
|
|
1506
|
+
{
|
|
1507
|
+
"description": "Defines the accessible description of the component.",
|
|
1508
|
+
"name": "accessible-description",
|
|
1509
|
+
"default": "undefined",
|
|
1510
|
+
"fieldName": "accessibleDescription",
|
|
1511
|
+
"type": {
|
|
1512
|
+
"text": "string | undefined"
|
|
1513
|
+
}
|
|
1514
|
+
},
|
|
1515
|
+
{
|
|
1516
|
+
"description": "Receives id(or many ids) of the elements that describe the textarea.",
|
|
1517
|
+
"name": "accessible-description-ref",
|
|
1518
|
+
"default": "undefined",
|
|
1519
|
+
"fieldName": "accessibleDescriptionRef",
|
|
1520
|
+
"type": {
|
|
1521
|
+
"text": "string | undefined"
|
|
1522
|
+
}
|
|
1523
|
+
},
|
|
1524
|
+
{
|
|
1525
|
+
"description": "Defines the accessible ARIA name of the component.",
|
|
1526
|
+
"name": "accessible-name",
|
|
1527
|
+
"default": "undefined",
|
|
1528
|
+
"fieldName": "accessibleName",
|
|
1529
|
+
"type": {
|
|
1530
|
+
"text": "string | undefined"
|
|
1531
|
+
}
|
|
1532
|
+
},
|
|
1533
|
+
{
|
|
1534
|
+
"description": "Receives id(or many ids) of the elements that label the textarea.",
|
|
1535
|
+
"name": "accessible-name-ref",
|
|
1536
|
+
"default": "undefined",
|
|
1537
|
+
"fieldName": "accessibleNameRef",
|
|
1538
|
+
"type": {
|
|
1539
|
+
"text": "string | undefined"
|
|
1540
|
+
}
|
|
1541
|
+
},
|
|
1542
|
+
{
|
|
1543
|
+
"description": "Indicates whether the user can interact with the component or not.\n\n**Note:** A disabled component is completely noninteractive.",
|
|
1544
|
+
"name": "disabled",
|
|
1545
|
+
"default": "false",
|
|
1546
|
+
"fieldName": "disabled",
|
|
1547
|
+
"type": {
|
|
1548
|
+
"text": "boolean"
|
|
1549
|
+
}
|
|
1550
|
+
},
|
|
1551
|
+
{
|
|
1552
|
+
"description": "Enables the component to automatically grow and shrink dynamically with its content.",
|
|
1553
|
+
"name": "growing",
|
|
1554
|
+
"default": "false",
|
|
1555
|
+
"fieldName": "growing",
|
|
1556
|
+
"type": {
|
|
1557
|
+
"text": "boolean"
|
|
1558
|
+
}
|
|
1559
|
+
},
|
|
1560
|
+
{
|
|
1561
|
+
"description": "Defines the maximum number of rows that the component can grow.",
|
|
1562
|
+
"name": "growing-max-rows",
|
|
1563
|
+
"default": "0",
|
|
1564
|
+
"fieldName": "growingMaxRows",
|
|
1565
|
+
"type": {
|
|
1566
|
+
"text": "number"
|
|
1567
|
+
}
|
|
1568
|
+
},
|
|
1569
|
+
{
|
|
1570
|
+
"description": "Defines the maximum number of characters that the `value` can have.",
|
|
1571
|
+
"name": "maxlength",
|
|
1572
|
+
"default": "undefined",
|
|
1573
|
+
"fieldName": "maxlength",
|
|
1574
|
+
"type": {
|
|
1575
|
+
"text": "number | undefined"
|
|
1576
|
+
}
|
|
1577
|
+
},
|
|
1578
|
+
{
|
|
1579
|
+
"description": "Determines the name by which the component will be identified upon submission in an HTML form.\n\n**Note:** This property is only applicable within the context of an HTML Form element.",
|
|
1580
|
+
"name": "name",
|
|
1581
|
+
"default": "undefined",
|
|
1582
|
+
"fieldName": "name",
|
|
1583
|
+
"type": {
|
|
1584
|
+
"text": "string | undefined"
|
|
1585
|
+
}
|
|
1586
|
+
},
|
|
1587
|
+
{
|
|
1588
|
+
"description": "Defines a short hint intended to aid the user with data entry when the component has no value.",
|
|
1589
|
+
"name": "placeholder",
|
|
1590
|
+
"default": "undefined",
|
|
1591
|
+
"fieldName": "placeholder",
|
|
1592
|
+
"type": {
|
|
1593
|
+
"text": "string | undefined"
|
|
1594
|
+
}
|
|
1595
|
+
},
|
|
1596
|
+
{
|
|
1597
|
+
"description": "Defines whether the component is read-only.\n\n**Note:** A read-only component is not editable,\nbut still provides visual feedback upon user interaction.",
|
|
1598
|
+
"name": "readonly",
|
|
1599
|
+
"default": "false",
|
|
1600
|
+
"fieldName": "readonly",
|
|
1601
|
+
"type": {
|
|
1602
|
+
"text": "boolean"
|
|
1603
|
+
}
|
|
1604
|
+
},
|
|
1605
|
+
{
|
|
1606
|
+
"description": "Defines whether the component is required.",
|
|
1607
|
+
"name": "required",
|
|
1608
|
+
"default": "false",
|
|
1609
|
+
"fieldName": "required",
|
|
1610
|
+
"type": {
|
|
1611
|
+
"text": "boolean"
|
|
1612
|
+
}
|
|
1613
|
+
},
|
|
1614
|
+
{
|
|
1615
|
+
"description": "Defines the number of visible text rows for the component.\n\n**Notes:**\n\n- If the `growing` property is enabled, this property defines the minimum rows to be displayed\nin the textarea.\n- The CSS `height` property wins over the `rows` property, if both are set.",
|
|
1616
|
+
"name": "rows",
|
|
1617
|
+
"default": "0",
|
|
1618
|
+
"fieldName": "rows",
|
|
1619
|
+
"type": {
|
|
1620
|
+
"text": "number"
|
|
1621
|
+
}
|
|
1622
|
+
},
|
|
1623
|
+
{
|
|
1624
|
+
"description": "Determines whether the characters exceeding the maximum allowed character count are visible\nin the component.\n\nIf set to `false`, the user is not allowed to enter more characters than what is set in the\n`maxlength` property.\nIf set to `true` the characters exceeding the `maxlength` value are selected on\npaste and the counter below the component displays their number.",
|
|
1625
|
+
"name": "show-exceeded-text",
|
|
1626
|
+
"default": "false",
|
|
1627
|
+
"fieldName": "showExceededText",
|
|
1628
|
+
"type": {
|
|
1629
|
+
"text": "boolean"
|
|
1630
|
+
}
|
|
1631
|
+
},
|
|
1632
|
+
{
|
|
1633
|
+
"description": "Defines the value of the component.",
|
|
1634
|
+
"name": "value",
|
|
1635
|
+
"default": "\"\"",
|
|
1636
|
+
"fieldName": "value",
|
|
1637
|
+
"type": {
|
|
1638
|
+
"text": "string"
|
|
1639
|
+
}
|
|
1640
|
+
},
|
|
1641
|
+
{
|
|
1642
|
+
"description": "Defines the value state of the component.\n\n**Note:** If `maxlength` property is set,\nthe component turns into \"Critical\" state once the characters exceeds the limit.\nIn this case, only the \"Negative\" state is considered and can be applied.",
|
|
1643
|
+
"name": "value-state",
|
|
1644
|
+
"default": "\"None\"",
|
|
1645
|
+
"fieldName": "valueState",
|
|
1646
|
+
"type": {
|
|
1647
|
+
"text": "\"None\" | \"Positive\" | \"Critical\" | \"Negative\" | \"Information\""
|
|
1648
|
+
}
|
|
1649
|
+
}
|
|
1650
|
+
],
|
|
1651
|
+
"superclass": {
|
|
1652
|
+
"name": "TextArea",
|
|
1653
|
+
"package": "@ui5/webcomponents",
|
|
1654
|
+
"module": "dist/TextArea.js"
|
|
1655
|
+
},
|
|
1656
|
+
"tagName": "ui5-ai-textarea",
|
|
1657
|
+
"customElement": true,
|
|
1658
|
+
"cssParts": [
|
|
1659
|
+
{
|
|
1660
|
+
"description": "Used to style the native textarea",
|
|
1661
|
+
"name": "textarea"
|
|
1662
|
+
}
|
|
1663
|
+
]
|
|
1664
|
+
}
|
|
1665
|
+
],
|
|
1666
|
+
"exports": [
|
|
1667
|
+
{
|
|
1668
|
+
"kind": "js",
|
|
1669
|
+
"name": "default",
|
|
1670
|
+
"declaration": {
|
|
1671
|
+
"name": "TextArea",
|
|
1672
|
+
"module": "dist/TextArea.js"
|
|
1673
|
+
}
|
|
1674
|
+
},
|
|
1675
|
+
{
|
|
1676
|
+
"kind": "custom-element-definition",
|
|
1677
|
+
"name": "ui5-ai-textarea",
|
|
1678
|
+
"declaration": {
|
|
1679
|
+
"name": "TextArea",
|
|
1680
|
+
"module": "dist/TextArea.js"
|
|
1681
|
+
}
|
|
1682
|
+
}
|
|
1683
|
+
]
|
|
1684
|
+
},
|
|
1685
|
+
{
|
|
1686
|
+
"kind": "javascript-module",
|
|
1687
|
+
"path": "dist/ToolbarLabel.js",
|
|
1688
|
+
"declarations": [
|
|
1689
|
+
{
|
|
1690
|
+
"kind": "class",
|
|
1691
|
+
"description": "### Overview\nThe `ui5-ai-toolbar-label` represents a text label,\nused in the `ui5-toolbar`.\n\n### ES6 Module Import\n`import \"@ui5/webcomponents-ai/dist/ToolbarLabel.js\";`",
|
|
1692
|
+
"name": "ToolbarLabel",
|
|
1693
|
+
"members": [
|
|
1694
|
+
{
|
|
1695
|
+
"kind": "field",
|
|
1696
|
+
"name": "text",
|
|
1697
|
+
"type": {
|
|
1698
|
+
"text": "string"
|
|
1699
|
+
},
|
|
1700
|
+
"default": "\"\"",
|
|
1701
|
+
"description": "Defines the text of the label.",
|
|
1702
|
+
"privacy": "public"
|
|
1703
|
+
},
|
|
1704
|
+
{
|
|
1705
|
+
"kind": "field",
|
|
1706
|
+
"name": "overflowPriority",
|
|
1707
|
+
"type": {
|
|
1708
|
+
"text": "ToolbarItemOverflowBehavior",
|
|
1709
|
+
"references": [
|
|
1710
|
+
{
|
|
1711
|
+
"name": "ToolbarItemOverflowBehavior",
|
|
1712
|
+
"package": "@ui5/webcomponents",
|
|
1713
|
+
"module": "dist/types/ToolbarItemOverflowBehavior.js"
|
|
1714
|
+
}
|
|
1715
|
+
]
|
|
1716
|
+
},
|
|
1717
|
+
"default": "\"Default\"",
|
|
1718
|
+
"description": "Property used to define the access of the item to the overflow Popover. If \"NeverOverflow\" option is set,\nthe item never goes in the Popover, if \"AlwaysOverflow\" - it never comes out of it.",
|
|
1719
|
+
"privacy": "public"
|
|
1720
|
+
},
|
|
1721
|
+
{
|
|
1722
|
+
"kind": "field",
|
|
1723
|
+
"name": "preventOverflowClosing",
|
|
1724
|
+
"type": {
|
|
1725
|
+
"text": "boolean"
|
|
1726
|
+
},
|
|
1727
|
+
"default": "false",
|
|
1728
|
+
"description": "Defines if the toolbar overflow popup should close upon interaction with the item.\nIt will close by default.",
|
|
1729
|
+
"privacy": "public"
|
|
1730
|
+
}
|
|
1731
|
+
],
|
|
1732
|
+
"attributes": [
|
|
1733
|
+
{
|
|
1734
|
+
"description": "Defines the text of the label.",
|
|
1735
|
+
"name": "text",
|
|
1736
|
+
"default": "\"\"",
|
|
1737
|
+
"fieldName": "text",
|
|
1738
|
+
"type": {
|
|
1739
|
+
"text": "string"
|
|
1740
|
+
}
|
|
1741
|
+
},
|
|
1742
|
+
{
|
|
1743
|
+
"description": "Property used to define the access of the item to the overflow Popover. If \"NeverOverflow\" option is set,\nthe item never goes in the Popover, if \"AlwaysOverflow\" - it never comes out of it.",
|
|
1744
|
+
"name": "overflow-priority",
|
|
1745
|
+
"default": "\"Default\"",
|
|
1746
|
+
"fieldName": "overflowPriority",
|
|
1747
|
+
"type": {
|
|
1748
|
+
"text": "\"Default\" | \"NeverOverflow\" | \"AlwaysOverflow\""
|
|
1749
|
+
}
|
|
1750
|
+
},
|
|
1751
|
+
{
|
|
1752
|
+
"description": "Defines if the toolbar overflow popup should close upon interaction with the item.\nIt will close by default.",
|
|
1753
|
+
"name": "prevent-overflow-closing",
|
|
1754
|
+
"default": "false",
|
|
1755
|
+
"fieldName": "preventOverflowClosing",
|
|
1756
|
+
"type": {
|
|
1757
|
+
"text": "boolean"
|
|
1758
|
+
}
|
|
1759
|
+
}
|
|
1760
|
+
],
|
|
1761
|
+
"superclass": {
|
|
1762
|
+
"name": "ToolbarItem",
|
|
1763
|
+
"package": "@ui5/webcomponents",
|
|
1764
|
+
"module": "dist/ToolbarItem.js"
|
|
1765
|
+
},
|
|
1766
|
+
"tagName": "ui5-ai-toolbar-label",
|
|
1767
|
+
"customElement": true,
|
|
1768
|
+
"slots": [
|
|
1769
|
+
{
|
|
1770
|
+
"name": "default",
|
|
1771
|
+
"description": "Wrapped component slot."
|
|
1772
|
+
}
|
|
1773
|
+
]
|
|
725
1774
|
}
|
|
726
1775
|
],
|
|
727
1776
|
"exports": [
|
|
@@ -729,144 +1778,137 @@
|
|
|
729
1778
|
"kind": "js",
|
|
730
1779
|
"name": "default",
|
|
731
1780
|
"declaration": {
|
|
732
|
-
"name": "
|
|
733
|
-
"module": "dist/
|
|
1781
|
+
"name": "ToolbarLabel",
|
|
1782
|
+
"module": "dist/ToolbarLabel.js"
|
|
734
1783
|
}
|
|
735
1784
|
},
|
|
736
1785
|
{
|
|
737
1786
|
"kind": "custom-element-definition",
|
|
738
|
-
"name": "ui5-ai-
|
|
1787
|
+
"name": "ui5-ai-toolbar-label",
|
|
739
1788
|
"declaration": {
|
|
740
|
-
"name": "
|
|
741
|
-
"module": "dist/
|
|
1789
|
+
"name": "ToolbarLabel",
|
|
1790
|
+
"module": "dist/ToolbarLabel.js"
|
|
742
1791
|
}
|
|
743
1792
|
}
|
|
744
1793
|
]
|
|
745
1794
|
},
|
|
746
1795
|
{
|
|
747
1796
|
"kind": "javascript-module",
|
|
748
|
-
"path": "dist/
|
|
1797
|
+
"path": "dist/Versioning.js",
|
|
749
1798
|
"declarations": [
|
|
750
1799
|
{
|
|
751
1800
|
"kind": "class",
|
|
752
|
-
"description": "### Overview\n\nThe `ui5-ai-
|
|
753
|
-
"name": "
|
|
754
|
-
"slots": [
|
|
755
|
-
{
|
|
756
|
-
"description": "Defines a slot for `ui5-menu` integration. This slot allows you to pass a `ui5-menu` instance that will be associated with the assistant.",
|
|
757
|
-
"name": "menu"
|
|
758
|
-
}
|
|
759
|
-
],
|
|
1801
|
+
"description": "### Overview\n\nThe `ui5-ai-versioning` component provides navigation controls for AI-generated content versions.\nIt displays the current version index and total versions, with previous/next navigation buttons.\nThis component extends ToolbarItem to participate in toolbar overflow behavior as a single unit.\n\n### Structure\nThe `ui5-ai-versioning` consists of the following elements:\n- Previous Button: Navigates to the previous version (disabled when at first version)\n- Version Counter: Shows current version / total versions (e.g., \"2 / 5\")\n- Next Button: Navigates to the nex\nt version (disabled when at last version)\n\n### Focus Management\nThe component automatically manages focus when users reach version boundaries,\nmoving focus to the available navigation button when one becomes disabled.\n\n### Responsive Behavior\nWhen used in a toolbar, the entire versioning component (buttons + label) will overflow\ntogether as a single unit when there is insufficient space.\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-ai/dist/Versioning.js\";`",
|
|
1802
|
+
"name": "Versioning",
|
|
760
1803
|
"members": [
|
|
761
1804
|
{
|
|
762
1805
|
"kind": "field",
|
|
763
|
-
"name": "
|
|
1806
|
+
"name": "currentStep",
|
|
764
1807
|
"type": {
|
|
765
|
-
"text": "
|
|
1808
|
+
"text": "number"
|
|
766
1809
|
},
|
|
767
|
-
"default": "
|
|
768
|
-
"description": "
|
|
1810
|
+
"default": "0",
|
|
1811
|
+
"description": "Indicates the index of the currently displayed result version.\n\nThis property represents the current position in the version history.",
|
|
769
1812
|
"privacy": "public"
|
|
770
1813
|
},
|
|
771
1814
|
{
|
|
772
1815
|
"kind": "field",
|
|
773
|
-
"name": "
|
|
1816
|
+
"name": "totalSteps",
|
|
774
1817
|
"type": {
|
|
775
|
-
"text": "
|
|
1818
|
+
"text": "number"
|
|
776
1819
|
},
|
|
777
|
-
"default": "
|
|
778
|
-
"description": "
|
|
1820
|
+
"default": "0",
|
|
1821
|
+
"description": "The total number of available result versions.\n\nNote: Versioning is hidden if the value is `0`.",
|
|
779
1822
|
"privacy": "public"
|
|
780
1823
|
},
|
|
781
1824
|
{
|
|
782
1825
|
"kind": "field",
|
|
783
|
-
"name": "
|
|
1826
|
+
"name": "overflowPriority",
|
|
784
1827
|
"type": {
|
|
785
|
-
"text": "
|
|
1828
|
+
"text": "ToolbarItemOverflowBehavior",
|
|
1829
|
+
"references": [
|
|
1830
|
+
{
|
|
1831
|
+
"name": "ToolbarItemOverflowBehavior",
|
|
1832
|
+
"package": "@ui5/webcomponents",
|
|
1833
|
+
"module": "dist/types/ToolbarItemOverflowBehavior.js"
|
|
1834
|
+
}
|
|
1835
|
+
]
|
|
786
1836
|
},
|
|
787
|
-
"default": "
|
|
788
|
-
"description": "
|
|
1837
|
+
"default": "\"Default\"",
|
|
1838
|
+
"description": "Property used to define the access of the item to the overflow Popover. If \"NeverOverflow\" option is set,\nthe item never goes in the Popover, if \"AlwaysOverflow\" - it never comes out of it.",
|
|
789
1839
|
"privacy": "public"
|
|
790
1840
|
},
|
|
791
1841
|
{
|
|
792
1842
|
"kind": "field",
|
|
793
|
-
"name": "
|
|
1843
|
+
"name": "preventOverflowClosing",
|
|
794
1844
|
"type": {
|
|
795
|
-
"text": "
|
|
1845
|
+
"text": "boolean"
|
|
796
1846
|
},
|
|
797
|
-
"default": "
|
|
798
|
-
"description": "
|
|
1847
|
+
"default": "false",
|
|
1848
|
+
"description": "Defines if the toolbar overflow popup should close upon interaction with the item.\nIt will close by default.",
|
|
799
1849
|
"privacy": "public"
|
|
800
1850
|
}
|
|
801
1851
|
],
|
|
802
1852
|
"events": [
|
|
803
1853
|
{
|
|
804
1854
|
"name": "version-change",
|
|
805
|
-
"type": {
|
|
806
|
-
"text": "CustomEvent<TextAreaVersionChangeEventDetail>",
|
|
807
|
-
"references": [
|
|
808
|
-
{
|
|
809
|
-
"name": "TextAreaVersionChangeEventDetail",
|
|
810
|
-
"package": "@ui5/webcomponents-ai",
|
|
811
|
-
"module": "dist/TextArea.js"
|
|
812
|
-
}
|
|
813
|
-
]
|
|
814
|
-
},
|
|
815
|
-
"description": "Fired when the user clicks on version navigation buttons."
|
|
816
|
-
},
|
|
817
|
-
{
|
|
818
|
-
"name": "stop-generation",
|
|
819
1855
|
"type": {
|
|
820
1856
|
"text": "CustomEvent"
|
|
821
1857
|
},
|
|
822
|
-
"description": "Fired when the user
|
|
1858
|
+
"description": "Fired when the user clicks on version navigation buttons."
|
|
823
1859
|
}
|
|
824
1860
|
],
|
|
825
1861
|
"attributes": [
|
|
826
1862
|
{
|
|
827
|
-
"description": "
|
|
828
|
-
"name": "
|
|
829
|
-
"default": "
|
|
830
|
-
"fieldName": "
|
|
1863
|
+
"description": "Indicates the index of the currently displayed result version.\n\nThis property represents the current position in the version history.",
|
|
1864
|
+
"name": "current-step",
|
|
1865
|
+
"default": "0",
|
|
1866
|
+
"fieldName": "currentStep",
|
|
831
1867
|
"type": {
|
|
832
|
-
"text": "
|
|
1868
|
+
"text": "number"
|
|
833
1869
|
}
|
|
834
1870
|
},
|
|
835
1871
|
{
|
|
836
|
-
"description": "
|
|
837
|
-
"name": "
|
|
838
|
-
"default": "
|
|
839
|
-
"fieldName": "
|
|
1872
|
+
"description": "The total number of available result versions.\n\nNote: Versioning is hidden if the value is `0`.",
|
|
1873
|
+
"name": "total-steps",
|
|
1874
|
+
"default": "0",
|
|
1875
|
+
"fieldName": "totalSteps",
|
|
840
1876
|
"type": {
|
|
841
|
-
"text": "
|
|
1877
|
+
"text": "number"
|
|
842
1878
|
}
|
|
843
1879
|
},
|
|
844
1880
|
{
|
|
845
|
-
"description": "
|
|
846
|
-
"name": "
|
|
847
|
-
"default": "
|
|
848
|
-
"fieldName": "
|
|
1881
|
+
"description": "Property used to define the access of the item to the overflow Popover. If \"NeverOverflow\" option is set,\nthe item never goes in the Popover, if \"AlwaysOverflow\" - it never comes out of it.",
|
|
1882
|
+
"name": "overflow-priority",
|
|
1883
|
+
"default": "\"Default\"",
|
|
1884
|
+
"fieldName": "overflowPriority",
|
|
849
1885
|
"type": {
|
|
850
|
-
"text": "
|
|
1886
|
+
"text": "\"Default\" | \"NeverOverflow\" | \"AlwaysOverflow\""
|
|
851
1887
|
}
|
|
852
1888
|
},
|
|
853
1889
|
{
|
|
854
|
-
"description": "
|
|
855
|
-
"name": "
|
|
856
|
-
"default": "
|
|
857
|
-
"fieldName": "
|
|
1890
|
+
"description": "Defines if the toolbar overflow popup should close upon interaction with the item.\nIt will close by default.",
|
|
1891
|
+
"name": "prevent-overflow-closing",
|
|
1892
|
+
"default": "false",
|
|
1893
|
+
"fieldName": "preventOverflowClosing",
|
|
858
1894
|
"type": {
|
|
859
|
-
"text": "
|
|
1895
|
+
"text": "boolean"
|
|
860
1896
|
}
|
|
861
1897
|
}
|
|
862
1898
|
],
|
|
863
1899
|
"superclass": {
|
|
864
|
-
"name": "
|
|
1900
|
+
"name": "ToolbarItem",
|
|
865
1901
|
"package": "@ui5/webcomponents",
|
|
866
|
-
"module": "dist/
|
|
1902
|
+
"module": "dist/ToolbarItem.js"
|
|
867
1903
|
},
|
|
868
|
-
"tagName": "ui5-ai-
|
|
869
|
-
"customElement": true
|
|
1904
|
+
"tagName": "ui5-ai-versioning",
|
|
1905
|
+
"customElement": true,
|
|
1906
|
+
"slots": [
|
|
1907
|
+
{
|
|
1908
|
+
"name": "default",
|
|
1909
|
+
"description": "Wrapped component slot."
|
|
1910
|
+
}
|
|
1911
|
+
]
|
|
870
1912
|
}
|
|
871
1913
|
],
|
|
872
1914
|
"exports": [
|
|
@@ -874,58 +1916,144 @@
|
|
|
874
1916
|
"kind": "js",
|
|
875
1917
|
"name": "default",
|
|
876
1918
|
"declaration": {
|
|
877
|
-
"name": "
|
|
878
|
-
"module": "dist/
|
|
1919
|
+
"name": "Versioning",
|
|
1920
|
+
"module": "dist/Versioning.js"
|
|
879
1921
|
}
|
|
880
1922
|
},
|
|
881
1923
|
{
|
|
882
1924
|
"kind": "custom-element-definition",
|
|
883
|
-
"name": "ui5-ai-
|
|
1925
|
+
"name": "ui5-ai-versioning",
|
|
884
1926
|
"declaration": {
|
|
885
|
-
"name": "
|
|
886
|
-
"module": "dist/
|
|
1927
|
+
"name": "Versioning",
|
|
1928
|
+
"module": "dist/Versioning.js"
|
|
887
1929
|
}
|
|
888
1930
|
}
|
|
889
1931
|
]
|
|
890
1932
|
},
|
|
891
1933
|
{
|
|
892
1934
|
"kind": "javascript-module",
|
|
893
|
-
"path": "dist/
|
|
894
|
-
"declarations": [
|
|
895
|
-
"exports": [
|
|
1935
|
+
"path": "dist/WritingAssistant.js",
|
|
1936
|
+
"declarations": [
|
|
896
1937
|
{
|
|
897
|
-
"kind": "
|
|
898
|
-
"
|
|
899
|
-
"
|
|
900
|
-
|
|
901
|
-
|
|
902
|
-
|
|
1938
|
+
"kind": "class",
|
|
1939
|
+
"description": "### Overview\n\nThe `ui5-ai-textarea-toolbar` component provides a specialized toolbar for AI TextArea functionality.\nIt manages different states of the AI assistant and provides version navigation capabilities.\n\n### Structure\nThe `ui5-ai-textarea-toolbar` consists of the following elements:\n- AI Generate Button: Triggers AI text generation or stops ongoing generation\n- Version Navigation: Allows navigation between multiple AI-generated results\n- Action Label: Displays the current AI action being performed\n\n### ES6 Module Import\n\n`import \"@sap-webcomponents/ai/dist/WritingAssistant.js\";`",
|
|
1940
|
+
"name": "WritingAssistant",
|
|
1941
|
+
"members": [
|
|
1942
|
+
{
|
|
1943
|
+
"kind": "field",
|
|
1944
|
+
"name": "currentVersion",
|
|
1945
|
+
"type": {
|
|
1946
|
+
"text": "number"
|
|
1947
|
+
},
|
|
1948
|
+
"default": "0",
|
|
1949
|
+
"description": "Indicates the index of the currently displayed result version.\n\nThe index is **0-based** (i.e. `0` represents the first result).\nThis property is synchronized with the parent AI TextArea component.",
|
|
1950
|
+
"privacy": "public"
|
|
1951
|
+
},
|
|
1952
|
+
{
|
|
1953
|
+
"kind": "method",
|
|
1954
|
+
"name": "handleButtonClick",
|
|
1955
|
+
"return": {
|
|
1956
|
+
"type": {
|
|
1957
|
+
"text": "void"
|
|
1958
|
+
}
|
|
1959
|
+
},
|
|
1960
|
+
"description": "Handles the click event for the AI generate button.\nToggles between generate and stop states based on current button state.",
|
|
1961
|
+
"privacy": "public"
|
|
1962
|
+
},
|
|
1963
|
+
{
|
|
1964
|
+
"kind": "field",
|
|
1965
|
+
"name": "promptDescription",
|
|
1966
|
+
"type": {
|
|
1967
|
+
"text": "string"
|
|
1968
|
+
},
|
|
1969
|
+
"default": "\"\"",
|
|
1970
|
+
"description": "Defines the prompt description of the Writing Assistant.\n\nThis text is displayed in the toolbar to indicate the current or last\nperformed AI action (e.g., \"Generated text\", \"Simplified text\").",
|
|
1971
|
+
"privacy": "public"
|
|
1972
|
+
},
|
|
1973
|
+
{
|
|
1974
|
+
"kind": "field",
|
|
1975
|
+
"name": "totalVersions",
|
|
1976
|
+
"type": {
|
|
1977
|
+
"text": "number"
|
|
1978
|
+
},
|
|
1979
|
+
"default": "0",
|
|
1980
|
+
"description": "Indicates the total number of result versions available.\n\nThis property determines whether version navigation controls are displayed.\nWhen totalVersions > 0, previous/next buttons become available.",
|
|
1981
|
+
"privacy": "public"
|
|
1982
|
+
}
|
|
1983
|
+
],
|
|
1984
|
+
"events": [
|
|
1985
|
+
{
|
|
1986
|
+
"name": "button-click",
|
|
1987
|
+
"type": {
|
|
1988
|
+
"text": "CustomEvent"
|
|
1989
|
+
},
|
|
1990
|
+
"description": "Fired when the user clicks on the AI button."
|
|
1991
|
+
},
|
|
1992
|
+
{
|
|
1993
|
+
"name": "stop-generation",
|
|
1994
|
+
"type": {
|
|
1995
|
+
"text": "CustomEvent"
|
|
1996
|
+
},
|
|
1997
|
+
"description": "Fired when the user clicks on the \"Stop\" button to stop ongoing AI text generation."
|
|
1998
|
+
},
|
|
1999
|
+
{
|
|
2000
|
+
"name": "version-change",
|
|
2001
|
+
"type": {
|
|
2002
|
+
"text": "CustomEvent"
|
|
2003
|
+
},
|
|
2004
|
+
"description": "Fired when the user clicks on version navigation buttons."
|
|
2005
|
+
}
|
|
2006
|
+
],
|
|
2007
|
+
"attributes": [
|
|
2008
|
+
{
|
|
2009
|
+
"description": "Indicates the index of the currently displayed result version.\n\nThe index is **0-based** (i.e. `0` represents the first result).\nThis property is synchronized with the parent AI TextArea component.",
|
|
2010
|
+
"name": "current-version",
|
|
2011
|
+
"default": "0",
|
|
2012
|
+
"fieldName": "currentVersion",
|
|
2013
|
+
"type": {
|
|
2014
|
+
"text": "number"
|
|
2015
|
+
}
|
|
2016
|
+
},
|
|
2017
|
+
{
|
|
2018
|
+
"description": "Defines the prompt description of the Writing Assistant.\n\nThis text is displayed in the toolbar to indicate the current or last\nperformed AI action (e.g., \"Generated text\", \"Simplified text\").",
|
|
2019
|
+
"name": "prompt-description",
|
|
2020
|
+
"default": "\"\"",
|
|
2021
|
+
"fieldName": "promptDescription",
|
|
2022
|
+
"type": {
|
|
2023
|
+
"text": "string"
|
|
2024
|
+
}
|
|
2025
|
+
},
|
|
2026
|
+
{
|
|
2027
|
+
"description": "Indicates the total number of result versions available.\n\nThis property determines whether version navigation controls are displayed.\nWhen totalVersions > 0, previous/next buttons become available.",
|
|
2028
|
+
"name": "total-versions",
|
|
2029
|
+
"default": "0",
|
|
2030
|
+
"fieldName": "totalVersions",
|
|
2031
|
+
"type": {
|
|
2032
|
+
"text": "number"
|
|
2033
|
+
}
|
|
2034
|
+
}
|
|
2035
|
+
],
|
|
2036
|
+
"superclass": {
|
|
2037
|
+
"name": "UI5Element",
|
|
2038
|
+
"package": "@ui5/webcomponents-base",
|
|
2039
|
+
"module": "dist/UI5Element.js"
|
|
2040
|
+
},
|
|
2041
|
+
"tagName": "ui5-ai-writing-assistant",
|
|
2042
|
+
"customElement": true
|
|
903
2043
|
}
|
|
904
|
-
]
|
|
905
|
-
},
|
|
906
|
-
{
|
|
907
|
-
"kind": "javascript-module",
|
|
908
|
-
"path": "dist/Versioning.js",
|
|
909
|
-
"declarations": [],
|
|
2044
|
+
],
|
|
910
2045
|
"exports": [
|
|
911
2046
|
{
|
|
912
2047
|
"kind": "js",
|
|
913
2048
|
"name": "default",
|
|
914
2049
|
"declaration": {
|
|
915
|
-
"name": "
|
|
916
|
-
"module": "dist/
|
|
2050
|
+
"name": "WritingAssistant",
|
|
2051
|
+
"module": "dist/WritingAssistant.js"
|
|
917
2052
|
}
|
|
918
|
-
}
|
|
919
|
-
]
|
|
920
|
-
},
|
|
921
|
-
{
|
|
922
|
-
"kind": "javascript-module",
|
|
923
|
-
"path": "dist/WritingAssistant.js",
|
|
924
|
-
"declarations": [],
|
|
925
|
-
"exports": [
|
|
2053
|
+
},
|
|
926
2054
|
{
|
|
927
|
-
"kind": "
|
|
928
|
-
"name": "
|
|
2055
|
+
"kind": "custom-element-definition",
|
|
2056
|
+
"name": "ui5-ai-writing-assistant",
|
|
929
2057
|
"declaration": {
|
|
930
2058
|
"name": "WritingAssistant",
|
|
931
2059
|
"module": "dist/WritingAssistant.js"
|