@ui5/webcomponents-ai 2.20.0-rc.2 → 2.20.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +16 -0
- package/dist/.tsbuildinfo +1 -1
- package/dist/Input.d.ts +2 -4
- package/dist/Input.js +2 -2
- package/dist/Input.js.map +1 -1
- package/dist/ToolbarLabel.d.ts +1 -1
- package/dist/ToolbarLabel.js +1 -1
- package/dist/ToolbarLabel.js.map +1 -1
- package/dist/custom-elements-internal.json +1781 -484
- package/dist/custom-elements.json +1484 -356
- package/dist/vscode.html-custom-data.json +97 -46
- package/dist/web-types.json +262 -127
- package/package.json +10 -8
|
@@ -3,8 +3,18 @@
|
|
|
3
3
|
"tags": [
|
|
4
4
|
{
|
|
5
5
|
"name": "ui5-ai-button",
|
|
6
|
-
"description": "### Overview\n\nThe `ui5-ai-button` component serves as a button for AI-related scenarios. Users can trigger actions by clicking or tapping the `ui5-ai-button`\nor by pressing keyboard keys like [Enter] or [Space].\n\n### Usage\n\nFor the `ui5-ai-button` user interface, you can define one or more button states by placing `ui5-ai-button-state` components in their default slot.\nEach state has a name for identification and can include text, an icon, and an end icon, as needed for its purpose.\nYou can define a split mode for the `ui5-ai-button`, which will results in displaying an arrow button for additional actions.\n\nYou can choose from a set of predefined designs for `ui5-ai-button` (as in `ui5-button`) to match the desired styling.\n\nThe `ui5-ai-button` can be activated by clicking or tapping it. You can change the button state in the click event handler. When the button is\nin split mode, you can activate the default button action by clicking or tapping it, or by pressing keyboard keys like [Enter] or [Space].\nYou can activate the arrow button by clicking or tapping it, or by pressing keyboard keys like [Arrow Up], [Arrow Down], or [F4].\nTo display additional actions, you can attach a menu to the arrow button.\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-ai/dist/Button.js\";`\n\n\n---\n\n\n\n\n### **Events:**\n - **
|
|
6
|
+
"description": "### Overview\n\nThe `ui5-ai-button` component serves as a button for AI-related scenarios. Users can trigger actions by clicking or tapping the `ui5-ai-button`\nor by pressing keyboard keys like [Enter] or [Space].\n\n### Usage\n\nFor the `ui5-ai-button` user interface, you can define one or more button states by placing `ui5-ai-button-state` components in their default slot.\nEach state has a name for identification and can include text, an icon, and an end icon, as needed for its purpose.\nYou can define a split mode for the `ui5-ai-button`, which will results in displaying an arrow button for additional actions.\n\nYou can choose from a set of predefined designs for `ui5-ai-button` (as in `ui5-button`) to match the desired styling.\n\nThe `ui5-ai-button` can be activated by clicking or tapping it. You can change the button state in the click event handler. When the button is\nin split mode, you can activate the default button action by clicking or tapping it, or by pressing keyboard keys like [Enter] or [Space].\nYou can activate the arrow button by clicking or tapping it, or by pressing keyboard keys like [Arrow Up], [Arrow Down], or [F4].\nTo display additional actions, you can attach a menu to the arrow button.\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-ai/dist/Button.js\";`\n\n\n---\n\n\n\n\n### **Events:**\n - **arrow-button-click** - 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.\n- **click** - Fired when the component is activated either with a\nmouse/tap or by using the Enter or Space key.\n\n### **Slots:**\n - **default** - Defines the available states of the component.\n**Note:** Although this slot accepts HTML Elements, it is strongly recommended that\nyou only use `ui5-ai-button-state` components in order to preserve the intended design.",
|
|
7
7
|
"attributes": [
|
|
8
|
+
{
|
|
9
|
+
"name": "accessibility-attributes",
|
|
10
|
+
"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`.",
|
|
11
|
+
"values": [{ "name": "AIButtonAccessibilityAttributes" }]
|
|
12
|
+
},
|
|
13
|
+
{
|
|
14
|
+
"name": "arrow-button-pressed",
|
|
15
|
+
"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.",
|
|
16
|
+
"values": []
|
|
17
|
+
},
|
|
8
18
|
{
|
|
9
19
|
"name": "design",
|
|
10
20
|
"description": "Defines the component design.",
|
|
@@ -26,16 +36,6 @@
|
|
|
26
36
|
"name": "state",
|
|
27
37
|
"description": "Defines the current state of the component.",
|
|
28
38
|
"values": []
|
|
29
|
-
},
|
|
30
|
-
{
|
|
31
|
-
"name": "arrow-button-pressed",
|
|
32
|
-
"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.",
|
|
33
|
-
"values": []
|
|
34
|
-
},
|
|
35
|
-
{
|
|
36
|
-
"name": "accessibility-attributes",
|
|
37
|
-
"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`.",
|
|
38
|
-
"values": [{ "name": "AIButtonAccessibilityAttributes" }]
|
|
39
39
|
}
|
|
40
40
|
],
|
|
41
41
|
"references": []
|
|
@@ -45,13 +45,8 @@
|
|
|
45
45
|
"description": "### Overview\n\n`ui5-ai-button-state` is the item to use for defining states of `ui5-ai-button` components.\n\n### Usage\n\n`ui5-ai-button-state` is an abstract element, representing a state of `ui5-ai-button`. It is meant to be used in the `default` slot\nof `ui5-ai-button` and should not be used as standalone component.\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents/dist/AiButtonState.js\";`\n\n\n---\n\n\n",
|
|
46
46
|
"attributes": [
|
|
47
47
|
{
|
|
48
|
-
"name": "
|
|
49
|
-
"description": "Defines the
|
|
50
|
-
"values": []
|
|
51
|
-
},
|
|
52
|
-
{
|
|
53
|
-
"name": "text",
|
|
54
|
-
"description": "Defines the text of the button in this state.",
|
|
48
|
+
"name": "end-icon",
|
|
49
|
+
"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).",
|
|
55
50
|
"values": []
|
|
56
51
|
},
|
|
57
52
|
{
|
|
@@ -60,14 +55,19 @@
|
|
|
60
55
|
"values": []
|
|
61
56
|
},
|
|
62
57
|
{
|
|
63
|
-
"name": "
|
|
64
|
-
"description": "Defines the
|
|
58
|
+
"name": "name",
|
|
59
|
+
"description": "Defines the name of the button state.",
|
|
65
60
|
"values": []
|
|
66
61
|
},
|
|
67
62
|
{
|
|
68
63
|
"name": "show-arrow-button",
|
|
69
64
|
"description": "Defines if the component is in split button mode.",
|
|
70
65
|
"values": []
|
|
66
|
+
},
|
|
67
|
+
{
|
|
68
|
+
"name": "text",
|
|
69
|
+
"description": "Defines the text of the button in this state.",
|
|
70
|
+
"values": []
|
|
71
71
|
}
|
|
72
72
|
],
|
|
73
73
|
"references": []
|
|
@@ -82,13 +82,13 @@
|
|
|
82
82
|
"values": []
|
|
83
83
|
},
|
|
84
84
|
{
|
|
85
|
-
"name": "
|
|
86
|
-
"description": "
|
|
85
|
+
"name": "loading",
|
|
86
|
+
"description": "Defines whether the AI Writing Assistant is currently loading.\n\nWhen `true`, indicates that an AI action is in progress.",
|
|
87
87
|
"values": []
|
|
88
88
|
},
|
|
89
89
|
{
|
|
90
|
-
"name": "
|
|
91
|
-
"description": "
|
|
90
|
+
"name": "total-versions",
|
|
91
|
+
"description": "Indicates the total number of result versions available.\n\nWhen not set or set to 0, the versioning will be hidden.",
|
|
92
92
|
"values": []
|
|
93
93
|
}
|
|
94
94
|
],
|
|
@@ -96,11 +96,21 @@
|
|
|
96
96
|
},
|
|
97
97
|
{
|
|
98
98
|
"name": "ui5-ai-prompt-input",
|
|
99
|
-
"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\"`\n\n\n---\n\n\n\n\n### **Events:**\n - **
|
|
99
|
+
"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\"`\n\n\n---\n\n\n\n\n### **Events:**\n - **change** - Fired when the input operation has finished by pressing Enter\nor on focusout.\n- **input** - Fired when the value of the component changes at each keystroke,\nand when a suggestion item has been selected.\n- **submit** - Fired when the input operation has finished by pressing Enter\nor AI button is clicked.\n\n### **Slots:**\n - **default** - 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.\n- **valueStateMessage** - 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.",
|
|
100
100
|
"attributes": [
|
|
101
101
|
{
|
|
102
|
-
"name": "
|
|
103
|
-
"description": "Defines the
|
|
102
|
+
"name": "disabled",
|
|
103
|
+
"description": "Defines whether the component is in disabled state.\n\n**Note:** A disabled component is completely noninteractive.",
|
|
104
|
+
"values": []
|
|
105
|
+
},
|
|
106
|
+
{
|
|
107
|
+
"name": "label",
|
|
108
|
+
"description": "Defines the label of the input field.",
|
|
109
|
+
"values": []
|
|
110
|
+
},
|
|
111
|
+
{
|
|
112
|
+
"name": "maxlength",
|
|
113
|
+
"description": "Sets the maximum number of characters available in the input field.",
|
|
104
114
|
"values": []
|
|
105
115
|
},
|
|
106
116
|
{
|
|
@@ -109,8 +119,8 @@
|
|
|
109
119
|
"values": []
|
|
110
120
|
},
|
|
111
121
|
{
|
|
112
|
-
"name": "
|
|
113
|
-
"description": "Defines the
|
|
122
|
+
"name": "readonly",
|
|
123
|
+
"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.",
|
|
114
124
|
"values": []
|
|
115
125
|
},
|
|
116
126
|
{
|
|
@@ -124,18 +134,13 @@
|
|
|
124
134
|
"values": []
|
|
125
135
|
},
|
|
126
136
|
{
|
|
127
|
-
"name": "
|
|
128
|
-
"description": "Defines whether the component
|
|
129
|
-
"values": []
|
|
130
|
-
},
|
|
131
|
-
{
|
|
132
|
-
"name": "readonly",
|
|
133
|
-
"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.",
|
|
137
|
+
"name": "show-suggestions",
|
|
138
|
+
"description": "Defines whether the component should show suggestions, if such are present.",
|
|
134
139
|
"values": []
|
|
135
140
|
},
|
|
136
141
|
{
|
|
137
|
-
"name": "
|
|
138
|
-
"description": "
|
|
142
|
+
"name": "value",
|
|
143
|
+
"description": "Defines the value of the component.",
|
|
139
144
|
"values": []
|
|
140
145
|
},
|
|
141
146
|
{
|
|
@@ -148,19 +153,19 @@
|
|
|
148
153
|
{ "name": "Critical" },
|
|
149
154
|
{ "name": "Information" }
|
|
150
155
|
]
|
|
151
|
-
},
|
|
152
|
-
{
|
|
153
|
-
"name": "show-suggestions",
|
|
154
|
-
"description": "Defines whether the component should show suggestions, if such are present.",
|
|
155
|
-
"values": []
|
|
156
156
|
}
|
|
157
157
|
],
|
|
158
158
|
"references": []
|
|
159
159
|
},
|
|
160
160
|
{
|
|
161
161
|
"name": "ui5-ai-textarea",
|
|
162
|
-
"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\";`\n\n\n---\n\n\n\n\n### **Events:**\n - **
|
|
162
|
+
"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\";`\n\n\n---\n\n\n\n\n### **Events:**\n - **stop-generation** - Fired when the user requests to stop AI text generation.\n- **version-change** - Fired when the user clicks on version navigation buttons.\n\n### **Slots:**\n - **menu** - Defines a slot for `ui5-menu` integration. This slot allows you to pass a `ui5-menu` instance that will be associated with the assistant.",
|
|
163
163
|
"attributes": [
|
|
164
|
+
{
|
|
165
|
+
"name": "current-version",
|
|
166
|
+
"description": "Indicates the index of the currently displayed version.",
|
|
167
|
+
"values": []
|
|
168
|
+
},
|
|
164
169
|
{
|
|
165
170
|
"name": "loading",
|
|
166
171
|
"description": "Defines whether the `ui5-ai-textarea` is currently in a loading(processing) state.",
|
|
@@ -171,14 +176,60 @@
|
|
|
171
176
|
"description": "Defines the prompt description of the current action.",
|
|
172
177
|
"values": []
|
|
173
178
|
},
|
|
179
|
+
{
|
|
180
|
+
"name": "total-versions",
|
|
181
|
+
"description": "Indicates the total number of result versions available.\n\nNotes:\nVersioning is hidden if the value is `0`",
|
|
182
|
+
"values": []
|
|
183
|
+
}
|
|
184
|
+
],
|
|
185
|
+
"references": []
|
|
186
|
+
},
|
|
187
|
+
{
|
|
188
|
+
"name": "ui5-ai-toolbar-label",
|
|
189
|
+
"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\";`\n\n\n---\n\n\n",
|
|
190
|
+
"attributes": [
|
|
191
|
+
{
|
|
192
|
+
"name": "text",
|
|
193
|
+
"description": "Defines the text of the label.",
|
|
194
|
+
"values": []
|
|
195
|
+
}
|
|
196
|
+
],
|
|
197
|
+
"references": []
|
|
198
|
+
},
|
|
199
|
+
{
|
|
200
|
+
"name": "ui5-ai-versioning",
|
|
201
|
+
"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\";`\n\n\n---\n\n\n\n\n### **Events:**\n - **version-change** - Fired when the user clicks on version navigation buttons.",
|
|
202
|
+
"attributes": [
|
|
203
|
+
{
|
|
204
|
+
"name": "current-step",
|
|
205
|
+
"description": "Indicates the index of the currently displayed result version.\n\nThis property represents the current position in the version history.",
|
|
206
|
+
"values": []
|
|
207
|
+
},
|
|
208
|
+
{
|
|
209
|
+
"name": "total-steps",
|
|
210
|
+
"description": "The total number of available result versions.\n\nNote: Versioning is hidden if the value is `0`.",
|
|
211
|
+
"values": []
|
|
212
|
+
}
|
|
213
|
+
],
|
|
214
|
+
"references": []
|
|
215
|
+
},
|
|
216
|
+
{
|
|
217
|
+
"name": "ui5-ai-writing-assistant",
|
|
218
|
+
"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\";`\n\n\n---\n\n\n\n\n### **Events:**\n - **button-click** - Fired when the user clicks on the AI button.\n- **stop-generation** - Fired when the user clicks on the \"Stop\" button to stop ongoing AI text generation.\n- **version-change** - Fired when the user clicks on version navigation buttons.\n\n### **Methods:**\n - **handleButtonClick(): _void_** - Handles the click event for the AI generate button.\nToggles between generate and stop states based on current button state.",
|
|
219
|
+
"attributes": [
|
|
174
220
|
{
|
|
175
221
|
"name": "current-version",
|
|
176
|
-
"description": "Indicates the index of the currently displayed version.",
|
|
222
|
+
"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.",
|
|
223
|
+
"values": []
|
|
224
|
+
},
|
|
225
|
+
{
|
|
226
|
+
"name": "prompt-description",
|
|
227
|
+
"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\").",
|
|
177
228
|
"values": []
|
|
178
229
|
},
|
|
179
230
|
{
|
|
180
231
|
"name": "total-versions",
|
|
181
|
-
"description": "Indicates the total number of result versions available.\n\
|
|
232
|
+
"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.",
|
|
182
233
|
"values": []
|
|
183
234
|
}
|
|
184
235
|
],
|