Skip to content

Commit e5de4db

Browse files
authored
feat: update to UI5 Web Components v2.14.0 (#7726)
1 parent 703dfec commit e5de4db

File tree

39 files changed

+1860
-226
lines changed

39 files changed

+1860
-226
lines changed

.storybook/components/DocsHeader.tsx

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ import {
1616
} from '@ui5/webcomponents-react';
1717
import { clsx } from 'clsx';
1818
import type { ComponentProps } from 'react';
19+
import { Fragment } from 'react';
1920
import { useGetSubComponentsOfModule } from '../utils';
2021
import classes from './DocsHeader.module.css';
2122
import { GitHubLogo } from './GitHub-Mark';
@@ -143,10 +144,10 @@ export const InfoTable = ({
143144
</th>
144145
<td data-import-cell={supportsClipboardApi}>
145146
{subComps.map((subComp) => (
146-
<>
147-
<Import key={subComp} moduleName={subComp} componentId={preparedMeta.componentId} />
147+
<Fragment key={subComp}>
148+
<Import moduleName={subComp} componentId={preparedMeta.componentId} />
148149
<br />
149-
</>
150+
</Fragment>
150151
))}
151152
{supportsClipboardApi && (
152153
<Button

.storybook/custom-element-manifests/fiori.json

Lines changed: 137 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1106,6 +1106,15 @@
11061106
"name": "TntDialog",
11071107
"readonly": true
11081108
},
1109+
{
1110+
"kind": "field",
1111+
"static": true,
1112+
"privacy": "public",
1113+
"description": "\"TntEmptyContentPane\" illustration type.",
1114+
"default": "TntEmptyContentPane",
1115+
"name": "TntEmptyContentPane",
1116+
"readonly": true
1117+
},
11091118
{
11101119
"kind": "field",
11111120
"static": true,
@@ -3697,7 +3706,7 @@
36973706
},
36983707
{
36993708
"name": "default",
3700-
"description": "Defines the component actions.",
3709+
"description": "Defines the component actions.\n\n**Note:** Not displayed when the `design` property is set to `Base`.",
37013710
"_ui5propertyName": "actions",
37023711
"_ui5type": {
37033712
"text": "Array<IButton>",
@@ -5330,6 +5339,17 @@
53305339
"kind": "class",
53315340
"description": "### Overview\nThe `ui5-product-switch-item` web component represents the items displayed in the\n`ui5-product-switch` web component.\n\n**Note:** `ui5-product-switch-item` is not supported when used outside of `ui5-product-switch`.\n\n### Keyboard Handling\nThe `ui5-product-switch` provides advanced keyboard handling.\nWhen focused, the user can use the following keyboard\nshortcuts in order to perform a navigation:\n\n- [Space] / [Enter] or [Return] - Trigger `ui5-click` event\n\n### ES6 Module Import\n`import \"@ui5/webcomponents-fiori/dist/ProductSwitchItem.js\";`",
53325341
"name": "ProductSwitchItem",
5342+
"slots": [
5343+
{
5344+
"name": "image",
5345+
"description": "Defines an image to be displayed instead of the standard icon.\n\n**Note:** The image slot takes precedence over the icon property.\n**Note:** We recommend using non-interactive ui5-avatar with size S, Square shape and Transparent colorScheme for best alignment.",
5346+
"_ui5since": "2.14.0",
5347+
"_ui5type": {
5348+
"text": "Array<HTMLElement>"
5349+
},
5350+
"_ui5privacy": "public"
5351+
}
5352+
],
53335353
"members": [
53345354
{
53355355
"kind": "field",
@@ -6295,6 +6315,87 @@
62956315
}
62966316
]
62976317
},
6318+
{
6319+
"kind": "javascript-module",
6320+
"path": "dist/SearchItemShowMore.js",
6321+
"declarations": [
6322+
{
6323+
"kind": "class",
6324+
"description": "### Overview\n\nA `ui5-search-item-show-more` is a special type of ui5-li that acts as a button to progressively reveal additional (overflow) items within a group.\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-fiori/dist/SearchItemShowMore.js\";`",
6325+
"name": "SearchItemShowMore",
6326+
"members": [
6327+
{
6328+
"kind": "field",
6329+
"name": "itemsToShowCount",
6330+
"type": {
6331+
"text": "number | undefined"
6332+
},
6333+
"description": "Specifies the number of additional items available to show.\nThis value replaces the placeholder (N) in the \"Show more (N)\" text.\nIf not set, the placeholder will remain as (N).",
6334+
"privacy": "public",
6335+
"default": "undefined"
6336+
},
6337+
{
6338+
"kind": "field",
6339+
"name": "selected",
6340+
"type": {
6341+
"text": "boolean"
6342+
},
6343+
"default": "false",
6344+
"description": "Defines whether the show more item is selected.",
6345+
"privacy": "public"
6346+
}
6347+
],
6348+
"attributes": [
6349+
{
6350+
"description": "Specifies the number of additional items available to show.\nThis value replaces the placeholder (N) in the \"Show more (N)\" text.\nIf not set, the placeholder will remain as (N).",
6351+
"name": "items-to-show-count",
6352+
"default": "undefined",
6353+
"fieldName": "itemsToShowCount",
6354+
"type": {
6355+
"text": "number | undefined"
6356+
}
6357+
},
6358+
{
6359+
"description": "Defines whether the show more item is selected.",
6360+
"name": "selected",
6361+
"default": "false",
6362+
"fieldName": "selected",
6363+
"type": {
6364+
"text": "boolean"
6365+
}
6366+
}
6367+
],
6368+
"superclass": {
6369+
"name": "ListItemBase",
6370+
"package": "@ui5/webcomponents",
6371+
"module": "dist/ListItemBase.js"
6372+
},
6373+
"tagName": "ui5-search-item-show-more",
6374+
"customElement": true,
6375+
"_ui5experimental": true,
6376+
"_ui5since": "2.14.0",
6377+
"_ui5privacy": "public"
6378+
}
6379+
],
6380+
"exports": [
6381+
{
6382+
"kind": "js",
6383+
"name": "default",
6384+
"declaration": {
6385+
"name": "SearchItemShowMore",
6386+
"module": "dist/SearchItemShowMore.js"
6387+
}
6388+
},
6389+
{
6390+
"kind": "custom-element-definition",
6391+
"name": "ui5-search-item-show-more",
6392+
"declaration": {
6393+
"name": "SearchItemShowMore",
6394+
"module": "dist/SearchItemShowMore.js"
6395+
}
6396+
}
6397+
]
6398+
},
62986399
{
62996400
"kind": "javascript-module",
63006401
"path": "dist/SearchMessageArea.js",
@@ -6566,12 +6667,12 @@
65666667
"name": "searchField",
65676668
"description": "Defines the `ui5-input`, that will be used as a search field.",
65686669
"_ui5type": {
6569-
"text": "Array<Input>",
6670+
"text": "Array<IShellBarSearchField>",
65706671
"references": [
65716672
{
6572-
"name": "Input",
6573-
"package": "@ui5/webcomponents",
6574-
"module": "dist/Input.js"
6673+
"name": "IShellBarSearchField",
6674+
"package": "@ui5/webcomponents-fiori",
6675+
"module": "dist/ShellBar.js"
65756676
}
65766677
]
65776678
},
@@ -6597,14 +6698,7 @@
65976698
"description": "Define the items displayed in the content area.\n\nUse the `data-hide-order` attribute with numeric value to specify the order of the items to be hidden when the space is not enough.\nLower values will be hidden first.\n\n**Note:** The `content` slot is in an experimental state and is a subject to change.",
65986699
"_ui5since": "2.7.0",
65996700
"_ui5type": {
6600-
"text": "Array<UI5Element>",
6601-
"references": [
6602-
{
6603-
"name": "UI5Element",
6604-
"package": "@ui5/webcomponents-base",
6605-
"module": "dist/UI5Element.js"
6606-
}
6607-
]
6701+
"text": "Array<HTMLElement>"
66086702
},
66096703
"_ui5privacy": "public"
66106704
}
@@ -7001,6 +7095,35 @@
70017095
}
70027096
]
70037097
},
7098+
{
7099+
"name": "search-field-clear",
7100+
"_ui5privacy": "public",
7101+
"type": {
7102+
"text": "CustomEvent<ShellBarSearchFieldClearEventDetail>",
7103+
"references": [
7104+
{
7105+
"name": "ShellBarSearchFieldClearEventDetail",
7106+
"package": "@ui5/webcomponents-fiori",
7107+
"module": "dist/ShellBar.js"
7108+
}
7109+
]
7110+
},
7111+
"description": "Fired, when the search cancel button is activated.\n\n**Note:** You can prevent the default behavior (clearing the search field value) by calling `event.preventDefault()`. The search will still be closed.\n**Note:** The `search-field-clear` event is in an experimental state and is a subject to change.",
7112+
"_ui5Cancelable": true,
7113+
"_ui5allowPreventDefault": true,
7114+
"_ui5Bubbles": true,
7115+
"_ui5since": "2.14.0",
7116+
"_ui5parameters": [
7117+
{
7118+
"type": {
7119+
"text": "HTMLElement"
7120+
},
7121+
"name": "targetRef",
7122+
"_ui5privacy": "public",
7123+
"description": "dom ref of the cancel button element"
7124+
}
7125+
]
7126+
},
70047127
{
70057128
"name": "content-item-visibility-change",
70067129
"_ui5privacy": "public",
@@ -8007,7 +8130,7 @@
80078130
"declarations": [
80088131
{
80098132
"kind": "class",
8010-
"description": "### Overview\n\nThe `SideNavigation` is used as a standard menu in applications.\nIt consists of three containers: header (top-aligned), main navigation section (top-aligned) and the secondary section (bottom-aligned).\n\n - The header is meant for displaying user related information - profile data, avatar, etc.\n - The main navigation section is related to the user’s current work context\n - The secondary section is mostly used to link additional information that may be of interest (legal information, developer communities, external help, contact information and so on).\n\n### Usage\n\nUse the available `ui5-side-navigation-group`, `ui5-side-navigation-item`\nand `ui5-side-navigation-sub-item` components to build your menu.\nThe items can consist of text only or an icon with text. The use or non-use of icons must be consistent for all items on one level.\nYou must not combine entries with and without icons on the same level. We strongly recommend that you do not use icons on the second level.\n\nThe `ui5-side-navigation` component is intended for use within an `ui5-navigation-layout` component.\nWhile it can function independently, it is recommended to use it with\nthe `ui5-navigation-layout` for optimal user experience.\n\n### Keyboard Handling\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`import \"@ui5/webcomponents-base/dist/features/F6Navigation.js\"`\n\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-fiori/dist/SideNavigation.js\"`\n\n`import \"@ui5/webcomponents-fiori/dist/SideNavigationGroup.js\";` (for `ui5-side-navigation-group`)\n\n`import \"@ui5/webcomponents-fiori/dist/SideNavigationItem.js\";` (for `ui5-side-navigation-item`)\n\n`import \"@ui5/webcomponents-fiori/dist/SideNavigationSubItem.js\";` (for `ui5-side-navigation-sub-item`)",
8133+
"description": "### Overview\n\nThe `SideNavigation` is used as a standard menu in applications.\nIt consists of three containers: header (top-aligned), main navigation section (top-aligned) and the secondary section (bottom-aligned).\n\n - The header is meant for displaying user related information - profile data, avatar, etc.\n - The main navigation section is related to the user’s current work context\n - The secondary section is mostly used to link additional information that may be of interest (legal information, developer communities, external help, contact information and so on).\n\n### Usage\n\nUse the available `ui5-side-navigation-group`, `ui5-side-navigation-item`\nand `ui5-side-navigation-sub-item` components to build your menu.\nThe items can consist of text only or an icon with text. The use or non-use of icons must be consistent for all items on one level.\nYou must not combine entries with and without icons on the same level. We strongly recommend that you do not use icons on the second level.\n\nThe `ui5-side-navigation` component is designed to be used within a `ui5-navigation-layout` component to ensure an optimal user experience.\n\nUsing it standalone may not match the intended design and functionality.\nFor example, the side navigation may not exhibit the correct behavior on phones and tablets.\nPadding of the `ui5-shellbar` will not match the padding of the side navigation.\n\n### Keyboard Handling\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`import \"@ui5/webcomponents-base/dist/features/F6Navigation.js\"`\n\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-fiori/dist/SideNavigation.js\"`\n\n`import \"@ui5/webcomponents-fiori/dist/SideNavigationGroup.js\";` (for `ui5-side-navigation-group`)\n\n`import \"@ui5/webcomponents-fiori/dist/SideNavigationItem.js\";` (for `ui5-side-navigation-item`)\n\n`import \"@ui5/webcomponents-fiori/dist/SideNavigationSubItem.js\";` (for `ui5-side-navigation-sub-item`)",
80118134
"name": "SideNavigation",
80128135
"slots": [
80138136
{

0 commit comments

Comments
 (0)