@ui5/webcomponents-ai 2.20.0-rc.2 → 2.20.0-rc.3
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 +8 -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 +1819 -484
- package/dist/custom-elements.json +1507 -351
- package/dist/vscode.html-custom-data.json +97 -46
- package/dist/web-types.json +262 -127
- package/package.json +10 -8
|
@@ -47,6 +47,36 @@
|
|
|
47
47
|
}
|
|
48
48
|
],
|
|
49
49
|
"members": [
|
|
50
|
+
{
|
|
51
|
+
"kind": "field",
|
|
52
|
+
"name": "accessibilityAttributes",
|
|
53
|
+
"type": {
|
|
54
|
+
"text": "AIButtonAccessibilityAttributes",
|
|
55
|
+
"references": [
|
|
56
|
+
{
|
|
57
|
+
"name": "AIButtonAccessibilityAttributes",
|
|
58
|
+
"package": "@ui5/webcomponents-ai",
|
|
59
|
+
"module": "dist/Button.js"
|
|
60
|
+
}
|
|
61
|
+
]
|
|
62
|
+
},
|
|
63
|
+
"default": "{}",
|
|
64
|
+
"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`.",
|
|
65
|
+
"privacy": "public",
|
|
66
|
+
"_ui5since": "2.6.0"
|
|
67
|
+
},
|
|
68
|
+
{
|
|
69
|
+
"kind": "field",
|
|
70
|
+
"name": "arrowButtonPressed",
|
|
71
|
+
"type": {
|
|
72
|
+
"text": "boolean"
|
|
73
|
+
},
|
|
74
|
+
"default": "false",
|
|
75
|
+
"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.",
|
|
76
|
+
"privacy": "public",
|
|
77
|
+
"_ui5since": "2.6.0",
|
|
78
|
+
"_ui5noAttribute": true
|
|
79
|
+
},
|
|
50
80
|
{
|
|
51
81
|
"kind": "field",
|
|
52
82
|
"name": "design",
|
|
@@ -83,63 +113,51 @@
|
|
|
83
113
|
"description": "Defines the current state of the component.",
|
|
84
114
|
"default": "undefined",
|
|
85
115
|
"privacy": "public"
|
|
86
|
-
},
|
|
87
|
-
{
|
|
88
|
-
"kind": "field",
|
|
89
|
-
"name": "arrowButtonPressed",
|
|
90
|
-
"type": {
|
|
91
|
-
"text": "boolean"
|
|
92
|
-
},
|
|
93
|
-
"default": "false",
|
|
94
|
-
"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.",
|
|
95
|
-
"privacy": "public",
|
|
96
|
-
"_ui5since": "2.6.0",
|
|
97
|
-
"_ui5noAttribute": true
|
|
98
|
-
},
|
|
99
|
-
{
|
|
100
|
-
"kind": "field",
|
|
101
|
-
"name": "accessibilityAttributes",
|
|
102
|
-
"type": {
|
|
103
|
-
"text": "AIButtonAccessibilityAttributes",
|
|
104
|
-
"references": [
|
|
105
|
-
{
|
|
106
|
-
"name": "AIButtonAccessibilityAttributes",
|
|
107
|
-
"package": "@ui5/webcomponents-ai",
|
|
108
|
-
"module": "dist/Button.js"
|
|
109
|
-
}
|
|
110
|
-
]
|
|
111
|
-
},
|
|
112
|
-
"default": "{}",
|
|
113
|
-
"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`.",
|
|
114
|
-
"privacy": "public",
|
|
115
|
-
"_ui5since": "2.6.0"
|
|
116
116
|
}
|
|
117
117
|
],
|
|
118
118
|
"events": [
|
|
119
119
|
{
|
|
120
|
-
"name": "click",
|
|
120
|
+
"name": "arrow-button-click",
|
|
121
121
|
"_ui5privacy": "public",
|
|
122
122
|
"type": {
|
|
123
123
|
"text": "CustomEvent"
|
|
124
124
|
},
|
|
125
|
-
"description": "Fired when the component is activated either
|
|
125
|
+
"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.",
|
|
126
126
|
"_ui5Cancelable": false,
|
|
127
127
|
"_ui5allowPreventDefault": false,
|
|
128
128
|
"_ui5Bubbles": true
|
|
129
129
|
},
|
|
130
130
|
{
|
|
131
|
-
"name": "
|
|
131
|
+
"name": "click",
|
|
132
132
|
"_ui5privacy": "public",
|
|
133
133
|
"type": {
|
|
134
134
|
"text": "CustomEvent"
|
|
135
135
|
},
|
|
136
|
-
"description": "Fired when the component is
|
|
136
|
+
"description": "Fired when the component is activated either with a\nmouse/tap or by using the Enter or Space key.",
|
|
137
137
|
"_ui5Cancelable": false,
|
|
138
138
|
"_ui5allowPreventDefault": false,
|
|
139
139
|
"_ui5Bubbles": true
|
|
140
140
|
}
|
|
141
141
|
],
|
|
142
142
|
"attributes": [
|
|
143
|
+
{
|
|
144
|
+
"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`.",
|
|
145
|
+
"name": "accessibility-attributes",
|
|
146
|
+
"default": "{}",
|
|
147
|
+
"fieldName": "accessibilityAttributes",
|
|
148
|
+
"type": {
|
|
149
|
+
"text": "AIButtonAccessibilityAttributes"
|
|
150
|
+
}
|
|
151
|
+
},
|
|
152
|
+
{
|
|
153
|
+
"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.",
|
|
154
|
+
"name": "arrow-button-pressed",
|
|
155
|
+
"default": "false",
|
|
156
|
+
"fieldName": "arrowButtonPressed",
|
|
157
|
+
"type": {
|
|
158
|
+
"text": "boolean"
|
|
159
|
+
}
|
|
160
|
+
},
|
|
143
161
|
{
|
|
144
162
|
"description": "Defines the component design.",
|
|
145
163
|
"name": "design",
|
|
@@ -166,24 +184,6 @@
|
|
|
166
184
|
"type": {
|
|
167
185
|
"text": "string | undefined"
|
|
168
186
|
}
|
|
169
|
-
},
|
|
170
|
-
{
|
|
171
|
-
"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.",
|
|
172
|
-
"name": "arrow-button-pressed",
|
|
173
|
-
"default": "false",
|
|
174
|
-
"fieldName": "arrowButtonPressed",
|
|
175
|
-
"type": {
|
|
176
|
-
"text": "boolean"
|
|
177
|
-
}
|
|
178
|
-
},
|
|
179
|
-
{
|
|
180
|
-
"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`.",
|
|
181
|
-
"name": "accessibility-attributes",
|
|
182
|
-
"default": "{}",
|
|
183
|
-
"fieldName": "accessibilityAttributes",
|
|
184
|
-
"type": {
|
|
185
|
-
"text": "AIButtonAccessibilityAttributes"
|
|
186
|
-
}
|
|
187
187
|
}
|
|
188
188
|
],
|
|
189
189
|
"superclass": {
|
|
@@ -228,21 +228,11 @@
|
|
|
228
228
|
"members": [
|
|
229
229
|
{
|
|
230
230
|
"kind": "field",
|
|
231
|
-
"name": "
|
|
232
|
-
"type": {
|
|
233
|
-
"text": "string | undefined"
|
|
234
|
-
},
|
|
235
|
-
"description": "Defines the name of the button state.",
|
|
236
|
-
"default": "undefined",
|
|
237
|
-
"privacy": "public"
|
|
238
|
-
},
|
|
239
|
-
{
|
|
240
|
-
"kind": "field",
|
|
241
|
-
"name": "text",
|
|
231
|
+
"name": "endIcon",
|
|
242
232
|
"type": {
|
|
243
233
|
"text": "string | undefined"
|
|
244
234
|
},
|
|
245
|
-
"description": "Defines the text
|
|
235
|
+
"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).",
|
|
246
236
|
"default": "undefined",
|
|
247
237
|
"privacy": "public"
|
|
248
238
|
},
|
|
@@ -258,11 +248,11 @@
|
|
|
258
248
|
},
|
|
259
249
|
{
|
|
260
250
|
"kind": "field",
|
|
261
|
-
"name": "
|
|
251
|
+
"name": "name",
|
|
262
252
|
"type": {
|
|
263
253
|
"text": "string | undefined"
|
|
264
254
|
},
|
|
265
|
-
"description": "Defines the
|
|
255
|
+
"description": "Defines the name of the button state.",
|
|
266
256
|
"default": "undefined",
|
|
267
257
|
"privacy": "public"
|
|
268
258
|
},
|
|
@@ -276,23 +266,24 @@
|
|
|
276
266
|
"description": "Defines if the component is in split button mode.",
|
|
277
267
|
"privacy": "public",
|
|
278
268
|
"_ui5since": "2.6.0"
|
|
279
|
-
}
|
|
280
|
-
],
|
|
281
|
-
"attributes": [
|
|
269
|
+
},
|
|
282
270
|
{
|
|
283
|
-
"
|
|
284
|
-
"name": "
|
|
285
|
-
"default": "undefined",
|
|
286
|
-
"fieldName": "name",
|
|
271
|
+
"kind": "field",
|
|
272
|
+
"name": "text",
|
|
287
273
|
"type": {
|
|
288
274
|
"text": "string | undefined"
|
|
289
|
-
}
|
|
290
|
-
},
|
|
291
|
-
{
|
|
275
|
+
},
|
|
292
276
|
"description": "Defines the text of the button in this state.",
|
|
293
|
-
"name": "text",
|
|
294
277
|
"default": "undefined",
|
|
295
|
-
"
|
|
278
|
+
"privacy": "public"
|
|
279
|
+
}
|
|
280
|
+
],
|
|
281
|
+
"attributes": [
|
|
282
|
+
{
|
|
283
|
+
"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).",
|
|
284
|
+
"name": "end-icon",
|
|
285
|
+
"default": "undefined",
|
|
286
|
+
"fieldName": "endIcon",
|
|
296
287
|
"type": {
|
|
297
288
|
"text": "string | undefined"
|
|
298
289
|
}
|
|
@@ -307,10 +298,10 @@
|
|
|
307
298
|
}
|
|
308
299
|
},
|
|
309
300
|
{
|
|
310
|
-
"description": "Defines the
|
|
311
|
-
"name": "
|
|
301
|
+
"description": "Defines the name of the button state.",
|
|
302
|
+
"name": "name",
|
|
312
303
|
"default": "undefined",
|
|
313
|
-
"fieldName": "
|
|
304
|
+
"fieldName": "name",
|
|
314
305
|
"type": {
|
|
315
306
|
"text": "string | undefined"
|
|
316
307
|
}
|
|
@@ -323,6 +314,15 @@
|
|
|
323
314
|
"type": {
|
|
324
315
|
"text": "boolean"
|
|
325
316
|
}
|
|
317
|
+
},
|
|
318
|
+
{
|
|
319
|
+
"description": "Defines the text of the button in this state.",
|
|
320
|
+
"name": "text",
|
|
321
|
+
"default": "undefined",
|
|
322
|
+
"fieldName": "text",
|
|
323
|
+
"type": {
|
|
324
|
+
"text": "string | undefined"
|
|
325
|
+
}
|
|
326
326
|
}
|
|
327
327
|
],
|
|
328
328
|
"superclass": {
|
|
@@ -373,6 +373,46 @@
|
|
|
373
373
|
"text": "Array<HTMLElement>"
|
|
374
374
|
},
|
|
375
375
|
"_ui5privacy": "public"
|
|
376
|
+
},
|
|
377
|
+
{
|
|
378
|
+
"name": "default",
|
|
379
|
+
"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.",
|
|
380
|
+
"_ui5propertyName": "suggestionItems",
|
|
381
|
+
"_ui5type": {
|
|
382
|
+
"text": "Array<IInputSuggestionItem>",
|
|
383
|
+
"references": [
|
|
384
|
+
{
|
|
385
|
+
"name": "IInputSuggestionItem",
|
|
386
|
+
"package": "@ui5/webcomponents",
|
|
387
|
+
"module": "dist/Input.js"
|
|
388
|
+
}
|
|
389
|
+
]
|
|
390
|
+
},
|
|
391
|
+
"_ui5privacy": "public"
|
|
392
|
+
},
|
|
393
|
+
{
|
|
394
|
+
"name": "icon",
|
|
395
|
+
"description": "Defines the icon to be displayed in the component.",
|
|
396
|
+
"_ui5type": {
|
|
397
|
+
"text": "Array<IIcon>",
|
|
398
|
+
"references": [
|
|
399
|
+
{
|
|
400
|
+
"name": "IIcon",
|
|
401
|
+
"package": "@ui5/webcomponents",
|
|
402
|
+
"module": "dist/Icon.js"
|
|
403
|
+
}
|
|
404
|
+
]
|
|
405
|
+
},
|
|
406
|
+
"_ui5privacy": "public"
|
|
407
|
+
},
|
|
408
|
+
{
|
|
409
|
+
"name": "valueStateMessage",
|
|
410
|
+
"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.",
|
|
411
|
+
"_ui5since": "1.0.0-rc.6",
|
|
412
|
+
"_ui5type": {
|
|
413
|
+
"text": "Array<HTMLElement>"
|
|
414
|
+
},
|
|
415
|
+
"_ui5privacy": "public"
|
|
376
416
|
}
|
|
377
417
|
],
|
|
378
418
|
"members": [
|
|
@@ -386,6 +426,16 @@
|
|
|
386
426
|
"description": "Indicates the index of the currently displayed version.",
|
|
387
427
|
"privacy": "public"
|
|
388
428
|
},
|
|
429
|
+
{
|
|
430
|
+
"kind": "field",
|
|
431
|
+
"name": "loading",
|
|
432
|
+
"type": {
|
|
433
|
+
"text": "boolean"
|
|
434
|
+
},
|
|
435
|
+
"default": "false",
|
|
436
|
+
"description": "Defines whether the AI Writing Assistant is currently loading.\n\nWhen `true`, indicates that an AI action is in progress.",
|
|
437
|
+
"privacy": "public"
|
|
438
|
+
},
|
|
389
439
|
{
|
|
390
440
|
"kind": "field",
|
|
391
441
|
"name": "totalVersions",
|
|
@@ -398,207 +448,116 @@
|
|
|
398
448
|
},
|
|
399
449
|
{
|
|
400
450
|
"kind": "field",
|
|
401
|
-
"name": "
|
|
451
|
+
"name": "accessibleDescription",
|
|
402
452
|
"type": {
|
|
403
|
-
"text": "
|
|
453
|
+
"text": "string | undefined"
|
|
404
454
|
},
|
|
405
|
-
"
|
|
406
|
-
"
|
|
407
|
-
"privacy": "public"
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
"events": [
|
|
455
|
+
"description": "Defines the accessible description of the component.",
|
|
456
|
+
"default": "undefined",
|
|
457
|
+
"privacy": "public",
|
|
458
|
+
"_ui5since": "2.9.0"
|
|
459
|
+
},
|
|
411
460
|
{
|
|
412
|
-
"
|
|
413
|
-
"
|
|
461
|
+
"kind": "field",
|
|
462
|
+
"name": "accessibleDescriptionRef",
|
|
414
463
|
"type": {
|
|
415
|
-
"text": "
|
|
464
|
+
"text": "string | undefined"
|
|
416
465
|
},
|
|
417
|
-
"description": "
|
|
418
|
-
"
|
|
419
|
-
"
|
|
420
|
-
"
|
|
466
|
+
"description": "Receives id(or many ids) of the elements that describe the input.",
|
|
467
|
+
"default": "undefined",
|
|
468
|
+
"privacy": "public",
|
|
469
|
+
"_ui5since": "2.9.0"
|
|
421
470
|
},
|
|
422
471
|
{
|
|
423
|
-
"
|
|
424
|
-
"
|
|
472
|
+
"kind": "field",
|
|
473
|
+
"name": "accessibleName",
|
|
425
474
|
"type": {
|
|
426
|
-
"text": "
|
|
427
|
-
"references": [
|
|
428
|
-
{
|
|
429
|
-
"name": "InputItemClickEventDetail",
|
|
430
|
-
"package": "@ui5/webcomponents-ai",
|
|
431
|
-
"module": "dist/Input.js"
|
|
432
|
-
}
|
|
433
|
-
]
|
|
475
|
+
"text": "string | undefined"
|
|
434
476
|
},
|
|
435
|
-
"description": "
|
|
436
|
-
"
|
|
437
|
-
"
|
|
438
|
-
"
|
|
439
|
-
"_ui5parameters": [
|
|
440
|
-
{
|
|
441
|
-
"type": {
|
|
442
|
-
"text": "HTMLElement"
|
|
443
|
-
},
|
|
444
|
-
"name": "item",
|
|
445
|
-
"_ui5privacy": "public",
|
|
446
|
-
"description": "The currently clicked menu item."
|
|
447
|
-
},
|
|
448
|
-
{
|
|
449
|
-
"type": {
|
|
450
|
-
"text": "string"
|
|
451
|
-
},
|
|
452
|
-
"name": "text",
|
|
453
|
-
"_ui5privacy": "public",
|
|
454
|
-
"description": "The text of the currently clicked menu item."
|
|
455
|
-
}
|
|
456
|
-
]
|
|
477
|
+
"description": "Defines the accessible ARIA name of the component.",
|
|
478
|
+
"default": "undefined",
|
|
479
|
+
"privacy": "public",
|
|
480
|
+
"_ui5since": "1.0.0-rc.15"
|
|
457
481
|
},
|
|
458
482
|
{
|
|
459
|
-
"
|
|
460
|
-
"
|
|
483
|
+
"kind": "field",
|
|
484
|
+
"name": "accessibleNameRef",
|
|
461
485
|
"type": {
|
|
462
|
-
"text": "
|
|
486
|
+
"text": "string | undefined"
|
|
463
487
|
},
|
|
464
|
-
"description": "
|
|
465
|
-
"
|
|
466
|
-
"
|
|
467
|
-
"
|
|
488
|
+
"description": "Receives id(or many ids) of the elements that label the input.",
|
|
489
|
+
"default": "undefined",
|
|
490
|
+
"privacy": "public",
|
|
491
|
+
"_ui5since": "1.0.0-rc.15"
|
|
468
492
|
},
|
|
469
493
|
{
|
|
470
|
-
"
|
|
471
|
-
"
|
|
494
|
+
"kind": "field",
|
|
495
|
+
"name": "disabled",
|
|
472
496
|
"type": {
|
|
473
|
-
"text": "
|
|
497
|
+
"text": "boolean"
|
|
498
|
+
},
|
|
499
|
+
"default": "false",
|
|
500
|
+
"description": "Defines whether the component is in disabled state.\n\n**Note:** A disabled component is completely noninteractive.",
|
|
501
|
+
"privacy": "public"
|
|
502
|
+
},
|
|
503
|
+
{
|
|
504
|
+
"kind": "field",
|
|
505
|
+
"name": "filter",
|
|
506
|
+
"type": {
|
|
507
|
+
"text": "InputSuggestionsFilter",
|
|
474
508
|
"references": [
|
|
475
509
|
{
|
|
476
|
-
"name": "
|
|
477
|
-
"package": "@ui5/webcomponents
|
|
478
|
-
"module": "dist/
|
|
510
|
+
"name": "InputSuggestionsFilter",
|
|
511
|
+
"package": "@ui5/webcomponents",
|
|
512
|
+
"module": "dist/types/InputSuggestionsFilter.js"
|
|
479
513
|
}
|
|
480
514
|
]
|
|
481
515
|
},
|
|
482
|
-
"description": "
|
|
483
|
-
"
|
|
484
|
-
"
|
|
485
|
-
"
|
|
486
|
-
|
|
487
|
-
{
|
|
488
|
-
"type": {
|
|
489
|
-
"text": "boolean"
|
|
490
|
-
},
|
|
491
|
-
"name": "backwards",
|
|
492
|
-
"_ui5privacy": "public",
|
|
493
|
-
"description": "Indicates if navigation is backwards (true) or forwards (false, default)"
|
|
494
|
-
}
|
|
495
|
-
]
|
|
496
|
-
}
|
|
497
|
-
],
|
|
498
|
-
"attributes": [
|
|
516
|
+
"description": "Defines the filter type of the component.",
|
|
517
|
+
"default": "\"None\"",
|
|
518
|
+
"privacy": "public",
|
|
519
|
+
"_ui5since": "2.19.0"
|
|
520
|
+
},
|
|
499
521
|
{
|
|
500
|
-
"
|
|
501
|
-
"name": "
|
|
502
|
-
"default": "0",
|
|
503
|
-
"fieldName": "currentVersion",
|
|
522
|
+
"kind": "field",
|
|
523
|
+
"name": "maxlength",
|
|
504
524
|
"type": {
|
|
505
|
-
"text": "number"
|
|
506
|
-
}
|
|
525
|
+
"text": "number | undefined"
|
|
526
|
+
},
|
|
527
|
+
"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.",
|
|
528
|
+
"default": "undefined",
|
|
529
|
+
"privacy": "public",
|
|
530
|
+
"_ui5since": "1.0.0-rc.5"
|
|
507
531
|
},
|
|
508
532
|
{
|
|
509
|
-
"
|
|
510
|
-
"name": "
|
|
511
|
-
"default": "0",
|
|
512
|
-
"fieldName": "totalVersions",
|
|
533
|
+
"kind": "field",
|
|
534
|
+
"name": "name",
|
|
513
535
|
"type": {
|
|
514
|
-
"text": "
|
|
515
|
-
}
|
|
536
|
+
"text": "string | undefined"
|
|
537
|
+
},
|
|
538
|
+
"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.",
|
|
539
|
+
"default": "undefined",
|
|
540
|
+
"privacy": "public"
|
|
516
541
|
},
|
|
517
542
|
{
|
|
518
|
-
"
|
|
519
|
-
"name": "
|
|
520
|
-
"default": "false",
|
|
521
|
-
"fieldName": "loading",
|
|
543
|
+
"kind": "field",
|
|
544
|
+
"name": "noTypeahead",
|
|
522
545
|
"type": {
|
|
523
546
|
"text": "boolean"
|
|
524
|
-
}
|
|
525
|
-
}
|
|
526
|
-
],
|
|
527
|
-
"superclass": {
|
|
528
|
-
"name": "Input",
|
|
529
|
-
"package": "@ui5/webcomponents",
|
|
530
|
-
"module": "dist/Input.js"
|
|
531
|
-
},
|
|
532
|
-
"tagName": "ui5-ai-input",
|
|
533
|
-
"customElement": true,
|
|
534
|
-
"_ui5experimental": "The **@ui5/webcomponents-ai** package is under active development and considered experimental. Component APIs are subject to change.\nFurthermore, the package supports **Horizon** themes only.",
|
|
535
|
-
"_ui5since": "2.16.0",
|
|
536
|
-
"_ui5privacy": "public"
|
|
537
|
-
}
|
|
538
|
-
],
|
|
539
|
-
"exports": [
|
|
540
|
-
{
|
|
541
|
-
"kind": "js",
|
|
542
|
-
"name": "default",
|
|
543
|
-
"declaration": {
|
|
544
|
-
"name": "Input",
|
|
545
|
-
"module": "dist/Input.js"
|
|
546
|
-
}
|
|
547
|
-
},
|
|
548
|
-
{
|
|
549
|
-
"kind": "custom-element-definition",
|
|
550
|
-
"name": "ui5-ai-input",
|
|
551
|
-
"declaration": {
|
|
552
|
-
"name": "Input",
|
|
553
|
-
"module": "dist/Input.js"
|
|
554
|
-
}
|
|
555
|
-
}
|
|
556
|
-
]
|
|
557
|
-
},
|
|
558
|
-
{
|
|
559
|
-
"kind": "javascript-module",
|
|
560
|
-
"path": "dist/PromptInput.js",
|
|
561
|
-
"declarations": [
|
|
562
|
-
{
|
|
563
|
-
"kind": "class",
|
|
564
|
-
"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\"`",
|
|
565
|
-
"name": "PromptInput",
|
|
566
|
-
"slots": [
|
|
567
|
-
{
|
|
568
|
-
"name": "default",
|
|
569
|
-
"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.",
|
|
570
|
-
"_ui5propertyName": "suggestionItems",
|
|
571
|
-
"_ui5type": {
|
|
572
|
-
"text": "Array<IInputSuggestionItem>",
|
|
573
|
-
"references": [
|
|
574
|
-
{
|
|
575
|
-
"name": "IInputSuggestionItem",
|
|
576
|
-
"package": "@ui5/webcomponents",
|
|
577
|
-
"module": "dist/Input.js"
|
|
578
|
-
}
|
|
579
|
-
]
|
|
580
547
|
},
|
|
581
|
-
"
|
|
548
|
+
"default": "false",
|
|
549
|
+
"description": "Defines whether the value will be autcompleted to match an item",
|
|
550
|
+
"privacy": "public",
|
|
551
|
+
"_ui5since": "1.4.0"
|
|
582
552
|
},
|
|
583
|
-
{
|
|
584
|
-
"name": "valueStateMessage",
|
|
585
|
-
"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.",
|
|
586
|
-
"_ui5since": "2.0.0",
|
|
587
|
-
"_ui5type": {
|
|
588
|
-
"text": "Array<HTMLElement>"
|
|
589
|
-
},
|
|
590
|
-
"_ui5privacy": "public"
|
|
591
|
-
}
|
|
592
|
-
],
|
|
593
|
-
"members": [
|
|
594
553
|
{
|
|
595
554
|
"kind": "field",
|
|
596
|
-
"name": "
|
|
555
|
+
"name": "open",
|
|
597
556
|
"type": {
|
|
598
|
-
"text": "
|
|
557
|
+
"text": "boolean"
|
|
599
558
|
},
|
|
600
|
-
"default": "
|
|
601
|
-
"description": "Defines the
|
|
559
|
+
"default": "false",
|
|
560
|
+
"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.",
|
|
602
561
|
"privacy": "public",
|
|
603
562
|
"_ui5since": "2.0.0"
|
|
604
563
|
},
|
|
@@ -610,74 +569,78 @@
|
|
|
610
569
|
},
|
|
611
570
|
"description": "Defines a short hint intended to aid the user with data entry when the\ncomponent has no value.",
|
|
612
571
|
"default": "undefined",
|
|
613
|
-
"privacy": "public"
|
|
614
|
-
"_ui5since": "2.0.0"
|
|
572
|
+
"privacy": "public"
|
|
615
573
|
},
|
|
616
574
|
{
|
|
617
575
|
"kind": "field",
|
|
618
|
-
"name": "
|
|
576
|
+
"name": "readonly",
|
|
619
577
|
"type": {
|
|
620
|
-
"text": "
|
|
578
|
+
"text": "boolean"
|
|
621
579
|
},
|
|
622
|
-
"
|
|
623
|
-
"
|
|
624
|
-
"privacy": "public"
|
|
625
|
-
"_ui5since": "2.0.0"
|
|
580
|
+
"default": "false",
|
|
581
|
+
"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.",
|
|
582
|
+
"privacy": "public"
|
|
626
583
|
},
|
|
627
584
|
{
|
|
628
585
|
"kind": "field",
|
|
629
|
-
"name": "
|
|
586
|
+
"name": "required",
|
|
630
587
|
"type": {
|
|
631
588
|
"text": "boolean"
|
|
632
589
|
},
|
|
633
590
|
"default": "false",
|
|
634
|
-
"description": "Defines whether the
|
|
591
|
+
"description": "Defines whether the component is required.",
|
|
635
592
|
"privacy": "public",
|
|
636
|
-
"_ui5since": "
|
|
593
|
+
"_ui5since": "1.0.0-rc.3"
|
|
637
594
|
},
|
|
638
595
|
{
|
|
639
596
|
"kind": "field",
|
|
640
|
-
"name": "
|
|
597
|
+
"name": "showClearIcon",
|
|
641
598
|
"type": {
|
|
642
599
|
"text": "boolean"
|
|
643
600
|
},
|
|
644
601
|
"default": "false",
|
|
645
|
-
"description": "
|
|
602
|
+
"description": "Defines whether the clear icon of the input will be shown.",
|
|
646
603
|
"privacy": "public",
|
|
647
|
-
"_ui5since": "2.0
|
|
604
|
+
"_ui5since": "1.2.0"
|
|
648
605
|
},
|
|
649
606
|
{
|
|
650
607
|
"kind": "field",
|
|
651
|
-
"name": "
|
|
608
|
+
"name": "showSuggestions",
|
|
652
609
|
"type": {
|
|
653
610
|
"text": "boolean"
|
|
654
611
|
},
|
|
655
612
|
"default": "false",
|
|
656
|
-
"description": "Defines whether the component
|
|
657
|
-
"privacy": "public"
|
|
658
|
-
"_ui5since": "2.0.0"
|
|
613
|
+
"description": "Defines whether the component should show suggestions, if such are present.",
|
|
614
|
+
"privacy": "public"
|
|
659
615
|
},
|
|
660
616
|
{
|
|
661
617
|
"kind": "field",
|
|
662
|
-
"name": "
|
|
618
|
+
"name": "type",
|
|
663
619
|
"type": {
|
|
664
|
-
"text": "
|
|
620
|
+
"text": "InputType",
|
|
621
|
+
"references": [
|
|
622
|
+
{
|
|
623
|
+
"name": "InputType",
|
|
624
|
+
"package": "@ui5/webcomponents",
|
|
625
|
+
"module": "dist/types/InputType.js"
|
|
626
|
+
}
|
|
627
|
+
]
|
|
665
628
|
},
|
|
666
|
-
"default": "
|
|
667
|
-
"description": "Defines
|
|
668
|
-
"privacy": "public"
|
|
669
|
-
"_ui5since": "2.0.0"
|
|
629
|
+
"default": "\"Text\"",
|
|
630
|
+
"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.",
|
|
631
|
+
"privacy": "public"
|
|
670
632
|
},
|
|
671
633
|
{
|
|
672
634
|
"kind": "field",
|
|
673
|
-
"name": "
|
|
635
|
+
"name": "value",
|
|
674
636
|
"type": {
|
|
675
|
-
"text": "
|
|
637
|
+
"text": "string"
|
|
676
638
|
},
|
|
677
|
-
"
|
|
678
|
-
"
|
|
639
|
+
"default": "\"\"",
|
|
640
|
+
"description": "Defines the value of the component.\n\n**Note:** The property is updated upon typing.",
|
|
679
641
|
"privacy": "public",
|
|
680
|
-
"
|
|
642
|
+
"_ui5formProperty": true,
|
|
643
|
+
"_ui5formEvents": "change,input"
|
|
681
644
|
},
|
|
682
645
|
{
|
|
683
646
|
"kind": "field",
|
|
@@ -694,66 +657,300 @@
|
|
|
694
657
|
},
|
|
695
658
|
"default": "\"None\"",
|
|
696
659
|
"description": "Defines the value state of the component.",
|
|
697
|
-
"privacy": "public",
|
|
698
|
-
"_ui5since": "2.0.0"
|
|
699
|
-
},
|
|
700
|
-
{
|
|
701
|
-
"kind": "field",
|
|
702
|
-
"name": "showSuggestions",
|
|
703
|
-
"type": {
|
|
704
|
-
"text": "boolean"
|
|
705
|
-
},
|
|
706
|
-
"default": "false",
|
|
707
|
-
"description": "Defines whether the component should show suggestions, if such are present.",
|
|
708
660
|
"privacy": "public"
|
|
709
661
|
}
|
|
710
662
|
],
|
|
711
663
|
"events": [
|
|
712
664
|
{
|
|
713
|
-
"name": "
|
|
665
|
+
"name": "button-click",
|
|
714
666
|
"_ui5privacy": "public",
|
|
715
667
|
"type": {
|
|
716
668
|
"text": "CustomEvent"
|
|
717
669
|
},
|
|
718
|
-
"description": "Fired when the
|
|
719
|
-
"_ui5Cancelable":
|
|
720
|
-
"_ui5allowPreventDefault":
|
|
721
|
-
"_ui5Bubbles":
|
|
722
|
-
"_ui5since": "2.0.0"
|
|
670
|
+
"description": "Fired when the user selects the AI button.",
|
|
671
|
+
"_ui5Cancelable": true,
|
|
672
|
+
"_ui5allowPreventDefault": true,
|
|
673
|
+
"_ui5Bubbles": false
|
|
723
674
|
},
|
|
724
675
|
{
|
|
725
|
-
"name": "
|
|
676
|
+
"name": "item-click",
|
|
726
677
|
"_ui5privacy": "public",
|
|
727
678
|
"type": {
|
|
728
|
-
"text": "CustomEvent"
|
|
679
|
+
"text": "CustomEvent<InputItemClickEventDetail>",
|
|
680
|
+
"references": [
|
|
681
|
+
{
|
|
682
|
+
"name": "InputItemClickEventDetail",
|
|
683
|
+
"package": "@ui5/webcomponents-ai",
|
|
684
|
+
"module": "dist/Input.js"
|
|
685
|
+
}
|
|
686
|
+
]
|
|
729
687
|
},
|
|
730
|
-
"description": "Fired when
|
|
688
|
+
"description": "Fired when an item from the AI actions menu is clicked.",
|
|
731
689
|
"_ui5Cancelable": false,
|
|
732
690
|
"_ui5allowPreventDefault": false,
|
|
733
|
-
"_ui5Bubbles":
|
|
734
|
-
"
|
|
735
|
-
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
|
|
741
|
-
|
|
742
|
-
|
|
691
|
+
"_ui5Bubbles": false,
|
|
692
|
+
"_ui5parameters": [
|
|
693
|
+
{
|
|
694
|
+
"type": {
|
|
695
|
+
"text": "HTMLElement"
|
|
696
|
+
},
|
|
697
|
+
"name": "item",
|
|
698
|
+
"_ui5privacy": "public",
|
|
699
|
+
"description": "The currently clicked menu item."
|
|
700
|
+
},
|
|
701
|
+
{
|
|
702
|
+
"type": {
|
|
703
|
+
"text": "string"
|
|
704
|
+
},
|
|
705
|
+
"name": "text",
|
|
706
|
+
"_ui5privacy": "public",
|
|
707
|
+
"description": "The text of the currently clicked menu item."
|
|
708
|
+
}
|
|
709
|
+
]
|
|
710
|
+
},
|
|
711
|
+
{
|
|
712
|
+
"name": "stop-generation",
|
|
713
|
+
"_ui5privacy": "public",
|
|
714
|
+
"type": {
|
|
715
|
+
"text": "CustomEvent"
|
|
716
|
+
},
|
|
717
|
+
"description": "Fired when the user selects the \"Stop\" button to stop ongoing AI text generation.",
|
|
718
|
+
"_ui5Cancelable": false,
|
|
719
|
+
"_ui5allowPreventDefault": false,
|
|
720
|
+
"_ui5Bubbles": false
|
|
721
|
+
},
|
|
722
|
+
{
|
|
723
|
+
"name": "version-change",
|
|
724
|
+
"_ui5privacy": "public",
|
|
725
|
+
"type": {
|
|
726
|
+
"text": "CustomEvent<InputVersionChangeEventDetail>",
|
|
727
|
+
"references": [
|
|
728
|
+
{
|
|
729
|
+
"name": "InputVersionChangeEventDetail",
|
|
730
|
+
"package": "@ui5/webcomponents-ai",
|
|
731
|
+
"module": "dist/Input.js"
|
|
732
|
+
}
|
|
733
|
+
]
|
|
734
|
+
},
|
|
735
|
+
"description": "Fired when the user selects the version navigation buttons.",
|
|
736
|
+
"_ui5Cancelable": false,
|
|
737
|
+
"_ui5allowPreventDefault": false,
|
|
738
|
+
"_ui5Bubbles": false,
|
|
739
|
+
"_ui5parameters": [
|
|
740
|
+
{
|
|
741
|
+
"type": {
|
|
742
|
+
"text": "boolean"
|
|
743
|
+
},
|
|
744
|
+
"name": "backwards",
|
|
745
|
+
"_ui5privacy": "public",
|
|
746
|
+
"description": "The text of the currently clicked menu item."
|
|
747
|
+
}
|
|
748
|
+
]
|
|
749
|
+
},
|
|
750
|
+
{
|
|
751
|
+
"name": "change",
|
|
752
|
+
"_ui5privacy": "public",
|
|
753
|
+
"type": {
|
|
754
|
+
"text": "CustomEvent"
|
|
755
|
+
},
|
|
756
|
+
"description": "Fired when the input operation has finished by pressing Enter or on focusout.",
|
|
757
|
+
"_ui5Cancelable": false,
|
|
758
|
+
"_ui5allowPreventDefault": false,
|
|
759
|
+
"_ui5Bubbles": true
|
|
760
|
+
},
|
|
761
|
+
{
|
|
762
|
+
"name": "close",
|
|
763
|
+
"_ui5privacy": "public",
|
|
764
|
+
"type": {
|
|
765
|
+
"text": "CustomEvent"
|
|
766
|
+
},
|
|
767
|
+
"description": "Fired when the suggestions picker is closed.",
|
|
768
|
+
"_ui5Cancelable": false,
|
|
769
|
+
"_ui5allowPreventDefault": false,
|
|
770
|
+
"_ui5Bubbles": false,
|
|
771
|
+
"_ui5since": "2.0.0"
|
|
772
|
+
},
|
|
773
|
+
{
|
|
774
|
+
"name": "input",
|
|
775
|
+
"_ui5privacy": "public",
|
|
776
|
+
"type": {
|
|
777
|
+
"text": "CustomEvent"
|
|
778
|
+
},
|
|
779
|
+
"description": "Fired when the value of the component changes at each keystroke,\nand when a suggestion item has been selected.",
|
|
780
|
+
"_ui5Cancelable": true,
|
|
781
|
+
"_ui5allowPreventDefault": true,
|
|
782
|
+
"_ui5Bubbles": true
|
|
783
|
+
},
|
|
784
|
+
{
|
|
785
|
+
"name": "open",
|
|
786
|
+
"_ui5privacy": "public",
|
|
787
|
+
"type": {
|
|
788
|
+
"text": "CustomEvent"
|
|
789
|
+
},
|
|
790
|
+
"description": "Fired when the suggestions picker is open.",
|
|
791
|
+
"_ui5Cancelable": false,
|
|
792
|
+
"_ui5allowPreventDefault": false,
|
|
793
|
+
"_ui5Bubbles": true,
|
|
794
|
+
"_ui5since": "2.0.0"
|
|
795
|
+
},
|
|
796
|
+
{
|
|
797
|
+
"name": "select",
|
|
798
|
+
"_ui5privacy": "public",
|
|
799
|
+
"type": {
|
|
800
|
+
"text": "CustomEvent"
|
|
801
|
+
},
|
|
802
|
+
"description": "Fired when some text has been selected.",
|
|
743
803
|
"_ui5Cancelable": false,
|
|
744
804
|
"_ui5allowPreventDefault": false,
|
|
745
805
|
"_ui5Bubbles": true,
|
|
746
806
|
"_ui5since": "2.0.0"
|
|
807
|
+
},
|
|
808
|
+
{
|
|
809
|
+
"name": "selection-change",
|
|
810
|
+
"_ui5privacy": "public",
|
|
811
|
+
"type": {
|
|
812
|
+
"text": "CustomEvent<InputSelectionChangeEventDetail>",
|
|
813
|
+
"references": [
|
|
814
|
+
{
|
|
815
|
+
"name": "InputSelectionChangeEventDetail",
|
|
816
|
+
"package": "@ui5/webcomponents",
|
|
817
|
+
"module": "dist/Input.js"
|
|
818
|
+
}
|
|
819
|
+
]
|
|
820
|
+
},
|
|
821
|
+
"description": "Fired when the user navigates to a suggestion item via the ARROW keys,\nas a preview, before the final selection.",
|
|
822
|
+
"_ui5Cancelable": false,
|
|
823
|
+
"_ui5allowPreventDefault": false,
|
|
824
|
+
"_ui5Bubbles": true,
|
|
825
|
+
"_ui5since": "2.0.0",
|
|
826
|
+
"_ui5parameters": [
|
|
827
|
+
{
|
|
828
|
+
"type": {
|
|
829
|
+
"text": "HTMLElement"
|
|
830
|
+
},
|
|
831
|
+
"name": "item",
|
|
832
|
+
"_ui5privacy": "public",
|
|
833
|
+
"description": "The previewed suggestion item."
|
|
834
|
+
}
|
|
835
|
+
]
|
|
747
836
|
}
|
|
748
837
|
],
|
|
749
838
|
"attributes": [
|
|
750
839
|
{
|
|
751
|
-
"description": "
|
|
752
|
-
"name": "
|
|
753
|
-
"default": "
|
|
754
|
-
"fieldName": "
|
|
840
|
+
"description": "Indicates the index of the currently displayed version.",
|
|
841
|
+
"name": "current-version",
|
|
842
|
+
"default": "0",
|
|
843
|
+
"fieldName": "currentVersion",
|
|
755
844
|
"type": {
|
|
756
|
-
"text": "
|
|
845
|
+
"text": "number"
|
|
846
|
+
}
|
|
847
|
+
},
|
|
848
|
+
{
|
|
849
|
+
"description": "Defines whether the AI Writing Assistant is currently loading.\n\nWhen `true`, indicates that an AI action is in progress.",
|
|
850
|
+
"name": "loading",
|
|
851
|
+
"default": "false",
|
|
852
|
+
"fieldName": "loading",
|
|
853
|
+
"type": {
|
|
854
|
+
"text": "boolean"
|
|
855
|
+
}
|
|
856
|
+
},
|
|
857
|
+
{
|
|
858
|
+
"description": "Indicates the total number of result versions available.\n\nWhen not set or set to 0, the versioning will be hidden.",
|
|
859
|
+
"name": "total-versions",
|
|
860
|
+
"default": "0",
|
|
861
|
+
"fieldName": "totalVersions",
|
|
862
|
+
"type": {
|
|
863
|
+
"text": "number"
|
|
864
|
+
}
|
|
865
|
+
},
|
|
866
|
+
{
|
|
867
|
+
"description": "Defines the accessible description of the component.",
|
|
868
|
+
"name": "accessible-description",
|
|
869
|
+
"default": "undefined",
|
|
870
|
+
"fieldName": "accessibleDescription",
|
|
871
|
+
"type": {
|
|
872
|
+
"text": "string | undefined"
|
|
873
|
+
}
|
|
874
|
+
},
|
|
875
|
+
{
|
|
876
|
+
"description": "Receives id(or many ids) of the elements that describe the input.",
|
|
877
|
+
"name": "accessible-description-ref",
|
|
878
|
+
"default": "undefined",
|
|
879
|
+
"fieldName": "accessibleDescriptionRef",
|
|
880
|
+
"type": {
|
|
881
|
+
"text": "string | undefined"
|
|
882
|
+
}
|
|
883
|
+
},
|
|
884
|
+
{
|
|
885
|
+
"description": "Defines the accessible ARIA name of the component.",
|
|
886
|
+
"name": "accessible-name",
|
|
887
|
+
"default": "undefined",
|
|
888
|
+
"fieldName": "accessibleName",
|
|
889
|
+
"type": {
|
|
890
|
+
"text": "string | undefined"
|
|
891
|
+
}
|
|
892
|
+
},
|
|
893
|
+
{
|
|
894
|
+
"description": "Receives id(or many ids) of the elements that label the input.",
|
|
895
|
+
"name": "accessible-name-ref",
|
|
896
|
+
"default": "undefined",
|
|
897
|
+
"fieldName": "accessibleNameRef",
|
|
898
|
+
"type": {
|
|
899
|
+
"text": "string | undefined"
|
|
900
|
+
}
|
|
901
|
+
},
|
|
902
|
+
{
|
|
903
|
+
"description": "Defines whether the component is in disabled state.\n\n**Note:** A disabled component is completely noninteractive.",
|
|
904
|
+
"name": "disabled",
|
|
905
|
+
"default": "false",
|
|
906
|
+
"fieldName": "disabled",
|
|
907
|
+
"type": {
|
|
908
|
+
"text": "boolean"
|
|
909
|
+
}
|
|
910
|
+
},
|
|
911
|
+
{
|
|
912
|
+
"description": "Defines the filter type of the component.",
|
|
913
|
+
"name": "filter",
|
|
914
|
+
"default": "\"None\"",
|
|
915
|
+
"fieldName": "filter",
|
|
916
|
+
"type": {
|
|
917
|
+
"text": "\"None\" | \"StartsWithPerTerm\" | \"StartsWith\" | \"Contains\""
|
|
918
|
+
}
|
|
919
|
+
},
|
|
920
|
+
{
|
|
921
|
+
"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.",
|
|
922
|
+
"name": "maxlength",
|
|
923
|
+
"default": "undefined",
|
|
924
|
+
"fieldName": "maxlength",
|
|
925
|
+
"type": {
|
|
926
|
+
"text": "number | undefined"
|
|
927
|
+
}
|
|
928
|
+
},
|
|
929
|
+
{
|
|
930
|
+
"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.",
|
|
931
|
+
"name": "name",
|
|
932
|
+
"default": "undefined",
|
|
933
|
+
"fieldName": "name",
|
|
934
|
+
"type": {
|
|
935
|
+
"text": "string | undefined"
|
|
936
|
+
}
|
|
937
|
+
},
|
|
938
|
+
{
|
|
939
|
+
"description": "Defines whether the value will be autcompleted to match an item",
|
|
940
|
+
"name": "no-typeahead",
|
|
941
|
+
"default": "false",
|
|
942
|
+
"fieldName": "noTypeahead",
|
|
943
|
+
"type": {
|
|
944
|
+
"text": "boolean"
|
|
945
|
+
}
|
|
946
|
+
},
|
|
947
|
+
{
|
|
948
|
+
"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.",
|
|
949
|
+
"name": "open",
|
|
950
|
+
"default": "false",
|
|
951
|
+
"fieldName": "open",
|
|
952
|
+
"type": {
|
|
953
|
+
"text": "boolean"
|
|
757
954
|
}
|
|
758
955
|
},
|
|
759
956
|
{
|
|
@@ -766,87 +963,1294 @@
|
|
|
766
963
|
}
|
|
767
964
|
},
|
|
768
965
|
{
|
|
769
|
-
"description": "Defines the
|
|
770
|
-
"name": "
|
|
771
|
-
"default": "
|
|
772
|
-
"fieldName": "
|
|
966
|
+
"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.",
|
|
967
|
+
"name": "readonly",
|
|
968
|
+
"default": "false",
|
|
969
|
+
"fieldName": "readonly",
|
|
773
970
|
"type": {
|
|
774
|
-
"text": "
|
|
971
|
+
"text": "boolean"
|
|
972
|
+
}
|
|
973
|
+
},
|
|
974
|
+
{
|
|
975
|
+
"description": "Defines whether the component is required.",
|
|
976
|
+
"name": "required",
|
|
977
|
+
"default": "false",
|
|
978
|
+
"fieldName": "required",
|
|
979
|
+
"type": {
|
|
980
|
+
"text": "boolean"
|
|
981
|
+
}
|
|
982
|
+
},
|
|
983
|
+
{
|
|
984
|
+
"description": "Defines whether the clear icon of the input will be shown.",
|
|
985
|
+
"name": "show-clear-icon",
|
|
986
|
+
"default": "false",
|
|
987
|
+
"fieldName": "showClearIcon",
|
|
988
|
+
"type": {
|
|
989
|
+
"text": "boolean"
|
|
775
990
|
}
|
|
776
991
|
},
|
|
777
992
|
{
|
|
778
|
-
"description": "Defines whether the
|
|
779
|
-
"name": "show-
|
|
780
|
-
"default": "false",
|
|
781
|
-
"fieldName": "
|
|
993
|
+
"description": "Defines whether the component should show suggestions, if such are present.",
|
|
994
|
+
"name": "show-suggestions",
|
|
995
|
+
"default": "false",
|
|
996
|
+
"fieldName": "showSuggestions",
|
|
997
|
+
"type": {
|
|
998
|
+
"text": "boolean"
|
|
999
|
+
}
|
|
1000
|
+
},
|
|
1001
|
+
{
|
|
1002
|
+
"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.",
|
|
1003
|
+
"name": "type",
|
|
1004
|
+
"default": "\"Text\"",
|
|
1005
|
+
"fieldName": "type",
|
|
1006
|
+
"type": {
|
|
1007
|
+
"text": "\"Text\" | \"Email\" | \"Number\" | \"Password\" | \"Tel\" | \"URL\" | \"Search\""
|
|
1008
|
+
}
|
|
1009
|
+
},
|
|
1010
|
+
{
|
|
1011
|
+
"description": "Defines the value of the component.\n\n**Note:** The property is updated upon typing.",
|
|
1012
|
+
"name": "value",
|
|
1013
|
+
"default": "\"\"",
|
|
1014
|
+
"fieldName": "value",
|
|
1015
|
+
"type": {
|
|
1016
|
+
"text": "string"
|
|
1017
|
+
}
|
|
1018
|
+
},
|
|
1019
|
+
{
|
|
1020
|
+
"description": "Defines the value state of the component.",
|
|
1021
|
+
"name": "value-state",
|
|
1022
|
+
"default": "\"None\"",
|
|
1023
|
+
"fieldName": "valueState",
|
|
1024
|
+
"type": {
|
|
1025
|
+
"text": "\"None\" | \"Positive\" | \"Critical\" | \"Negative\" | \"Information\""
|
|
1026
|
+
}
|
|
1027
|
+
}
|
|
1028
|
+
],
|
|
1029
|
+
"superclass": {
|
|
1030
|
+
"name": "Input",
|
|
1031
|
+
"package": "@ui5/webcomponents",
|
|
1032
|
+
"module": "dist/Input.js"
|
|
1033
|
+
},
|
|
1034
|
+
"tagName": "ui5-ai-input",
|
|
1035
|
+
"customElement": true,
|
|
1036
|
+
"_ui5experimental": "The **@ui5/webcomponents-ai** package is under active development and considered experimental. Component APIs are subject to change.\nFurthermore, the package supports **Horizon** themes only.",
|
|
1037
|
+
"_ui5since": "2.16.0",
|
|
1038
|
+
"_ui5privacy": "public",
|
|
1039
|
+
"cssParts": [
|
|
1040
|
+
{
|
|
1041
|
+
"description": "Used to style the clear icon, which can be pressed to clear user input text",
|
|
1042
|
+
"name": "clear-icon"
|
|
1043
|
+
},
|
|
1044
|
+
{
|
|
1045
|
+
"description": "Used to style the native input element",
|
|
1046
|
+
"name": "input"
|
|
1047
|
+
},
|
|
1048
|
+
{
|
|
1049
|
+
"description": "Used to style the root DOM element of the Input component",
|
|
1050
|
+
"name": "root"
|
|
1051
|
+
}
|
|
1052
|
+
]
|
|
1053
|
+
}
|
|
1054
|
+
],
|
|
1055
|
+
"exports": [
|
|
1056
|
+
{
|
|
1057
|
+
"kind": "js",
|
|
1058
|
+
"name": "default",
|
|
1059
|
+
"declaration": {
|
|
1060
|
+
"name": "Input",
|
|
1061
|
+
"module": "dist/Input.js"
|
|
1062
|
+
}
|
|
1063
|
+
},
|
|
1064
|
+
{
|
|
1065
|
+
"kind": "custom-element-definition",
|
|
1066
|
+
"name": "ui5-ai-input",
|
|
1067
|
+
"declaration": {
|
|
1068
|
+
"name": "Input",
|
|
1069
|
+
"module": "dist/Input.js"
|
|
1070
|
+
}
|
|
1071
|
+
}
|
|
1072
|
+
]
|
|
1073
|
+
},
|
|
1074
|
+
{
|
|
1075
|
+
"kind": "javascript-module",
|
|
1076
|
+
"path": "dist/PromptInput.js",
|
|
1077
|
+
"declarations": [
|
|
1078
|
+
{
|
|
1079
|
+
"kind": "class",
|
|
1080
|
+
"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\"`",
|
|
1081
|
+
"name": "PromptInput",
|
|
1082
|
+
"slots": [
|
|
1083
|
+
{
|
|
1084
|
+
"name": "default",
|
|
1085
|
+
"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.",
|
|
1086
|
+
"_ui5propertyName": "suggestionItems",
|
|
1087
|
+
"_ui5type": {
|
|
1088
|
+
"text": "Array<IInputSuggestionItem>",
|
|
1089
|
+
"references": [
|
|
1090
|
+
{
|
|
1091
|
+
"name": "IInputSuggestionItem",
|
|
1092
|
+
"package": "@ui5/webcomponents",
|
|
1093
|
+
"module": "dist/Input.js"
|
|
1094
|
+
}
|
|
1095
|
+
]
|
|
1096
|
+
},
|
|
1097
|
+
"_ui5privacy": "public"
|
|
1098
|
+
},
|
|
1099
|
+
{
|
|
1100
|
+
"name": "valueStateMessage",
|
|
1101
|
+
"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.",
|
|
1102
|
+
"_ui5since": "2.0.0",
|
|
1103
|
+
"_ui5type": {
|
|
1104
|
+
"text": "Array<HTMLElement>"
|
|
1105
|
+
},
|
|
1106
|
+
"_ui5privacy": "public"
|
|
1107
|
+
}
|
|
1108
|
+
],
|
|
1109
|
+
"members": [
|
|
1110
|
+
{
|
|
1111
|
+
"kind": "field",
|
|
1112
|
+
"name": "disabled",
|
|
1113
|
+
"type": {
|
|
1114
|
+
"text": "boolean"
|
|
1115
|
+
},
|
|
1116
|
+
"default": "false",
|
|
1117
|
+
"description": "Defines whether the component is in disabled state.\n\n**Note:** A disabled component is completely noninteractive.",
|
|
1118
|
+
"privacy": "public",
|
|
1119
|
+
"_ui5since": "2.0.0"
|
|
1120
|
+
},
|
|
1121
|
+
{
|
|
1122
|
+
"kind": "field",
|
|
1123
|
+
"name": "label",
|
|
1124
|
+
"type": {
|
|
1125
|
+
"text": "string | undefined"
|
|
1126
|
+
},
|
|
1127
|
+
"description": "Defines the label of the input field.",
|
|
1128
|
+
"default": "undefined",
|
|
1129
|
+
"privacy": "public",
|
|
1130
|
+
"_ui5since": "2.0.0"
|
|
1131
|
+
},
|
|
1132
|
+
{
|
|
1133
|
+
"kind": "field",
|
|
1134
|
+
"name": "maxlength",
|
|
1135
|
+
"type": {
|
|
1136
|
+
"text": "number | undefined"
|
|
1137
|
+
},
|
|
1138
|
+
"description": "Sets the maximum number of characters available in the input field.",
|
|
1139
|
+
"default": "undefined",
|
|
1140
|
+
"privacy": "public",
|
|
1141
|
+
"_ui5since": "2.0.0"
|
|
1142
|
+
},
|
|
1143
|
+
{
|
|
1144
|
+
"kind": "field",
|
|
1145
|
+
"name": "placeholder",
|
|
1146
|
+
"type": {
|
|
1147
|
+
"text": "string | undefined"
|
|
1148
|
+
},
|
|
1149
|
+
"description": "Defines a short hint intended to aid the user with data entry when the\ncomponent has no value.",
|
|
1150
|
+
"default": "undefined",
|
|
1151
|
+
"privacy": "public",
|
|
1152
|
+
"_ui5since": "2.0.0"
|
|
1153
|
+
},
|
|
1154
|
+
{
|
|
1155
|
+
"kind": "field",
|
|
1156
|
+
"name": "readonly",
|
|
1157
|
+
"type": {
|
|
1158
|
+
"text": "boolean"
|
|
1159
|
+
},
|
|
1160
|
+
"default": "false",
|
|
1161
|
+
"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.",
|
|
1162
|
+
"privacy": "public",
|
|
1163
|
+
"_ui5since": "2.0.0"
|
|
1164
|
+
},
|
|
1165
|
+
{
|
|
1166
|
+
"kind": "field",
|
|
1167
|
+
"name": "showClearIcon",
|
|
1168
|
+
"type": {
|
|
1169
|
+
"text": "boolean"
|
|
1170
|
+
},
|
|
1171
|
+
"default": "false",
|
|
1172
|
+
"description": "Defines whether the clear icon of the input will be shown.",
|
|
1173
|
+
"privacy": "public",
|
|
1174
|
+
"_ui5since": "2.0.0"
|
|
1175
|
+
},
|
|
1176
|
+
{
|
|
1177
|
+
"kind": "field",
|
|
1178
|
+
"name": "showExceededText",
|
|
1179
|
+
"type": {
|
|
1180
|
+
"text": "boolean"
|
|
1181
|
+
},
|
|
1182
|
+
"default": "false",
|
|
1183
|
+
"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.",
|
|
1184
|
+
"privacy": "public",
|
|
1185
|
+
"_ui5since": "2.0.0"
|
|
1186
|
+
},
|
|
1187
|
+
{
|
|
1188
|
+
"kind": "field",
|
|
1189
|
+
"name": "showSuggestions",
|
|
1190
|
+
"type": {
|
|
1191
|
+
"text": "boolean"
|
|
1192
|
+
},
|
|
1193
|
+
"default": "false",
|
|
1194
|
+
"description": "Defines whether the component should show suggestions, if such are present.",
|
|
1195
|
+
"privacy": "public"
|
|
1196
|
+
},
|
|
1197
|
+
{
|
|
1198
|
+
"kind": "field",
|
|
1199
|
+
"name": "value",
|
|
1200
|
+
"type": {
|
|
1201
|
+
"text": "string"
|
|
1202
|
+
},
|
|
1203
|
+
"default": "\"\"",
|
|
1204
|
+
"description": "Defines the value of the component.",
|
|
1205
|
+
"privacy": "public",
|
|
1206
|
+
"_ui5since": "2.0.0"
|
|
1207
|
+
},
|
|
1208
|
+
{
|
|
1209
|
+
"kind": "field",
|
|
1210
|
+
"name": "valueState",
|
|
1211
|
+
"type": {
|
|
1212
|
+
"text": "ValueState",
|
|
1213
|
+
"references": [
|
|
1214
|
+
{
|
|
1215
|
+
"name": "ValueState",
|
|
1216
|
+
"package": "@ui5/webcomponents-base",
|
|
1217
|
+
"module": "dist/types/ValueState.js"
|
|
1218
|
+
}
|
|
1219
|
+
]
|
|
1220
|
+
},
|
|
1221
|
+
"default": "\"None\"",
|
|
1222
|
+
"description": "Defines the value state of the component.",
|
|
1223
|
+
"privacy": "public",
|
|
1224
|
+
"_ui5since": "2.0.0"
|
|
1225
|
+
}
|
|
1226
|
+
],
|
|
1227
|
+
"events": [
|
|
1228
|
+
{
|
|
1229
|
+
"name": "change",
|
|
1230
|
+
"_ui5privacy": "public",
|
|
1231
|
+
"type": {
|
|
1232
|
+
"text": "CustomEvent"
|
|
1233
|
+
},
|
|
1234
|
+
"description": "Fired when the input operation has finished by pressing Enter\nor on focusout.",
|
|
1235
|
+
"_ui5Cancelable": false,
|
|
1236
|
+
"_ui5allowPreventDefault": false,
|
|
1237
|
+
"_ui5Bubbles": true,
|
|
1238
|
+
"_ui5since": "2.0.0"
|
|
1239
|
+
},
|
|
1240
|
+
{
|
|
1241
|
+
"name": "input",
|
|
1242
|
+
"_ui5privacy": "public",
|
|
1243
|
+
"type": {
|
|
1244
|
+
"text": "CustomEvent"
|
|
1245
|
+
},
|
|
1246
|
+
"description": "Fired when the value of the component changes at each keystroke,\nand when a suggestion item has been selected.",
|
|
1247
|
+
"_ui5Cancelable": false,
|
|
1248
|
+
"_ui5allowPreventDefault": false,
|
|
1249
|
+
"_ui5Bubbles": true,
|
|
1250
|
+
"_ui5since": "2.0.0"
|
|
1251
|
+
},
|
|
1252
|
+
{
|
|
1253
|
+
"name": "submit",
|
|
1254
|
+
"_ui5privacy": "public",
|
|
1255
|
+
"type": {
|
|
1256
|
+
"text": "CustomEvent"
|
|
1257
|
+
},
|
|
1258
|
+
"description": "Fired when the input operation has finished by pressing Enter\nor AI button is clicked.",
|
|
1259
|
+
"_ui5Cancelable": false,
|
|
1260
|
+
"_ui5allowPreventDefault": false,
|
|
1261
|
+
"_ui5Bubbles": true,
|
|
1262
|
+
"_ui5since": "2.0.0"
|
|
1263
|
+
}
|
|
1264
|
+
],
|
|
1265
|
+
"attributes": [
|
|
1266
|
+
{
|
|
1267
|
+
"description": "Defines whether the component is in disabled state.\n\n**Note:** A disabled component is completely noninteractive.",
|
|
1268
|
+
"name": "disabled",
|
|
1269
|
+
"default": "false",
|
|
1270
|
+
"fieldName": "disabled",
|
|
1271
|
+
"type": {
|
|
1272
|
+
"text": "boolean"
|
|
1273
|
+
}
|
|
1274
|
+
},
|
|
1275
|
+
{
|
|
1276
|
+
"description": "Defines the label of the input field.",
|
|
1277
|
+
"name": "label",
|
|
1278
|
+
"default": "undefined",
|
|
1279
|
+
"fieldName": "label",
|
|
1280
|
+
"type": {
|
|
1281
|
+
"text": "string | undefined"
|
|
1282
|
+
}
|
|
1283
|
+
},
|
|
1284
|
+
{
|
|
1285
|
+
"description": "Sets the maximum number of characters available in the input field.",
|
|
1286
|
+
"name": "maxlength",
|
|
1287
|
+
"default": "undefined",
|
|
1288
|
+
"fieldName": "maxlength",
|
|
1289
|
+
"type": {
|
|
1290
|
+
"text": "number | undefined"
|
|
1291
|
+
}
|
|
1292
|
+
},
|
|
1293
|
+
{
|
|
1294
|
+
"description": "Defines a short hint intended to aid the user with data entry when the\ncomponent has no value.",
|
|
1295
|
+
"name": "placeholder",
|
|
1296
|
+
"default": "undefined",
|
|
1297
|
+
"fieldName": "placeholder",
|
|
1298
|
+
"type": {
|
|
1299
|
+
"text": "string | undefined"
|
|
1300
|
+
}
|
|
1301
|
+
},
|
|
1302
|
+
{
|
|
1303
|
+
"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.",
|
|
1304
|
+
"name": "readonly",
|
|
1305
|
+
"default": "false",
|
|
1306
|
+
"fieldName": "readonly",
|
|
1307
|
+
"type": {
|
|
1308
|
+
"text": "boolean"
|
|
1309
|
+
}
|
|
1310
|
+
},
|
|
1311
|
+
{
|
|
1312
|
+
"description": "Defines whether the clear icon of the input will be shown.",
|
|
1313
|
+
"name": "show-clear-icon",
|
|
1314
|
+
"default": "false",
|
|
1315
|
+
"fieldName": "showClearIcon",
|
|
1316
|
+
"type": {
|
|
1317
|
+
"text": "boolean"
|
|
1318
|
+
}
|
|
1319
|
+
},
|
|
1320
|
+
{
|
|
1321
|
+
"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.",
|
|
1322
|
+
"name": "show-exceeded-text",
|
|
1323
|
+
"default": "false",
|
|
1324
|
+
"fieldName": "showExceededText",
|
|
1325
|
+
"type": {
|
|
1326
|
+
"text": "boolean"
|
|
1327
|
+
}
|
|
1328
|
+
},
|
|
1329
|
+
{
|
|
1330
|
+
"description": "Defines whether the component should show suggestions, if such are present.",
|
|
1331
|
+
"name": "show-suggestions",
|
|
1332
|
+
"default": "false",
|
|
1333
|
+
"fieldName": "showSuggestions",
|
|
1334
|
+
"type": {
|
|
1335
|
+
"text": "boolean"
|
|
1336
|
+
}
|
|
1337
|
+
},
|
|
1338
|
+
{
|
|
1339
|
+
"description": "Defines the value of the component.",
|
|
1340
|
+
"name": "value",
|
|
1341
|
+
"default": "\"\"",
|
|
1342
|
+
"fieldName": "value",
|
|
1343
|
+
"type": {
|
|
1344
|
+
"text": "string"
|
|
1345
|
+
}
|
|
1346
|
+
},
|
|
1347
|
+
{
|
|
1348
|
+
"description": "Defines the value state of the component.",
|
|
1349
|
+
"name": "value-state",
|
|
1350
|
+
"default": "\"None\"",
|
|
1351
|
+
"fieldName": "valueState",
|
|
1352
|
+
"type": {
|
|
1353
|
+
"text": "\"Positive\" | \"Negative\" | \"None\" | \"Critical\" | \"Information\""
|
|
1354
|
+
}
|
|
1355
|
+
}
|
|
1356
|
+
],
|
|
1357
|
+
"superclass": {
|
|
1358
|
+
"name": "UI5Element",
|
|
1359
|
+
"package": "@ui5/webcomponents-base",
|
|
1360
|
+
"module": "dist/UI5Element.js"
|
|
1361
|
+
},
|
|
1362
|
+
"tagName": "ui5-ai-prompt-input",
|
|
1363
|
+
"customElement": true,
|
|
1364
|
+
"_ui5experimental": "The **@ui5/webcomponents-ai** package is under development and considered experimental - components' APIs are subject to change.\nFurthermore, the package supports **Horizon** themes only.",
|
|
1365
|
+
"_ui5privacy": "public"
|
|
1366
|
+
}
|
|
1367
|
+
],
|
|
1368
|
+
"exports": [
|
|
1369
|
+
{
|
|
1370
|
+
"kind": "js",
|
|
1371
|
+
"name": "default",
|
|
1372
|
+
"declaration": {
|
|
1373
|
+
"name": "PromptInput",
|
|
1374
|
+
"module": "dist/PromptInput.js"
|
|
1375
|
+
}
|
|
1376
|
+
},
|
|
1377
|
+
{
|
|
1378
|
+
"kind": "custom-element-definition",
|
|
1379
|
+
"name": "ui5-ai-prompt-input",
|
|
1380
|
+
"declaration": {
|
|
1381
|
+
"name": "PromptInput",
|
|
1382
|
+
"module": "dist/PromptInput.js"
|
|
1383
|
+
}
|
|
1384
|
+
}
|
|
1385
|
+
]
|
|
1386
|
+
},
|
|
1387
|
+
{
|
|
1388
|
+
"kind": "javascript-module",
|
|
1389
|
+
"path": "dist/TextArea.js",
|
|
1390
|
+
"declarations": [
|
|
1391
|
+
{
|
|
1392
|
+
"kind": "class",
|
|
1393
|
+
"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\";`",
|
|
1394
|
+
"name": "TextArea",
|
|
1395
|
+
"slots": [
|
|
1396
|
+
{
|
|
1397
|
+
"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.",
|
|
1398
|
+
"name": "menu",
|
|
1399
|
+
"_ui5privacy": "public",
|
|
1400
|
+
"_ui5type": {
|
|
1401
|
+
"text": "HTMLElement"
|
|
1402
|
+
}
|
|
1403
|
+
},
|
|
1404
|
+
{
|
|
1405
|
+
"name": "valueStateMessage",
|
|
1406
|
+
"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`.",
|
|
1407
|
+
"_ui5since": "1.0.0-rc.7",
|
|
1408
|
+
"_ui5type": {
|
|
1409
|
+
"text": "Array<HTMLElement>"
|
|
1410
|
+
},
|
|
1411
|
+
"_ui5privacy": "public"
|
|
1412
|
+
}
|
|
1413
|
+
],
|
|
1414
|
+
"members": [
|
|
1415
|
+
{
|
|
1416
|
+
"kind": "field",
|
|
1417
|
+
"name": "currentVersion",
|
|
1418
|
+
"type": {
|
|
1419
|
+
"text": "number"
|
|
1420
|
+
},
|
|
1421
|
+
"default": "0",
|
|
1422
|
+
"description": "Indicates the index of the currently displayed version.",
|
|
1423
|
+
"privacy": "public"
|
|
1424
|
+
},
|
|
1425
|
+
{
|
|
1426
|
+
"kind": "field",
|
|
1427
|
+
"name": "loading",
|
|
1428
|
+
"type": {
|
|
1429
|
+
"text": "boolean"
|
|
1430
|
+
},
|
|
1431
|
+
"default": "false",
|
|
1432
|
+
"description": "Defines whether the `ui5-ai-textarea` is currently in a loading(processing) state.",
|
|
1433
|
+
"privacy": "public"
|
|
1434
|
+
},
|
|
1435
|
+
{
|
|
1436
|
+
"kind": "field",
|
|
1437
|
+
"name": "promptDescription",
|
|
1438
|
+
"type": {
|
|
1439
|
+
"text": "string"
|
|
1440
|
+
},
|
|
1441
|
+
"default": "\"\"",
|
|
1442
|
+
"description": "Defines the prompt description of the current action.",
|
|
1443
|
+
"privacy": "public"
|
|
1444
|
+
},
|
|
1445
|
+
{
|
|
1446
|
+
"kind": "field",
|
|
1447
|
+
"name": "totalVersions",
|
|
1448
|
+
"type": {
|
|
1449
|
+
"text": "number"
|
|
1450
|
+
},
|
|
1451
|
+
"default": "0",
|
|
1452
|
+
"description": "Indicates the total number of result versions available.\n\nNotes:\nVersioning is hidden if the value is `0`",
|
|
1453
|
+
"privacy": "public"
|
|
1454
|
+
},
|
|
1455
|
+
{
|
|
1456
|
+
"kind": "field",
|
|
1457
|
+
"name": "accessibleDescription",
|
|
1458
|
+
"type": {
|
|
1459
|
+
"text": "string | undefined"
|
|
1460
|
+
},
|
|
1461
|
+
"description": "Defines the accessible description of the component.",
|
|
1462
|
+
"default": "undefined",
|
|
1463
|
+
"privacy": "public",
|
|
1464
|
+
"_ui5since": "2.16.0"
|
|
1465
|
+
},
|
|
1466
|
+
{
|
|
1467
|
+
"kind": "field",
|
|
1468
|
+
"name": "accessibleDescriptionRef",
|
|
1469
|
+
"type": {
|
|
1470
|
+
"text": "string | undefined"
|
|
1471
|
+
},
|
|
1472
|
+
"description": "Receives id(or many ids) of the elements that describe the textarea.",
|
|
1473
|
+
"default": "undefined",
|
|
1474
|
+
"privacy": "public",
|
|
1475
|
+
"_ui5since": "2.16.0"
|
|
1476
|
+
},
|
|
1477
|
+
{
|
|
1478
|
+
"kind": "field",
|
|
1479
|
+
"name": "accessibleName",
|
|
1480
|
+
"type": {
|
|
1481
|
+
"text": "string | undefined"
|
|
1482
|
+
},
|
|
1483
|
+
"description": "Defines the accessible ARIA name of the component.",
|
|
1484
|
+
"default": "undefined",
|
|
1485
|
+
"privacy": "public",
|
|
1486
|
+
"_ui5since": "1.0.0-rc.15"
|
|
1487
|
+
},
|
|
1488
|
+
{
|
|
1489
|
+
"kind": "field",
|
|
1490
|
+
"name": "accessibleNameRef",
|
|
1491
|
+
"type": {
|
|
1492
|
+
"text": "string | undefined"
|
|
1493
|
+
},
|
|
1494
|
+
"description": "Receives id(or many ids) of the elements that label the textarea.",
|
|
1495
|
+
"default": "undefined",
|
|
1496
|
+
"privacy": "public",
|
|
1497
|
+
"_ui5since": "1.0.0-rc.15"
|
|
1498
|
+
},
|
|
1499
|
+
{
|
|
1500
|
+
"kind": "field",
|
|
1501
|
+
"name": "disabled",
|
|
1502
|
+
"type": {
|
|
1503
|
+
"text": "boolean"
|
|
1504
|
+
},
|
|
1505
|
+
"default": "false",
|
|
1506
|
+
"description": "Indicates whether the user can interact with the component or not.\n\n**Note:** A disabled component is completely noninteractive.",
|
|
1507
|
+
"privacy": "public"
|
|
1508
|
+
},
|
|
1509
|
+
{
|
|
1510
|
+
"kind": "field",
|
|
1511
|
+
"name": "growing",
|
|
1512
|
+
"type": {
|
|
1513
|
+
"text": "boolean"
|
|
1514
|
+
},
|
|
1515
|
+
"default": "false",
|
|
1516
|
+
"description": "Enables the component to automatically grow and shrink dynamically with its content.",
|
|
1517
|
+
"privacy": "public"
|
|
1518
|
+
},
|
|
1519
|
+
{
|
|
1520
|
+
"kind": "field",
|
|
1521
|
+
"name": "growingMaxRows",
|
|
1522
|
+
"type": {
|
|
1523
|
+
"text": "number"
|
|
1524
|
+
},
|
|
1525
|
+
"default": "0",
|
|
1526
|
+
"description": "Defines the maximum number of rows that the component can grow.",
|
|
1527
|
+
"privacy": "public"
|
|
1528
|
+
},
|
|
1529
|
+
{
|
|
1530
|
+
"kind": "field",
|
|
1531
|
+
"name": "maxlength",
|
|
1532
|
+
"type": {
|
|
1533
|
+
"text": "number | undefined"
|
|
1534
|
+
},
|
|
1535
|
+
"description": "Defines the maximum number of characters that the `value` can have.",
|
|
1536
|
+
"default": "undefined",
|
|
1537
|
+
"privacy": "public"
|
|
1538
|
+
},
|
|
1539
|
+
{
|
|
1540
|
+
"kind": "field",
|
|
1541
|
+
"name": "name",
|
|
1542
|
+
"type": {
|
|
1543
|
+
"text": "string | undefined"
|
|
1544
|
+
},
|
|
1545
|
+
"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.",
|
|
1546
|
+
"default": "undefined",
|
|
1547
|
+
"privacy": "public"
|
|
1548
|
+
},
|
|
1549
|
+
{
|
|
1550
|
+
"kind": "field",
|
|
1551
|
+
"name": "placeholder",
|
|
1552
|
+
"type": {
|
|
1553
|
+
"text": "string | undefined"
|
|
1554
|
+
},
|
|
1555
|
+
"description": "Defines a short hint intended to aid the user with data entry when the component has no value.",
|
|
1556
|
+
"default": "undefined",
|
|
1557
|
+
"privacy": "public"
|
|
1558
|
+
},
|
|
1559
|
+
{
|
|
1560
|
+
"kind": "field",
|
|
1561
|
+
"name": "readonly",
|
|
1562
|
+
"type": {
|
|
1563
|
+
"text": "boolean"
|
|
1564
|
+
},
|
|
1565
|
+
"default": "false",
|
|
1566
|
+
"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.",
|
|
1567
|
+
"privacy": "public"
|
|
1568
|
+
},
|
|
1569
|
+
{
|
|
1570
|
+
"kind": "field",
|
|
1571
|
+
"name": "required",
|
|
1572
|
+
"type": {
|
|
1573
|
+
"text": "boolean"
|
|
1574
|
+
},
|
|
1575
|
+
"default": "false",
|
|
1576
|
+
"description": "Defines whether the component is required.",
|
|
1577
|
+
"privacy": "public",
|
|
1578
|
+
"_ui5since": "1.0.0-rc.3"
|
|
1579
|
+
},
|
|
1580
|
+
{
|
|
1581
|
+
"kind": "field",
|
|
1582
|
+
"name": "rows",
|
|
1583
|
+
"type": {
|
|
1584
|
+
"text": "number"
|
|
1585
|
+
},
|
|
1586
|
+
"default": "0",
|
|
1587
|
+
"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.",
|
|
1588
|
+
"privacy": "public"
|
|
1589
|
+
},
|
|
1590
|
+
{
|
|
1591
|
+
"kind": "field",
|
|
1592
|
+
"name": "showExceededText",
|
|
1593
|
+
"type": {
|
|
1594
|
+
"text": "boolean"
|
|
1595
|
+
},
|
|
1596
|
+
"default": "false",
|
|
1597
|
+
"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.",
|
|
1598
|
+
"privacy": "public"
|
|
1599
|
+
},
|
|
1600
|
+
{
|
|
1601
|
+
"kind": "field",
|
|
1602
|
+
"name": "value",
|
|
1603
|
+
"type": {
|
|
1604
|
+
"text": "string"
|
|
1605
|
+
},
|
|
1606
|
+
"default": "\"\"",
|
|
1607
|
+
"description": "Defines the value of the component.",
|
|
1608
|
+
"privacy": "public",
|
|
1609
|
+
"_ui5formProperty": true,
|
|
1610
|
+
"_ui5formEvents": "change,input"
|
|
1611
|
+
},
|
|
1612
|
+
{
|
|
1613
|
+
"kind": "field",
|
|
1614
|
+
"name": "valueState",
|
|
1615
|
+
"type": {
|
|
1616
|
+
"text": "ValueState",
|
|
1617
|
+
"references": [
|
|
1618
|
+
{
|
|
1619
|
+
"name": "ValueState",
|
|
1620
|
+
"package": "@ui5/webcomponents-base",
|
|
1621
|
+
"module": "dist/types/ValueState.js"
|
|
1622
|
+
}
|
|
1623
|
+
]
|
|
1624
|
+
},
|
|
1625
|
+
"default": "\"None\"",
|
|
1626
|
+
"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.",
|
|
1627
|
+
"privacy": "public",
|
|
1628
|
+
"_ui5since": "1.0.0-rc.7"
|
|
1629
|
+
}
|
|
1630
|
+
],
|
|
1631
|
+
"events": [
|
|
1632
|
+
{
|
|
1633
|
+
"name": "stop-generation",
|
|
1634
|
+
"_ui5privacy": "public",
|
|
1635
|
+
"type": {
|
|
1636
|
+
"text": "CustomEvent"
|
|
1637
|
+
},
|
|
1638
|
+
"description": "Fired when the user requests to stop AI text generation.",
|
|
1639
|
+
"_ui5Cancelable": false,
|
|
1640
|
+
"_ui5allowPreventDefault": false,
|
|
1641
|
+
"_ui5Bubbles": false
|
|
1642
|
+
},
|
|
1643
|
+
{
|
|
1644
|
+
"name": "version-change",
|
|
1645
|
+
"_ui5privacy": "public",
|
|
1646
|
+
"type": {
|
|
1647
|
+
"text": "CustomEvent<TextAreaVersionChangeEventDetail>",
|
|
1648
|
+
"references": [
|
|
1649
|
+
{
|
|
1650
|
+
"name": "TextAreaVersionChangeEventDetail",
|
|
1651
|
+
"package": "@ui5/webcomponents-ai",
|
|
1652
|
+
"module": "dist/TextArea.js"
|
|
1653
|
+
}
|
|
1654
|
+
]
|
|
1655
|
+
},
|
|
1656
|
+
"description": "Fired when the user clicks on version navigation buttons.",
|
|
1657
|
+
"_ui5Cancelable": false,
|
|
1658
|
+
"_ui5allowPreventDefault": false,
|
|
1659
|
+
"_ui5Bubbles": false,
|
|
1660
|
+
"_ui5parameters": [
|
|
1661
|
+
{
|
|
1662
|
+
"type": {
|
|
1663
|
+
"text": "boolean"
|
|
1664
|
+
},
|
|
1665
|
+
"name": "backwards",
|
|
1666
|
+
"_ui5privacy": "public",
|
|
1667
|
+
"description": "Indicates if navigation is backwards (true) or forwards (false, default)."
|
|
1668
|
+
}
|
|
1669
|
+
]
|
|
1670
|
+
},
|
|
1671
|
+
{
|
|
1672
|
+
"name": "change",
|
|
1673
|
+
"_ui5privacy": "public",
|
|
1674
|
+
"type": {
|
|
1675
|
+
"text": "CustomEvent"
|
|
1676
|
+
},
|
|
1677
|
+
"description": "Fired when the text has changed and the focus leaves the component.",
|
|
1678
|
+
"_ui5Cancelable": false,
|
|
1679
|
+
"_ui5allowPreventDefault": false,
|
|
1680
|
+
"_ui5Bubbles": true
|
|
1681
|
+
},
|
|
1682
|
+
{
|
|
1683
|
+
"name": "input",
|
|
1684
|
+
"_ui5privacy": "public",
|
|
1685
|
+
"type": {
|
|
1686
|
+
"text": "CustomEvent<TextAreaInputEventDetail>",
|
|
1687
|
+
"references": [
|
|
1688
|
+
{
|
|
1689
|
+
"name": "TextAreaInputEventDetail",
|
|
1690
|
+
"package": "@ui5/webcomponents",
|
|
1691
|
+
"module": "dist/TextArea.js"
|
|
1692
|
+
}
|
|
1693
|
+
]
|
|
1694
|
+
},
|
|
1695
|
+
"description": "Fired when the value of the component changes at each keystroke or when\nsomething is pasted.",
|
|
1696
|
+
"_ui5Cancelable": true,
|
|
1697
|
+
"_ui5allowPreventDefault": true,
|
|
1698
|
+
"_ui5Bubbles": true,
|
|
1699
|
+
"_ui5since": "1.0.0-rc.5",
|
|
1700
|
+
"_ui5parameters": [
|
|
1701
|
+
{
|
|
1702
|
+
"type": {
|
|
1703
|
+
"text": "boolean"
|
|
1704
|
+
},
|
|
1705
|
+
"name": "escapePressed",
|
|
1706
|
+
"_ui5privacy": "public",
|
|
1707
|
+
"description": "Indicates whether the Escape key was pressed, which triggers a revert to the previous value"
|
|
1708
|
+
}
|
|
1709
|
+
]
|
|
1710
|
+
},
|
|
1711
|
+
{
|
|
1712
|
+
"name": "scroll",
|
|
1713
|
+
"_ui5privacy": "public",
|
|
1714
|
+
"type": {
|
|
1715
|
+
"text": "CustomEvent"
|
|
1716
|
+
},
|
|
1717
|
+
"description": "Fired when textarea is scrolled.",
|
|
1718
|
+
"_ui5Cancelable": false,
|
|
1719
|
+
"_ui5allowPreventDefault": false,
|
|
1720
|
+
"_ui5Bubbles": true,
|
|
1721
|
+
"_ui5since": "1.23.0"
|
|
1722
|
+
},
|
|
1723
|
+
{
|
|
1724
|
+
"name": "select",
|
|
1725
|
+
"_ui5privacy": "public",
|
|
1726
|
+
"type": {
|
|
1727
|
+
"text": "CustomEvent"
|
|
1728
|
+
},
|
|
1729
|
+
"description": "Fired when some text has been selected.",
|
|
1730
|
+
"_ui5Cancelable": false,
|
|
1731
|
+
"_ui5allowPreventDefault": false,
|
|
1732
|
+
"_ui5Bubbles": true,
|
|
1733
|
+
"_ui5since": "1.23.0"
|
|
1734
|
+
}
|
|
1735
|
+
],
|
|
1736
|
+
"attributes": [
|
|
1737
|
+
{
|
|
1738
|
+
"description": "Indicates the index of the currently displayed version.",
|
|
1739
|
+
"name": "current-version",
|
|
1740
|
+
"default": "0",
|
|
1741
|
+
"fieldName": "currentVersion",
|
|
1742
|
+
"type": {
|
|
1743
|
+
"text": "number"
|
|
1744
|
+
}
|
|
1745
|
+
},
|
|
1746
|
+
{
|
|
1747
|
+
"description": "Defines whether the `ui5-ai-textarea` is currently in a loading(processing) state.",
|
|
1748
|
+
"name": "loading",
|
|
1749
|
+
"default": "false",
|
|
1750
|
+
"fieldName": "loading",
|
|
1751
|
+
"type": {
|
|
1752
|
+
"text": "boolean"
|
|
1753
|
+
}
|
|
1754
|
+
},
|
|
1755
|
+
{
|
|
1756
|
+
"description": "Defines the prompt description of the current action.",
|
|
1757
|
+
"name": "prompt-description",
|
|
1758
|
+
"default": "\"\"",
|
|
1759
|
+
"fieldName": "promptDescription",
|
|
1760
|
+
"type": {
|
|
1761
|
+
"text": "string"
|
|
1762
|
+
}
|
|
1763
|
+
},
|
|
1764
|
+
{
|
|
1765
|
+
"description": "Indicates the total number of result versions available.\n\nNotes:\nVersioning is hidden if the value is `0`",
|
|
1766
|
+
"name": "total-versions",
|
|
1767
|
+
"default": "0",
|
|
1768
|
+
"fieldName": "totalVersions",
|
|
1769
|
+
"type": {
|
|
1770
|
+
"text": "number"
|
|
1771
|
+
}
|
|
1772
|
+
},
|
|
1773
|
+
{
|
|
1774
|
+
"description": "Defines the accessible description of the component.",
|
|
1775
|
+
"name": "accessible-description",
|
|
1776
|
+
"default": "undefined",
|
|
1777
|
+
"fieldName": "accessibleDescription",
|
|
1778
|
+
"type": {
|
|
1779
|
+
"text": "string | undefined"
|
|
1780
|
+
}
|
|
1781
|
+
},
|
|
1782
|
+
{
|
|
1783
|
+
"description": "Receives id(or many ids) of the elements that describe the textarea.",
|
|
1784
|
+
"name": "accessible-description-ref",
|
|
1785
|
+
"default": "undefined",
|
|
1786
|
+
"fieldName": "accessibleDescriptionRef",
|
|
1787
|
+
"type": {
|
|
1788
|
+
"text": "string | undefined"
|
|
1789
|
+
}
|
|
1790
|
+
},
|
|
1791
|
+
{
|
|
1792
|
+
"description": "Defines the accessible ARIA name of the component.",
|
|
1793
|
+
"name": "accessible-name",
|
|
1794
|
+
"default": "undefined",
|
|
1795
|
+
"fieldName": "accessibleName",
|
|
1796
|
+
"type": {
|
|
1797
|
+
"text": "string | undefined"
|
|
1798
|
+
}
|
|
1799
|
+
},
|
|
1800
|
+
{
|
|
1801
|
+
"description": "Receives id(or many ids) of the elements that label the textarea.",
|
|
1802
|
+
"name": "accessible-name-ref",
|
|
1803
|
+
"default": "undefined",
|
|
1804
|
+
"fieldName": "accessibleNameRef",
|
|
1805
|
+
"type": {
|
|
1806
|
+
"text": "string | undefined"
|
|
1807
|
+
}
|
|
1808
|
+
},
|
|
1809
|
+
{
|
|
1810
|
+
"description": "Indicates whether the user can interact with the component or not.\n\n**Note:** A disabled component is completely noninteractive.",
|
|
1811
|
+
"name": "disabled",
|
|
1812
|
+
"default": "false",
|
|
1813
|
+
"fieldName": "disabled",
|
|
1814
|
+
"type": {
|
|
1815
|
+
"text": "boolean"
|
|
1816
|
+
}
|
|
1817
|
+
},
|
|
1818
|
+
{
|
|
1819
|
+
"description": "Enables the component to automatically grow and shrink dynamically with its content.",
|
|
1820
|
+
"name": "growing",
|
|
1821
|
+
"default": "false",
|
|
1822
|
+
"fieldName": "growing",
|
|
1823
|
+
"type": {
|
|
1824
|
+
"text": "boolean"
|
|
1825
|
+
}
|
|
1826
|
+
},
|
|
1827
|
+
{
|
|
1828
|
+
"description": "Defines the maximum number of rows that the component can grow.",
|
|
1829
|
+
"name": "growing-max-rows",
|
|
1830
|
+
"default": "0",
|
|
1831
|
+
"fieldName": "growingMaxRows",
|
|
1832
|
+
"type": {
|
|
1833
|
+
"text": "number"
|
|
1834
|
+
}
|
|
1835
|
+
},
|
|
1836
|
+
{
|
|
1837
|
+
"description": "Defines the maximum number of characters that the `value` can have.",
|
|
1838
|
+
"name": "maxlength",
|
|
1839
|
+
"default": "undefined",
|
|
1840
|
+
"fieldName": "maxlength",
|
|
1841
|
+
"type": {
|
|
1842
|
+
"text": "number | undefined"
|
|
1843
|
+
}
|
|
1844
|
+
},
|
|
1845
|
+
{
|
|
1846
|
+
"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.",
|
|
1847
|
+
"name": "name",
|
|
1848
|
+
"default": "undefined",
|
|
1849
|
+
"fieldName": "name",
|
|
1850
|
+
"type": {
|
|
1851
|
+
"text": "string | undefined"
|
|
1852
|
+
}
|
|
1853
|
+
},
|
|
1854
|
+
{
|
|
1855
|
+
"description": "Defines a short hint intended to aid the user with data entry when the component has no value.",
|
|
1856
|
+
"name": "placeholder",
|
|
1857
|
+
"default": "undefined",
|
|
1858
|
+
"fieldName": "placeholder",
|
|
1859
|
+
"type": {
|
|
1860
|
+
"text": "string | undefined"
|
|
1861
|
+
}
|
|
1862
|
+
},
|
|
1863
|
+
{
|
|
1864
|
+
"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.",
|
|
1865
|
+
"name": "readonly",
|
|
1866
|
+
"default": "false",
|
|
1867
|
+
"fieldName": "readonly",
|
|
1868
|
+
"type": {
|
|
1869
|
+
"text": "boolean"
|
|
1870
|
+
}
|
|
1871
|
+
},
|
|
1872
|
+
{
|
|
1873
|
+
"description": "Defines whether the component is required.",
|
|
1874
|
+
"name": "required",
|
|
1875
|
+
"default": "false",
|
|
1876
|
+
"fieldName": "required",
|
|
1877
|
+
"type": {
|
|
1878
|
+
"text": "boolean"
|
|
1879
|
+
}
|
|
1880
|
+
},
|
|
1881
|
+
{
|
|
1882
|
+
"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.",
|
|
1883
|
+
"name": "rows",
|
|
1884
|
+
"default": "0",
|
|
1885
|
+
"fieldName": "rows",
|
|
1886
|
+
"type": {
|
|
1887
|
+
"text": "number"
|
|
1888
|
+
}
|
|
1889
|
+
},
|
|
1890
|
+
{
|
|
1891
|
+
"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.",
|
|
1892
|
+
"name": "show-exceeded-text",
|
|
1893
|
+
"default": "false",
|
|
1894
|
+
"fieldName": "showExceededText",
|
|
1895
|
+
"type": {
|
|
1896
|
+
"text": "boolean"
|
|
1897
|
+
}
|
|
1898
|
+
},
|
|
1899
|
+
{
|
|
1900
|
+
"description": "Defines the value of the component.",
|
|
1901
|
+
"name": "value",
|
|
1902
|
+
"default": "\"\"",
|
|
1903
|
+
"fieldName": "value",
|
|
1904
|
+
"type": {
|
|
1905
|
+
"text": "string"
|
|
1906
|
+
}
|
|
1907
|
+
},
|
|
1908
|
+
{
|
|
1909
|
+
"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.",
|
|
1910
|
+
"name": "value-state",
|
|
1911
|
+
"default": "\"None\"",
|
|
1912
|
+
"fieldName": "valueState",
|
|
1913
|
+
"type": {
|
|
1914
|
+
"text": "\"None\" | \"Positive\" | \"Critical\" | \"Negative\" | \"Information\""
|
|
1915
|
+
}
|
|
1916
|
+
}
|
|
1917
|
+
],
|
|
1918
|
+
"superclass": {
|
|
1919
|
+
"name": "TextArea",
|
|
1920
|
+
"package": "@ui5/webcomponents",
|
|
1921
|
+
"module": "dist/TextArea.js"
|
|
1922
|
+
},
|
|
1923
|
+
"tagName": "ui5-ai-textarea",
|
|
1924
|
+
"customElement": true,
|
|
1925
|
+
"_ui5experimental": "The **@ui5/webcomponents-ai** package is under development and considered experimental - components' APIs are subject to change.\nFurthermore, the package supports **Horizon** themes only.",
|
|
1926
|
+
"_ui5since": "2.16.0",
|
|
1927
|
+
"_ui5privacy": "public",
|
|
1928
|
+
"cssParts": [
|
|
1929
|
+
{
|
|
1930
|
+
"description": "Used to style the native textarea",
|
|
1931
|
+
"name": "textarea"
|
|
1932
|
+
}
|
|
1933
|
+
]
|
|
1934
|
+
}
|
|
1935
|
+
],
|
|
1936
|
+
"exports": [
|
|
1937
|
+
{
|
|
1938
|
+
"kind": "js",
|
|
1939
|
+
"name": "default",
|
|
1940
|
+
"declaration": {
|
|
1941
|
+
"name": "TextArea",
|
|
1942
|
+
"module": "dist/TextArea.js"
|
|
1943
|
+
}
|
|
1944
|
+
},
|
|
1945
|
+
{
|
|
1946
|
+
"kind": "custom-element-definition",
|
|
1947
|
+
"name": "ui5-ai-textarea",
|
|
1948
|
+
"declaration": {
|
|
1949
|
+
"name": "TextArea",
|
|
1950
|
+
"module": "dist/TextArea.js"
|
|
1951
|
+
}
|
|
1952
|
+
}
|
|
1953
|
+
]
|
|
1954
|
+
},
|
|
1955
|
+
{
|
|
1956
|
+
"kind": "javascript-module",
|
|
1957
|
+
"path": "dist/ToolbarLabel.js",
|
|
1958
|
+
"declarations": [
|
|
1959
|
+
{
|
|
1960
|
+
"kind": "class",
|
|
1961
|
+
"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\";`",
|
|
1962
|
+
"name": "ToolbarLabel",
|
|
1963
|
+
"members": [
|
|
1964
|
+
{
|
|
1965
|
+
"kind": "field",
|
|
1966
|
+
"name": "text",
|
|
1967
|
+
"type": {
|
|
1968
|
+
"text": "string"
|
|
1969
|
+
},
|
|
1970
|
+
"default": "\"\"",
|
|
1971
|
+
"description": "Defines the text of the label.",
|
|
1972
|
+
"privacy": "public"
|
|
1973
|
+
},
|
|
1974
|
+
{
|
|
1975
|
+
"kind": "field",
|
|
1976
|
+
"name": "overflowPriority",
|
|
1977
|
+
"type": {
|
|
1978
|
+
"text": "ToolbarItemOverflowBehavior",
|
|
1979
|
+
"references": [
|
|
1980
|
+
{
|
|
1981
|
+
"name": "ToolbarItemOverflowBehavior",
|
|
1982
|
+
"package": "@ui5/webcomponents",
|
|
1983
|
+
"module": "dist/types/ToolbarItemOverflowBehavior.js"
|
|
1984
|
+
}
|
|
1985
|
+
]
|
|
1986
|
+
},
|
|
1987
|
+
"default": "\"Default\"",
|
|
1988
|
+
"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.",
|
|
1989
|
+
"privacy": "public"
|
|
1990
|
+
},
|
|
1991
|
+
{
|
|
1992
|
+
"kind": "field",
|
|
1993
|
+
"name": "preventOverflowClosing",
|
|
1994
|
+
"type": {
|
|
1995
|
+
"text": "boolean"
|
|
1996
|
+
},
|
|
1997
|
+
"default": "false",
|
|
1998
|
+
"description": "Defines if the toolbar overflow popup should close upon interaction with the item.\nIt will close by default.",
|
|
1999
|
+
"privacy": "public"
|
|
2000
|
+
}
|
|
2001
|
+
],
|
|
2002
|
+
"attributes": [
|
|
2003
|
+
{
|
|
2004
|
+
"description": "Defines the text of the label.",
|
|
2005
|
+
"name": "text",
|
|
2006
|
+
"default": "\"\"",
|
|
2007
|
+
"fieldName": "text",
|
|
2008
|
+
"type": {
|
|
2009
|
+
"text": "string"
|
|
2010
|
+
}
|
|
2011
|
+
},
|
|
2012
|
+
{
|
|
2013
|
+
"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.",
|
|
2014
|
+
"name": "overflow-priority",
|
|
2015
|
+
"default": "\"Default\"",
|
|
2016
|
+
"fieldName": "overflowPriority",
|
|
2017
|
+
"type": {
|
|
2018
|
+
"text": "\"Default\" | \"NeverOverflow\" | \"AlwaysOverflow\""
|
|
2019
|
+
}
|
|
2020
|
+
},
|
|
2021
|
+
{
|
|
2022
|
+
"description": "Defines if the toolbar overflow popup should close upon interaction with the item.\nIt will close by default.",
|
|
2023
|
+
"name": "prevent-overflow-closing",
|
|
2024
|
+
"default": "false",
|
|
2025
|
+
"fieldName": "preventOverflowClosing",
|
|
2026
|
+
"type": {
|
|
2027
|
+
"text": "boolean"
|
|
2028
|
+
}
|
|
2029
|
+
}
|
|
2030
|
+
],
|
|
2031
|
+
"superclass": {
|
|
2032
|
+
"name": "ToolbarItem",
|
|
2033
|
+
"package": "@ui5/webcomponents",
|
|
2034
|
+
"module": "dist/ToolbarItem.js"
|
|
2035
|
+
},
|
|
2036
|
+
"tagName": "ui5-ai-toolbar-label",
|
|
2037
|
+
"customElement": true,
|
|
2038
|
+
"_ui5since": "1.0.0-rc.1",
|
|
2039
|
+
"_ui5privacy": "private",
|
|
2040
|
+
"slots": [
|
|
2041
|
+
{
|
|
2042
|
+
"name": "default",
|
|
2043
|
+
"description": "Wrapped component slot.",
|
|
2044
|
+
"_ui5since": "2.20.0",
|
|
2045
|
+
"_ui5propertyName": "item",
|
|
2046
|
+
"_ui5type": {
|
|
2047
|
+
"text": "Array<IOverflowToolbarItem>",
|
|
2048
|
+
"references": [
|
|
2049
|
+
{
|
|
2050
|
+
"name": "IOverflowToolbarItem",
|
|
2051
|
+
"package": "@ui5/webcomponents",
|
|
2052
|
+
"module": "dist/ToolbarItem.js"
|
|
2053
|
+
}
|
|
2054
|
+
]
|
|
2055
|
+
},
|
|
2056
|
+
"_ui5privacy": "public"
|
|
2057
|
+
}
|
|
2058
|
+
],
|
|
2059
|
+
"events": [
|
|
2060
|
+
{
|
|
2061
|
+
"name": "close-overflow",
|
|
2062
|
+
"_ui5privacy": "public",
|
|
2063
|
+
"type": {
|
|
2064
|
+
"text": "CustomEvent"
|
|
2065
|
+
},
|
|
2066
|
+
"description": "Fired when the overflow popover is closed.",
|
|
2067
|
+
"_ui5Cancelable": true,
|
|
2068
|
+
"_ui5allowPreventDefault": true,
|
|
2069
|
+
"_ui5Bubbles": true,
|
|
2070
|
+
"_ui5since": "1.17.0"
|
|
2071
|
+
}
|
|
2072
|
+
],
|
|
2073
|
+
"cssStates": [
|
|
2074
|
+
{
|
|
2075
|
+
"description": "When the item is displayed in the overflow popover. Use this state to apply different styles when the item is overflowed. Available since 2.20.0.",
|
|
2076
|
+
"name": "overflowed"
|
|
2077
|
+
}
|
|
2078
|
+
]
|
|
2079
|
+
}
|
|
2080
|
+
],
|
|
2081
|
+
"exports": [
|
|
2082
|
+
{
|
|
2083
|
+
"kind": "js",
|
|
2084
|
+
"name": "default",
|
|
2085
|
+
"declaration": {
|
|
2086
|
+
"name": "ToolbarLabel",
|
|
2087
|
+
"module": "dist/ToolbarLabel.js"
|
|
2088
|
+
}
|
|
2089
|
+
},
|
|
2090
|
+
{
|
|
2091
|
+
"kind": "custom-element-definition",
|
|
2092
|
+
"name": "ui5-ai-toolbar-label",
|
|
2093
|
+
"declaration": {
|
|
2094
|
+
"name": "ToolbarLabel",
|
|
2095
|
+
"module": "dist/ToolbarLabel.js"
|
|
2096
|
+
}
|
|
2097
|
+
}
|
|
2098
|
+
]
|
|
2099
|
+
},
|
|
2100
|
+
{
|
|
2101
|
+
"kind": "javascript-module",
|
|
2102
|
+
"path": "dist/Versioning.js",
|
|
2103
|
+
"declarations": [
|
|
2104
|
+
{
|
|
2105
|
+
"kind": "class",
|
|
2106
|
+
"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\";`",
|
|
2107
|
+
"name": "Versioning",
|
|
2108
|
+
"members": [
|
|
2109
|
+
{
|
|
2110
|
+
"kind": "field",
|
|
2111
|
+
"name": "currentStep",
|
|
2112
|
+
"type": {
|
|
2113
|
+
"text": "number"
|
|
2114
|
+
},
|
|
2115
|
+
"default": "0",
|
|
2116
|
+
"description": "Indicates the index of the currently displayed result version.\n\nThis property represents the current position in the version history.",
|
|
2117
|
+
"privacy": "public"
|
|
2118
|
+
},
|
|
2119
|
+
{
|
|
2120
|
+
"kind": "field",
|
|
2121
|
+
"name": "totalSteps",
|
|
2122
|
+
"type": {
|
|
2123
|
+
"text": "number"
|
|
2124
|
+
},
|
|
2125
|
+
"default": "0",
|
|
2126
|
+
"description": "The total number of available result versions.\n\nNote: Versioning is hidden if the value is `0`.",
|
|
2127
|
+
"privacy": "public"
|
|
2128
|
+
},
|
|
2129
|
+
{
|
|
2130
|
+
"kind": "field",
|
|
2131
|
+
"name": "overflowPriority",
|
|
2132
|
+
"type": {
|
|
2133
|
+
"text": "ToolbarItemOverflowBehavior",
|
|
2134
|
+
"references": [
|
|
2135
|
+
{
|
|
2136
|
+
"name": "ToolbarItemOverflowBehavior",
|
|
2137
|
+
"package": "@ui5/webcomponents",
|
|
2138
|
+
"module": "dist/types/ToolbarItemOverflowBehavior.js"
|
|
2139
|
+
}
|
|
2140
|
+
]
|
|
2141
|
+
},
|
|
2142
|
+
"default": "\"Default\"",
|
|
2143
|
+
"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.",
|
|
2144
|
+
"privacy": "public"
|
|
2145
|
+
},
|
|
2146
|
+
{
|
|
2147
|
+
"kind": "field",
|
|
2148
|
+
"name": "preventOverflowClosing",
|
|
782
2149
|
"type": {
|
|
783
2150
|
"text": "boolean"
|
|
784
|
-
}
|
|
785
|
-
},
|
|
786
|
-
{
|
|
787
|
-
"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.",
|
|
788
|
-
"name": "show-exceeded-text",
|
|
2151
|
+
},
|
|
789
2152
|
"default": "false",
|
|
790
|
-
"
|
|
2153
|
+
"description": "Defines if the toolbar overflow popup should close upon interaction with the item.\nIt will close by default.",
|
|
2154
|
+
"privacy": "public"
|
|
2155
|
+
}
|
|
2156
|
+
],
|
|
2157
|
+
"events": [
|
|
2158
|
+
{
|
|
2159
|
+
"name": "version-change",
|
|
2160
|
+
"_ui5privacy": "public",
|
|
791
2161
|
"type": {
|
|
792
|
-
"text": "
|
|
793
|
-
}
|
|
2162
|
+
"text": "CustomEvent"
|
|
2163
|
+
},
|
|
2164
|
+
"description": "Fired when the user clicks on version navigation buttons.",
|
|
2165
|
+
"_ui5Cancelable": false,
|
|
2166
|
+
"_ui5allowPreventDefault": false,
|
|
2167
|
+
"_ui5Bubbles": false
|
|
794
2168
|
},
|
|
795
2169
|
{
|
|
796
|
-
"
|
|
797
|
-
"
|
|
798
|
-
"default": "false",
|
|
799
|
-
"fieldName": "disabled",
|
|
2170
|
+
"name": "close-overflow",
|
|
2171
|
+
"_ui5privacy": "public",
|
|
800
2172
|
"type": {
|
|
801
|
-
"text": "
|
|
802
|
-
}
|
|
803
|
-
|
|
2173
|
+
"text": "CustomEvent"
|
|
2174
|
+
},
|
|
2175
|
+
"description": "Fired when the overflow popover is closed.",
|
|
2176
|
+
"_ui5Cancelable": true,
|
|
2177
|
+
"_ui5allowPreventDefault": true,
|
|
2178
|
+
"_ui5Bubbles": true,
|
|
2179
|
+
"_ui5since": "1.17.0"
|
|
2180
|
+
}
|
|
2181
|
+
],
|
|
2182
|
+
"attributes": [
|
|
804
2183
|
{
|
|
805
|
-
"description": "
|
|
806
|
-
"name": "
|
|
807
|
-
"default": "
|
|
808
|
-
"fieldName": "
|
|
2184
|
+
"description": "Indicates the index of the currently displayed result version.\n\nThis property represents the current position in the version history.",
|
|
2185
|
+
"name": "current-step",
|
|
2186
|
+
"default": "0",
|
|
2187
|
+
"fieldName": "currentStep",
|
|
809
2188
|
"type": {
|
|
810
|
-
"text": "
|
|
2189
|
+
"text": "number"
|
|
811
2190
|
}
|
|
812
2191
|
},
|
|
813
2192
|
{
|
|
814
|
-
"description": "
|
|
815
|
-
"name": "
|
|
816
|
-
"default": "
|
|
817
|
-
"fieldName": "
|
|
2193
|
+
"description": "The total number of available result versions.\n\nNote: Versioning is hidden if the value is `0`.",
|
|
2194
|
+
"name": "total-steps",
|
|
2195
|
+
"default": "0",
|
|
2196
|
+
"fieldName": "totalSteps",
|
|
818
2197
|
"type": {
|
|
819
|
-
"text": "number
|
|
2198
|
+
"text": "number"
|
|
820
2199
|
}
|
|
821
2200
|
},
|
|
822
2201
|
{
|
|
823
|
-
"description": "
|
|
824
|
-
"name": "
|
|
825
|
-
"default": "\"
|
|
826
|
-
"fieldName": "
|
|
2202
|
+
"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.",
|
|
2203
|
+
"name": "overflow-priority",
|
|
2204
|
+
"default": "\"Default\"",
|
|
2205
|
+
"fieldName": "overflowPriority",
|
|
827
2206
|
"type": {
|
|
828
|
-
"text": "\"
|
|
2207
|
+
"text": "\"Default\" | \"NeverOverflow\" | \"AlwaysOverflow\""
|
|
829
2208
|
}
|
|
830
2209
|
},
|
|
831
2210
|
{
|
|
832
|
-
"description": "Defines
|
|
833
|
-
"name": "
|
|
2211
|
+
"description": "Defines if the toolbar overflow popup should close upon interaction with the item.\nIt will close by default.",
|
|
2212
|
+
"name": "prevent-overflow-closing",
|
|
834
2213
|
"default": "false",
|
|
835
|
-
"fieldName": "
|
|
2214
|
+
"fieldName": "preventOverflowClosing",
|
|
836
2215
|
"type": {
|
|
837
2216
|
"text": "boolean"
|
|
838
2217
|
}
|
|
839
2218
|
}
|
|
840
2219
|
],
|
|
841
2220
|
"superclass": {
|
|
842
|
-
"name": "
|
|
843
|
-
"package": "@ui5/webcomponents
|
|
844
|
-
"module": "dist/
|
|
2221
|
+
"name": "ToolbarItem",
|
|
2222
|
+
"package": "@ui5/webcomponents",
|
|
2223
|
+
"module": "dist/ToolbarItem.js"
|
|
845
2224
|
},
|
|
846
|
-
"tagName": "ui5-ai-
|
|
2225
|
+
"tagName": "ui5-ai-versioning",
|
|
847
2226
|
"customElement": true,
|
|
848
|
-
"
|
|
849
|
-
"_ui5privacy": "
|
|
2227
|
+
"_ui5since": "2.16.0",
|
|
2228
|
+
"_ui5privacy": "private",
|
|
2229
|
+
"slots": [
|
|
2230
|
+
{
|
|
2231
|
+
"name": "default",
|
|
2232
|
+
"description": "Wrapped component slot.",
|
|
2233
|
+
"_ui5since": "2.20.0",
|
|
2234
|
+
"_ui5propertyName": "item",
|
|
2235
|
+
"_ui5type": {
|
|
2236
|
+
"text": "Array<IOverflowToolbarItem>",
|
|
2237
|
+
"references": [
|
|
2238
|
+
{
|
|
2239
|
+
"name": "IOverflowToolbarItem",
|
|
2240
|
+
"package": "@ui5/webcomponents",
|
|
2241
|
+
"module": "dist/ToolbarItem.js"
|
|
2242
|
+
}
|
|
2243
|
+
]
|
|
2244
|
+
},
|
|
2245
|
+
"_ui5privacy": "public"
|
|
2246
|
+
}
|
|
2247
|
+
],
|
|
2248
|
+
"cssStates": [
|
|
2249
|
+
{
|
|
2250
|
+
"description": "When the item is displayed in the overflow popover. Use this state to apply different styles when the item is overflowed. Available since 2.20.0.",
|
|
2251
|
+
"name": "overflowed"
|
|
2252
|
+
}
|
|
2253
|
+
]
|
|
850
2254
|
}
|
|
851
2255
|
],
|
|
852
2256
|
"exports": [
|
|
@@ -854,67 +2258,59 @@
|
|
|
854
2258
|
"kind": "js",
|
|
855
2259
|
"name": "default",
|
|
856
2260
|
"declaration": {
|
|
857
|
-
"name": "
|
|
858
|
-
"module": "dist/
|
|
2261
|
+
"name": "Versioning",
|
|
2262
|
+
"module": "dist/Versioning.js"
|
|
859
2263
|
}
|
|
860
2264
|
},
|
|
861
2265
|
{
|
|
862
2266
|
"kind": "custom-element-definition",
|
|
863
|
-
"name": "ui5-ai-
|
|
2267
|
+
"name": "ui5-ai-versioning",
|
|
864
2268
|
"declaration": {
|
|
865
|
-
"name": "
|
|
866
|
-
"module": "dist/
|
|
2269
|
+
"name": "Versioning",
|
|
2270
|
+
"module": "dist/Versioning.js"
|
|
867
2271
|
}
|
|
868
2272
|
}
|
|
869
2273
|
]
|
|
870
2274
|
},
|
|
871
2275
|
{
|
|
872
2276
|
"kind": "javascript-module",
|
|
873
|
-
"path": "dist/
|
|
2277
|
+
"path": "dist/WritingAssistant.js",
|
|
874
2278
|
"declarations": [
|
|
875
2279
|
{
|
|
876
2280
|
"kind": "class",
|
|
877
|
-
"description": "### Overview\n\nThe `ui5-ai-textarea` component
|
|
878
|
-
"name": "
|
|
879
|
-
"slots": [
|
|
880
|
-
{
|
|
881
|
-
"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.",
|
|
882
|
-
"name": "menu",
|
|
883
|
-
"_ui5privacy": "public",
|
|
884
|
-
"_ui5type": {
|
|
885
|
-
"text": "HTMLElement"
|
|
886
|
-
}
|
|
887
|
-
}
|
|
888
|
-
],
|
|
2281
|
+
"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\";`",
|
|
2282
|
+
"name": "WritingAssistant",
|
|
889
2283
|
"members": [
|
|
890
2284
|
{
|
|
891
2285
|
"kind": "field",
|
|
892
|
-
"name": "
|
|
2286
|
+
"name": "currentVersion",
|
|
893
2287
|
"type": {
|
|
894
|
-
"text": "
|
|
2288
|
+
"text": "number"
|
|
895
2289
|
},
|
|
896
|
-
"default": "
|
|
897
|
-
"description": "
|
|
898
|
-
"privacy": "public"
|
|
2290
|
+
"default": "0",
|
|
2291
|
+
"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.",
|
|
2292
|
+
"privacy": "public",
|
|
2293
|
+
"_ui5since": "2.16.0"
|
|
899
2294
|
},
|
|
900
2295
|
{
|
|
901
|
-
"kind": "
|
|
902
|
-
"name": "
|
|
903
|
-
"
|
|
904
|
-
"
|
|
2296
|
+
"kind": "method",
|
|
2297
|
+
"name": "handleButtonClick",
|
|
2298
|
+
"return": {
|
|
2299
|
+
"type": {
|
|
2300
|
+
"text": "void"
|
|
2301
|
+
}
|
|
905
2302
|
},
|
|
906
|
-
"
|
|
907
|
-
"description": "Defines the prompt description of the current action.",
|
|
2303
|
+
"description": "Handles the click event for the AI generate button.\nToggles between generate and stop states based on current button state.",
|
|
908
2304
|
"privacy": "public"
|
|
909
2305
|
},
|
|
910
2306
|
{
|
|
911
2307
|
"kind": "field",
|
|
912
|
-
"name": "
|
|
2308
|
+
"name": "promptDescription",
|
|
913
2309
|
"type": {
|
|
914
|
-
"text": "
|
|
2310
|
+
"text": "string"
|
|
915
2311
|
},
|
|
916
|
-
"default": "
|
|
917
|
-
"description": "
|
|
2312
|
+
"default": "\"\"",
|
|
2313
|
+
"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\").",
|
|
918
2314
|
"privacy": "public"
|
|
919
2315
|
},
|
|
920
2316
|
{
|
|
@@ -924,38 +2320,21 @@
|
|
|
924
2320
|
"text": "number"
|
|
925
2321
|
},
|
|
926
2322
|
"default": "0",
|
|
927
|
-
"description": "Indicates the total number of result versions available.\n\
|
|
2323
|
+
"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.",
|
|
928
2324
|
"privacy": "public"
|
|
929
2325
|
}
|
|
930
2326
|
],
|
|
931
2327
|
"events": [
|
|
932
2328
|
{
|
|
933
|
-
"name": "
|
|
2329
|
+
"name": "button-click",
|
|
934
2330
|
"_ui5privacy": "public",
|
|
935
2331
|
"type": {
|
|
936
|
-
"text": "CustomEvent
|
|
937
|
-
"references": [
|
|
938
|
-
{
|
|
939
|
-
"name": "TextAreaVersionChangeEventDetail",
|
|
940
|
-
"package": "@ui5/webcomponents-ai",
|
|
941
|
-
"module": "dist/TextArea.js"
|
|
942
|
-
}
|
|
943
|
-
]
|
|
2332
|
+
"text": "CustomEvent"
|
|
944
2333
|
},
|
|
945
|
-
"description": "Fired when the user clicks on
|
|
2334
|
+
"description": "Fired when the user clicks on the AI button.",
|
|
946
2335
|
"_ui5Cancelable": false,
|
|
947
2336
|
"_ui5allowPreventDefault": false,
|
|
948
|
-
"_ui5Bubbles": false
|
|
949
|
-
"_ui5parameters": [
|
|
950
|
-
{
|
|
951
|
-
"type": {
|
|
952
|
-
"text": "boolean"
|
|
953
|
-
},
|
|
954
|
-
"name": "backwards",
|
|
955
|
-
"_ui5privacy": "public",
|
|
956
|
-
"description": "Indicates if navigation is backwards (true) or forwards (false, default)."
|
|
957
|
-
}
|
|
958
|
-
]
|
|
2337
|
+
"_ui5Bubbles": false
|
|
959
2338
|
},
|
|
960
2339
|
{
|
|
961
2340
|
"name": "stop-generation",
|
|
@@ -963,7 +2342,18 @@
|
|
|
963
2342
|
"type": {
|
|
964
2343
|
"text": "CustomEvent"
|
|
965
2344
|
},
|
|
966
|
-
"description": "Fired when the user
|
|
2345
|
+
"description": "Fired when the user clicks on the \"Stop\" button to stop ongoing AI text generation.",
|
|
2346
|
+
"_ui5Cancelable": false,
|
|
2347
|
+
"_ui5allowPreventDefault": false,
|
|
2348
|
+
"_ui5Bubbles": false
|
|
2349
|
+
},
|
|
2350
|
+
{
|
|
2351
|
+
"name": "version-change",
|
|
2352
|
+
"_ui5privacy": "public",
|
|
2353
|
+
"type": {
|
|
2354
|
+
"text": "CustomEvent"
|
|
2355
|
+
},
|
|
2356
|
+
"description": "Fired when the user clicks on version navigation buttons.",
|
|
967
2357
|
"_ui5Cancelable": false,
|
|
968
2358
|
"_ui5allowPreventDefault": false,
|
|
969
2359
|
"_ui5Bubbles": false
|
|
@@ -971,16 +2361,16 @@
|
|
|
971
2361
|
],
|
|
972
2362
|
"attributes": [
|
|
973
2363
|
{
|
|
974
|
-
"description": "
|
|
975
|
-
"name": "
|
|
976
|
-
"default": "
|
|
977
|
-
"fieldName": "
|
|
2364
|
+
"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.",
|
|
2365
|
+
"name": "current-version",
|
|
2366
|
+
"default": "0",
|
|
2367
|
+
"fieldName": "currentVersion",
|
|
978
2368
|
"type": {
|
|
979
|
-
"text": "
|
|
2369
|
+
"text": "number"
|
|
980
2370
|
}
|
|
981
2371
|
},
|
|
982
2372
|
{
|
|
983
|
-
"description": "Defines the prompt description of the current action.",
|
|
2373
|
+
"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\").",
|
|
984
2374
|
"name": "prompt-description",
|
|
985
2375
|
"default": "\"\"",
|
|
986
2376
|
"fieldName": "promptDescription",
|
|
@@ -989,16 +2379,7 @@
|
|
|
989
2379
|
}
|
|
990
2380
|
},
|
|
991
2381
|
{
|
|
992
|
-
"description": "Indicates the
|
|
993
|
-
"name": "current-version",
|
|
994
|
-
"default": "0",
|
|
995
|
-
"fieldName": "currentVersion",
|
|
996
|
-
"type": {
|
|
997
|
-
"text": "number"
|
|
998
|
-
}
|
|
999
|
-
},
|
|
1000
|
-
{
|
|
1001
|
-
"description": "Indicates the total number of result versions available.\n\nNotes:\nVersioning is hidden if the value is `0`",
|
|
2382
|
+
"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.",
|
|
1002
2383
|
"name": "total-versions",
|
|
1003
2384
|
"default": "0",
|
|
1004
2385
|
"fieldName": "totalVersions",
|
|
@@ -1008,15 +2389,14 @@
|
|
|
1008
2389
|
}
|
|
1009
2390
|
],
|
|
1010
2391
|
"superclass": {
|
|
1011
|
-
"name": "
|
|
1012
|
-
"package": "@ui5/webcomponents",
|
|
1013
|
-
"module": "dist/
|
|
2392
|
+
"name": "UI5Element",
|
|
2393
|
+
"package": "@ui5/webcomponents-base",
|
|
2394
|
+
"module": "dist/UI5Element.js"
|
|
1014
2395
|
},
|
|
1015
|
-
"tagName": "ui5-ai-
|
|
2396
|
+
"tagName": "ui5-ai-writing-assistant",
|
|
1016
2397
|
"customElement": true,
|
|
1017
|
-
"_ui5experimental": "The **@ui5/webcomponents-ai** package is under development and considered experimental - components' APIs are subject to change.\nFurthermore, the package supports **Horizon** themes only.",
|
|
1018
2398
|
"_ui5since": "2.16.0",
|
|
1019
|
-
"_ui5privacy": "
|
|
2399
|
+
"_ui5privacy": "private"
|
|
1020
2400
|
}
|
|
1021
2401
|
],
|
|
1022
2402
|
"exports": [
|
|
@@ -1024,58 +2404,13 @@
|
|
|
1024
2404
|
"kind": "js",
|
|
1025
2405
|
"name": "default",
|
|
1026
2406
|
"declaration": {
|
|
1027
|
-
"name": "
|
|
1028
|
-
"module": "dist/
|
|
2407
|
+
"name": "WritingAssistant",
|
|
2408
|
+
"module": "dist/WritingAssistant.js"
|
|
1029
2409
|
}
|
|
1030
2410
|
},
|
|
1031
2411
|
{
|
|
1032
2412
|
"kind": "custom-element-definition",
|
|
1033
|
-
"name": "ui5-ai-
|
|
1034
|
-
"declaration": {
|
|
1035
|
-
"name": "TextArea",
|
|
1036
|
-
"module": "dist/TextArea.js"
|
|
1037
|
-
}
|
|
1038
|
-
}
|
|
1039
|
-
]
|
|
1040
|
-
},
|
|
1041
|
-
{
|
|
1042
|
-
"kind": "javascript-module",
|
|
1043
|
-
"path": "dist/ToolbarLabel.js",
|
|
1044
|
-
"declarations": [],
|
|
1045
|
-
"exports": [
|
|
1046
|
-
{
|
|
1047
|
-
"kind": "js",
|
|
1048
|
-
"name": "default",
|
|
1049
|
-
"declaration": {
|
|
1050
|
-
"name": "ToolbarLabel",
|
|
1051
|
-
"module": "dist/ToolbarLabel.js"
|
|
1052
|
-
}
|
|
1053
|
-
}
|
|
1054
|
-
]
|
|
1055
|
-
},
|
|
1056
|
-
{
|
|
1057
|
-
"kind": "javascript-module",
|
|
1058
|
-
"path": "dist/Versioning.js",
|
|
1059
|
-
"declarations": [],
|
|
1060
|
-
"exports": [
|
|
1061
|
-
{
|
|
1062
|
-
"kind": "js",
|
|
1063
|
-
"name": "default",
|
|
1064
|
-
"declaration": {
|
|
1065
|
-
"name": "Versioning",
|
|
1066
|
-
"module": "dist/Versioning.js"
|
|
1067
|
-
}
|
|
1068
|
-
}
|
|
1069
|
-
]
|
|
1070
|
-
},
|
|
1071
|
-
{
|
|
1072
|
-
"kind": "javascript-module",
|
|
1073
|
-
"path": "dist/WritingAssistant.js",
|
|
1074
|
-
"declarations": [],
|
|
1075
|
-
"exports": [
|
|
1076
|
-
{
|
|
1077
|
-
"kind": "js",
|
|
1078
|
-
"name": "default",
|
|
2413
|
+
"name": "ui5-ai-writing-assistant",
|
|
1079
2414
|
"declaration": {
|
|
1080
2415
|
"name": "WritingAssistant",
|
|
1081
2416
|
"module": "dist/WritingAssistant.js"
|