@ui5/webcomponents 2.29.0-rc.0 → 2.29.0-rc.1
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 +22 -0
- package/README.md +12 -0
- package/dist/.tsbuildinfo +1 -1
- package/dist/Carousel.d.ts +4 -1
- package/dist/Carousel.js +9 -2
- package/dist/Carousel.js.map +1 -1
- package/dist/CarouselTemplate.js +5 -5
- package/dist/CarouselTemplate.js.map +1 -1
- package/dist/ComboBox.js +1 -2
- package/dist/ComboBox.js.map +1 -1
- package/dist/ComboBoxItem.js +1 -1
- package/dist/ComboBoxItem.js.map +1 -1
- package/dist/ComboBoxItemTemplate.js +6 -1
- package/dist/ComboBoxItemTemplate.js.map +1 -1
- package/dist/ComboBoxPopoverTemplate.js +2 -3
- package/dist/ComboBoxPopoverTemplate.js.map +1 -1
- package/dist/Input.js +1 -3
- package/dist/Input.js.map +1 -1
- package/dist/ListItemTemplate.js +1 -1
- package/dist/ListItemTemplate.js.map +1 -1
- package/dist/Popup.js +3 -0
- package/dist/Popup.js.map +1 -1
- package/dist/SuggestionItem.js +1 -1
- package/dist/SuggestionItem.js.map +1 -1
- package/dist/SuggestionItemTemplate.js +6 -1
- package/dist/SuggestionItemTemplate.js.map +1 -1
- package/dist/TabContainer.d.ts +1 -1
- package/dist/Table.d.ts +2 -0
- package/dist/Table.js +2 -0
- package/dist/Table.js.map +1 -1
- package/dist/TableDragAndDrop.d.ts +3 -0
- package/dist/TableDragAndDrop.js +44 -1
- package/dist/TableDragAndDrop.js.map +1 -1
- package/dist/TableNavigation.js +1 -1
- package/dist/TableNavigation.js.map +1 -1
- package/dist/TableRow.d.ts +1 -0
- package/dist/TableRow.js +15 -4
- package/dist/TableRow.js.map +1 -1
- package/dist/Tree.js +2 -1
- package/dist/Tree.js.map +1 -1
- package/dist/css/themes/ListItem.css +1 -1
- package/dist/css/themes/OptionBase.css +1 -1
- package/dist/css/themes/TabInStrip.css +1 -1
- package/dist/custom-elements-internal.json +107 -103
- package/dist/custom-elements.json +107 -103
- package/dist/features/InputSuggestions.d.ts +0 -1
- package/dist/features/InputSuggestions.js +0 -4
- package/dist/features/InputSuggestions.js.map +1 -1
- package/dist/generated/themes/ListItem.css.d.ts +1 -1
- package/dist/generated/themes/ListItem.css.js +1 -1
- package/dist/generated/themes/ListItem.css.js.map +1 -1
- package/dist/generated/themes/OptionBase.css.d.ts +1 -1
- package/dist/generated/themes/OptionBase.css.js +1 -1
- package/dist/generated/themes/OptionBase.css.js.map +1 -1
- package/dist/generated/themes/TabInStrip.css.d.ts +1 -1
- package/dist/generated/themes/TabInStrip.css.js +1 -1
- package/dist/generated/themes/TabInStrip.css.js.map +1 -1
- package/dist/vscode.html-custom-data.json +2 -2
- package/dist/web-types.json +7 -3
- package/llms.txt +180 -0
- package/package.json +13 -10
- package/src/CarouselTemplate.tsx +3 -4
- package/src/ComboBoxItemTemplate.tsx +9 -2
- package/src/ComboBoxPopoverTemplate.tsx +2 -3
- package/src/ListItemTemplate.tsx +1 -1
- package/src/SuggestionItemTemplate.tsx +8 -1
- package/src/themes/ListItem.css +2 -1
- package/src/themes/OptionBase.css +17 -2
package/dist/web-types.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json",
|
|
3
3
|
"name": "@ui5/webcomponents",
|
|
4
|
-
"version": "2.29.0-rc.
|
|
4
|
+
"version": "2.29.0-rc.1",
|
|
5
5
|
"description-markup": "markdown",
|
|
6
6
|
"contributions": {
|
|
7
7
|
"html": {
|
|
@@ -1288,7 +1288,7 @@
|
|
|
1288
1288
|
},
|
|
1289
1289
|
{
|
|
1290
1290
|
"name": "ui5-carousel",
|
|
1291
|
-
"description": "### Overview\nThe Carousel allows the user to browse through a set of items.\nThe component is mostly used for showing a gallery of images, but can hold any other HTML element.\n\nThere are several ways to perform navigation:\n\n- on desktop - the user can navigate using the navigation arrows or with keyboard shortcuts.\n- on touch devices - the user can navigate using the navigation arrows (always visible) or can use swipe gestures.\n\n### Usage\n\n#### When to use:\n\n- The items you want to display are very different from each other.\n- You want to display the items one after the other.\n\n#### When not to use:\n\n- The items you want to display need to be visible at the same time.\n- The items you want to display are uniform and very similar.\n\n### Hidden Items\n\nCarousel items can be conditionally hidden by adding the `hidden` attribute to any child element.\nHidden items are automatically excluded from carousel navigation and will not be displayed or counted in pagination.\nThis allows for dynamic showing or hiding of carousel items without affecting the overall carousel behavior.\n\n### Keyboard Handling\n\n#### Basic Navigation\nWhen the `ui5-carousel` is focused the user can navigate between the items\nwith the following keyboard shortcuts:\n\n- [Up] or [Down] - Navigates to previous and next item\n- [Left] or [Right] - Navigates to previous and next item\n\n### Fast Navigation\nThis component provides a build in fast navigation group which can be used via [F6] / [Shift] + [F6] / [Ctrl] + [Alt/Option] / [Down] or [Ctrl] + [Alt/Option] + [Up].\nIn order to use this functionality, you need to import the following module:\n\n`import \"@ui5/webcomponents-base/dist/features/F6Navigation.js\"`\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents/dist/Carousel.js\";`\n---\n\n\n### **Events:**\n - **navigate** - Fired whenever the page changes due to user interaction,\nwhen the user clicks on the navigation arrows or while resizing,\nbased on the `items-per-page` property.\n\n### **Methods:**\n - **navigateTo(itemIndex: _number_): _void_** - Changes the currently displayed page.\n\n### **Slots:**\n - **default** - Defines the content of the component.\n\n**Note:** Items with the `hidden` attribute will be automatically excluded from carousel navigation and page calculations.\nThey will not be displayed or accessible via keyboard navigation. See [sample](./#carousel-with-hidden-items).\n\n### **CSS Parts:**\n - **content** - Used to style the content of the component",
|
|
1291
|
+
"description": "### Overview\nThe Carousel allows the user to browse through a set of items.\nThe component is mostly used for showing a gallery of images, but can hold any other HTML element.\n\nThere are several ways to perform navigation:\n\n- on desktop - the user can navigate using the navigation arrows or with keyboard shortcuts.\n- on touch devices - the user can navigate using the navigation arrows (always visible) or can use swipe gestures.\n\n### Usage\n\n#### When to use:\n\n- The items you want to display are very different from each other.\n- You want to display the items one after the other.\n\n#### When not to use:\n\n- The items you want to display need to be visible at the same time.\n- The items you want to display are uniform and very similar.\n\n### Hidden Items\n\nCarousel items can be conditionally hidden by adding the `hidden` attribute to any child element.\nHidden items are automatically excluded from carousel navigation and will not be displayed or counted in pagination.\nThis allows for dynamic showing or hiding of carousel items without affecting the overall carousel behavior.\n\n### Keyboard Handling\n\n#### Basic Navigation\nWhen the `ui5-carousel` is focused the user can navigate between the items\nwith the following keyboard shortcuts:\n\n- [Up] or [Down] - Navigates to previous and next item\n- [Left] or [Right] - Navigates to previous and next item\n\n### Fast Navigation\nThis component provides a build in fast navigation group which can be used via [F6] / [Shift] + [F6] / [Ctrl] + [Alt/Option] / [Down] or [Ctrl] + [Alt/Option] + [Up].\nIn order to use this functionality, you need to import the following module:\n\n`import \"@ui5/webcomponents-base/dist/features/F6Navigation.js\"`\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents/dist/Carousel.js\";`\n---\n\n\n### **Events:**\n - **navigate** - Fired whenever the page changes due to user interaction,\nwhen the user clicks on the navigation arrows or while resizing,\nbased on the `items-per-page` property.\n\n### **Methods:**\n - **navigateTo(itemIndex: _number_): _void_** - Changes the currently displayed page.\n\n### **Slots:**\n - **default** - Defines the content of the component.\n\n**Note:** Items with the `hidden` attribute will be automatically excluded from carousel navigation and page calculations.\nThey will not be displayed or accessible via keyboard navigation. See [sample](./#carousel-with-hidden-items).\n\n### **CSS Parts:**\n - **content** - Used to style the content of the component\n- **item** - Used to style the item of the component",
|
|
1292
1292
|
"doc-url": "",
|
|
1293
1293
|
"attributes": [
|
|
1294
1294
|
{
|
|
@@ -10569,7 +10569,7 @@
|
|
|
10569
10569
|
},
|
|
10570
10570
|
{
|
|
10571
10571
|
"name": "ui5-table",
|
|
10572
|
-
"description": "### Overview\n\nThe `ui5-table` component provides a set of sophisticated features for displaying and dealing with vast amounts of data in a responsive manner.\nTo render the `ui5-table`, you need to define the columns and rows. You can use the provided `ui5-table-header-row` and `ui5-table-row` components for this purpose.\n\n### Features\n\nThe `ui5-table` can be enhanced in its functionalities by applying different features.\nFeatures can be slotted into the `features` slot, to enable them in the component.\nFeatures need to be imported separately, as they are not enabled by default.\n\nThe following features are currently available:\n\n* [TableSelectionMulti](../TableSelectionMulti) - adds multi-selection capabilities to the table\n* [TableSelectionSingle](../TableSelectionSingle) - adds single-selection capabilities to the table\n* [TableGrowing](../TableGrowing) - provides growing capabilities to load more data\n* [TableVirtualizer](../TableVirtualizer) - adds virtualization capabilities to the table\n\n### Keyboard Handling\n\nThis component provides a build in fast navigation group which can be used via [F6] / [Shift] + [F6] / [Ctrl] + [Alt/Option] / [Down] or [Ctrl] + [Alt/Option] + [Up].\nIn order to use this functionality, you need to import the following module:\n`import \"@ui5/webcomponents-base/dist/features/F6Navigation.js\"`\n\nFurthermore, you can interact with `ui5-table` via the following keys:\n\nIf the focus is on a row, the following keyboard shortcuts are available:\n* <kbd>Down</kbd> - Navigates down\n* <kbd>Up</kbd> - Navigates up\n* <kbd>Right</kbd> - Selects the first cell of the row\n* <kbd>Space</kbd> - Toggles the selection of the row\n* <kbd>Ctrl/Cmd + A</kbd> - In multi selection mode, toggles the selection of all rows\n* <kbd>Home</kbd> - Navigates to the first row, if the focus is on the first row, navigates to the header row\n* <kbd>End</kbd> - Navigates to the last row, if the focus is on the last row, navigates to the growing button\n* <kbd>Page Up</kbd> - Navigates one page up, if the focus is on the first row, navigates to the header row\n* <kbd>Page Down</kbd> - Navigates one page down, if the focus is on the last row, navigates to the growing button\n* <kbd>F2</kbd> - Focuses the first tabbable element in the row\n* <kbd>F7</kbd> - If focus position is remembered, moves focus to the corresponding focus position row, otherwise to the first tabbable element within the row\n* <kbd>[Shift]Tab</kbd> - Move focus to the element in the tab chain outside the table\n\nIf the focus is on a cell, the following keyboard shortcuts are available:\n* <kbd>Down</kbd> - Navigates down\n* <kbd>Up</kbd> - Navigates up\n* <kbd>Right</kbd> - Navigates right\n* <kbd>Left</kbd> - Navigates left, if the focus is on the first cell of the row, the focus is moved to the row.\n* <kbd>Home</kbd> - Navigates to the first cell of the current row, if the focus is on the first cell, navigates to the corresponding row\n* <kbd>End</kbd> - Navigates to the last cell of the current row, if the focus is on the last cell, navigates to the corresponding row\n* <kbd>Page Up</kbd> - Navigates one page up while keeping the focus in same column\n* <kbd>Page Down</kbd> - Navigates one page down while keeping the focus in same column\n* <kbd>F2</kbd> - Toggles the focus between the first tabbable cell content and the cell\n* <kbd>Enter</kbd> - Focuses the first tabbable cell content\n* <kbd>F7</kbd> - If the focus is on an interactive element inside a row, moves focus to the corresponding row and remembers the focus position of the element within the row\n* <kbd>[Shift]Tab</kbd> - Move focus to the element in the tab chain outside the table\n\nIf the focus is on an interactive cell content, the following keyboard shortcuts are available:\n* <kbd>Down</kbd> - Move the focus to the interactive element in the same column of the previous row, unless the focused element prevents the default\n* <kbd>Up</kbd> - Move the focus to the interactive element in the same column of the next row, unless the focused element prevents the default\n* <kbd>[Shift]Tab</kbd> - Move the focus to the element in the tab chain\n\n### Accessibility\n\nThe `ui5-table` follows the [ARIA grid design pattern](https://www.w3.org/WAI/ARIA/apg/patterns/grid/).\nThis pattern enables cell-based keyboard navigation and, as explained above, we also support row-based keyboard navigation.\nSince the grid design pattern does not inherently provide row-based keyboard behavior, if the focus is on a row, not only the row information but also the corresponding column headers for each cell must be announced.\nThis can only be achieved through a custom accessibility announcement.\nTo support this, UI5 Web Components expose its own accessibility metadata via the `accessibilityInfo` property.\nThe `ui5-table` uses this information to create the required custom announcements dynamically.\nIf you include custom web components inside table cells that are not part of the standard UI5 Web Components set, their accessibility information can be provided using the `data-ui5-acc-text` attribute.\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents/dist/Table.js\";` (`ui5-table`)\\\n`import \"@ui5/webcomponents/dist/TableRow.js\";` (`ui5-table-row`)\\\n`import \"@ui5/webcomponents/dist/TableCell.js\";` (`ui5-table-cell`)\\\n`import \"@ui5/webcomponents/dist/TableHeaderRow.js\";` (`ui5-table-header-row`)\\\n`import \"@ui5/webcomponents/dist/TableHeaderCell.js\";` (`ui5-table-header-cell`)\n---\n\n\n### **Events:**\n - **move** - Fired when a movable list item is dropped onto a drop target.\n\n**Notes:**\n\nThe `move` event is fired only if there was a preceding `move-over` with prevented default action.\n\nIf the dragging operation is a cross-browser operation or files are moved to a potential drop target,\nthe `source` parameter will be `null`.\n- **move-over** - Fired when a movable item is moved over a potential drop target during a dragging operation.\n\nIf the new position is valid, prevent the default action of the event using `preventDefault()`.\n\n**Note:** If the dragging operation is a cross-browser operation or files are moved to a potential drop target,\nthe `source` parameter will be `null`.\n- **row-action-click** - Fired when a row action is clicked.\n- **row-click** - Fired when an interactive row is clicked.\n\n**Note:** This event is not fired if the `behavior` property of the selection component is set to `RowOnly`.\nIn that case, use the `change` event of the selection component instead.\n\n### **Slots:**\n - **default** - Defines the rows of the component.\n\n**Note:** Use `ui5-table-row` for the intended design.\n- **features** - Defines the features of the component.\n- **headerRow** - Defines the header row of the component.\n\n**Note:** Use `ui5-table-header-row` for the intended design.\n- **noData** - Defines the custom visualization if there is no data available.",
|
|
10572
|
+
"description": "### Overview\n\nThe `ui5-table` component provides a set of sophisticated features for displaying and dealing with vast amounts of data in a responsive manner.\nTo render the `ui5-table`, you need to define the columns and rows. You can use the provided `ui5-table-header-row` and `ui5-table-row` components for this purpose.\n\n### Features\n\nThe `ui5-table` can be enhanced in its functionalities by applying different features.\nFeatures can be slotted into the `features` slot, to enable them in the component.\nFeatures need to be imported separately, as they are not enabled by default.\n\nThe following features are currently available:\n\n* [TableSelectionMulti](../TableSelectionMulti) - adds multi-selection capabilities to the table\n* [TableSelectionSingle](../TableSelectionSingle) - adds single-selection capabilities to the table\n* [TableGrowing](../TableGrowing) - provides growing capabilities to load more data\n* [TableVirtualizer](../TableVirtualizer) - adds virtualization capabilities to the table\n\n### Keyboard Handling\n\nThis component provides a build in fast navigation group which can be used via [F6] / [Shift] + [F6] / [Ctrl] + [Alt/Option] / [Down] or [Ctrl] + [Alt/Option] + [Up].\nIn order to use this functionality, you need to import the following module:\n`import \"@ui5/webcomponents-base/dist/features/F6Navigation.js\"`\n\nFurthermore, you can interact with `ui5-table` via the following keys:\n\nIf the focus is on a row, the following keyboard shortcuts are available:\n* <kbd>Down</kbd> - Navigates down\n* <kbd>Up</kbd> - Navigates up\n* <kbd>Right</kbd> - Selects the first cell of the row\n* <kbd>Space</kbd> - Toggles the selection of the row\n* <kbd>Ctrl/Cmd + A</kbd> - In multi selection mode, toggles the selection of all rows\n* <kbd>Home</kbd> - Navigates to the first row, if the focus is on the first row, navigates to the header row\n* <kbd>End</kbd> - Navigates to the last row, if the focus is on the last row, navigates to the growing button\n* <kbd>Page Up</kbd> - Navigates one page up, if the focus is on the first row, navigates to the header row\n* <kbd>Page Down</kbd> - Navigates one page down, if the focus is on the last row, navigates to the growing button\n* <kbd>F2</kbd> - Focuses the first tabbable element in the row\n* <kbd>F7</kbd> - If focus position is remembered, moves focus to the corresponding focus position row, otherwise to the first tabbable element within the row\n* <kbd>[Shift]Tab</kbd> - Move focus to the element in the tab chain outside the table\n* <kbd>Alt + Enter</kbd> - Triggers the navigation action of the row, if available\n\nIf the focus is on a cell, the following keyboard shortcuts are available:\n* <kbd>Down</kbd> - Navigates down\n* <kbd>Up</kbd> - Navigates up\n* <kbd>Right</kbd> - Navigates right\n* <kbd>Left</kbd> - Navigates left, if the focus is on the first cell of the row, the focus is moved to the row.\n* <kbd>Home</kbd> - Navigates to the first cell of the current row, if the focus is on the first cell, navigates to the corresponding row\n* <kbd>End</kbd> - Navigates to the last cell of the current row, if the focus is on the last cell, navigates to the corresponding row\n* <kbd>Page Up</kbd> - Navigates one page up while keeping the focus in same column\n* <kbd>Page Down</kbd> - Navigates one page down while keeping the focus in same column\n* <kbd>F2</kbd> - Toggles the focus between the first tabbable cell content and the cell\n* <kbd>Enter</kbd> - Focuses the first tabbable cell content\n* <kbd>F7</kbd> - If the focus is on an interactive element inside a row, moves focus to the corresponding row and remembers the focus position of the element within the row\n* <kbd>[Shift]Tab</kbd> - Move focus to the element in the tab chain outside the table\n* <kbd>Alt + Enter</kbd> - Triggers the navigation action of the row, if available\n\nIf the focus is on an interactive cell content, the following keyboard shortcuts are available:\n* <kbd>Down</kbd> - Move the focus to the interactive element in the same column of the previous row, unless the focused element prevents the default\n* <kbd>Up</kbd> - Move the focus to the interactive element in the same column of the next row, unless the focused element prevents the default\n* <kbd>[Shift]Tab</kbd> - Move the focus to the element in the tab chain\n\n### Accessibility\n\nThe `ui5-table` follows the [ARIA grid design pattern](https://www.w3.org/WAI/ARIA/apg/patterns/grid/).\nThis pattern enables cell-based keyboard navigation and, as explained above, we also support row-based keyboard navigation.\nSince the grid design pattern does not inherently provide row-based keyboard behavior, if the focus is on a row, not only the row information but also the corresponding column headers for each cell must be announced.\nThis can only be achieved through a custom accessibility announcement.\nTo support this, UI5 Web Components expose its own accessibility metadata via the `accessibilityInfo` property.\nThe `ui5-table` uses this information to create the required custom announcements dynamically.\nIf you include custom web components inside table cells that are not part of the standard UI5 Web Components set, their accessibility information can be provided using the `data-ui5-acc-text` attribute.\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents/dist/Table.js\";` (`ui5-table`)\\\n`import \"@ui5/webcomponents/dist/TableRow.js\";` (`ui5-table-row`)\\\n`import \"@ui5/webcomponents/dist/TableCell.js\";` (`ui5-table-cell`)\\\n`import \"@ui5/webcomponents/dist/TableHeaderRow.js\";` (`ui5-table-header-row`)\\\n`import \"@ui5/webcomponents/dist/TableHeaderCell.js\";` (`ui5-table-header-cell`)\n---\n\n\n### **Events:**\n - **move** - Fired when a movable list item is dropped onto a drop target.\n\n**Notes:**\n\nThe `move` event is fired only if there was a preceding `move-over` with prevented default action.\n\nIf the dragging operation is a cross-browser operation or files are moved to a potential drop target,\nthe `source` parameter will be `null`.\n- **move-over** - Fired when a movable item is moved over a potential drop target during a dragging operation.\n\nIf the new position is valid, prevent the default action of the event using `preventDefault()`.\n\n**Note:** If the dragging operation is a cross-browser operation or files are moved to a potential drop target,\nthe `source` parameter will be `null`.\n- **row-action-click** - Fired when a row action is clicked.\n- **row-click** - Fired when an interactive row is clicked.\n\n**Note:** This event is not fired if the `behavior` property of the selection component is set to `RowOnly`.\nIn that case, use the `change` event of the selection component instead.\n\n### **Slots:**\n - **default** - Defines the rows of the component.\n\n**Note:** Use `ui5-table-row` for the intended design.\n- **features** - Defines the features of the component.\n- **headerRow** - Defines the header row of the component.\n\n**Note:** Use `ui5-table-header-row` for the intended design.\n- **noData** - Defines the custom visualization if there is no data available.",
|
|
10573
10573
|
"doc-url": "",
|
|
10574
10574
|
"attributes": [
|
|
10575
10575
|
{
|
|
@@ -14340,6 +14340,10 @@
|
|
|
14340
14340
|
"name": "part(content)",
|
|
14341
14341
|
"description": "Used to style the content of the component"
|
|
14342
14342
|
},
|
|
14343
|
+
{
|
|
14344
|
+
"name": "part(item)",
|
|
14345
|
+
"description": "Used to style the item of the component"
|
|
14346
|
+
},
|
|
14343
14347
|
{
|
|
14344
14348
|
"name": "part(icon)",
|
|
14345
14349
|
"description": "Used to style the icon of the `ui5-checkbox`"
|
package/llms.txt
ADDED
|
@@ -0,0 +1,180 @@
|
|
|
1
|
+
# @ui5/webcomponents
|
|
2
|
+
|
|
3
|
+
> Consumer guidance for applications using this npm package.
|
|
4
|
+
|
|
5
|
+
Version: 2.29.0-rc.1
|
|
6
|
+
|
|
7
|
+
Primary components for forms, data display, navigation, and layouts.
|
|
8
|
+
|
|
9
|
+
## Read the installed API
|
|
10
|
+
|
|
11
|
+
- [Public API manifest](./dist/custom-elements.json): component tags, module paths, properties, attributes, events, slots, methods, CSS parts, and deprecations.
|
|
12
|
+
- [Package metadata](./package.json): installed version, dependencies, and exports.
|
|
13
|
+
- [Package README](./README.md): assets and package-specific setup.
|
|
14
|
+
- TypeScript declarations next to each component in dist provide additional type information.
|
|
15
|
+
- [Online documentation and examples](https://ui5.github.io/webcomponents/): check that examples apply to the installed version. Prefer the local manifest and declarations when versions differ.
|
|
16
|
+
|
|
17
|
+
Read the relevant component declaration before writing code. Do not invent properties, event names, slots, or methods. This index lists components in this package; inspect the corresponding installed package for other components.
|
|
18
|
+
|
|
19
|
+
## Usage conventions
|
|
20
|
+
|
|
21
|
+
- Import a component's JavaScript module to register its custom element, using the /dist/ paths below. Import child components used in your markup explicitly rather than assuming they are registered transitively.
|
|
22
|
+
- These are native web components. JSX wrappers from @ui5/webcomponents-react have a separate API and package; do not substitute wrapper props for native APIs.
|
|
23
|
+
- HTML attributes and JavaScript properties can have different names (for example, accessible-name and accessibleName). Use the manifest's attribute mapping. Boolean attributes are true when present; remove them for false rather than writing disabled="false". Assign arrays and objects through JavaScript properties or your framework's property binding.
|
|
24
|
+
- Use addEventListener with the documented DOM event name; read documented custom event payloads from event.detail. In frameworks, check their custom-element event binding syntax.
|
|
25
|
+
- Place children in the documented default or named slots. Use slot="name" for a named slot and the documented child component types.
|
|
26
|
+
- Import icons separately, for example import "@ui5/webcomponents-icons/dist/save.js" before using icon="save". Check the icon exists in the installed icon package.
|
|
27
|
+
- For themes and translations, follow the README's Assets.js setup and the application's bundler configuration.
|
|
28
|
+
- Use stable attribute selectors such as [ui5-button] in CSS and DOM queries to support tag-name scoping. Under scoping, create markup with the application's configured scoped tag names.
|
|
29
|
+
- Style with supported theme variables and documented CSS parts. Avoid depending on private shadow DOM structure.
|
|
30
|
+
- In TypeScript, use import type for component types when a separate side-effect import registers the element.
|
|
31
|
+
|
|
32
|
+
## Minimal registration example
|
|
33
|
+
|
|
34
|
+
```js
|
|
35
|
+
import "@ui5/webcomponents/dist/Button.js";
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
```html
|
|
39
|
+
<ui5-button>Save</ui5-button>
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## Component index
|
|
43
|
+
|
|
44
|
+
Generated from the public manifest. Descriptions are abbreviated; consult the manifest for complete usage constraints and API details.
|
|
45
|
+
|
|
46
|
+
| Component | Tag | Import module | Purpose |
|
|
47
|
+
| --- | --- | --- | --- |
|
|
48
|
+
| Avatar | `ui5-avatar` | `@ui5/webcomponents/dist/Avatar.js` | An image-like component that has different display options for representing images and icons in different shapes and sizes, depending on the use case. |
|
|
49
|
+
| AvatarBadge | `ui5-avatar-badge` | `@ui5/webcomponents/dist/AvatarBadge.js` | The ui5-avatar-badge component is used to display a badge on top of ui5-avatar component. The badge can display an icon and supports different states for visual affordance. |
|
|
50
|
+
| AvatarGroup | `ui5-avatar-group` | `@ui5/webcomponents/dist/AvatarGroup.js` | Displays a group of avatars arranged horizontally. It is useful to visually showcase a group of related avatars, such as, project team members or employees. |
|
|
51
|
+
| Bar | `ui5-bar` | `@ui5/webcomponents/dist/Bar.js` | The Bar is a container which is primarily used to hold titles, buttons and input elements and its design and functionality is the basis for page headers and footers. The component consists of three areas to hold its content - startContent… |
|
|
52
|
+
| Breadcrumbs | `ui5-breadcrumbs` | `@ui5/webcomponents/dist/Breadcrumbs.js` | Enables users to navigate between items by providing a list of links to previous steps in the user's navigation path. It helps the user to be aware of their location within the application and allows faster navigation. |
|
|
53
|
+
| BreadcrumbsItem | `ui5-breadcrumbs-item` | `@ui5/webcomponents/dist/BreadcrumbsItem.js` | The ui5-breadcrumbs-item component defines the content of an item in ui5-breadcrumbs. |
|
|
54
|
+
| BusyIndicator | `ui5-busy-indicator` | `@ui5/webcomponents/dist/BusyIndicator.js` | The ui5-busy-indicator signals that some operation is going on and that the user must wait. It does not block the current UI screen so other operations could be triggered in parallel. It displays 3 dots and each dot expands and shrinks at… |
|
|
55
|
+
| Button | `ui5-button` | `@ui5/webcomponents/dist/Button.js` | The ui5-button component represents a simple push button. It enables users to trigger actions by clicking or tapping the ui5-button, or by pressing certain keyboard keys, such as Enter. |
|
|
56
|
+
| ButtonBadge | `ui5-button-badge` | `@ui5/webcomponents/dist/ButtonBadge.js` | The ui5-button-badge component defines a badge that appears in the ui5-button. |
|
|
57
|
+
| Calendar | `ui5-calendar` | `@ui5/webcomponents/dist/Calendar.js` | The ui5-calendar component allows users to select one or more dates. |
|
|
58
|
+
| CalendarLegend | `ui5-calendar-legend` | `@ui5/webcomponents/dist/CalendarLegend.js` | The ui5-calendar-legend component is designed for use within the ui5-calendar to display a legend. Each ui5-calendar-legend-item represents a unique date type, specifying its visual style and a corresponding textual label. |
|
|
59
|
+
| CalendarLegendItem | `ui5-calendar-legend-item` | `@ui5/webcomponents/dist/CalendarLegendItem.js` | Each ui5-calendar-legend-item represents a legend item, displaying a color with a label. The color is determined by the type property and the label by the text property. If a ui5-special-date is used within the ui5-calendar and a type is… |
|
|
60
|
+
| Card | `ui5-card` | `@ui5/webcomponents/dist/Card.js` | The ui5-card is a component that represents information in the form of a tile with separate header and content areas. The content area of a ui5-card can be arbitrary HTML content. The header can be used through slot header. For which there… |
|
|
61
|
+
| CardHeader | `ui5-card-header` | `@ui5/webcomponents/dist/CardHeader.js` | The ui5-card-header is a component, meant to be used as a header of the ui5-card component. It displays valuable information, that can be defined with several properties, such as: titleText, subtitleText, additionalText and two slots:… |
|
|
62
|
+
| Carousel | `ui5-carousel` | `@ui5/webcomponents/dist/Carousel.js` | The Carousel allows the user to browse through a set of items. The component is mostly used for showing a gallery of images, but can hold any other HTML element. |
|
|
63
|
+
| ComboBoxItem | `ui5-cb-item` | `@ui5/webcomponents/dist/ComboBoxItem.js` | The ui5-cb-item represents the item for a ui5-combobox. |
|
|
64
|
+
| ComboBoxItemCustom | `ui5-cb-item-custom` | `@ui5/webcomponents/dist/ComboBoxItemCustom.js` | The ui5-cb-item-custom is a combobox item component that allows placing custom content inside a combobox item. The text property is used for filtering and auto-complete. For highlighting functionality, see… |
|
|
65
|
+
| ComboBoxItemGroup | `ui5-cb-item-group` | `@ui5/webcomponents/dist/ComboBoxItemGroup.js` | The ui5-cb-group-item is type of suggestion item, that can be used to split the ui5-combobox suggestions into groups. |
|
|
66
|
+
| CheckBox | `ui5-checkbox` | `@ui5/webcomponents/dist/CheckBox.js` | Allows the user to set a binary value, such as true/false or yes/no for an item. |
|
|
67
|
+
| ColorPalette | `ui5-color-palette` | `@ui5/webcomponents/dist/ColorPalette.js` | The ui5-color-palette provides the users with a range of predefined colors. The colors are fixed and do not change with the theme. |
|
|
68
|
+
| ColorPaletteItem | `ui5-color-palette-item` | `@ui5/webcomponents/dist/ColorPaletteItem.js` | The ui5-color-palette-item component represents a color in the the ui5-color-palette. |
|
|
69
|
+
| ColorPalettePopover | `ui5-color-palette-popover` | `@ui5/webcomponents/dist/ColorPalettePopover.js` | Represents a predefined range of colors for easier selection. |
|
|
70
|
+
| ColorPicker | `ui5-color-picker` | `@ui5/webcomponents/dist/ColorPicker.js` | The ui5-color-picker allows users to choose any color and provides different input options for selecting colors. |
|
|
71
|
+
| ComboBox | `ui5-combobox` | `@ui5/webcomponents/dist/ComboBox.js` | The ui5-combobox component represents a drop-down menu with a list of the available options and a text input field to narrow down the options. |
|
|
72
|
+
| CalendarDate | `ui5-date` | `@ui5/webcomponents/dist/CalendarDate.js` | The ui5-date component defines a calendar date to be used inside ui5-calendar |
|
|
73
|
+
| DatePicker | `ui5-date-picker` | `@ui5/webcomponents/dist/DatePicker.js` | The ui5-date-picker component provides an input field with assigned calendar which opens on user action. The ui5-date-picker allows users to select a localized date using touch, mouse, or keyboard input. It consists of two parts: the date… |
|
|
74
|
+
| CalendarDateRange | `ui5-date-range` | `@ui5/webcomponents/dist/CalendarDateRange.js` | The ui5-date-range component defines a range of dates to be used inside ui5-calendar |
|
|
75
|
+
| DateRangePicker | `ui5-daterange-picker` | `@ui5/webcomponents/dist/DateRangePicker.js` | The DateRangePicker enables the users to enter a localized date range using touch, mouse, keyboard input, or by selecting a date range in the calendar. |
|
|
76
|
+
| DateTimeInput | `ui5-datetime-input` | `@ui5/webcomponents/dist/DateTimeInput.js` | Extention of the UI5 Input, so we do not modify Input's private properties within the datetime components. Intended to be used for the DateTime components. |
|
|
77
|
+
| DateTimePicker | `ui5-datetime-picker` | `@ui5/webcomponents/dist/DateTimePicker.js` | The DateTimePicker component alows users to select both date (day, month and year) and time (hours, minutes and seconds) and for the purpose it consists of input field and Date/Time picker. |
|
|
78
|
+
| DayPicker | `ui5-daypicker` | `@ui5/webcomponents/dist/DayPicker.js` | Represents the days inside a single month view of the ui5-calendar component. |
|
|
79
|
+
| Dialog | `ui5-dialog` | `@ui5/webcomponents/dist/Dialog.js` | The ui5-dialog component is used to temporarily display some information in a size-limited window in front of the regular app screen. It is used to prompt the user for an action or a confirmation. The ui5-dialog interrupts the current app… |
|
|
80
|
+
| DropIndicator | `ui5-drop-indicator` | `@ui5/webcomponents/dist/DropIndicator.js` | import "@ui5/webcomponents/dist/DropIndicator.js"; |
|
|
81
|
+
| DynamicDateRange | `ui5-dynamic-date-range` | `@ui5/webcomponents/dist/DynamicDateRange.js` | The ui5-dynamic-date-range component provides a flexible interface to define date ranges using a combination of absolute dates, relative intervals, and preset ranges (e.g., "Today", "Yesterday", etc.). It allows users to select a date… |
|
|
82
|
+
| ExpandableText | `ui5-expandable-text` | `@ui5/webcomponents/dist/ExpandableText.js` | The ui5-expandable-text component allows displaying a large body of text in a small space. It provides an "expand/collapse" functionality, which shows/hides potentially truncated text. |
|
|
83
|
+
| FileUploader | `ui5-file-uploader` | `@ui5/webcomponents/dist/FileUploader.js` | The ui5-file-uploader opens a file explorer dialog and enables users to upload files. The component consists of input field, but you can provide an HTML element by your choice to trigger the file upload, by using the default slot.… |
|
|
84
|
+
| Form | `ui5-form` | `@ui5/webcomponents/dist/Form.js` | The Form is a layout component that arranges labels and form fields (like input fields) pairs into a specific number of columns. |
|
|
85
|
+
| FormGroup | `ui5-form-group` | `@ui5/webcomponents/dist/FormGroup.js` | The FormGroup (ui5-form-group) represents a group inside the Form (ui5-form) component and it consists of FormItem (ui5-form-item) components. |
|
|
86
|
+
| FormItem | `ui5-form-item` | `@ui5/webcomponents/dist/FormItem.js` | The FormItem (ui5-form-item) represents pair of a label and one or more components (text or text fields), associated to it. |
|
|
87
|
+
| Icon | `ui5-icon` | `@ui5/webcomponents/dist/Icon.js` | The ui5-icon component represents an SVG icon. There are two main scenarios how the ui5-icon component is used: as a purely decorative element, or as an interactive element that can be focused and clicked. |
|
|
88
|
+
| Input | `ui5-input` | `@ui5/webcomponents/dist/Input.js` | The ui5-input component allows the user to enter and edit text or numeric values in one line. |
|
|
89
|
+
| InputIcon | `ui5-input-icon` | `@ui5/webcomponents/dist/InputIcon.js` | The ui5-input-icon component represents an interactive icon that can be placed inside an ui5-input component. Unlike the standard ui5-icon, this component provides button-like behavior with hover, focus, and active states, matching the… |
|
|
90
|
+
| Label | `ui5-label` | `@ui5/webcomponents/dist/Label.js` | The ui5-label is a component used to represent a label for elements like input, textarea, select. The for property of the ui5-label must be the same as the id attribute of the related input element. Screen readers read out the label, when… |
|
|
91
|
+
| ListItemStandard | `ui5-li` | `@ui5/webcomponents/dist/ListItemStandard.js` | The ui5-li represents the simplest type of item for a ui5-list. |
|
|
92
|
+
| ListItemCustom | `ui5-li-custom` | `@ui5/webcomponents/dist/ListItemCustom.js` | A component to be used as custom list item within the ui5-list the same way as the standard ui5-li. |
|
|
93
|
+
| ListItemGroup | `ui5-li-group` | `@ui5/webcomponents/dist/ListItemGroup.js` | The ui5-li-group is a special list item, used only to create groups of list items. |
|
|
94
|
+
| ListItemGroupHeader | `ui5-li-group-header` | `@ui5/webcomponents/dist/ListItemGroupHeader.js` | The ui5-li-group-header is a special list item, used only to separate other list items into logical groups. |
|
|
95
|
+
| SuggestionListItem | `ui5-li-suggestion-item` | `@ui5/webcomponents/dist/SuggestionListItem.js` | The ui5-li-suggestion-item represents the suggestion item in the ui5-input suggestion popover. |
|
|
96
|
+
| Link | `ui5-link` | `@ui5/webcomponents/dist/Link.js` | The ui5-link is a hyperlink component that is used to navigate to other apps and web pages, or to trigger actions. It is a clickable text element, visualized in such a way that it stands out from the standard text. On hover, it changes its… |
|
|
97
|
+
| List | `ui5-list` | `@ui5/webcomponents/dist/List.js` | The ui5-list component allows displaying a list of items, advanced keyboard handling support for navigating between items, and predefined modes to improve the development efficiency. |
|
|
98
|
+
| MultiComboBoxItem | `ui5-mcb-item` | `@ui5/webcomponents/dist/MultiComboBoxItem.js` | The ui5-mcb-item represents the item for a ui5-multi-combobox. |
|
|
99
|
+
| MultiComboBoxItemCustom | `ui5-mcb-item-custom` | `@ui5/webcomponents/dist/MultiComboBoxItemCustom.js` | The ui5-mcb-item-custom is a multi-combobox item component that allows placing custom content inside a multi-combobox item. The text property is used for filtering and token display. For highlighting functionality, see… |
|
|
100
|
+
| MultiComboBoxItemGroup | `ui5-mcb-item-group` | `@ui5/webcomponents/dist/MultiComboBoxItemGroup.js` | The ui5-mcb-item-group is type of suggestion item, that can be used to split the ui5-multi-combobox suggestions into groups. |
|
|
101
|
+
| Menu | `ui5-menu` | `@ui5/webcomponents/dist/Menu.js` | ui5-menu component represents a hierarchical menu structure. |
|
|
102
|
+
| MenuItem | `ui5-menu-item` | `@ui5/webcomponents/dist/MenuItem.js` | ui5-menu-item is the item to use inside a ui5-menu. An arbitrary hierarchy structure can be represented by recursively nesting menu items. |
|
|
103
|
+
| MenuItemGroup | `ui5-menu-item-group` | `@ui5/webcomponents/dist/MenuItemGroup.js` | The ui5-menu-item-group component represents a group of items designed for use inside a ui5-menu. Items belonging to the same group should be wrapped by a ui5-menu-item-group. Each group can have an checkMode property, which defines the… |
|
|
104
|
+
| MenuSeparator | `ui5-menu-separator` | `@ui5/webcomponents/dist/MenuSeparator.js` | The ui5-menu-separator represents a horizontal line to separate menu items inside a ui5-menu. |
|
|
105
|
+
| MessageStrip | `ui5-message-strip` | `@ui5/webcomponents/dist/MessageStrip.js` | The ui5-message-strip component allows for the embedding of application-related messages. It supports four semantic designs, each with its own color and icon: "Information", "Positive", "Critical", and "Negative". Additionally, users can… |
|
|
106
|
+
| MonthPicker | `ui5-monthpicker` | `@ui5/webcomponents/dist/MonthPicker.js` | Month picker component. |
|
|
107
|
+
| MultiComboBox | `ui5-multi-combobox` | `@ui5/webcomponents/dist/MultiComboBox.js` | The ui5-multi-combobox component consists of a list box with items and a text field allowing the user to either type a value directly into the text field, or choose from the list of existing items. |
|
|
108
|
+
| MultiInput | `ui5-multi-input` | `@ui5/webcomponents/dist/MultiInput.js` | A ui5-multi-input field allows the user to enter multiple values, which are displayed as ui5-token. |
|
|
109
|
+
| NumericInput | `ui5-numeric-input` | `@ui5/webcomponents/dist/NumericInput.js` | The ui5-numeric-input component is a numeric input field. It allows users to enter, edit and select numeric values. |
|
|
110
|
+
| Option | `ui5-option` | `@ui5/webcomponents/dist/Option.js` | The ui5-option component defines the content of an option in the ui5-select. |
|
|
111
|
+
| OptionCustom | `ui5-option-custom` | `@ui5/webcomponents/dist/OptionCustom.js` | The ui5-option-custom component defines a custom content of an option in the ui5-select. A component to be the same way as the standard ui5-option. The component accepts arbitrary HTML content to allow full customization. |
|
|
112
|
+
| OptionGroup | `ui5-option-group` | `@ui5/webcomponents/dist/OptionGroup.js` | The ui5-option-group component is used to group options within a ui5-select. |
|
|
113
|
+
| Panel | `ui5-panel` | `@ui5/webcomponents/dist/Panel.js` | The ui5-panel component is a container which has a header and a content area and is used for grouping and displaying information. It can be collapsed to save space on the screen. |
|
|
114
|
+
| Popover | `ui5-popover` | `@ui5/webcomponents/dist/Popover.js` | The ui5-popover component displays additional information for an object in a compact way and without leaving the page. The Popover can contain various UI elements, such as fields, tables, images, and charts. It can also include actions in… |
|
|
115
|
+
| ProgressIndicator | `ui5-progress-indicator` | `@ui5/webcomponents/dist/ProgressIndicator.js` | Shows the progress of a process in a graphical way. To indicate the progress, the inside of the component is filled with a color. |
|
|
116
|
+
| RadioButton | `ui5-radio-button` | `@ui5/webcomponents/dist/RadioButton.js` | The ui5-radio-button component enables users to select a single option from a set of options. When a ui5-radio-button is selected by the user, the change event is fired. When a ui5-radio-button that is within a group is selected, the one… |
|
|
117
|
+
| RangeSlider | `ui5-range-slider` | `@ui5/webcomponents/dist/RangeSlider.js` | Represents a numerical interval and two handles (grips) to select a sub-range within it. The purpose of the component to enable visual selection of sub-ranges within a given interval. |
|
|
118
|
+
| RatingIndicator | `ui5-rating-indicator` | `@ui5/webcomponents/dist/RatingIndicator.js` | The Rating Indicator is used to display a specific number of icons that are used to rate an item. Additionally, it is also used to display the average and overall ratings. |
|
|
119
|
+
| ResponsivePopover | `ui5-responsive-popover` | `@ui5/webcomponents/dist/ResponsivePopover.js` | The ui5-responsive-popover acts as a Popover on desktop and tablet, while on phone it acts as a Dialog. The component improves tremendously the user experience on mobile. |
|
|
120
|
+
| SegmentedButton | `ui5-segmented-button` | `@ui5/webcomponents/dist/SegmentedButton.js` | The ui5-segmented-button shows a group of items. When the user clicks or taps one of the items, it stays in a pressed state. It automatically resizes the items to fit proportionally within the component. When no width is set, the component… |
|
|
121
|
+
| SegmentedButtonItem | `ui5-segmented-button-item` | `@ui5/webcomponents/dist/SegmentedButtonItem.js` | Users can use the ui5-segmented-button-item as part of a ui5-segmented-button. |
|
|
122
|
+
| Select | `ui5-select` | `@ui5/webcomponents/dist/Select.js` | The ui5-select component is used to create a drop-down list. |
|
|
123
|
+
| Slider | `ui5-slider` | `@ui5/webcomponents/dist/Slider.js` | The Slider component represents a numerical range and a handle (grip). The purpose of the component is to enable visual selection of a value in a continuous numerical range by moving an adjustable handle. |
|
|
124
|
+
| SliderHandle | `ui5-slider-handle` | `@ui5/webcomponents/dist/SliderHandle.js` | The ui5-slider-handle component represents the handle of the ui5-slider component. |
|
|
125
|
+
| SliderTooltip | `ui5-slider-tooltip` | `@ui5/webcomponents/dist/SliderTooltip.js` | |
|
|
126
|
+
| SpecialCalendarDate | `ui5-special-date` | `@ui5/webcomponents/dist/SpecialCalendarDate.js` | The ui5-special-date component defines a special calendar date to be used inside ui5-calendar, which is visually distinguished from the rest of the dates. |
|
|
127
|
+
| SplitButton | `ui5-split-button` | `@ui5/webcomponents/dist/SplitButton.js` | ui5-split-button enables users to trigger actions. It is constructed of two separate actions - default action and arrow action that can be activated by clicking or tapping, or by pressing certain keyboard keys - Space or Enter for default… |
|
|
128
|
+
| StepInput | `ui5-step-input` | `@ui5/webcomponents/dist/StepInput.js` | The ui5-step-input consists of an input field and buttons with icons to increase/decrease the value with the predefined step. |
|
|
129
|
+
| SuggestionItem | `ui5-suggestion-item` | `@ui5/webcomponents/dist/SuggestionItem.js` | The ui5-suggestion-item represents the suggestion item of the ui5-input. |
|
|
130
|
+
| SuggestionItemCustom | `ui5-suggestion-item-custom` | `@ui5/webcomponents/dist/SuggestionItemCustom.js` | The ui5-suggestion-item-custom is type of suggestion item, that can be used to place suggestion items with custom content in the input. The text property is considered only for autocomplete. In case the user needs highlighting… |
|
|
131
|
+
| SuggestionItemGroup | `ui5-suggestion-item-group` | `@ui5/webcomponents/dist/SuggestionItemGroup.js` | The ui5-suggestion-item-group is type of suggestion item, that can be used to split the ui5-input suggestions into groups. |
|
|
132
|
+
| Switch | `ui5-switch` | `@ui5/webcomponents/dist/Switch.js` | The ui5-switch component is used for changing between binary states. |
|
|
133
|
+
| Tab | `ui5-tab` | `@ui5/webcomponents/dist/Tab.js` | The ui5-tab represents a selectable item inside a ui5-tabcontainer. It defines both the item in the tab strip (top part of the ui5-tabcontainer) and the content that is presented to the user once the tab is selected. |
|
|
134
|
+
| TabSeparator | `ui5-tab-separator` | `@ui5/webcomponents/dist/TabSeparator.js` | The ui5-tab-separator represents a vertical line to separate tabs inside a ui5-tabcontainer. |
|
|
135
|
+
| TabContainer | `ui5-tabcontainer` | `@ui5/webcomponents/dist/TabContainer.js` | The ui5-tabcontainer represents a collection of tabs with associated content. Navigation through the tabs changes the content display of the currently active content area. A tab can be labeled with text only, or icons with text. |
|
|
136
|
+
| Table | `ui5-table` | `@ui5/webcomponents/dist/Table.js` | The ui5-table component provides a set of sophisticated features for displaying and dealing with vast amounts of data in a responsive manner. To render the ui5-table, you need to define the columns and rows. You can use the provided… |
|
|
137
|
+
| TableCell | `ui5-table-cell` | `@ui5/webcomponents/dist/TableCell.js` | The ui5-table-cell represents a cell inside of a ui5-table. It is tightly coupled to the ui5-table and thus should only be used in the table component. |
|
|
138
|
+
| TableGroupRow | `ui5-table-group-row` | `@ui5/webcomponents/dist/TableGroupRow.js` | The ui5-table-group-row component represents a group header row in the ui5-table. It is used to visually group rows and spans across all visible table columns. |
|
|
139
|
+
| TableGrowing | `ui5-table-growing` | `@ui5/webcomponents/dist/TableGrowing.js` | The ui5-table-growing component is used inside the ui5-table to add a growing/data loading functionalities to the table. |
|
|
140
|
+
| TableHeaderCell | `ui5-table-header-cell` | `@ui5/webcomponents/dist/TableHeaderCell.js` | The ui5-table-header-cell component represents a column in the ui5-table. |
|
|
141
|
+
| TableHeaderCellActionAI | `ui5-table-header-cell-action-ai` | `@ui5/webcomponents/dist/TableHeaderCellActionAI.js` | The ui5-table-header-cell-action-ai component defines a dedicated AI action for the table column. |
|
|
142
|
+
| TableHeaderRow | `ui5-table-header-row` | `@ui5/webcomponents/dist/TableHeaderRow.js` | The ui5-table-header-row component represents the table headers of a ui5-table. |
|
|
143
|
+
| TableRow | `ui5-table-row` | `@ui5/webcomponents/dist/TableRow.js` | The ui5-table-row component represents a row in the ui5-table. |
|
|
144
|
+
| TableRowAction | `ui5-table-row-action` | `@ui5/webcomponents/dist/TableRowAction.js` | The ui5-table-row-action component defines an action for table rows. |
|
|
145
|
+
| TableRowActionNavigation | `ui5-table-row-action-navigation` | `@ui5/webcomponents/dist/TableRowActionNavigation.js` | The ui5-table-row-action-navigation component defines a navigation action for table rows. |
|
|
146
|
+
| TableSelection | `ui5-table-selection` | `@ui5/webcomponents/dist/TableSelection.js` | The ui5-table-selection component is used inside the ui5-table to add key-based selection capabilities to the ui5-table. Deprecated; check the manifest for migration guidance. |
|
|
147
|
+
| TableSelectionMulti | `ui5-table-selection-multi` | `@ui5/webcomponents/dist/TableSelectionMulti.js` | The ui5-table-selection-multi component is used inside the ui5-table to add multi-selection capabilities to the ui5-table. Since selection is key-based, each ui5-table-row must define a unique row-key property. |
|
|
148
|
+
| TableSelectionSingle | `ui5-table-selection-single` | `@ui5/webcomponents/dist/TableSelectionSingle.js` | The ui5-table-selection-single component is used inside the ui5-table to add single selection capabilities to the ui5-table. Since selection is key-based, each ui5-table-row must define a unique row-key property. |
|
|
149
|
+
| TableVirtualizer | `ui5-table-virtualizer` | `@ui5/webcomponents/dist/TableVirtualizer.js` | The ui5-table-virtualizer component is used inside the ui5-table to virtualize the table rows, if the overflowMode property of the table is set to 'Scroll'. It is responsible for rendering only the rows that are visible in the viewport and… |
|
|
150
|
+
| Tag | `ui5-tag` | `@ui5/webcomponents/dist/Tag.js` | The ui5-tag is a component which serves the purpose to attract the user attention to some piece of information (state, quantity, condition, etc.). It can contain icon and text information, and its design can be chosen from specific design… |
|
|
151
|
+
| Text | `ui5-text` | `@ui5/webcomponents/dist/Text.js` | The ui5-text component displays text that can be used in any content area of an application. |
|
|
152
|
+
| TextArea | `ui5-textarea` | `@ui5/webcomponents/dist/TextArea.js` | The ui5-textarea component is used to enter multiple rows of text. |
|
|
153
|
+
| TimePicker | `ui5-time-picker` | `@ui5/webcomponents/dist/TimePicker.js` | The ui5-time-picker component provides an input field with assigned clocks which are opened on user action. The ui5-time-picker allows users to select a localized time using touch, mouse, or keyboard input. It consists of two parts: the… |
|
|
154
|
+
| TimePickerClock | `ui5-time-picker-clock` | `@ui5/webcomponents/dist/TimePickerClock.js` | ui5-time-picker-clock allows selecting of hours,minutes or seconds (depending on property set). The component supports interactions with mouse, touch and mouse wheel. The step for displaying or selecting of items can be configured. |
|
|
155
|
+
| TimeSelectionClocks | `ui5-time-selection-clocks` | `@ui5/webcomponents/dist/TimeSelectionClocks.js` | ui5-time-selection-clocks is component that contains all the ui5-time-picker-clock components necessary for the ui5-time-picker as well as all necessary ui5-toggle-spin-button components used for switching between different clocks.… |
|
|
156
|
+
| TimeSelectionInputs | `ui5-time-selection-inputs` | `@ui5/webcomponents/dist/TimeSelectionInputs.js` | ui5-time-selection-inputs displays a popover with ui5-input components of type="number" and an optional a AM/PM ui5-segmented-button according to the display format given to the ui5-time-picker. Using of numeric input components enables… |
|
|
157
|
+
| Title | `ui5-title` | `@ui5/webcomponents/dist/Title.js` | The ui5-title component is used to display titles inside a page. It is a simple, large-sized text with explicit header/title semantics. |
|
|
158
|
+
| Toast | `ui5-toast` | `@ui5/webcomponents/dist/Toast.js` | The ui5-toast is a small, non-disruptive popup for success or information messages that disappears automatically after a few seconds. |
|
|
159
|
+
| ToggleButton | `ui5-toggle-button` | `@ui5/webcomponents/dist/ToggleButton.js` | The ui5-toggle-button component is an enhanced ui5-button that can be toggled between pressed and normal states. Users can use the ui5-toggle-button as a switch to turn a setting on or off. It can also be used to represent an independent… |
|
|
160
|
+
| ToggleSpinButton | `ui5-toggle-spin-button` | `@ui5/webcomponents/dist/ToggleSpinButton.js` | ui5-toggle-spin-button is explicitly used in the new design of ui5-time-picker. It extends ui5-toggle-button with some specific accessibility-related properties in order to have spin button look and feel from accessibility point of view.… |
|
|
161
|
+
| Token | `ui5-token` | `@ui5/webcomponents/dist/Token.js` | Tokens are small items of information (similar to tags) that mainly serve to visualize previously selected items. |
|
|
162
|
+
| Tokenizer | `ui5-tokenizer` | `@ui5/webcomponents/dist/Tokenizer.js` | A ui5-tokenizer is an invisible container for ui5-tokens that supports keyboard navigation and token selection. |
|
|
163
|
+
| Toolbar | `ui5-toolbar` | `@ui5/webcomponents/dist/Toolbar.js` | The ui5-toolbar component is used to create a horizontal layout with items. The items can be overflowing in a popover, when the space is not enough to show all of them. |
|
|
164
|
+
| ToolbarButton | `ui5-toolbar-button` | `@ui5/webcomponents/dist/ToolbarButton.js` | The ui5-toolbar-button represents an abstract action, used in the ui5-toolbar. |
|
|
165
|
+
| ToolbarItem | `ui5-toolbar-item` | `@ui5/webcomponents/dist/ToolbarItem.js` | The ui5-toolbar-item is a wrapper component used to integrate UI5 Web Components into the ui5-toolbar. It renders within the toolbar's shadow DOM and manages the lifecycle and overflow behavior of its child component. |
|
|
166
|
+
| ToolbarSelect | `ui5-toolbar-select` | `@ui5/webcomponents/dist/ToolbarSelect.js` | The ui5-toolbar-select component is used to create a toolbar drop-down list. The items inside the ui5-toolbar-select define the available options by using the ui5-toolbar-select-option component. |
|
|
167
|
+
| ToolbarSelectOption | `ui5-toolbar-select-option` | `@ui5/webcomponents/dist/ToolbarSelectOption.js` | The ui5-toolbar-select-option component defines the content of an option in the ui5-toolbar-select. |
|
|
168
|
+
| ToolbarSeparator | `ui5-toolbar-separator` | `@ui5/webcomponents/dist/ToolbarSeparator.js` | The ui5-toolbar-separator is an element, used for visual separation between two elements. It takes no space in calculating toolbar items width. |
|
|
169
|
+
| ToolbarSpacer | `ui5-toolbar-spacer` | `@ui5/webcomponents/dist/ToolbarSpacer.js` | The ui5-toolbar-spacer is an element, used for taking needed space for toolbar items to take 100% width. It takes no space in calculating toolbar items width. |
|
|
170
|
+
| Tree | `ui5-tree` | `@ui5/webcomponents/dist/Tree.js` | The ui5-tree component provides a tree structure for displaying data in a hierarchy. |
|
|
171
|
+
| TreeItem | `ui5-tree-item` | `@ui5/webcomponents/dist/TreeItem.js` | The ui5-tree-item represents a node in a tree structure, shown as a ui5-list. |
|
|
172
|
+
| TreeItemCustom | `ui5-tree-item-custom` | `@ui5/webcomponents/dist/TreeItemCustom.js` | The ui5-tree-item-custom represents a node in a tree structure, shown as a ui5-list. |
|
|
173
|
+
| YearPicker | `ui5-yearpicker` | `@ui5/webcomponents/dist/YearPicker.js` | Displays years which can be selected. |
|
|
174
|
+
| YearRangePicker | `ui5-yearrangepicker` | `@ui5/webcomponents/dist/YearRangePicker.js` | Displays year ranges which help navigate through years faster. |
|
|
175
|
+
|
|
176
|
+
## Discovering this file
|
|
177
|
+
|
|
178
|
+
Package documentation is not automatically loaded by every coding assistant. In your application's agent instructions, point to this installed package's llms.txt and ask the assistant to read it before using these components. Tools can resolve @ui5/webcomponents/llms.txt and read it as text.
|
|
179
|
+
|
|
180
|
+
Generated by @ui5/webcomponents-tools from the installed package metadata and public manifest. This file is a build artifact shipped in npm and ignored by Git. Maintainers: run yarn generateAPI from the repository root to refresh after API changes; edit packages/tools/lib/cem/llms.mjs for usage guidance.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ui5/webcomponents",
|
|
3
|
-
"version": "2.29.0-rc.
|
|
3
|
+
"version": "2.29.0-rc.1",
|
|
4
4
|
"description": "UI5 Web Components: webcomponents.main",
|
|
5
5
|
"ui5": {
|
|
6
6
|
"webComponentsPackage": true
|
|
@@ -23,6 +23,7 @@
|
|
|
23
23
|
"generate": "wc-dev generate",
|
|
24
24
|
"generateCEM": "wc-dev generateAPI.generateCEM",
|
|
25
25
|
"mergeCEM": "wc-dev generateAPI.mergeCEM",
|
|
26
|
+
"generateLLMs": "wc-dev generateAPI.generateLLMs",
|
|
26
27
|
"validateCEM": "wc-dev generateAPI.validateCEM",
|
|
27
28
|
"build": "wc-dev build",
|
|
28
29
|
"bundle": "wc-dev build.bundle",
|
|
@@ -39,12 +40,14 @@
|
|
|
39
40
|
"test:vitest": "yarn vitest run",
|
|
40
41
|
"test:ssr": "node -e \"import('./test/ssr/component-imports.js')\"",
|
|
41
42
|
"create-ui5-element": "wc-create-ui5-element",
|
|
42
|
-
"prepublishOnly": "tsc -b"
|
|
43
|
+
"prepublishOnly": "tsc -b",
|
|
44
|
+
"prepack": "yarn generateLLMs"
|
|
43
45
|
},
|
|
44
46
|
"exports": {
|
|
45
47
|
"./src/*": "./src/*",
|
|
46
48
|
"./dist/*": "./dist/*",
|
|
47
49
|
"./package.json": "./package.json",
|
|
50
|
+
"./llms.txt": "./llms.txt",
|
|
48
51
|
"./bundle.esm.js": "./bundle.esm.js",
|
|
49
52
|
"./bundle.common.js": "./bundle.common.js",
|
|
50
53
|
"./bundle.scoped.esm.js": "./bundle.scoped.esm.js",
|
|
@@ -56,22 +59,22 @@
|
|
|
56
59
|
"directory": "packages/main"
|
|
57
60
|
},
|
|
58
61
|
"dependencies": {
|
|
59
|
-
"@ui5/webcomponents-base": "2.29.0-rc.
|
|
60
|
-
"@ui5/webcomponents-icons": "2.29.0-rc.
|
|
61
|
-
"@ui5/webcomponents-icons-business-suite": "2.29.0-rc.
|
|
62
|
-
"@ui5/webcomponents-icons-tnt": "2.29.0-rc.
|
|
63
|
-
"@ui5/webcomponents-localization": "2.29.0-rc.
|
|
64
|
-
"@ui5/webcomponents-theming": "2.29.0-rc.
|
|
62
|
+
"@ui5/webcomponents-base": "2.29.0-rc.1",
|
|
63
|
+
"@ui5/webcomponents-icons": "2.29.0-rc.1",
|
|
64
|
+
"@ui5/webcomponents-icons-business-suite": "2.29.0-rc.1",
|
|
65
|
+
"@ui5/webcomponents-icons-tnt": "2.29.0-rc.1",
|
|
66
|
+
"@ui5/webcomponents-localization": "2.29.0-rc.1",
|
|
67
|
+
"@ui5/webcomponents-theming": "2.29.0-rc.1"
|
|
65
68
|
},
|
|
66
69
|
"devDependencies": {
|
|
67
70
|
"@custom-elements-manifest/analyzer": "^0.10.10",
|
|
68
71
|
"@ui5/cypress-internal": "0.1.0",
|
|
69
|
-
"@ui5/webcomponents-tools": "2.29.0-rc.
|
|
72
|
+
"@ui5/webcomponents-tools": "2.29.0-rc.1",
|
|
70
73
|
"cypress": "15.18.1",
|
|
71
74
|
"jsdom": "^26.0.0",
|
|
72
75
|
"lit": "^2.0.0",
|
|
73
76
|
"vite": "5.4.21",
|
|
74
77
|
"vitest": "^3.2.7"
|
|
75
78
|
},
|
|
76
|
-
"gitHead": "
|
|
79
|
+
"gitHead": "87edd7e1a7e71ff6b967b6102d5b31ae9c2b8287"
|
|
77
80
|
}
|
package/src/CarouselTemplate.tsx
CHANGED
|
@@ -17,6 +17,7 @@ export default function CarouselTemplate(this: Carousel) {
|
|
|
17
17
|
onMouseOut={this._onmouseout}
|
|
18
18
|
onMouseOver={this._onmouseover}
|
|
19
19
|
onTouchStart={this._ontouchstart}
|
|
20
|
+
onTouchEnd={this._ontouchend}
|
|
20
21
|
onMouseDown={this._onmousedown}
|
|
21
22
|
>
|
|
22
23
|
<div class={this.classes.viewport} part="content">
|
|
@@ -64,7 +65,6 @@ export default function CarouselTemplate(this: Carousel) {
|
|
|
64
65
|
|
|
65
66
|
function arrowBack(this: Carousel) {
|
|
66
67
|
return <Icon name={slimArrowLeft}
|
|
67
|
-
tabindex={-1}
|
|
68
68
|
data-ui5-arrow-back
|
|
69
69
|
title={this.previousPageText}
|
|
70
70
|
mode="Decorative"
|
|
@@ -72,13 +72,12 @@ function arrowBack(this: Carousel) {
|
|
|
72
72
|
"ui5-carousel-navigation-button": true,
|
|
73
73
|
"ui5-carousel-navigation-button--hidden": !this.hasPrev
|
|
74
74
|
}}
|
|
75
|
-
onClick={this.
|
|
75
|
+
onClick={this._onNavButtonClick}
|
|
76
76
|
/>;
|
|
77
77
|
}
|
|
78
78
|
|
|
79
79
|
function arrowForward(this: Carousel) {
|
|
80
80
|
return <Icon name={slimArrowRight}
|
|
81
|
-
tabindex={-1}
|
|
82
81
|
data-ui5-arrow-forward
|
|
83
82
|
title={this.nextPageText}
|
|
84
83
|
mode="Decorative"
|
|
@@ -86,7 +85,7 @@ function arrowForward(this: Carousel) {
|
|
|
86
85
|
"ui5-carousel-navigation-button": true,
|
|
87
86
|
"ui5-carousel-navigation-button--hidden": !this.hasNext
|
|
88
87
|
}}
|
|
89
|
-
onClick={this.
|
|
88
|
+
onClick={this._onNavButtonClick}
|
|
90
89
|
/>;
|
|
91
90
|
}
|
|
92
91
|
|
|
@@ -1,16 +1,23 @@
|
|
|
1
1
|
import ListItemBaseTemplate from "./ListItemBaseTemplate.js";
|
|
2
2
|
import type ComboBoxItem from "./ComboBoxItem.js";
|
|
3
|
+
import generateHighlightedMarkupFirstMatch from "@ui5/webcomponents-base/dist/util/generateHighlightedMarkupFirstMatch.js";
|
|
3
4
|
|
|
4
5
|
export default function ComboBoxItemTemplate(this: ComboBoxItem) {
|
|
5
6
|
return ListItemBaseTemplate.call(this, { listItemContent }, { role: "option" });
|
|
6
7
|
}
|
|
7
8
|
|
|
8
9
|
function listItemContent(this: ComboBoxItem) {
|
|
10
|
+
const text = this.text ?? "";
|
|
11
|
+
const highlightedMarkup = this.markupText ? generateHighlightedMarkupFirstMatch(text, this.markupText) : undefined;
|
|
12
|
+
|
|
9
13
|
return (
|
|
10
14
|
<div part="content" id="content" class="ui5-li-content">
|
|
11
15
|
<div class="ui5-li-text-wrapper">
|
|
12
|
-
{
|
|
13
|
-
|
|
16
|
+
{highlightedMarkup
|
|
17
|
+
? <span part="title" className="ui5-li-title" dangerouslySetInnerHTML={{ __html: highlightedMarkup }}></span>
|
|
18
|
+
: <span part="title" className="ui5-li-title">{text}</span>
|
|
19
|
+
}
|
|
20
|
+
{this.additionalText && <span part="additional-text" class="ui5-li-additional-text">{this.additionalText}</span>}
|
|
14
21
|
</div>
|
|
15
22
|
</div>
|
|
16
23
|
);
|
|
@@ -8,7 +8,6 @@ import Popover from "./Popover.js";
|
|
|
8
8
|
import ResponsivePopover from "./ResponsivePopover.js";
|
|
9
9
|
import BusyIndicator from "./BusyIndicator.js";
|
|
10
10
|
import SuggestionItem from "./SuggestionItem.js";
|
|
11
|
-
import generateHighlightedMarkupFirstMatch from "@ui5/webcomponents-base/dist/util/generateHighlightedMarkupFirstMatch.js";
|
|
12
11
|
import type ComboBox from "./ComboBox.js";
|
|
13
12
|
import { LOADING_DELAY } from "./features/ComboBoxLazyLoading.js";
|
|
14
13
|
|
|
@@ -185,11 +184,11 @@ function dialogHeader(this: ComboBox) {
|
|
|
185
184
|
return item.items
|
|
186
185
|
.filter(nestedItem => !!nestedItem)
|
|
187
186
|
.map(nestedItem =>
|
|
188
|
-
<SuggestionItem text={nestedItem.text} additionalText={nestedItem.additionalText} markupText={
|
|
187
|
+
<SuggestionItem text={nestedItem.text} additionalText={nestedItem.additionalText} markupText={this.filterValue} />
|
|
189
188
|
);
|
|
190
189
|
}
|
|
191
190
|
// For regular items
|
|
192
|
-
return <SuggestionItem text={item.text} additionalText={item.additionalText} markupText={
|
|
191
|
+
return <SuggestionItem text={item.text} additionalText={item.additionalText} markupText={this.filterValue} />;
|
|
193
192
|
})}
|
|
194
193
|
</Input>
|
|
195
194
|
</div>
|
package/src/ListItemTemplate.tsx
CHANGED
|
@@ -1,14 +1,21 @@
|
|
|
1
1
|
import ListItemBaseTemplate from "./ListItemBaseTemplate.js";
|
|
2
2
|
import type SuggestionItem from "./SuggestionItem.js";
|
|
3
|
+
import highlightText from "@ui5/webcomponents-base/dist/util/highlightText.js";
|
|
3
4
|
|
|
4
5
|
export default function SuggestionItemTemplate(this: SuggestionItem) {
|
|
5
6
|
return [ListItemBaseTemplate.call(this, { listItemContent }, { role: "option" })];
|
|
6
7
|
}
|
|
7
8
|
|
|
8
9
|
function listItemContent(this: SuggestionItem) {
|
|
10
|
+
const text = this.text ?? "";
|
|
11
|
+
const highlightedMarkup = this.markupText ? highlightText(text, this.markupText) : undefined;
|
|
12
|
+
|
|
9
13
|
return <div part="content" id="content" class="ui5-li-content">
|
|
10
14
|
<div class="ui5-li-text-wrapper">
|
|
11
|
-
|
|
15
|
+
{highlightedMarkup
|
|
16
|
+
? <span part="title" className="ui5-li-title" dangerouslySetInnerHTML={{ __html: highlightedMarkup }}></span>
|
|
17
|
+
: <span part="title" className="ui5-li-title">{text}</span>
|
|
18
|
+
}
|
|
12
19
|
{this.additionalText &&
|
|
13
20
|
<span part="additional-text" class="ui5-li-additional-text">{this.additionalText}</span>
|
|
14
21
|
}
|
package/src/themes/ListItem.css
CHANGED
|
@@ -1,10 +1,25 @@
|
|
|
1
|
+
:host(:not([hidden])) {
|
|
2
|
+
display: flex;
|
|
3
|
+
}
|
|
4
|
+
|
|
1
5
|
:host {
|
|
2
|
-
height:
|
|
6
|
+
height: auto;
|
|
7
|
+
min-height: var(--_ui5_list_item_dropdown_base_height);
|
|
3
8
|
--_ui5_list_item_title_size: var(--sapFontSize);
|
|
4
9
|
}
|
|
5
10
|
|
|
11
|
+
:host .ui5-li-root {
|
|
12
|
+
height: auto;
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
:host .ui5-li-content {
|
|
16
|
+
padding-block: 0.375rem;
|
|
17
|
+
overflow: visible;
|
|
18
|
+
white-space: normal;
|
|
19
|
+
}
|
|
20
|
+
|
|
6
21
|
:host(:active[actionable]:not([data-moving])),
|
|
7
22
|
:host(:active[actionable][selected]:not([data-moving])) {
|
|
8
23
|
background-color: var(--sapList_Active_Background);
|
|
9
24
|
border-bottom-color: var(--sapList_Active_Background);
|
|
10
|
-
}
|
|
25
|
+
}
|