Skip to content

Commit 610d03a

Browse files
authored
docs: ai package supports Horizon theme only (#12845)
* docs: ai package supports Horizon theme only * chore: update * chore: update
1 parent 17b5276 commit 610d03a

File tree

6 files changed

+9
-5
lines changed

6 files changed

+9
-5
lines changed

packages/ai/README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@
55
Provides web components implementing AI-related visual and interaction.
66

77

8-
**Note:** The package is available since 2.0 and experimental
9-
8+
**Note:** The package is available since 2.0. It's under active development and considered experimental. Component APIs are subject to change. Furthermore, the package supports **Horizon** themes only.
109

1110
## Provided components
1211

@@ -23,7 +22,7 @@ Provides web components implementing AI-related visual and interaction.
2322

2423
| Assets | Module | Notes
2524
|------------|-----------|-----------
26-
| `i18n`, `themes` | `@ui5/webcomponents-ai/dist/Assets.js` | Theming parameters and translations for the components
25+
| `i18n`, `themes` | `@ui5/webcomponents-ai/dist/Assets.js` | Theming parameters (Horizon themes only) and translations for the components
2726

2827

2928
## Resources

packages/ai/src/Button.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,8 @@ type AIButtonAccessibilityAttributes = { root?: AIButtonRootAccessibilityAttribu
5757
* @extends UI5Element
5858
* @since 2.0.0
5959
* @public
60-
* @experimental The Button and ButtonState web components are availabe since 2.0 under an experimental flag and their API and behaviour are subject to change.
60+
* @experimental The **@ui5/webcomponents-ai** package (including Button and ButtonState) is under active development and considered experimental. Component APIs are subject to change.
61+
* Furthermore, the package supports **Horizon** themes only.
6162
*/
6263

6364
@customElement({

packages/ai/src/ButtonState.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ import property from "@ui5/webcomponents-base/dist/decorators/property.js";
2222
* @abstract
2323
* @since 2.0.0
2424
* @public
25-
* @experimental The Button and ButtonState web components are available since 2.0 under an experimental flag and their API and behaviour are subject to change.
25+
* @experimental The **@ui5/webcomponents-ai** package (including ButtonState) is under active development and considered experimental. Component APIs are subject to change.
26+
* Furthermore, the package supports **Horizon** themes only.
2627
*/
2728
@customElement("ui5-ai-button-state")
2829
class ButtonState extends UI5Element {

packages/ai/src/Input.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ type InputVersionChangeEventDetail = {
6262
* @extends BaseInput
6363
* @since 2.16.0
6464
* @experimental The **@ui5/webcomponents-ai** package is under active development and considered experimental. Component APIs are subject to change.
65+
* Furthermore, the package supports **Horizon** themes only.
6566
* @public
6667
*/
6768
@customElement({

packages/ai/src/PromptInput.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ import type { UI5CustomEvent } from "@ui5/webcomponents-base/dist/index.js";
3939
* @public
4040
* @extends UI5Element
4141
* @experimental The **@ui5/webcomponents-ai** package is under development and considered experimental - components' APIs are subject to change.
42+
* Furthermore, the package supports **Horizon** themes only.
4243
*/
4344
@customElement({
4445
tag: "ui5-ai-prompt-input",

packages/ai/src/TextArea.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ type TextAreaVersionChangeEventDetail = {
4444
* @constructor
4545
* @extends BaseTextArea
4646
* @experimental The **@ui5/webcomponents-ai** package is under development and considered experimental - components' APIs are subject to change.
47+
* Furthermore, the package supports **Horizon** themes only.
4748
* @since 2.16.0
4849
* @public
4950
* @slot {HTMLElement} 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.

0 commit comments

Comments
 (0)