{ "schemaVersion": "1.0.0", "readme": "", "modules": [ { "kind": "javascript-module", "path": "dist/Assets-fetch.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "dist/Assets-node.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "dist/Assets.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "dist/Button.js", "declarations": [ { "kind": "class", "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\";`", "name": "Button", "slots": [ { "name": "default", "description": "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.", "_ui5propertyName": "states", "_ui5type": { "text": "Array", "references": [ { "name": "ButtonState", "package": "@ui5/webcomponents-ai", "module": "dist/ButtonState.js" } ] }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "accessibilityAttributes", "type": { "text": "AIButtonAccessibilityAttributes", "references": [ { "name": "AIButtonAccessibilityAttributes", "package": "@ui5/webcomponents-ai", "module": "dist/Button.js" } ] }, "default": "{}", "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`.", "privacy": "public", "_ui5since": "2.6.0" }, { "kind": "field", "name": "arrowButtonPressed", "type": { "text": "boolean" }, "default": "false", "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.", "privacy": "public", "_ui5since": "2.6.0", "_ui5noAttribute": true }, { "kind": "field", "name": "design", "type": { "text": "ButtonDesign | undefined", "references": [ { "name": "ButtonDesign", "package": "@ui5/webcomponents", "module": "dist/types/ButtonDesign.js" } ] }, "default": "\"Default\"", "description": "Defines the component design.", "privacy": "public" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Defines whether the component is disabled.\nA disabled component can't be pressed or\nfocused, and it is not in the tab chain.", "privacy": "public" }, { "kind": "field", "name": "state", "type": { "text": "string | undefined" }, "description": "Defines the current state of the component.", "default": "undefined", "privacy": "public" } ], "events": [ { "name": "arrow-button-click", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "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.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true }, { "name": "click", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the component is activated either with a\nmouse/tap or by using the Enter or Space key.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true } ], "attributes": [ { "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`.", "name": "accessibility-attributes", "default": "{}", "fieldName": "accessibilityAttributes", "type": { "text": "AIButtonAccessibilityAttributes" } }, { "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.", "name": "arrow-button-pressed", "default": "false", "fieldName": "arrowButtonPressed", "type": { "text": "boolean" } }, { "description": "Defines the component design.", "name": "design", "default": "\"Default\"", "fieldName": "design", "type": { "text": "\"Default\" | \"Positive\" | \"Negative\" | \"Transparent\" | \"Emphasized\" | \"Attention\" | undefined" } }, { "description": "Defines whether the component is disabled.\nA disabled component can't be pressed or\nfocused, and it is not in the tab chain.", "name": "disabled", "default": "false", "fieldName": "disabled", "type": { "text": "boolean" } }, { "description": "Defines the current state of the component.", "name": "state", "default": "undefined", "fieldName": "state", "type": { "text": "string | undefined" } } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-ai-button", "customElement": true, "_ui5experimental": "The **@ui5/webcomponents-ai** package (including Button and ButtonState) is under active development and considered experimental. Component APIs are subject to change.\nFurthermore, the package supports **Horizon** themes only.", "_ui5since": "2.0.0", "_ui5privacy": "public" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "Button", "module": "dist/Button.js" } }, { "kind": "custom-element-definition", "name": "ui5-ai-button", "declaration": { "name": "Button", "module": "dist/Button.js" } } ] }, { "kind": "javascript-module", "path": "dist/ButtonState.js", "declarations": [ { "kind": "class", "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\";`", "name": "ButtonState", "members": [ { "kind": "field", "name": "endIcon", "type": { "text": "string | undefined" }, "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).", "default": "undefined", "privacy": "public" }, { "kind": "field", "name": "icon", "type": { "text": "string | undefined" }, "description": "Defines the icon to be displayed as graphical element within the component before 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).", "default": "undefined", "privacy": "public" }, { "kind": "field", "name": "name", "type": { "text": "string | undefined" }, "description": "Defines the name of the button state.", "default": "undefined", "privacy": "public" }, { "kind": "field", "name": "showArrowButton", "type": { "text": "boolean" }, "default": "false", "description": "Defines if the component is in split button mode.", "privacy": "public", "_ui5since": "2.6.0" }, { "kind": "field", "name": "text", "type": { "text": "string | undefined" }, "description": "Defines the text of the button in this state.", "default": "undefined", "privacy": "public" } ], "attributes": [ { "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).", "name": "end-icon", "default": "undefined", "fieldName": "endIcon", "type": { "text": "string | undefined" } }, { "description": "Defines the icon to be displayed as graphical element within the component before 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).", "name": "icon", "default": "undefined", "fieldName": "icon", "type": { "text": "string | undefined" } }, { "description": "Defines the name of the button state.", "name": "name", "default": "undefined", "fieldName": "name", "type": { "text": "string | undefined" } }, { "description": "Defines if the component is in split button mode.", "name": "show-arrow-button", "default": "false", "fieldName": "showArrowButton", "type": { "text": "boolean" } }, { "description": "Defines the text of the button in this state.", "name": "text", "default": "undefined", "fieldName": "text", "type": { "text": "string | undefined" } } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-ai-button-state", "customElement": true, "_ui5experimental": "The **@ui5/webcomponents-ai** package (including ButtonState) is under active development and considered experimental. Component APIs are subject to change.\nFurthermore, the package supports **Horizon** themes only.", "_ui5since": "2.0.0", "_ui5privacy": "public", "_ui5abstract": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "ButtonState", "module": "dist/ButtonState.js" } }, { "kind": "custom-element-definition", "name": "ui5-ai-button-state", "declaration": { "name": "ButtonState", "module": "dist/ButtonState.js" } } ] }, { "kind": "javascript-module", "path": "dist/Input.js", "declarations": [ { "kind": "class", "description": "### Overview\n\nThe `ui5-ai-input` component extends the standard `ui5-input` with **AI Writing Assistant** capabilities.\n\n### Structure\n\nThe `ui5-ai-input` consists of the following main parts:\n\n- **Input Field** – Inherits all standard Input behaviors.\n- **AI Action Button** – Appears when focused or loading, providing access to AI-related actions or stopping generation.\n\nThe component automatically determines which elements to render based on its internal state:\n- The AI Button is only shown when there are available `actions`.\n- The version navigation appears only when `totalVersions > 1`.\n\n### Keyboard Support\n\n- **Shift + F4** — Opens the AI menu.\n- **Ctrl + Shift + Z / Y** — Navigates backward/forward between AI-generated versions.\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-ai/dist/Input.js\";`", "name": "Input", "slots": [ { "name": "actions", "description": "Defines the items of the menu for the component.", "_ui5type": { "text": "Array" }, "_ui5privacy": "public" }, { "name": "default", "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 ``, `` and `ui5-suggestion-item-custom` are recommended to be used as suggestion items.", "_ui5propertyName": "suggestionItems", "_ui5type": { "text": "Array", "references": [ { "name": "IInputSuggestionItem", "package": "@ui5/webcomponents", "module": "dist/Input.js" } ] }, "_ui5privacy": "public" }, { "name": "icon", "description": "Defines the icon to be displayed in the component.", "_ui5type": { "text": "Array", "references": [ { "name": "IIcon", "package": "@ui5/webcomponents", "module": "dist/Icon.js" } ] }, "_ui5privacy": "public" }, { "name": "valueStateMessage", "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.", "_ui5since": "1.0.0-rc.6", "_ui5type": { "text": "Array" }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "currentVersion", "type": { "text": "number" }, "default": "0", "description": "Indicates the index of the currently displayed version.", "privacy": "public" }, { "kind": "field", "name": "loading", "type": { "text": "boolean" }, "default": "false", "description": "Defines whether the AI Writing Assistant is currently loading.\n\nWhen `true`, indicates that an AI action is in progress.", "privacy": "public" }, { "kind": "field", "name": "totalVersions", "type": { "text": "number" }, "default": "0", "description": "Indicates the total number of result versions available.\n\nWhen not set or set to 0, the versioning will be hidden.", "privacy": "public" }, { "kind": "field", "name": "accessibleDescription", "type": { "text": "string | undefined" }, "description": "Defines the accessible description of the component.", "default": "undefined", "privacy": "public", "_ui5since": "2.9.0" }, { "kind": "field", "name": "accessibleDescriptionRef", "type": { "text": "string | undefined" }, "description": "Receives id(or many ids) of the elements that describe the input.", "default": "undefined", "privacy": "public", "_ui5since": "2.9.0" }, { "kind": "field", "name": "accessibleName", "type": { "text": "string | undefined" }, "description": "Defines the accessible ARIA name of the component.", "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15" }, { "kind": "field", "name": "accessibleNameRef", "type": { "text": "string | undefined" }, "description": "Receives id(or many ids) of the elements that label the input.", "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Defines whether the component is in disabled state.\n\n**Note:** A disabled component is completely noninteractive.", "privacy": "public" }, { "kind": "field", "name": "filter", "type": { "text": "InputSuggestionsFilter", "references": [ { "name": "InputSuggestionsFilter", "package": "@ui5/webcomponents", "module": "dist/types/InputSuggestionsFilter.js" } ] }, "description": "Defines the filter type of the component.", "default": "\"None\"", "privacy": "public", "_ui5since": "2.19.0" }, { "kind": "field", "name": "maxlength", "type": { "text": "number | undefined" }, "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.", "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.5" }, { "kind": "field", "name": "name", "type": { "text": "string | undefined" }, "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.", "default": "undefined", "privacy": "public" }, { "kind": "field", "name": "noTypeahead", "type": { "text": "boolean" }, "default": "false", "description": "Defines whether the value will be autcompleted to match an item", "privacy": "public", "_ui5since": "1.4.0" }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "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.", "privacy": "public", "_ui5since": "2.0.0" }, { "kind": "field", "name": "placeholder", "type": { "text": "string | undefined" }, "description": "Defines a short hint intended to aid the user with data entry when the\ncomponent has no value.", "default": "undefined", "privacy": "public" }, { "kind": "field", "name": "readonly", "type": { "text": "boolean" }, "default": "false", "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.", "privacy": "public" }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Defines whether the component is required.", "privacy": "public", "_ui5since": "1.0.0-rc.3" }, { "kind": "field", "name": "showClearIcon", "type": { "text": "boolean" }, "default": "false", "description": "Defines whether the clear icon of the input will be shown.", "privacy": "public", "_ui5since": "1.2.0" }, { "kind": "field", "name": "showSuggestions", "type": { "text": "boolean" }, "default": "false", "description": "Defines whether the component should show suggestions, if such are present.", "privacy": "public" }, { "kind": "field", "name": "type", "type": { "text": "InputType", "references": [ { "name": "InputType", "package": "@ui5/webcomponents", "module": "dist/types/InputType.js" } ] }, "default": "\"Text\"", "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.", "privacy": "public" }, { "kind": "field", "name": "value", "type": { "text": "string" }, "default": "\"\"", "description": "Defines the value of the component.\n\n**Note:** The property is updated upon typing.", "privacy": "public", "_ui5formProperty": true, "_ui5formEvents": "change,input" }, { "kind": "field", "name": "valueState", "type": { "text": "ValueState", "references": [ { "name": "ValueState", "package": "@ui5/webcomponents-base", "module": "dist/types/ValueState.js" } ] }, "default": "\"None\"", "description": "Defines the value state of the component.", "privacy": "public" } ], "events": [ { "name": "button-click", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the user selects the AI button.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": false }, { "name": "item-click", "_ui5privacy": "public", "type": { "text": "CustomEvent", "references": [ { "name": "InputItemClickEventDetail", "package": "@ui5/webcomponents-ai", "module": "dist/Input.js" } ] }, "description": "Fired when an item from the AI actions menu is clicked.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": false, "_ui5parameters": [ { "type": { "text": "HTMLElement" }, "name": "item", "_ui5privacy": "public", "description": "The currently clicked menu item." }, { "type": { "text": "string" }, "name": "text", "_ui5privacy": "public", "description": "The text of the currently clicked menu item." } ] }, { "name": "stop-generation", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the user selects the \"Stop\" button to stop ongoing AI text generation.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": false }, { "name": "version-change", "_ui5privacy": "public", "type": { "text": "CustomEvent", "references": [ { "name": "InputVersionChangeEventDetail", "package": "@ui5/webcomponents-ai", "module": "dist/Input.js" } ] }, "description": "Fired when the user selects the version navigation buttons.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": false, "_ui5parameters": [ { "type": { "text": "boolean" }, "name": "backwards", "_ui5privacy": "public", "description": "The text of the currently clicked menu item." } ] }, { "name": "change", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the input operation has finished by pressing Enter or on focusout.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true }, { "name": "close", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the suggestions picker is closed.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": false, "_ui5since": "2.0.0" }, { "name": "input", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the value of the component changes at each keystroke,\nand when a suggestion item has been selected.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": true }, { "name": "open", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the suggestions picker is open.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5since": "2.0.0" }, { "name": "select", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when some text has been selected.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5since": "2.0.0" }, { "name": "selection-change", "_ui5privacy": "public", "type": { "text": "CustomEvent", "references": [ { "name": "InputSelectionChangeEventDetail", "package": "@ui5/webcomponents", "module": "dist/Input.js" } ] }, "description": "Fired when the user navigates to a suggestion item via the ARROW keys,\nas a preview, before the final selection.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5since": "2.0.0", "_ui5parameters": [ { "type": { "text": "HTMLElement" }, "name": "item", "_ui5privacy": "public", "description": "The previewed suggestion item." } ] } ], "attributes": [ { "description": "Indicates the index of the currently displayed version.", "name": "current-version", "default": "0", "fieldName": "currentVersion", "type": { "text": "number" } }, { "description": "Defines whether the AI Writing Assistant is currently loading.\n\nWhen `true`, indicates that an AI action is in progress.", "name": "loading", "default": "false", "fieldName": "loading", "type": { "text": "boolean" } }, { "description": "Indicates the total number of result versions available.\n\nWhen not set or set to 0, the versioning will be hidden.", "name": "total-versions", "default": "0", "fieldName": "totalVersions", "type": { "text": "number" } }, { "description": "Defines the accessible description of the component.", "name": "accessible-description", "default": "undefined", "fieldName": "accessibleDescription", "type": { "text": "string | undefined" } }, { "description": "Receives id(or many ids) of the elements that describe the input.", "name": "accessible-description-ref", "default": "undefined", "fieldName": "accessibleDescriptionRef", "type": { "text": "string | undefined" } }, { "description": "Defines the accessible ARIA name of the component.", "name": "accessible-name", "default": "undefined", "fieldName": "accessibleName", "type": { "text": "string | undefined" } }, { "description": "Receives id(or many ids) of the elements that label the input.", "name": "accessible-name-ref", "default": "undefined", "fieldName": "accessibleNameRef", "type": { "text": "string | undefined" } }, { "description": "Defines whether the component is in disabled state.\n\n**Note:** A disabled component is completely noninteractive.", "name": "disabled", "default": "false", "fieldName": "disabled", "type": { "text": "boolean" } }, { "description": "Defines the filter type of the component.", "name": "filter", "default": "\"None\"", "fieldName": "filter", "type": { "text": "\"None\" | \"StartsWithPerTerm\" | \"StartsWith\" | \"Contains\"" } }, { "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.", "name": "maxlength", "default": "undefined", "fieldName": "maxlength", "type": { "text": "number | undefined" } }, { "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.", "name": "name", "default": "undefined", "fieldName": "name", "type": { "text": "string | undefined" } }, { "description": "Defines whether the value will be autcompleted to match an item", "name": "no-typeahead", "default": "false", "fieldName": "noTypeahead", "type": { "text": "boolean" } }, { "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.", "name": "open", "default": "false", "fieldName": "open", "type": { "text": "boolean" } }, { "description": "Defines a short hint intended to aid the user with data entry when the\ncomponent has no value.", "name": "placeholder", "default": "undefined", "fieldName": "placeholder", "type": { "text": "string | undefined" } }, { "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.", "name": "readonly", "default": "false", "fieldName": "readonly", "type": { "text": "boolean" } }, { "description": "Defines whether the component is required.", "name": "required", "default": "false", "fieldName": "required", "type": { "text": "boolean" } }, { "description": "Defines whether the clear icon of the input will be shown.", "name": "show-clear-icon", "default": "false", "fieldName": "showClearIcon", "type": { "text": "boolean" } }, { "description": "Defines whether the component should show suggestions, if such are present.", "name": "show-suggestions", "default": "false", "fieldName": "showSuggestions", "type": { "text": "boolean" } }, { "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.", "name": "type", "default": "\"Text\"", "fieldName": "type", "type": { "text": "\"Text\" | \"Email\" | \"Number\" | \"Password\" | \"Tel\" | \"URL\" | \"Search\"" } }, { "description": "Defines the value of the component.\n\n**Note:** The property is updated upon typing.", "name": "value", "default": "\"\"", "fieldName": "value", "type": { "text": "string" } }, { "description": "Defines the value state of the component.", "name": "value-state", "default": "\"None\"", "fieldName": "valueState", "type": { "text": "\"None\" | \"Positive\" | \"Critical\" | \"Negative\" | \"Information\"" } } ], "superclass": { "name": "Input", "package": "@ui5/webcomponents", "module": "dist/Input.js" }, "tagName": "ui5-ai-input", "customElement": true, "_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.", "_ui5since": "2.16.0", "_ui5privacy": "public", "cssParts": [ { "description": "Used to style the clear icon, which can be pressed to clear user input text", "name": "clear-icon" }, { "description": "Used to style the native input element", "name": "input" }, { "description": "Used to style the root DOM element of the Input component", "name": "root" } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "Input", "module": "dist/Input.js" } }, { "kind": "custom-element-definition", "name": "ui5-ai-input", "declaration": { "name": "Input", "module": "dist/Input.js" } } ] }, { "kind": "javascript-module", "path": "dist/PromptInput.js", "declarations": [ { "kind": "class", "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\"`", "name": "PromptInput", "slots": [ { "name": "default", "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 ``, `` and `ui5-suggestion-item-custom` are recommended to be used as suggestion items.", "_ui5propertyName": "suggestionItems", "_ui5type": { "text": "Array", "references": [ { "name": "IInputSuggestionItem", "package": "@ui5/webcomponents", "module": "dist/Input.js" } ] }, "_ui5privacy": "public" }, { "name": "valueStateMessage", "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.", "_ui5since": "2.0.0", "_ui5type": { "text": "Array" }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Defines whether the component is in disabled state.\n\n**Note:** A disabled component is completely noninteractive.", "privacy": "public", "_ui5since": "2.0.0" }, { "kind": "field", "name": "label", "type": { "text": "string | undefined" }, "description": "Defines the label of the input field.", "default": "undefined", "privacy": "public", "_ui5since": "2.0.0" }, { "kind": "field", "name": "maxlength", "type": { "text": "number | undefined" }, "description": "Sets the maximum number of characters available in the input field.", "default": "undefined", "privacy": "public", "_ui5since": "2.0.0" }, { "kind": "field", "name": "placeholder", "type": { "text": "string | undefined" }, "description": "Defines a short hint intended to aid the user with data entry when the\ncomponent has no value.", "default": "undefined", "privacy": "public", "_ui5since": "2.0.0" }, { "kind": "field", "name": "readonly", "type": { "text": "boolean" }, "default": "false", "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.", "privacy": "public", "_ui5since": "2.0.0" }, { "kind": "field", "name": "showClearIcon", "type": { "text": "boolean" }, "default": "false", "description": "Defines whether the clear icon of the input will be shown.", "privacy": "public", "_ui5since": "2.0.0" }, { "kind": "field", "name": "showExceededText", "type": { "text": "boolean" }, "default": "false", "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.", "privacy": "public", "_ui5since": "2.0.0" }, { "kind": "field", "name": "showSuggestions", "type": { "text": "boolean" }, "default": "false", "description": "Defines whether the component should show suggestions, if such are present.", "privacy": "public" }, { "kind": "field", "name": "value", "type": { "text": "string" }, "default": "\"\"", "description": "Defines the value of the component.", "privacy": "public", "_ui5since": "2.0.0" }, { "kind": "field", "name": "valueState", "type": { "text": "ValueState", "references": [ { "name": "ValueState", "package": "@ui5/webcomponents-base", "module": "dist/types/ValueState.js" } ] }, "default": "\"None\"", "description": "Defines the value state of the component.", "privacy": "public", "_ui5since": "2.0.0" } ], "events": [ { "name": "change", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the input operation has finished by pressing Enter\nor on focusout.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5since": "2.0.0" }, { "name": "input", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the value of the component changes at each keystroke,\nand when a suggestion item has been selected.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5since": "2.0.0" }, { "name": "submit", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the input operation has finished by pressing Enter\nor AI button is clicked.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5since": "2.0.0" } ], "attributes": [ { "description": "Defines whether the component is in disabled state.\n\n**Note:** A disabled component is completely noninteractive.", "name": "disabled", "default": "false", "fieldName": "disabled", "type": { "text": "boolean" } }, { "description": "Defines the label of the input field.", "name": "label", "default": "undefined", "fieldName": "label", "type": { "text": "string | undefined" } }, { "description": "Sets the maximum number of characters available in the input field.", "name": "maxlength", "default": "undefined", "fieldName": "maxlength", "type": { "text": "number | undefined" } }, { "description": "Defines a short hint intended to aid the user with data entry when the\ncomponent has no value.", "name": "placeholder", "default": "undefined", "fieldName": "placeholder", "type": { "text": "string | undefined" } }, { "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.", "name": "readonly", "default": "false", "fieldName": "readonly", "type": { "text": "boolean" } }, { "description": "Defines whether the clear icon of the input will be shown.", "name": "show-clear-icon", "default": "false", "fieldName": "showClearIcon", "type": { "text": "boolean" } }, { "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.", "name": "show-exceeded-text", "default": "false", "fieldName": "showExceededText", "type": { "text": "boolean" } }, { "description": "Defines whether the component should show suggestions, if such are present.", "name": "show-suggestions", "default": "false", "fieldName": "showSuggestions", "type": { "text": "boolean" } }, { "description": "Defines the value of the component.", "name": "value", "default": "\"\"", "fieldName": "value", "type": { "text": "string" } }, { "description": "Defines the value state of the component.", "name": "value-state", "default": "\"None\"", "fieldName": "valueState", "type": { "text": "\"Positive\" | \"Negative\" | \"None\" | \"Critical\" | \"Information\"" } } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-ai-prompt-input", "customElement": true, "_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.", "_ui5privacy": "public" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "PromptInput", "module": "dist/PromptInput.js" } }, { "kind": "custom-element-definition", "name": "ui5-ai-prompt-input", "declaration": { "name": "PromptInput", "module": "dist/PromptInput.js" } } ] }, { "kind": "javascript-module", "path": "dist/TextArea.js", "declarations": [ { "kind": "class", "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\";`", "name": "TextArea", "slots": [ { "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.", "name": "menu", "_ui5privacy": "public", "_ui5type": { "text": "HTMLElement" } }, { "name": "valueStateMessage", "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`.", "_ui5since": "1.0.0-rc.7", "_ui5type": { "text": "Array" }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "currentVersion", "type": { "text": "number" }, "default": "0", "description": "Indicates the index of the currently displayed version.", "privacy": "public" }, { "kind": "field", "name": "loading", "type": { "text": "boolean" }, "default": "false", "description": "Defines whether the `ui5-ai-textarea` is currently in a loading(processing) state.", "privacy": "public" }, { "kind": "field", "name": "promptDescription", "type": { "text": "string" }, "default": "\"\"", "description": "Defines the prompt description of the current action.", "privacy": "public" }, { "kind": "field", "name": "totalVersions", "type": { "text": "number" }, "default": "0", "description": "Indicates the total number of result versions available.\n\nNotes:\nVersioning is hidden if the value is `0`", "privacy": "public" }, { "kind": "field", "name": "accessibleDescription", "type": { "text": "string | undefined" }, "description": "Defines the accessible description of the component.", "default": "undefined", "privacy": "public", "_ui5since": "2.16.0" }, { "kind": "field", "name": "accessibleDescriptionRef", "type": { "text": "string | undefined" }, "description": "Receives id(or many ids) of the elements that describe the textarea.", "default": "undefined", "privacy": "public", "_ui5since": "2.16.0" }, { "kind": "field", "name": "accessibleName", "type": { "text": "string | undefined" }, "description": "Defines the accessible ARIA name of the component.", "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15" }, { "kind": "field", "name": "accessibleNameRef", "type": { "text": "string | undefined" }, "description": "Receives id(or many ids) of the elements that label the textarea.", "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the user can interact with the component or not.\n\n**Note:** A disabled component is completely noninteractive.", "privacy": "public" }, { "kind": "field", "name": "growing", "type": { "text": "boolean" }, "default": "false", "description": "Enables the component to automatically grow and shrink dynamically with its content.", "privacy": "public" }, { "kind": "field", "name": "growingMaxRows", "type": { "text": "number" }, "default": "0", "description": "Defines the maximum number of rows that the component can grow.", "privacy": "public" }, { "kind": "field", "name": "maxlength", "type": { "text": "number | undefined" }, "description": "Defines the maximum number of characters that the `value` can have.", "default": "undefined", "privacy": "public" }, { "kind": "field", "name": "name", "type": { "text": "string | undefined" }, "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.", "default": "undefined", "privacy": "public" }, { "kind": "field", "name": "placeholder", "type": { "text": "string | undefined" }, "description": "Defines a short hint intended to aid the user with data entry when the component has no value.", "default": "undefined", "privacy": "public" }, { "kind": "field", "name": "readonly", "type": { "text": "boolean" }, "default": "false", "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.", "privacy": "public" }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Defines whether the component is required.", "privacy": "public", "_ui5since": "1.0.0-rc.3" }, { "kind": "field", "name": "rows", "type": { "text": "number" }, "default": "0", "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.", "privacy": "public" }, { "kind": "field", "name": "showExceededText", "type": { "text": "boolean" }, "default": "false", "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.", "privacy": "public" }, { "kind": "field", "name": "value", "type": { "text": "string" }, "default": "\"\"", "description": "Defines the value of the component.", "privacy": "public", "_ui5formProperty": true, "_ui5formEvents": "change,input" }, { "kind": "field", "name": "valueState", "type": { "text": "ValueState", "references": [ { "name": "ValueState", "package": "@ui5/webcomponents-base", "module": "dist/types/ValueState.js" } ] }, "default": "\"None\"", "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.", "privacy": "public", "_ui5since": "1.0.0-rc.7" } ], "events": [ { "name": "stop-generation", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the user requests to stop AI text generation.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": false }, { "name": "version-change", "_ui5privacy": "public", "type": { "text": "CustomEvent", "references": [ { "name": "TextAreaVersionChangeEventDetail", "package": "@ui5/webcomponents-ai", "module": "dist/TextArea.js" } ] }, "description": "Fired when the user clicks on version navigation buttons.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": false, "_ui5parameters": [ { "type": { "text": "boolean" }, "name": "backwards", "_ui5privacy": "public", "description": "Indicates if navigation is backwards (true) or forwards (false, default)." } ] }, { "name": "change", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the text has changed and the focus leaves the component.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true }, { "name": "input", "_ui5privacy": "public", "type": { "text": "CustomEvent", "references": [ { "name": "TextAreaInputEventDetail", "package": "@ui5/webcomponents", "module": "dist/TextArea.js" } ] }, "description": "Fired when the value of the component changes at each keystroke or when\nsomething is pasted.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": true, "_ui5since": "1.0.0-rc.5", "_ui5parameters": [ { "type": { "text": "boolean" }, "name": "escapePressed", "_ui5privacy": "public", "description": "Indicates whether the Escape key was pressed, which triggers a revert to the previous value" } ] }, { "name": "scroll", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when textarea is scrolled.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5since": "1.23.0" }, { "name": "select", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when some text has been selected.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5since": "1.23.0" } ], "attributes": [ { "description": "Indicates the index of the currently displayed version.", "name": "current-version", "default": "0", "fieldName": "currentVersion", "type": { "text": "number" } }, { "description": "Defines whether the `ui5-ai-textarea` is currently in a loading(processing) state.", "name": "loading", "default": "false", "fieldName": "loading", "type": { "text": "boolean" } }, { "description": "Defines the prompt description of the current action.", "name": "prompt-description", "default": "\"\"", "fieldName": "promptDescription", "type": { "text": "string" } }, { "description": "Indicates the total number of result versions available.\n\nNotes:\nVersioning is hidden if the value is `0`", "name": "total-versions", "default": "0", "fieldName": "totalVersions", "type": { "text": "number" } }, { "description": "Defines the accessible description of the component.", "name": "accessible-description", "default": "undefined", "fieldName": "accessibleDescription", "type": { "text": "string | undefined" } }, { "description": "Receives id(or many ids) of the elements that describe the textarea.", "name": "accessible-description-ref", "default": "undefined", "fieldName": "accessibleDescriptionRef", "type": { "text": "string | undefined" } }, { "description": "Defines the accessible ARIA name of the component.", "name": "accessible-name", "default": "undefined", "fieldName": "accessibleName", "type": { "text": "string | undefined" } }, { "description": "Receives id(or many ids) of the elements that label the textarea.", "name": "accessible-name-ref", "default": "undefined", "fieldName": "accessibleNameRef", "type": { "text": "string | undefined" } }, { "description": "Indicates whether the user can interact with the component or not.\n\n**Note:** A disabled component is completely noninteractive.", "name": "disabled", "default": "false", "fieldName": "disabled", "type": { "text": "boolean" } }, { "description": "Enables the component to automatically grow and shrink dynamically with its content.", "name": "growing", "default": "false", "fieldName": "growing", "type": { "text": "boolean" } }, { "description": "Defines the maximum number of rows that the component can grow.", "name": "growing-max-rows", "default": "0", "fieldName": "growingMaxRows", "type": { "text": "number" } }, { "description": "Defines the maximum number of characters that the `value` can have.", "name": "maxlength", "default": "undefined", "fieldName": "maxlength", "type": { "text": "number | undefined" } }, { "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.", "name": "name", "default": "undefined", "fieldName": "name", "type": { "text": "string | undefined" } }, { "description": "Defines a short hint intended to aid the user with data entry when the component has no value.", "name": "placeholder", "default": "undefined", "fieldName": "placeholder", "type": { "text": "string | undefined" } }, { "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.", "name": "readonly", "default": "false", "fieldName": "readonly", "type": { "text": "boolean" } }, { "description": "Defines whether the component is required.", "name": "required", "default": "false", "fieldName": "required", "type": { "text": "boolean" } }, { "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.", "name": "rows", "default": "0", "fieldName": "rows", "type": { "text": "number" } }, { "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.", "name": "show-exceeded-text", "default": "false", "fieldName": "showExceededText", "type": { "text": "boolean" } }, { "description": "Defines the value of the component.", "name": "value", "default": "\"\"", "fieldName": "value", "type": { "text": "string" } }, { "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.", "name": "value-state", "default": "\"None\"", "fieldName": "valueState", "type": { "text": "\"None\" | \"Positive\" | \"Critical\" | \"Negative\" | \"Information\"" } } ], "superclass": { "name": "TextArea", "package": "@ui5/webcomponents", "module": "dist/TextArea.js" }, "tagName": "ui5-ai-textarea", "customElement": true, "_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.", "_ui5since": "2.16.0", "_ui5privacy": "public", "cssParts": [ { "description": "Used to style the native textarea", "name": "textarea" } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "TextArea", "module": "dist/TextArea.js" } }, { "kind": "custom-element-definition", "name": "ui5-ai-textarea", "declaration": { "name": "TextArea", "module": "dist/TextArea.js" } } ] }, { "kind": "javascript-module", "path": "dist/ToolbarLabel.js", "declarations": [ { "kind": "class", "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\";`", "name": "ToolbarLabel", "members": [ { "kind": "field", "name": "text", "type": { "text": "string" }, "default": "\"\"", "description": "Defines the text of the label.", "privacy": "public" }, { "kind": "field", "name": "overflowPriority", "type": { "text": "ToolbarItemOverflowBehavior", "references": [ { "name": "ToolbarItemOverflowBehavior", "package": "@ui5/webcomponents", "module": "dist/types/ToolbarItemOverflowBehavior.js" } ] }, "default": "\"Default\"", "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.", "privacy": "public" }, { "kind": "field", "name": "preventOverflowClosing", "type": { "text": "boolean" }, "default": "false", "description": "Defines if the toolbar overflow popup should close upon interaction with the item.\nIt will close by default.", "privacy": "public" } ], "attributes": [ { "description": "Defines the text of the label.", "name": "text", "default": "\"\"", "fieldName": "text", "type": { "text": "string" } }, { "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.", "name": "overflow-priority", "default": "\"Default\"", "fieldName": "overflowPriority", "type": { "text": "\"Default\" | \"NeverOverflow\" | \"AlwaysOverflow\"" } }, { "description": "Defines if the toolbar overflow popup should close upon interaction with the item.\nIt will close by default.", "name": "prevent-overflow-closing", "default": "false", "fieldName": "preventOverflowClosing", "type": { "text": "boolean" } } ], "superclass": { "name": "ToolbarItem", "package": "@ui5/webcomponents", "module": "dist/ToolbarItem.js" }, "tagName": "ui5-ai-toolbar-label", "customElement": true, "_ui5since": "1.0.0-rc.1", "_ui5privacy": "private", "slots": [ { "name": "default", "description": "Wrapped component slot.", "_ui5since": "2.20.0", "_ui5propertyName": "item", "_ui5type": { "text": "Array", "references": [ { "name": "IToolbarItemContent", "package": "@ui5/webcomponents", "module": "dist/ToolbarItem.js" } ] }, "_ui5privacy": "public" } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "ToolbarLabel", "module": "dist/ToolbarLabel.js" } }, { "kind": "custom-element-definition", "name": "ui5-ai-toolbar-label", "declaration": { "name": "ToolbarLabel", "module": "dist/ToolbarLabel.js" } } ] }, { "kind": "javascript-module", "path": "dist/Versioning.js", "declarations": [ { "kind": "class", "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\";`", "name": "Versioning", "members": [ { "kind": "field", "name": "currentStep", "type": { "text": "number" }, "default": "0", "description": "Indicates the index of the currently displayed result version.\n\nThis property represents the current position in the version history.", "privacy": "public" }, { "kind": "field", "name": "totalSteps", "type": { "text": "number" }, "default": "0", "description": "The total number of available result versions.\n\nNote: Versioning is hidden if the value is `0`.", "privacy": "public" }, { "kind": "field", "name": "overflowPriority", "type": { "text": "ToolbarItemOverflowBehavior", "references": [ { "name": "ToolbarItemOverflowBehavior", "package": "@ui5/webcomponents", "module": "dist/types/ToolbarItemOverflowBehavior.js" } ] }, "default": "\"Default\"", "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.", "privacy": "public" }, { "kind": "field", "name": "preventOverflowClosing", "type": { "text": "boolean" }, "default": "false", "description": "Defines if the toolbar overflow popup should close upon interaction with the item.\nIt will close by default.", "privacy": "public" } ], "events": [ { "name": "version-change", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the user clicks on version navigation buttons.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": false } ], "attributes": [ { "description": "Indicates the index of the currently displayed result version.\n\nThis property represents the current position in the version history.", "name": "current-step", "default": "0", "fieldName": "currentStep", "type": { "text": "number" } }, { "description": "The total number of available result versions.\n\nNote: Versioning is hidden if the value is `0`.", "name": "total-steps", "default": "0", "fieldName": "totalSteps", "type": { "text": "number" } }, { "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.", "name": "overflow-priority", "default": "\"Default\"", "fieldName": "overflowPriority", "type": { "text": "\"Default\" | \"NeverOverflow\" | \"AlwaysOverflow\"" } }, { "description": "Defines if the toolbar overflow popup should close upon interaction with the item.\nIt will close by default.", "name": "prevent-overflow-closing", "default": "false", "fieldName": "preventOverflowClosing", "type": { "text": "boolean" } } ], "superclass": { "name": "ToolbarItem", "package": "@ui5/webcomponents", "module": "dist/ToolbarItem.js" }, "tagName": "ui5-ai-versioning", "customElement": true, "_ui5since": "2.16.0", "_ui5privacy": "private", "slots": [ { "name": "default", "description": "Wrapped component slot.", "_ui5since": "2.20.0", "_ui5propertyName": "item", "_ui5type": { "text": "Array", "references": [ { "name": "IToolbarItemContent", "package": "@ui5/webcomponents", "module": "dist/ToolbarItem.js" } ] }, "_ui5privacy": "public" } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "Versioning", "module": "dist/Versioning.js" } }, { "kind": "custom-element-definition", "name": "ui5-ai-versioning", "declaration": { "name": "Versioning", "module": "dist/Versioning.js" } } ] }, { "kind": "javascript-module", "path": "dist/WritingAssistant.js", "declarations": [ { "kind": "class", "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\";`", "name": "WritingAssistant", "members": [ { "kind": "field", "name": "currentVersion", "type": { "text": "number" }, "default": "0", "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.", "privacy": "public", "_ui5since": "2.16.0" }, { "kind": "method", "name": "handleButtonClick", "return": { "type": { "text": "void" } }, "description": "Handles the click event for the AI generate button.\nToggles between generate and stop states based on current button state.", "privacy": "public" }, { "kind": "field", "name": "promptDescription", "type": { "text": "string" }, "default": "\"\"", "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\").", "privacy": "public" }, { "kind": "field", "name": "totalVersions", "type": { "text": "number" }, "default": "0", "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.", "privacy": "public" } ], "events": [ { "name": "button-click", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the user clicks on the AI button.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": false }, { "name": "stop-generation", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the user clicks on the \"Stop\" button to stop ongoing AI text generation.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": false }, { "name": "version-change", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the user clicks on version navigation buttons.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": false } ], "attributes": [ { "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.", "name": "current-version", "default": "0", "fieldName": "currentVersion", "type": { "text": "number" } }, { "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\").", "name": "prompt-description", "default": "\"\"", "fieldName": "promptDescription", "type": { "text": "string" } }, { "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.", "name": "total-versions", "default": "0", "fieldName": "totalVersions", "type": { "text": "number" } } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-ai-writing-assistant", "customElement": true, "_ui5since": "2.16.0", "_ui5privacy": "private" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "WritingAssistant", "module": "dist/WritingAssistant.js" } }, { "kind": "custom-element-definition", "name": "ui5-ai-writing-assistant", "declaration": { "name": "WritingAssistant", "module": "dist/WritingAssistant.js" } } ] } ] }