From d48837a0c579f643553cbb24f1757aabd759a277 Mon Sep 17 00:00:00 2001 From: Marcus Notheis Date: Wed, 3 Jul 2024 16:57:07 +0200 Subject: [PATCH 1/9] update deps to ui5 web components 2.0.0 --- codemodConfig.json | 432 ----------------------------------- package.json | 10 +- packages/base/package.json | 2 +- packages/charts/package.json | 4 +- packages/compat/package.json | 2 +- packages/main/package.json | 8 +- yarn.lock | 232 +++++++++++++------ 7 files changed, 169 insertions(+), 521 deletions(-) delete mode 100644 codemodConfig.json diff --git a/codemodConfig.json b/codemodConfig.json deleted file mode 100644 index 0cae25e5611..00000000000 --- a/codemodConfig.json +++ /dev/null @@ -1,432 +0,0 @@ -{ - "components": { - "DONOTUSE_TEMPLATE": { - "newComponent": "", - "changedProps": { - "oldName": "newName" - }, - "removedProps": ["propName"] - }, - "ActionSheet": { - "changedProps": { - "onAfterClose": "onClose", - "onAfterOpen": "onOpen", - "placementType": "placement" - } - }, - "Avatar": {}, - "Badge": { - "newComponent": "Tag" - }, - "Bar": {}, - "BarcodeScannerDialog": {}, - "Breadcrumbs": { - "changedProps": { - "separatorStyle": "separators" - } - }, - "BusyIndicator": {}, - "Button": { - "comment": "new slot endIcon", - "removedProps": ["iconEnd"] - }, - "Calendar": { - "changedProps": { - "onSelectedDatesChange": "onSelectionChange" - } - }, - "CalendarDate": {}, - "CalendarLegend": {}, - "CalendarLegendItem": {}, - "Card": {}, - "CardHeader": { - "changedProps": { - "status": "additionalText" - } - }, - "Carousel": { - "comment": "combine s, m and l into a single string S M L", - "changedProps": { - "itemsPerPageS": "itemsPerPage", - "itemsPerPageM": "itemsPerPage", - "itemsPerPageL": "itemsPerPage", - "pageIndicatorStyle": "pageIndicatorType" - } - }, - "CheckBox": {}, - "ColorPalette": {}, - "ColorPaletteItem": {}, - "ColorPalettePopover": {}, - "ColorPicker": { - "changedProps": { - "color": "value" - } - }, - "CustomListItem": {}, - "DatePicker": {}, - "DateRangePicker": {}, - "DateTimePicker": {}, - "Dialog": { - "changedProps": { - "onAfterClose": "onClose", - "onAfterOpen": "onOpen" - } - }, - "DynamicPage": { - "comment": "TODO: add note for props that can't be migrated", - "changedProps": { - "alwaysShowContentHeader": "headerPinned", - "headerCollapsed": "headerSnapped", - "footer": "footerArea", - "headerContent": "headerArea", - "headerTitle": "titleArea" - }, - "removedProps": ["preserveHeaderStateOnScroll", "showHideHeaderButton"] - }, - "DynamicPageTitle": { - "comment": "TODO: add note for props that can't be migrated & outline oddity about expanded/snappedContent prop", - "changedProps": { - "header": "heading" - }, - "removedProps": [ - "showSubHeaderRight", - "actionsToolbarProps", - "navigationActionsToolbarProps", - "expandedContent", - "snappedContent" - ] - }, - "DynamicSideContent": {}, - "FileUploader": {}, - "FilterItem": {}, - "FilterItemOption": {}, - "Icon": { - "comment": "interactive=true becomes mode=IconMode.Interactive", - "changedProps": { - "interactive": "mode" - }, - "removedProps": ["accessibleRole"] - }, - "IllustratedMessage": { - "changedProps": { - "size": "design" - }, - "removedProps": ["titleLevel"] - }, - "Input": { - "changedProps": { - "onSuggestionItemPreview": "onSelectionChange" - }, - "removedProps": ["onSuggestionItemSelect"] - }, - "Label": {}, - "Link": { - "changedProps": { - "title": "tooltip" - } - }, - "List": { - "changedProps": { - "mode": "selectionMode", - "busy": "loading" - } - }, - "ListItemGroup": {}, - "MediaGallery": {}, - "MediaGalleryItem": {}, - "Menu": { - "changedProps": { - "busy": "loading", - "busyDelay": "loadingDelay", - "onAfterClose": "onClose", - "onAfterOpen": "onOpen" - } - }, - "MenuItem": { - "changedProps": { - "busy": "loading", - "busyDelay": "loadingDelay" - } - }, - "MessageStrip": {}, - "MultiComboBox": { - "changedProps": { - "allowCustomValues": "noValidation" - } - }, - "MultiComboBoxGroupItem": {}, - "MultiComboBoxItem": {}, - "MultiInput": { - "changedProps": { - "onSuggestionItemPreview": "onSelectionChange" - }, - "removedProps": ["onSuggestionItemSelect"] - }, - "NotificationAction": {}, - "NotificationListGroupItem": { - "changedProps": { - "busy": "loading", - "busyDelay": "loadingDelay" - }, - "removedProps": ["actions", "priority", "showClose", "showCounter"] - }, - "NotificationListItem": { - "changedProps": { - "busy": "loading", - "busyDelay": "loadingDelay", - "actions": "menu", - "priority": "importance" - } - }, - "Option": { - "changedProps": { - "title": "tooltip" - }, - "removedProps": ["disabled"] - }, - "Page": { - "comment": "logic for floatingFooter is inverted", - "changedProps": { - "disableScrolling": "noScrolling", - "floatingFooter": "fixedFooter" - }, - "removedProps": ["disabled"] - }, - "Panel": {}, - "Popover": { - "changedProps": { - "placementType": "placement", - "onAfterClose": "onClose", - "onAfterOpen": "onOpen" - }, - "removedProps": ["hideBackdrop"] - }, - "ProductSwitch": {}, - "ProductSwitchItem": {}, - "ProgressIndicator": { - "removedProps": ["disabled"] - }, - "RadioButton": {}, - "RangeSlider": {}, - "RatingIndicator": {}, - "ResponsivePopover": { - "changedProps": { - "placementType": "placement", - "onAfterClose": "onClose", - "onAfterOpen": "onOpen" - }, - "removedProps": ["hideBackdrop"] - }, - "SegmentedButton": { - "changedProps": { - "mode": "selectionMode" - } - }, - "SegmentedButtonItem": { - "changedProps": { - "pressed": "selected" - } - }, - "Select": { - "removedProps": ["menu"] - }, - "SelectDialog": { - "changedProps": { - "mode": "selectionMode", - "onAfterClose": "onClose", - "onAfterOpen": "onOpen" - } - }, - "SelectMenu": {}, - "SelectMenuOption": {}, - "ShellBar": { - "removedProps": ["showCoPilot", "onCoPilotClick"] - }, - "ShellBarItem": {}, - "SideNavigation": {}, - "SideNavigationGroup": { - "changedProps": { - "title": "tooltip" - } - }, - "SideNavigationItem": { - "changedProps": { - "title": "tooltip" - } - }, - "SideNavigationSubItem": { - "changedProps": { - "title": "tooltip" - } - }, - "Slider": {}, - "SortItem": {}, - "SpecialCalendarDate": {}, - "SplitButton": { - "removedProps": ["activeIcon"] - }, - "StandardListItem": {}, - "StepInput": {}, - "SuggestionGroupItem": {}, - "SuggestionItem": {}, - "Switch": {}, - "Tab": { - "changedProps": { - "subTabs": "items" - } - }, - "TabContainer": { - "changedProps": { - "tabsOverflowMode": "overflowMode" - }, - "removedProps": ["fixed", "showOverflow"] - }, - "TabSeparator": {}, - "TextArea": { - "changedProps": { - "growingMaxLines": "growingMaxRows" - } - }, - "TimePicker": {}, - "Timeline": {}, - "TimelineItem": {}, - "Title": {}, - "Toast": { - "changedProps": { - "onAfterClose": "onClose" - } - }, - "ToggleButton": { - "removedProps": ["iconEnd"] - }, - "Token": { - "removedProps": ["disabled"] - }, - "Toolbar": {}, - "ToolbarButton": { - "removedProps": ["iconEnd"] - }, - "ToolbarSelect": {}, - "ToolbarSelectOption": {}, - "ToolbarSeparator": {}, - "ToolbarSpacer": {}, - "Tree": { - "changedProps": { - "mode": "selectionMode" - } - }, - "TreeItem": {}, - "TreeItemCustom": {}, - "UploadCollection": { - "changedProps": { - "mode": "selectionMode" - } - }, - "UploadCollectionItem": {}, - "ViewSettingsDialog": {}, - "Wizard": {}, - "WizardStep": {} - }, - "enums": { - "AvatarColorScheme": "@ui5/webcomponents/dist/types/AvatarColorScheme.js", - "AvatarGroupType": "@ui5/webcomponents/dist/types/AvatarGroupType.js", - "AvatarShape": "@ui5/webcomponents/dist/types/AvatarShape.js", - "AvatarSize": "@ui5/webcomponents/dist/types/AvatarSize.js", - "BadgeDesign": "@ui5/webcomponents/dist/types/TagDesign.js", - "BarDesign": "@ui5/webcomponents/dist/types/BarDesign.js", - "BackgroundDesign": "@ui5/webcomponents/dist/types/BackgroundDesign.js", - "BorderDesign": "@ui5/webcomponents/dist/types/BorderDesign.js", - "BreadcrumbsDesign": "@ui5/webcomponents/dist/types/BreadcrumbsDesign.js", - "BreadcrumbsSeparatorStyle": "@ui5/webcomponents/dist/types/BreadcrumbsSeparator.js", - "BusyIndicatorSize": "@ui5/webcomponents/dist/types/BusyIndicatorSize.js", - "BusyIndicatorTextPlacement": "@ui5/webcomponents/dist/types/BusyIndicatorTextPlacement.js", - "ButtonDesign": "@ui5/webcomponents/dist/types/ButtonDesign.js", - "ButtonType": "@ui5/webcomponents/dist/types/ButtonType.js", - "CalendarLegendItemType": "@ui5/webcomponents/dist/types/CalendarLegendItemType.js", - "CalendarSelection": "@ui5/webcomponents/dist/types/CalendarSelectionMode.js", - "CalendarSelectionMode": "@ui5/webcomponents/dist/types/CalendarSelectionMode.js", - "CalendarType": "@ui5/webcomponents-base/dist/types/CalendarType.js", - "CarouselPageIndicatorStyle": "@ui5/webcomponents/dist/types/CarouselPageIndicatorType.js", - "ComboBoxFilter": "@ui5/webcomponents/dist/types/ComboBoxFilter.js", - "FCLLayout": "@ui5/webcomponents-fiori/dist/types/FCLLayout.js", - "HighlightTypes": "@ui5/webcomponents/dist/types/Highlight.js", - "IconDesign": "@ui5/webcomponents/dist/types/IconDesign.js", - "IllustrationMessageSize": "@ui5/webcomponents-fiori/dist/types/IllustrationMessageSize.js", - "IllustrationMessageType": "@ui5/webcomponents-fiori/dist/types/IllustrationMessageType.js", - "InputType": "@ui5/webcomponents/dist/types/InputType.js", - "LinkDesign": "@ui5/webcomponents/dist/types/LinkDesign.js", - "ListItemType": "@ui5/webcomponents/dist/types/ListItemType.js", - "ListMode": "@ui5/webcomponents/dist/types/ListSelectionMode.js", - "ListGrowingMode": "@ui5/webcomponents/dist/types/ListGrowingMode.js", - "ListSeparators": "@ui5/webcomponents/dist/types/ListSeparators.js", - "MediaGalleryItemLayout": "@ui5/webcomponents-fiori/dist/types/MediaGalleryItemLayout.js", - "MediaGalleryLayout": "@ui5/webcomponents-fiori/dist/types/MediaGalleryLayout.js", - "MediaGalleryMenuHorizontalAlign": "@ui5/webcomponents-fiori/dist/types/MediaGalleryMenuHorizontalAlign.js", - "MediaGalleryMenuVerticalAlign": "@ui5/webcomponents-fiori/dist/types/MediaGalleryMenuVerticalAlign.js", - "MessageStripDesign": "@ui5/webcomponents/dist/types/MessageStripDesign.js", - "Priority": "@ui5/webcomponents/dist/types/Priority.js", - "PageBackgroundDesign": "@ui5/webcomponents-fiori/dist/types/PageBackgroundDesign.js", - "PanelAccessibleRole": "@ui5/webcomponents/dist/types/PanelAccessibleRole.js", - "PopoverHorizontalAlign": "@ui5/webcomponents/dist/types/PopoverHorizontalAlign.js", - "PopoverPlacementType": "@ui5/webcomponents/dist/types/PopoverPlacement.js", - "PopoverPlacement": "@ui5/webcomponents/dist/types/PopoverPlacement.js", - "PopoverVerticalAlign": "@ui5/webcomponents/dist/types/PopoverVerticalAlign.js", - "PopupAccessibleRole": "@ui5/webcomponents/dist/types/PopupAccessibleRole.js", - "SegmentedButtonMode": "@ui5/webcomponents/dist/types/SegmentedButtonSelectionMode.js", - "SemanticColor": "@ui5/webcomponents/dist/types/SemanticColor.js", - "SideContentFallDown": "@ui5/webcomponents-fiori/dist/types/SideContentFallDown.js", - "SideContentPosition": "@ui5/webcomponents-fiori/dist/types/SideContentPosition.js", - "SideContentVisibility": "@ui5/webcomponents-fiori/dist/types/SideContentVisibility.js", - "SwitchDesign": "@ui5/webcomponents/dist/types/SwitchDesign.js", - "TabContainerBackgroundDesign": "@ui5/webcomponents/dist/types/BackgroundDesign.js", - "TabLayout": "@ui5/webcomponents/dist/types/TabLayout.js", - "TabsOverflowMode": "@ui5/webcomponents/dist/types/OverflowMode.js", - "TableColumnPopinDisplay": "@ui5/webcomponents-compat/dist/types/TableColumnPopinDisplay.js", - "TableGrowingMode": "@ui5/webcomponents-compat/dist/types/TableGrowingMode.js", - "TableMode": "@ui5/webcomponents-compat/dist/types/TableMode.js", - "TableRowType": "@ui5/webcomponents-compat/dist/types/TableRowType.js", - "TimelineLayout": "@ui5/webcomponents-fiori/dist/types/TimelineLayout.js", - "TitleLevel": "@ui5/webcomponents/dist/types/TitleLevel.js", - "ToastPlacement": "@ui5/webcomponents/dist/types/ToastPlacement.js", - "ToolbarAlign": "@ui5/webcomponents/dist/types/ToolbarAlign.js", - "ToolbarItemOverflowBehavior": "@ui5/webcomponents/dist/types/ToolbarItemOverflowBehavior.js", - "UploadState": "@ui5/webcomponents-fiori/dist/types/UploadState.js", - "ValueState": "@ui5/webcomponents-base/dist/types/ValueState.js", - "WizardContentLayout": "@ui5/webcomponents-fiori/dist/types/WizardContentLayout.js", - "WrappingType": "@ui5/webcomponents/dist/types/WrappingType.js" - }, - "enumProperties": { - "ValueState": { - "Success": "Positive", - "Warning": "Critical", - "Error": "Negative" - }, - "HighlightTypes": { - "Success": "Positive", - "Warning": "Critical", - "Error": "Negative" - }, - "ListMode": { - "SingleSelectBegin": "SingleStart", - "SingleSelect": "Single", - "MultiSelect": "Multiple", - "SingleSelectEnd": "SingleEnd", - "SingleSelectAuto": "SingleAuto" - }, - "MessageStripDesign": { - "Warning": "Critical" - }, - "PopoverPlacementType": { - "Left": "Start", - "Right": "End" - }, - "PopoverHorizontalAlign": { - "Left": "Start", - "Right": "End" - }, - "SegmentedButtonMode": { - "SingleSelect": "Single", - "MultiSelect": "Multiple" - } - } -} diff --git a/package.json b/package.json index cf2332f5a68..741b556c0f7 100644 --- a/package.json +++ b/package.json @@ -40,10 +40,10 @@ "@storybook/react": "8.0.10", "@storybook/react-vite": "8.0.10", "@storybook/theming": "8.0.10", - "@ui5/webcomponents": "2.0.0-rc.6", - "@ui5/webcomponents-compat": "2.0.0-rc.6", - "@ui5/webcomponents-fiori": "2.0.0-rc.6", - "@ui5/webcomponents-icons": "2.0.0-rc.6", + "@ui5/webcomponents": "2.0.0", + "@ui5/webcomponents-compat": "2.0.0", + "@ui5/webcomponents-fiori": "2.0.0", + "@ui5/webcomponents-icons": "2.0.0", "react": "19.0.0-rc-c21bcd627b-20240624", "react-dom": "19.0.0-rc-c21bcd627b-20240624", "remark-gfm": "^4.0.0", @@ -65,7 +65,7 @@ "@types/use-sync-external-store": "^0.0.6", "@typescript-eslint/eslint-plugin": "^7.0.0", "@typescript-eslint/parser": "^7.0.0", - "@ui5/webcomponents-tools": "2.0.0-rc.6", + "@ui5/webcomponents-tools": "2.0.0", "@vitejs/plugin-react": "^4.2.0", "chromatic": "^11.0.0", "cssnano": "^7.0.0", diff --git a/packages/base/package.json b/packages/base/package.json index ffce2fbce86..db08b55edfc 100644 --- a/packages/base/package.json +++ b/packages/base/package.json @@ -30,7 +30,7 @@ }, "peerDependencies": { "@types/react": "*", - "@ui5/webcomponents-base": "2.0.0-rc.6", + "@ui5/webcomponents-base": "~2.0.0", "react": "^16.14.0 || ^17 || ^18 || ^19" }, "peerDependenciesMeta": { diff --git a/packages/charts/package.json b/packages/charts/package.json index d4d95ed98d2..3fc4d7acee9 100644 --- a/packages/charts/package.json +++ b/packages/charts/package.json @@ -38,8 +38,8 @@ "recharts": "2.12.7" }, "peerDependencies": { - "@ui5/webcomponents-react": "~1.29.0", - "@ui5/webcomponents-react-base": "~1.29.0", + "@ui5/webcomponents-react": "~2.0.0", + "@ui5/webcomponents-react-base": "~2.0.0", "react": "^16.14.0 || ^17 || ^18" }, "publishConfig": { diff --git a/packages/compat/package.json b/packages/compat/package.json index 6518a2be7a5..cf700d41d36 100644 --- a/packages/compat/package.json +++ b/packages/compat/package.json @@ -40,7 +40,7 @@ "peerDependencies": { "@types/react": "*", "@types/react-dom": "*", - "@ui5/webcomponents-compat": "~2.0.0-rc.6", + "@ui5/webcomponents-compat": "~2.0.0", "@ui5/webcomponents-react": "workspace:~", "react": "^16.14.0 || ^17 || ^18 || ^19", "react-dom": "^16.14.0 || ^17 || ^18 || ^19" diff --git a/packages/main/package.json b/packages/main/package.json index 5001b157a95..57dd37b5cc3 100644 --- a/packages/main/package.json +++ b/packages/main/package.json @@ -60,10 +60,10 @@ "peerDependencies": { "@types/react": "*", "@types/react-dom": "*", - "@ui5/webcomponents": "2.0.0-rc.6", - "@ui5/webcomponents-base": "2.0.0-rc.6", - "@ui5/webcomponents-fiori": "2.0.0-rc.6", - "@ui5/webcomponents-icons": "2.0.0-rc.6", + "@ui5/webcomponents": "~2.0.0", + "@ui5/webcomponents-base": "~2.0.0", + "@ui5/webcomponents-fiori": "~2.0.0", + "@ui5/webcomponents-icons": "~2.0.0", "react": "^16.14.0 || ^17 || ^18 || ^19", "react-dom": "^16.14.0 || ^17 || ^18 || ^19" }, diff --git a/yarn.lock b/yarn.lock index 1bca755aa97..d48c8d8d86b 100644 --- a/yarn.lock +++ b/yarn.lock @@ -6519,25 +6519,25 @@ __metadata: languageName: node linkType: hard -"@ui5/webcomponents-base@npm:2.0.0-rc.6": - version: 2.0.0-rc.6 - resolution: "@ui5/webcomponents-base@npm:2.0.0-rc.6" +"@ui5/webcomponents-base@npm:2.0.0": + version: 2.0.0 + resolution: "@ui5/webcomponents-base@npm:2.0.0" dependencies: "@lit-labs/ssr-dom-shim": "npm:^1.1.2" lit-html: "npm:^2.0.1" - checksum: 10c0/c329ea7b9029ec5f93cb4938b7e6cef1a323307dabf9dd222dd7cd67f289119cc4c3754f44af70dc5f503d949d5b1ffbd7ea2c369c5c8fd8fd7348e4c2f2f5ac + checksum: 10c0/7aa342aa5d11099d370a5e65dd3a1f69cdafc5a5a3c9a5077b911f19d3b3d83f32ea17ca6b590610dd9bf6828ef9a63917ab63e9df2abe2e3018c1582c595c13 languageName: node linkType: hard -"@ui5/webcomponents-compat@npm:2.0.0-rc.6": - version: 2.0.0-rc.6 - resolution: "@ui5/webcomponents-compat@npm:2.0.0-rc.6" +"@ui5/webcomponents-compat@npm:2.0.0": + version: 2.0.0 + resolution: "@ui5/webcomponents-compat@npm:2.0.0" dependencies: - "@ui5/webcomponents": "npm:2.0.0-rc.6" - "@ui5/webcomponents-base": "npm:2.0.0-rc.6" - "@ui5/webcomponents-icons": "npm:2.0.0-rc.6" - "@ui5/webcomponents-theming": "npm:2.0.0-rc.6" - checksum: 10c0/53ec6e4916a4bb5f9c8679b496533229fe58371aecccb59d5c04c5c70abbf3612c7c61433571a59d3cf13d430f719d28045f26e7099cb8dcdd4fbeb2ad4931a3 + "@ui5/webcomponents": "npm:2.0.0" + "@ui5/webcomponents-base": "npm:2.0.0" + "@ui5/webcomponents-icons": "npm:2.0.0" + "@ui5/webcomponents-theming": "npm:2.0.0" + checksum: 10c0/1310edd09049f086b73b36a9178be5ed51b6d153f19233ba1e9aed250a33452e59200268285c9f7c55f979f36551f906b18dd2ed13cb47caf37d40b65d0e033a languageName: node linkType: hard @@ -6549,53 +6549,53 @@ __metadata: languageName: unknown linkType: soft -"@ui5/webcomponents-fiori@npm:2.0.0-rc.6": - version: 2.0.0-rc.6 - resolution: "@ui5/webcomponents-fiori@npm:2.0.0-rc.6" +"@ui5/webcomponents-fiori@npm:2.0.0": + version: 2.0.0 + resolution: "@ui5/webcomponents-fiori@npm:2.0.0" dependencies: - "@ui5/webcomponents": "npm:2.0.0-rc.6" - "@ui5/webcomponents-base": "npm:2.0.0-rc.6" - "@ui5/webcomponents-icons": "npm:2.0.0-rc.6" - "@ui5/webcomponents-theming": "npm:2.0.0-rc.6" + "@ui5/webcomponents": "npm:2.0.0" + "@ui5/webcomponents-base": "npm:2.0.0" + "@ui5/webcomponents-icons": "npm:2.0.0" + "@ui5/webcomponents-theming": "npm:2.0.0" "@zxing/library": "npm:^0.17.1" - checksum: 10c0/00b5a8dd9a5ff52ab223be7b2dd477b75fd64a4ab5f0ac99b9855ff735e74a2d6b91ad3530177f63ab45ef8581e6c045a58caaf83f0d73afd53cc86e45ee2c0d + checksum: 10c0/52cd830374670df0f73dd04d2a52594a724e67f43e83ad2fc3e61c562518ccedd9faffb66fd70930491bae6bdd885c1de2f9fd92b3e50275114e580147293e3f languageName: node linkType: hard -"@ui5/webcomponents-icons-business-suite@npm:2.0.0-rc.6": - version: 2.0.0-rc.6 - resolution: "@ui5/webcomponents-icons-business-suite@npm:2.0.0-rc.6" +"@ui5/webcomponents-icons-business-suite@npm:2.0.0": + version: 2.0.0 + resolution: "@ui5/webcomponents-icons-business-suite@npm:2.0.0" dependencies: - "@ui5/webcomponents-base": "npm:2.0.0-rc.6" - checksum: 10c0/4243ff66eed63d09d9dcdf89c603693d18eef9101180a373fe715c2934c046c40d3bee5ddf1a4869b640ed6a1f9f86c5ce840f548920818f514935ebb7b6fa15 + "@ui5/webcomponents-base": "npm:2.0.0" + checksum: 10c0/a9ac5e42a5e80ee51eab437cc73d7c65c19cb635d899bb9885127c64806270c787ff6170ea92d2224a943ae4f10700b151405b14fcb07f3cfc341b4ac1246d75 languageName: node linkType: hard -"@ui5/webcomponents-icons-tnt@npm:2.0.0-rc.6": - version: 2.0.0-rc.6 - resolution: "@ui5/webcomponents-icons-tnt@npm:2.0.0-rc.6" +"@ui5/webcomponents-icons-tnt@npm:2.0.0": + version: 2.0.0 + resolution: "@ui5/webcomponents-icons-tnt@npm:2.0.0" dependencies: - "@ui5/webcomponents-base": "npm:2.0.0-rc.6" - checksum: 10c0/d01aab45a5c5e534a48dce85ae5fbcb93e9c8b09a2b846135dcd420e2f211493e92fe4532736bc1e70375b5192542fcee5792dffdeb21c98f29634a64a821235 + "@ui5/webcomponents-base": "npm:2.0.0" + checksum: 10c0/681f1963bc018c83c2394058356deb482616d3f40c073f2ceecf5f003998666af4294e1907e8470a14e7b99e5e71a84b55cd3514135ae7429b2e020e730abe5d languageName: node linkType: hard -"@ui5/webcomponents-icons@npm:2.0.0-rc.6": - version: 2.0.0-rc.6 - resolution: "@ui5/webcomponents-icons@npm:2.0.0-rc.6" +"@ui5/webcomponents-icons@npm:2.0.0": + version: 2.0.0 + resolution: "@ui5/webcomponents-icons@npm:2.0.0" dependencies: - "@ui5/webcomponents-base": "npm:2.0.0-rc.6" - checksum: 10c0/f8367355e07ac2f69ebbb7aa20c1157ff4188825f1b89d346829c89637dc1c2a7c98fad66745f7f52dc9187cff10d0e3efbb6496036322e246526c75913971dc + "@ui5/webcomponents-base": "npm:2.0.0" + checksum: 10c0/2bf7e60c5116b7f5b3e16498c4fb4bf42b1f02286cfaf39b6f8ddbec6df75510cd7258a1de2d995efe8cd490d0ffdc9971ce6e29bde90764218e0c0249953156 languageName: node linkType: hard -"@ui5/webcomponents-localization@npm:2.0.0-rc.6": - version: 2.0.0-rc.6 - resolution: "@ui5/webcomponents-localization@npm:2.0.0-rc.6" +"@ui5/webcomponents-localization@npm:2.0.0": + version: 2.0.0 + resolution: "@ui5/webcomponents-localization@npm:2.0.0" dependencies: "@types/openui5": "npm:^1.113.0" - "@ui5/webcomponents-base": "npm:2.0.0-rc.6" - checksum: 10c0/b01401bf38bb205ec563df67914c3a72db44f9561dbaa7dcae8352c0e83e920f11b5719806ecd5b7625a89a1a09d8cfc4c8567b74a2d9776651bb0ba9de15038 + "@ui5/webcomponents-base": "npm:2.0.0" + checksum: 10c0/85e26be424638ff5ef1e8eb7788a1786996cef9e5ba66302ecbadaae313b498492f14a41857130cb286dd4bc9afbcca896ecf7ac2ecb56f1d57fba69bb4bc551 languageName: node linkType: hard @@ -6606,7 +6606,7 @@ __metadata: use-sync-external-store: "npm:1.2.2" peerDependencies: "@types/react": "*" - "@ui5/webcomponents-base": 2.0.0-rc.6 + "@ui5/webcomponents-base": ~2.0.0 react: ^16.14.0 || ^17 || ^18 || ^19 peerDependenciesMeta: "@types/react": @@ -6626,8 +6626,8 @@ __metadata: react-content-loader: "npm:7.0.2" recharts: "npm:2.12.7" peerDependencies: - "@ui5/webcomponents-react": ~1.29.0 - "@ui5/webcomponents-react-base": ~1.29.0 + "@ui5/webcomponents-react": ~2.0.0 + "@ui5/webcomponents-react-base": ~2.0.0 react: ^16.14.0 || ^17 || ^18 languageName: unknown linkType: soft @@ -6651,7 +6651,7 @@ __metadata: peerDependencies: "@types/react": "*" "@types/react-dom": "*" - "@ui5/webcomponents-compat": ~2.0.0-rc.6 + "@ui5/webcomponents-compat": ~2.0.0 "@ui5/webcomponents-react": "workspace:~" react: ^16.14.0 || ^17 || ^18 || ^19 react-dom: ^16.14.0 || ^17 || ^18 || ^19 @@ -6678,10 +6678,10 @@ __metadata: peerDependencies: "@types/react": "*" "@types/react-dom": "*" - "@ui5/webcomponents": 2.0.0-rc.6 - "@ui5/webcomponents-base": 2.0.0-rc.6 - "@ui5/webcomponents-fiori": 2.0.0-rc.6 - "@ui5/webcomponents-icons": 2.0.0-rc.6 + "@ui5/webcomponents": ~2.0.0 + "@ui5/webcomponents-base": ~2.0.0 + "@ui5/webcomponents-fiori": ~2.0.0 + "@ui5/webcomponents-icons": ~2.0.0 react: ^16.14.0 || ^17 || ^18 || ^19 react-dom: ^16.14.0 || ^17 || ^18 || ^19 peerDependenciesMeta: @@ -6696,19 +6696,19 @@ __metadata: languageName: unknown linkType: soft -"@ui5/webcomponents-theming@npm:2.0.0-rc.6": - version: 2.0.0-rc.6 - resolution: "@ui5/webcomponents-theming@npm:2.0.0-rc.6" +"@ui5/webcomponents-theming@npm:2.0.0": + version: 2.0.0 + resolution: "@ui5/webcomponents-theming@npm:2.0.0" dependencies: "@sap-theming/theming-base-content": "npm:11.12.0" - "@ui5/webcomponents-base": "npm:2.0.0-rc.6" - checksum: 10c0/fb58df4807a9780add40f8b7cd470507053143d63702894924b0ce8063460a8fc428ced7fce5d50238570270b1885e587e02dbd9cf6f4355fc07a9932ddf8dd9 + "@ui5/webcomponents-base": "npm:2.0.0" + checksum: 10c0/65f6362d7c1c12c71462acf723abb605d29e96b23552f72b15af1a0342a35a7edb36c2a236d1a506cfad1291047cda41d00f7da5b30724787a4a17c6a7a1ea92 languageName: node linkType: hard -"@ui5/webcomponents-tools@npm:2.0.0-rc.6": - version: 2.0.0-rc.6 - resolution: "@ui5/webcomponents-tools@npm:2.0.0-rc.6" +"@ui5/webcomponents-tools@npm:2.0.0": + version: 2.0.0 + resolution: "@ui5/webcomponents-tools@npm:2.0.0" dependencies: "@custom-elements-manifest/analyzer": "npm:^0.8.4" "@typescript-eslint/eslint-plugin": "npm:^6.9.0" @@ -6723,13 +6723,15 @@ __metadata: cem-plugin-vs-code-custom-data-generator: "npm:^1.4.2" chai: "npm:^4.3.4" child_process: "npm:^1.0.2" - chokidar: "npm:^3.5.1" + chokidar: "npm:^3.6.0" chokidar-cli: "npm:^3.0.0" command-line-args: "npm:^5.1.1" comment-parser: "npm:^1.4.0" concurrently: "npm:^6.0.0" cross-env: "npm:^7.0.3" custom-element-jet-brains-integration: "npm:^1.4.4" + cypress: "npm:^13.11.0" + cypress-real-events: "npm:^1.12.0" escodegen: "npm:^2.0.0" eslint: "npm:^7.22.0" eslint-config-airbnb-base: "npm:^14.2.1" @@ -6757,28 +6759,28 @@ __metadata: wdio-chromedriver-service: "npm:^7.3.2" peerDependencies: chromedriver: "*" - typescript: ^4.9.4 + typescript: ^5.2.2 peerDependenciesMeta: typescript: optional: true bin: wc-create-ui5-element: bin/create-ui5-element.js wc-dev: bin/dev.js - checksum: 10c0/a45569a61708d325386744b9b424fcf05bf0fe01886ff00f9bc9944c059ef91971b2b88578b6a13c61662d212820894709855fed5b4058bd29280d28144d02bd + checksum: 10c0/55042bfe57672dbca5f365a29c9283186dc9750d718e1c380b4f13476d11a8c4d3b10b1f6e0594453678d92863abdcdf8898c526e4bb2a20288742f170f0ead9 languageName: node linkType: hard -"@ui5/webcomponents@npm:2.0.0-rc.6": - version: 2.0.0-rc.6 - resolution: "@ui5/webcomponents@npm:2.0.0-rc.6" +"@ui5/webcomponents@npm:2.0.0": + version: 2.0.0 + resolution: "@ui5/webcomponents@npm:2.0.0" dependencies: - "@ui5/webcomponents-base": "npm:2.0.0-rc.6" - "@ui5/webcomponents-icons": "npm:2.0.0-rc.6" - "@ui5/webcomponents-icons-business-suite": "npm:2.0.0-rc.6" - "@ui5/webcomponents-icons-tnt": "npm:2.0.0-rc.6" - "@ui5/webcomponents-localization": "npm:2.0.0-rc.6" - "@ui5/webcomponents-theming": "npm:2.0.0-rc.6" - checksum: 10c0/c355c4adf5b7639b8c8ed41592abff02d9b352e94e4a1411e6aebca9d966b7088aefde15305bf472e5bfe092402191c2b9707fe6e3bc689a1ba276982433ac4a + "@ui5/webcomponents-base": "npm:2.0.0" + "@ui5/webcomponents-icons": "npm:2.0.0" + "@ui5/webcomponents-icons-business-suite": "npm:2.0.0" + "@ui5/webcomponents-icons-tnt": "npm:2.0.0" + "@ui5/webcomponents-localization": "npm:2.0.0" + "@ui5/webcomponents-theming": "npm:2.0.0" + checksum: 10c0/f829a76b5a9a957502a6432811d528735181af961208a7307de57ba901babc29a23a1daef6923f0fb026b4c9d2b3d7f21e1b9b99afa97664679a27ea69595fac languageName: node linkType: hard @@ -8686,7 +8688,7 @@ __metadata: languageName: node linkType: hard -"chokidar@npm:3.5.3, chokidar@npm:^3.0.0, chokidar@npm:^3.3.0, chokidar@npm:^3.4.0, chokidar@npm:^3.5.1, chokidar@npm:^3.5.2, chokidar@npm:^3.5.3": +"chokidar@npm:3.5.3, chokidar@npm:^3.0.0, chokidar@npm:^3.3.0, chokidar@npm:^3.4.0, chokidar@npm:^3.5.2, chokidar@npm:^3.5.3": version: 3.5.3 resolution: "chokidar@npm:3.5.3" dependencies: @@ -8705,6 +8707,25 @@ __metadata: languageName: node linkType: hard +"chokidar@npm:^3.6.0": + version: 3.6.0 + resolution: "chokidar@npm:3.6.0" + dependencies: + anymatch: "npm:~3.1.2" + braces: "npm:~3.0.2" + fsevents: "npm:~2.3.2" + glob-parent: "npm:~5.1.2" + is-binary-path: "npm:~2.1.0" + is-glob: "npm:~4.0.1" + normalize-path: "npm:~3.0.0" + readdirp: "npm:~3.6.0" + dependenciesMeta: + fsevents: + optional: true + checksum: 10c0/8361dcd013f2ddbe260eacb1f3cb2f2c6f2b0ad118708a343a5ed8158941a39cb8fb1d272e0f389712e74ee90ce8ba864eece9e0e62b9705cb468a2f6d917462 + languageName: node + linkType: hard + "chownr@npm:^1.1.1": version: 1.1.4 resolution: "chownr@npm:1.1.4" @@ -9618,7 +9639,7 @@ __metadata: languageName: node linkType: hard -"cypress-real-events@npm:^1.8.1": +"cypress-real-events@npm:^1.12.0, cypress-real-events@npm:^1.8.1": version: 1.13.0 resolution: "cypress-real-events@npm:1.13.0" peerDependencies: @@ -9679,6 +9700,58 @@ __metadata: languageName: node linkType: hard +"cypress@npm:^13.11.0": + version: 13.13.0 + resolution: "cypress@npm:13.13.0" + dependencies: + "@cypress/request": "npm:^3.0.0" + "@cypress/xvfb": "npm:^1.2.4" + "@types/sinonjs__fake-timers": "npm:8.1.1" + "@types/sizzle": "npm:^2.3.2" + arch: "npm:^2.2.0" + blob-util: "npm:^2.0.2" + bluebird: "npm:^3.7.2" + buffer: "npm:^5.7.1" + cachedir: "npm:^2.3.0" + chalk: "npm:^4.1.0" + check-more-types: "npm:^2.24.0" + cli-cursor: "npm:^3.1.0" + cli-table3: "npm:~0.6.1" + commander: "npm:^6.2.1" + common-tags: "npm:^1.8.0" + dayjs: "npm:^1.10.4" + debug: "npm:^4.3.4" + enquirer: "npm:^2.3.6" + eventemitter2: "npm:6.4.7" + execa: "npm:4.1.0" + executable: "npm:^4.1.1" + extract-zip: "npm:2.0.1" + figures: "npm:^3.2.0" + fs-extra: "npm:^9.1.0" + getos: "npm:^3.2.1" + is-ci: "npm:^3.0.1" + is-installed-globally: "npm:~0.4.0" + lazy-ass: "npm:^1.6.0" + listr2: "npm:^3.8.3" + lodash: "npm:^4.17.21" + log-symbols: "npm:^4.0.0" + minimist: "npm:^1.2.8" + ospath: "npm:^1.2.2" + pretty-bytes: "npm:^5.6.0" + process: "npm:^0.11.10" + proxy-from-env: "npm:1.0.0" + request-progress: "npm:^3.0.0" + semver: "npm:^7.5.3" + supports-color: "npm:^8.1.1" + tmp: "npm:~0.2.3" + untildify: "npm:^4.0.0" + yauzl: "npm:^2.10.0" + bin: + cypress: bin/cypress + checksum: 10c0/732533a3d783ca98763643307ec519d8006528c38af98be4e3880583a15bd4bb1ccaf5eed5d68f61ecf4d5f887211fec82b25bb3c0fee959707c87bc7a2684a2 + languageName: node + linkType: hard + "d3-array@npm:2 - 3, d3-array@npm:2.10.0 - 3, d3-array@npm:^3.1.6": version: 3.2.2 resolution: "d3-array@npm:3.2.2" @@ -21815,6 +21888,13 @@ __metadata: languageName: node linkType: hard +"tmp@npm:~0.2.3": + version: 0.2.3 + resolution: "tmp@npm:0.2.3" + checksum: 10c0/3e809d9c2f46817475b452725c2aaa5d11985cf18d32a7a970ff25b568438e2c076c2e8609224feef3b7923fa9749b74428e3e634f6b8e520c534eef2fd24125 + languageName: node + linkType: hard + "to-fast-properties@npm:^2.0.0": version: 2.0.0 resolution: "to-fast-properties@npm:2.0.0" @@ -22394,11 +22474,11 @@ __metadata: "@types/use-sync-external-store": "npm:^0.0.6" "@typescript-eslint/eslint-plugin": "npm:^7.0.0" "@typescript-eslint/parser": "npm:^7.0.0" - "@ui5/webcomponents": "npm:2.0.0-rc.6" - "@ui5/webcomponents-compat": "npm:2.0.0-rc.6" - "@ui5/webcomponents-fiori": "npm:2.0.0-rc.6" - "@ui5/webcomponents-icons": "npm:2.0.0-rc.6" - "@ui5/webcomponents-tools": "npm:2.0.0-rc.6" + "@ui5/webcomponents": "npm:2.0.0" + "@ui5/webcomponents-compat": "npm:2.0.0" + "@ui5/webcomponents-fiori": "npm:2.0.0" + "@ui5/webcomponents-icons": "npm:2.0.0" + "@ui5/webcomponents-tools": "npm:2.0.0" "@vitejs/plugin-react": "npm:^4.2.0" chromatic: "npm:^11.0.0" cssnano: "npm:^7.0.0" From 6374769d9f7a6911ac35930612a4acb8828b9368 Mon Sep 17 00:00:00 2001 From: Marcus Notheis Date: Wed, 3 Jul 2024 17:10:58 +0200 Subject: [PATCH 2/9] update components /1 --- .../custom-element-manifests/fiori.json | 770 ++-- .storybook/custom-element-manifests/main.json | 3516 +++++++++-------- .../codemod/transforms/v2/codemodConfig.json | 28 +- .../compat/src/components/Table/index.tsx | 12 +- .../src/components/TableColumn/index.tsx | 3 +- .../main/src/webComponents/Avatar/index.tsx | 10 +- .../webComponents/BreadcrumbsItem/index.tsx | 5 +- .../src/webComponents/BusyIndicator/index.tsx | 3 +- .../main/src/webComponents/Button/index.tsx | 12 +- .../main/src/webComponents/Calendar/index.tsx | 6 +- .../CalendarLegendItem/index.tsx | 3 +- .../main/src/webComponents/Card/index.tsx | 6 +- .../src/webComponents/CardHeader/index.tsx | 9 +- .../main/src/webComponents/Carousel/index.tsx | 6 +- .../main/src/webComponents/CheckBox/index.tsx | 12 +- .../webComponents/ColorPaletteItem/index.tsx | 4 +- .../ColorPalettePopover/index.tsx | 4 +- .../src/webComponents/ColorPicker/index.tsx | 8 +- .../main/src/webComponents/ComboBox/index.tsx | 12 +- .../src/webComponents/ComboBoxItem/index.tsx | 6 +- .../webComponents/ComboBoxItemGroup/index.tsx | 5 +- .../src/webComponents/DatePicker/index.tsx | 12 +- .../webComponents/DateRangePicker/index.tsx | 14 +- .../webComponents/DateTimePicker/index.tsx | 12 +- .../main/src/webComponents/Dialog/index.tsx | 9 +- .../src/webComponents/FileUploader/index.tsx | 8 +- .../src/webComponents/FilterItem/index.tsx | 6 +- .../webComponents/FilterItemOption/index.tsx | 3 +- .../FlexibleColumnLayout/index.tsx | 31 +- .../main/src/webComponents/Form/index.tsx | 3 +- .../src/webComponents/FormGroup/index.tsx | 3 +- .../main/src/webComponents/Icon/index.tsx | 6 +- .../IllustratedMessage/index.tsx | 15 +- .../main/src/webComponents/Input/index.tsx | 16 +- .../main/src/webComponents/Label/index.tsx | 3 +- .../main/src/webComponents/Link/index.tsx | 23 +- .../main/src/webComponents/List/index.tsx | 22 +- .../webComponents/ListItemCustom/index.tsx | 6 +- .../src/webComponents/ListItemGroup/index.tsx | 6 +- .../webComponents/ListItemStandard/index.tsx | 38 +- .../main/src/webComponents/Menu/index.tsx | 16 +- .../main/src/webComponents/MenuItem/index.tsx | 27 +- .../src/webComponents/MenuSeparator/index.tsx | 32 + .../src/webComponents/MultiComboBox/index.tsx | 12 +- .../webComponents/MultiComboBoxItem/index.tsx | 6 +- .../MultiComboBoxItemGroup/index.tsx | 5 +- .../src/webComponents/MultiInput/index.tsx | 16 +- .../webComponents/NotificationList/index.tsx | 5 +- .../NotificationListGroupItem/index.tsx | 11 +- .../NotificationListItem/index.tsx | 11 +- .../main/src/webComponents/Option/index.tsx | 12 +- .../src/webComponents/OptionCustom/index.tsx | 9 +- .../main/src/webComponents/Panel/index.tsx | 6 +- .../main/src/webComponents/Popover/index.tsx | 9 +- .../webComponents/ProductSwitchItem/index.tsx | 18 +- .../webComponents/ProgressIndicator/index.tsx | 7 +- .../src/webComponents/RadioButton/index.tsx | 12 +- .../src/webComponents/RangeSlider/index.tsx | 6 +- .../webComponents/RatingIndicator/index.tsx | 9 +- .../webComponents/ResponsivePopover/index.tsx | 9 +- .../SegmentedButtonItem/index.tsx | 9 +- .../main/src/webComponents/Select/index.tsx | 9 +- .../main/src/webComponents/ShellBar/index.tsx | 9 +- .../src/webComponents/ShellBarItem/index.tsx | 9 +- .../SideNavigationGroup/index.tsx | 6 +- .../SideNavigationItem/index.tsx | 15 +- .../SideNavigationSubItem/index.tsx | 15 +- .../main/src/webComponents/Slider/index.tsx | 6 +- .../main/src/webComponents/SortItem/index.tsx | 3 +- .../src/webComponents/SplitButton/index.tsx | 3 +- .../src/webComponents/StepInput/index.tsx | 9 +- .../main/src/webComponents/Switch/index.tsx | 18 +- packages/main/src/webComponents/Tab/index.tsx | 9 +- .../main/src/webComponents/TextArea/index.tsx | 12 +- .../src/webComponents/TimePicker/index.tsx | 11 +- .../main/src/webComponents/Timeline/index.tsx | 3 +- .../src/webComponents/TimelineItem/index.tsx | 12 +- .../src/webComponents/ToggleButton/index.tsx | 12 +- .../main/src/webComponents/Token/index.tsx | 3 +- .../main/src/webComponents/Toolbar/index.tsx | 6 +- .../src/webComponents/ToolbarButton/index.tsx | 18 +- .../src/webComponents/ToolbarSelect/index.tsx | 10 +- .../src/webComponents/ToolbarSpacer/index.tsx | 3 +- .../main/src/webComponents/Tree/index.tsx | 17 +- .../main/src/webComponents/TreeItem/index.tsx | 15 +- .../webComponents/TreeItemCustom/index.tsx | 9 +- .../webComponents/UploadCollection/index.tsx | 9 +- .../ViewSettingsDialog/index.tsx | 41 +- .../src/webComponents/WizardStep/index.tsx | 9 +- packages/main/src/webComponents/index.ts | 1 + 90 files changed, 2744 insertions(+), 2481 deletions(-) create mode 100644 packages/main/src/webComponents/MenuSeparator/index.tsx diff --git a/.storybook/custom-element-manifests/fiori.json b/.storybook/custom-element-manifests/fiori.json index e30623781fe..bcdbd0d752b 100644 --- a/.storybook/custom-element-manifests/fiori.json +++ b/.storybook/custom-element-manifests/fiori.json @@ -37,7 +37,7 @@ "kind": "field", "static": true, "privacy": "public", - "description": "\nDesktop: 67 - 33 - -- Start (expanded) and Mid columns are displayed\nTablet: 67 - 33 - -- Start (expanded) and Mid columns are displayed\nPhone: -- 100 -- only the Mid column is displayed\n\nUse to display both a list and a detail page when the user should focus on the list page.", + "description": "\nDesktop: Defaults to 67 - 33 - -- percent widths of columns. Start (expanded) and Mid columns are displayed.\nTablet: Defaults to 67 - 33 - -- percent widths of columns. Start (expanded) and Mid columns are displayed.\nPhone: Fixed -- 100 -- percent widths of columns, only the Mid column is displayed\n\nUse to display both a list and a detail page when the user should focus on the list page.", "default": "TwoColumnsStartExpanded", "name": "TwoColumnsStartExpanded", "readonly": true @@ -46,7 +46,7 @@ "kind": "field", "static": true, "privacy": "public", - "description": "Desktop: 33 - 67 - -- Start and Mid (expanded) columns are displayed\nTablet: 33 - 67 - -- Start and Mid (expanded) columns are displayed\nPhone: -- 100 -- only the Mid column is displayed\n\nUse to display both a list and a detail page when the user should focus on the detail page.", + "description": "Desktop: Defaults to 33 - 67 - -- percent widths of columns. Start and Mid (expanded) columns are displayed\nTablet: Defaults to 33 - 67 - -- percent widths of columns. Start and Mid (expanded) columns are displayed\nPhone: Fixed -- 100 -- percent widths of columns, only the Mid column is displayed\n\nUse to display both a list and a detail page when the user should focus on the detail page.", "default": "TwoColumnsMidExpanded", "name": "TwoColumnsMidExpanded", "readonly": true @@ -55,7 +55,7 @@ "kind": "field", "static": true, "privacy": "public", - "description": "Desktop: 25 - 50 - 25 Start, Mid (expanded) and End columns are displayed\nTablet: 0 - 67 - 33 Mid (expanded) and End columns are displayed, Start is accessible by a layout arrow\nPhone: -- -- 100 only the End column is displayed\n\nUse to display all three pages (list, detail, detail-detail) when the user should focus on the detail.", + "description": "Desktop: Defaults to 25 - 50 - 25 percent widths of columns. Start, Mid (expanded) and End columns are displayed\nTablet: Defaults to 0 - 67 - 33 percent widths of columns. Mid (expanded) and End columns are displayed, Start is accessible by dragging the columns-separator\nPhone: Fixed -- -- 100 percent widths of columns, only the End column is displayed\n\nUse to display all three pages (list, detail, detail-detail) when the user should focus on the detail.", "default": "ThreeColumnsMidExpanded", "name": "ThreeColumnsMidExpanded", "readonly": true @@ -64,7 +64,7 @@ "kind": "field", "static": true, "privacy": "public", - "description": "Desktop: 25 - 25 - 50 Start, Mid and End (expanded) columns are displayed\nTablet: 0 - 33 - 67 Mid and End (expanded) columns are displayed, Start is accessible by layout arrows\nPhone: -- -- 100 (only the End column is displayed)\n\nUse to display all three pages (list, detail, detail-detail) when the user should focus on the detail-detail.", + "description": "Desktop: Defaults to 25 - 25 - 50 percent widths of columns. Start, Mid and End (expanded) columns are displayed\nTablet: Defaults to 0 - 33 - 67 percent widths of columns. Mid and End (expanded) columns are displayed, Start is accessible by dragging the columns-separator\nPhone: Fixed -- -- 100 percent widths of columns (only the End column is displayed)\n\nUse to display all three pages (list, detail, detail-detail) when the user should focus on the detail-detail.", "default": "ThreeColumnsEndExpanded", "name": "ThreeColumnsEndExpanded", "readonly": true @@ -73,7 +73,7 @@ "kind": "field", "static": true, "privacy": "public", - "description": "Desktop: 67 - 33 - 0 Start (expanded) and Mid columns are displayed, End is accessible by layout arrows\nTablet: 67 - 33 - 0 Start (expanded) and Mid columns are displayed, End is accessible by layout arrows\nPhone: -- -- 100 only the End column is displayed\n\nUse to display the list and detail pages when the user should focus on the list.\nThe detail-detail is still loaded and easily accessible with layout arrows.", + "description": "Desktop: Defaults to 67 - 33 - 0 percent widths of columns. Start (expanded) and Mid columns are displayed, End is accessible by dragging the columns-separator\nTablet: Defaults to 67 - 33 - 0 percent widths of columns. Start (expanded) and Mid columns are displayed, End is accessible by dragging the columns-separator\nPhone: Fixed -- -- 100 percent widths of columns, only the End column is displayed\n\nUse to display the list and detail pages when the user should focus on the list.\nThe detail-detail is still loaded and easily accessible by dragging the columns-separator", "default": "ThreeColumnsStartExpandedEndHidden", "name": "ThreeColumnsStartExpandedEndHidden", "readonly": true @@ -82,7 +82,7 @@ "kind": "field", "static": true, "privacy": "public", - "description": "Desktop: 33 - 67 - 0 Start and Mid (expanded) columns are displayed, End is accessible by a layout arrow\nTablet: 33 - 67 - 0 Start and Mid (expanded) columns are displayed, End is accessible by a layout arrow\nPhone: -- -- 100 only the End column is displayed\n\nUse to display the list and detail pages when the user should focus on the detail.\nThe detail-detail is still loaded and easily accessible with a layout arrow.", + "description": "Desktop: Defaults to 33 - 67 - 0 percent widths of columns. Start and Mid (expanded) columns are displayed, End is accessible by dragging the columns-separator\nTablet: Defaults to 33 - 67 - 0 percent widths of columns. Start and Mid (expanded) columns are displayed, End is accessible by dragging the columns-separator\nPhone: Fixed -- -- 100 percent widths of columns, only the End column is displayed\n\nUse to display the list and detail pages when the user should focus on the detail.\nThe detail-detail is still loaded and easily accessible by dragging the columns-separator", "default": "ThreeColumnsMidExpandedEndHidden", "name": "ThreeColumnsMidExpandedEndHidden", "readonly": true @@ -91,7 +91,7 @@ "kind": "field", "static": true, "privacy": "public", - "description": "Desktop: -- 100 -- only the Mid column is displayed\nTablet: -- 100 -- only the Mid column is displayed\nPhone: -- 100 -- only the Mid column is displayed\n\nUse to display a detail page only, when the user should focus entirely on it.", + "description": "Desktop: Fixed -- 100 -- percent widths of columns, only the Mid column is displayed\nTablet: Fixed -- 100 -- percent widths of columns, only the Mid column is displayed\nPhone: Fixed -- 100 -- percent widths of columns, only the Mid column is displayed\n\nUse to display a detail page only, when the user should focus entirely on it.", "default": "MidColumnFullScreen", "name": "MidColumnFullScreen", "readonly": true @@ -100,7 +100,7 @@ "kind": "field", "static": true, "privacy": "public", - "description": "Desktop: -- -- 100 only the End column is displayed\nTablet: -- -- 100 only the End column is displayed\nPhone: -- -- 100 only the End column is displayed\n\nUse to display a detail-detail page only, when the user should focus entirely on it.", + "description": "Desktop: Fixed -- -- 100 percent widths of columns, only the End column is displayed\nTablet: Fixed -- -- 100 percent widths of columns, only the End column is displayed\nPhone: Fixed -- -- 100 percent widths of columns, only the End column is displayed\n\nUse to display a detail-detail page only, when the user should focus entirely on it.", "default": "EndColumnFullScreen", "name": "EndColumnFullScreen", "readonly": true @@ -121,14 +121,14 @@ }, { "kind": "javascript-module", - "path": "dist/types/IllustrationMessageSize.js", + "path": "dist/types/IllustrationMessageDesign.js", "declarations": [ { "kind": "enum", - "name": "IllustrationMessageSize", - "description": "Different types of IllustrationMessageSize.", + "name": "IllustrationMessageDesign", + "description": "Different types of IllustrationMessageDesign.", "_ui5privacy": "public", - "_ui5since": "1.5.0", + "_ui5since": "2.0.0", "members": [ { "kind": "field", @@ -192,8 +192,8 @@ "kind": "js", "name": "default", "declaration": { - "name": "IllustrationMessageSize", - "module": "dist/types/IllustrationMessageSize.js" + "name": "IllustrationMessageDesign", + "module": "dist/types/IllustrationMessageDesign.js" } } ] @@ -1914,9 +1914,9 @@ "type": { "text": "boolean" }, + "default": "false", "description": "Indicates whether the dialog is open.", "privacy": "public", - "default": "false", "_ui5since": "1.24.0", "_ui5validator": "Boolean" } @@ -2108,8 +2108,8 @@ "type": { "text": "boolean" }, - "description": "Defines if the pin button is hidden.", "default": "false", + "description": "Defines if the pin button is hidden.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -2119,8 +2119,8 @@ "type": { "text": "boolean" }, - "description": "Defines if the header is pinned.", "default": "false", + "description": "Defines if the header is pinned.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -2130,8 +2130,8 @@ "type": { "text": "boolean" }, - "description": "Defines if the footer is shown.", "default": "false", + "description": "Defines if the footer is shown.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -2444,8 +2444,8 @@ "type": { "text": "boolean" }, - "description": "Defines the visibility of the main content.", "default": "false", + "description": "Defines the visibility of the main content.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -2455,8 +2455,8 @@ "type": { "text": "boolean" }, - "description": "Defines the visibility of the side content.", "default": "false", + "description": "Defines the visibility of the side content.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -2473,10 +2473,10 @@ } ] }, - "description": "Defines whether the side content is positioned before the main content (left side\nin LTR mode), or after the the main content (right side in LTR mode).", "default": "\"End\"", + "description": "Defines whether the side content is positioned before the main content (left side\nin LTR mode), or after the the main content (right side in LTR mode).", "privacy": "public", - "_ui5validator": "SideContentPosition" + "_ui5validator": "String" }, { "kind": "field", @@ -2491,10 +2491,10 @@ } ] }, - "description": "Defines on which breakpoints the side content is visible.", "default": "\"ShowAboveS\"", + "description": "Defines on which breakpoints the side content is visible.", "privacy": "public", - "_ui5validator": "SideContentVisibility" + "_ui5validator": "String" }, { "kind": "field", @@ -2509,10 +2509,10 @@ } ] }, - "description": "Defines on which breakpoints the side content falls down below the main content.", "default": "\"OnMinimumWidth\"", + "description": "Defines on which breakpoints the side content falls down below the main content.", "privacy": "public", - "_ui5validator": "SideContentFallDown" + "_ui5validator": "String" }, { "kind": "field", @@ -2520,8 +2520,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is in equal split mode. In this mode, the side and\nthe main content take 50:50 percent of the container on all screen sizes\nexcept for phone, where the main and side contents are switching visibility\nusing the toggle method.", "default": "false", + "description": "Defines whether the component is in equal split mode. In this mode, the side and\nthe main content take 50:50 percent of the container on all screen sizes\nexcept for phone, where the main and side contents are switching visibility\nusing the toggle method.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -2563,7 +2563,7 @@ }, { "type": { - "text": "string" + "text": "string | undefined" }, "name": "previousBreakpoint", "_ui5privacy": "public", @@ -2704,10 +2704,10 @@ "kind": "field", "name": "text", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -2715,10 +2715,10 @@ "kind": "field", "name": "additionalText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the additional text of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" } @@ -2727,19 +2727,19 @@ { "description": "Defines the text of the component.", "name": "text", - "default": "\"\"", + "default": "undefined", "fieldName": "text", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the additional text of the component.", "name": "additional-text", - "default": "\"\"", + "default": "undefined", "fieldName": "additionalText", "type": { - "text": "string" + "text": "string | undefined" } } ], @@ -2787,10 +2787,10 @@ "kind": "field", "name": "text", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -2800,8 +2800,8 @@ "type": { "text": "boolean" }, - "description": "Defines if the component is selected.", "default": "false", + "description": "Defines if the component is selected.", "privacy": "public", "_ui5validator": "Boolean" } @@ -2810,10 +2810,10 @@ { "description": "Defines the text of the component.", "name": "text", - "default": "\"\"", + "default": "undefined", "fieldName": "text", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -2863,7 +2863,7 @@ "declarations": [ { "kind": "class", - "description": "### Overview\n\nThe `FlexibleColumnLayout` implements the list-detail-detail paradigm by displaying up to three pages in separate columns.\nThere are several possible layouts that can be changed either with the component API, or by pressing the arrows, displayed between the columns.\n\n### Usage\n\nUse this component for applications that need to display several logical levels of related information side by side (e.g. list of items, item, sub-item, etc.).\nThe Component is flexible in a sense that the application can focus the user's attention on one particular column.\n\n### Responsive Behavior\n\nThe `FlexibleColumnLayout` automatically displays the maximum possible number of columns based on `layout` property and the window size.\nThe component would display 1 column for window size smaller than 599px, up to two columns between 599px and 1023px,\nand 3 columns for sizes bigger than 1023px.\n\n### Keyboard Handling\n\n#### Basic Navigation\n\n- [Space] / [Enter] or [Return] - If focus is on the layout toggle button (arrow button), once activated, it triggers the associated action (such as expand/collapse the column).\n- This 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#### 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### ES6 Module Import\n\n`import \"@ui5/webcomponents-fiori/dist/FlexibleColumnLayout.js\";`", + "description": "### Overview\n\nThe `FlexibleColumnLayout` implements the list-detail-detail paradigm by displaying up to three pages in separate columns.\nThere are several possible layouts that can be changed either with the component API, or by dragging the column separators.\n\n### Usage\n\nUse this component for applications that need to display several logical levels of related information side by side (e.g. list of items, item, sub-item, etc.).\nThe Component is flexible in a sense that the application can focus the user's attention on one particular column.\n\n### Responsive Behavior\n\nThe `FlexibleColumnLayout` automatically displays the maximum possible number of columns based on `layout` property and the window size.\nThe component would display 1 column for window size smaller than 599px, up to two columns between 599px and 1023px,\nand 3 columns for sizes bigger than 1023px.\n\n**Note:** When the component displays more than one column, the minimal width of each column is 312px. Consequently, when the user drags a column separator to resize the columns, the minimal allowed width of any resized column is 312px.\n\n### Keyboard Handling\n\n#### Basic Navigation\n\nWhen a column separator is focused, the following keyboard\nshortcuts allow the user to resize the columns and change the layout:\n\n- [Shift] + [Left] or [Shift] + [Right] - Moves the separator to the left or right, which resizes the columns accordingly.\n- [Left] or [Right] - Moves the separator to the left or right with a bigger step, which resizes the columns accordingly.\n- [Home] - Moves the separator to the start position.\n- [End] - Moves the separator to the end position.\n- This 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#### 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### ES6 Module Import\n\n`import \"@ui5/webcomponents-fiori/dist/FlexibleColumnLayout.js\";`", "name": "FlexibleColumnLayout", "slots": [ { @@ -2905,21 +2905,21 @@ } ] }, - "description": "Defines the columns layout and their proportion.\n\n**Note:** The layout also depends on the screen size - one column for screens smaller than 599px,\ntwo columns between 599px and 1023px and three columns for sizes bigger than 1023px.\n\n**For example:** layout=`TwoColumnsStartExpanded` means the layout will display up to two columns\nin 67%/33% proportion.", "default": "\"OneColumn\"", + "description": "Defines the columns layout and their proportion.\n\n**Note:** The layout also depends on the screen size - one column for screens smaller than 599px,\ntwo columns between 599px and 1023px and three columns for sizes bigger than 1023px.\n\n**For example:** layout=`TwoColumnsStartExpanded` means the layout will display up to two columns\nin 67%/33% proportion.", "privacy": "public", - "_ui5validator": "FCLLayout" + "_ui5validator": "String" }, { "kind": "field", - "name": "hideArrows", + "name": "disableResizing", "type": { "text": "boolean" }, - "description": "Defines the visibility of the arrows,\nused for expanding and shrinking the columns.", "default": "false", + "description": "Specifies if the user is allowed to change the columns layout by dragging the separator between the columns.", "privacy": "public", - "_ui5since": "1.0.0-rc.15", + "_ui5since": "2.0.0", "_ui5validator": "Boolean" }, { @@ -2935,8 +2935,8 @@ } ] }, - "description": "Defines additional accessibility attributes on different areas of the component.\n\nThe accessibilityAttributes object has the following fields,\nwhere each field is an object supporting one or more accessibility attributes:\n\n - **startColumn**: `startColumn.role` and `startColumn.name`.\n - **midColumn**: `midColumn.role` and `midColumn.name`.\n - **endColumn**: `endColumn.role` and `endColumn.name`.\n - **startArrowContainer**: `startArrowContainer.role` and `startArrowContainer.name`.\n - **endArrowContainer**: `endArrowContainerrole.role` and `endArrowContainer.name`.\n - **startArrowLeft**: `startArrowLeft.name`.\n - **startArrowRight**: `startArrowRight.name`.\n - **endArrowLeft**: `endArrowLeft.name`.\n - **endArrowRight**: `endArrowRight.name`.\n\nThe accessibility attributes support the following values:\n\n- **role**: Defines the accessible ARIA landmark role of the area.\nAccepts the following values: `none`, `complementary`, `contentinfo`, `main` or `region`.\n\n- **name**: Defines the accessible ARIA name of the area.\nAccepts any string.", "default": "{}", + "description": "Defines additional accessibility attributes on different areas of the component.\n\nThe accessibilityAttributes object has the following fields,\nwhere each field is an object supporting one or more accessibility attributes:\n\n - **startColumn**: `startColumn.role` and `startColumn.name`.\n - **midColumn**: `midColumn.role` and `midColumn.name`.\n - **endColumn**: `endColumn.role` and `endColumn.name`.\n - **startSeparator**: `startSeparator.role` and `startSeparator.name`.\n - **endSeparator**: `endSeparator.role` and `endSeparator.name`.\n\nThe accessibility attributes support the following values:\n\n- **role**: Defines the accessible ARIA landmark role of the area.\nAccepts the following values: `none`, `complementary`, `contentinfo`, `main` or `region`.\n\n- **name**: Defines the accessible ARIA name of the area.\nAccepts any string.", "privacy": "public", "_ui5since": "2.0.0", "_ui5validator": "Object" @@ -3018,7 +3018,7 @@ } ] }, - "description": "Fired when the layout changes via user interaction by clicking the arrows\nor by changing the component size due to resizing.", + "description": "Fired when the layout changes via user interaction by dragging the separators\nor by changing the component size due to resizing.", "_ui5parameters": [ { "type": { @@ -3071,17 +3071,17 @@ "type": { "text": "boolean" }, - "name": "arrowsUsed", + "name": "separatorsUsed", "_ui5privacy": "public", - "description": "Indicates if the layout is changed via the arrows" + "description": "Indicates if the layout was changed by dragging the column separators" }, { "type": { "text": "boolean" }, - "name": "resize", + "name": "resized", "_ui5privacy": "public", - "description": "Indicates if the layout is changed via resizing" + "description": "Indicates if the layout was changed by resizing the entire component" } ] } @@ -3097,10 +3097,10 @@ } }, { - "description": "Defines the visibility of the arrows,\nused for expanding and shrinking the columns.", - "name": "hide-arrows", + "description": "Specifies if the user is allowed to change the columns layout by dragging the separator between the columns.", + "name": "disable-resizing", "default": "false", - "fieldName": "hideArrows", + "fieldName": "disableResizing", "type": { "text": "boolean" } @@ -3238,8 +3238,8 @@ "type": { "text": "string" }, - "description": "Defines the illustration name that will be displayed in the component.\n\nExample:\n\n`name='BeforeSearch'`, `name='UnableToUpload'`, etc..\n\n**Note:** To use the TNT illustrations,\nyou need to set the `tnt` or `Tnt` prefix in front of the icon's name.\n\nExample:\n\n`name='tnt/Avatar'` or `name='TntAvatar'`.\n\n**Note:** By default the `BeforeSearch` illustration is loaded.\nWhen using an illustration type, other than the default, it should be loaded in addition:\n\n`import \"@ui5/webcomponents-fiori/dist/illustrations/NoData.js\";`\n\nFor TNT illustrations:\n\n`import \"@ui5/webcomponents-fiori/dist/illustrations/tnt/SessionExpired.js\";`", "default": "\"BeforeSearch\"", + "description": "Defines the illustration name that will be displayed in the component.\n\nExample:\n\n`name='BeforeSearch'`, `name='UnableToUpload'`, etc..\n\n**Note:** To use the TNT illustrations,\nyou need to set the `tnt` or `Tnt` prefix in front of the icon's name.\n\nExample:\n\n`name='tnt/Avatar'` or `name='TntAvatar'`.\n\n**Note:** By default the `BeforeSearch` illustration is loaded.\nWhen using an illustration type, other than the default, it should be loaded in addition:\n\n`import \"@ui5/webcomponents-fiori/dist/illustrations/NoData.js\";`\n\nFor TNT illustrations:\n\n`import \"@ui5/webcomponents-fiori/dist/illustrations/tnt/SessionExpired.js\";`", "privacy": "public", "_ui5validator": "String" }, @@ -3247,29 +3247,29 @@ "kind": "field", "name": "design", "type": { - "text": "IllustrationMessageSize", + "text": "IllustrationMessageDesign", "references": [ { - "name": "IllustrationMessageSize", + "name": "IllustrationMessageDesign", "package": "@ui5/webcomponents-fiori", - "module": "dist/types/IllustrationMessageSize.js" + "module": "dist/types/IllustrationMessageDesign.js" } ] }, - "description": "Determines which illustration breakpoint variant is used.\n\nAs `IllustratedMessage` adapts itself around the `Illustration`, the other\nelements of the component are displayed differently on the different breakpoints/illustration designs.", "default": "\"Auto\"", + "description": "Determines which illustration breakpoint variant is used.\n\nAs `IllustratedMessage` adapts itself around the `Illustration`, the other\nelements of the component are displayed differently on the different breakpoints/illustration designs.", "privacy": "public", - "_ui5since": "1.5.0", - "_ui5validator": "IllustrationMessageSize" + "_ui5since": "2.0.0", + "_ui5validator": "String" }, { "kind": "field", "name": "subtitleText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the subtitle of the component.\n\n**Note:** Using this property, the default subtitle text of illustration will be overwritten.\n\n**Note:** Using `subtitle` slot, the default of this property will be overwritten.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -3277,10 +3277,10 @@ "kind": "field", "name": "titleText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the title of the component.\n\n**Note:** Using this property, the default title text of illustration will be overwritten.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -3288,10 +3288,10 @@ "kind": "field", "name": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Receives id(or many ids) of the elements that label the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.7.0", "_ui5validator": "String" @@ -3319,28 +3319,28 @@ { "description": "Defines the subtitle of the component.\n\n**Note:** Using this property, the default subtitle text of illustration will be overwritten.\n\n**Note:** Using `subtitle` slot, the default of this property will be overwritten.", "name": "subtitle-text", - "default": "\"\"", + "default": "undefined", "fieldName": "subtitleText", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the title of the component.\n\n**Note:** Using this property, the default title text of illustration will be overwritten.", "name": "title-text", - "default": "\"\"", + "default": "undefined", "fieldName": "titleText", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Receives id(or many ids) of the elements that label the component.", "name": "accessible-name-ref", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" } } ], @@ -3413,8 +3413,8 @@ "type": { "text": "boolean" }, - "description": "If set to `true`, all thumbnails are rendered in a scrollable container.\nIf `false`, only up to five thumbnails are rendered, followed by\nan overflow button that shows the count of the remaining thumbnails.", "default": "false", + "description": "If set to `true`, all thumbnails are rendered in a scrollable container.\nIf `false`, only up to five thumbnails are rendered, followed by\nan overflow button that shows the count of the remaining thumbnails.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -3424,8 +3424,8 @@ "type": { "text": "boolean" }, - "description": "If enabled, a `display-area-click` event is fired\nwhen the user clicks or taps on the display area.\n\nThe display area is the central area that contains\nthe enlarged content of the currently selected item.", "default": "false", + "description": "If enabled, a `display-area-click` event is fired\nwhen the user clicks or taps on the display area.\n\nThe display area is the central area that contains\nthe enlarged content of the currently selected item.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -3442,10 +3442,10 @@ } ] }, - "description": "Determines the layout of the component.", "default": "\"Auto\"", + "description": "Determines the layout of the component.", "privacy": "public", - "_ui5validator": "MediaGalleryLayout" + "_ui5validator": "String" }, { "kind": "field", @@ -3460,10 +3460,10 @@ } ] }, - "description": "Determines the horizontal alignment of the thumbnails menu\nvs. the central display area.", "default": "\"Left\"", + "description": "Determines the horizontal alignment of the thumbnails menu\nvs. the central display area.", "privacy": "public", - "_ui5validator": "MediaGalleryMenuHorizontalAlign" + "_ui5validator": "String" }, { "kind": "field", @@ -3478,10 +3478,10 @@ } ] }, - "description": "Determines the vertical alignment of the thumbnails menu\nvs. the central display area.", "default": "\"Bottom\"", + "description": "Determines the vertical alignment of the thumbnails menu\nvs. the central display area.", "privacy": "public", - "_ui5validator": "MediaGalleryMenuVerticalAlign" + "_ui5validator": "String" } ], "events": [ @@ -3638,8 +3638,8 @@ "type": { "text": "boolean" }, - "description": "Defines the selected state of the component.", "default": "false", + "description": "Defines the selected state of the component.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -3649,8 +3649,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is in disabled state.", "default": "false", + "description": "Defines whether the component is in disabled state.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -3667,10 +3667,10 @@ } ] }, - "description": "Determines the layout of the item container.", "default": "\"Square\"", + "description": "Determines the layout of the item container.", "privacy": "public", - "_ui5validator": "MediaGalleryItemLayout" + "_ui5validator": "String" } ], "attributes": [ @@ -3770,10 +3770,10 @@ "kind": "field", "name": "noDataText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text that is displayed when the component contains no items.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" } @@ -3860,10 +3860,10 @@ { "description": "Defines the text that is displayed when the component contains no items.", "name": "no-data-text", - "default": "\"\"", + "default": "undefined", "fieldName": "noDataText", "type": { - "text": "string" + "text": "string | undefined" } } ], @@ -3874,7 +3874,7 @@ }, "tagName": "ui5-notification-list", "customElement": true, - "_ui5since": "2.0", + "_ui5since": "2.0.0", "_ui5privacy": "public" } ], @@ -3930,8 +3930,8 @@ "type": { "text": "boolean" }, - "description": "Defines if the group is collapsed or expanded.", "default": "false", + "description": "Defines if the group is collapsed or expanded.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -3939,10 +3939,10 @@ "kind": "field", "name": "titleText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the `titleText` of the item.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String", "inheritedFrom": { @@ -3956,8 +3956,8 @@ "type": { "text": "boolean" }, - "description": "Defines if the `notification` is new or has been already read.\n\n**Note:** if set to `false` the `titleText` has bold font,\nif set to true - it has a normal font.", "default": "false", + "description": "Defines if the `notification` is new or has been already read.\n\n**Note:** if set to `false` the `titleText` has bold font,\nif set to true - it has a normal font.", "privacy": "public", "_ui5validator": "Boolean", "inheritedFrom": { @@ -3971,8 +3971,8 @@ "type": { "text": "boolean" }, - "description": "Defines if a busy indicator would be displayed over the item.", "default": "false", + "description": "Defines if a busy indicator would be displayed over the item.", "privacy": "public", "_ui5since": "1.0.0-rc.8", "_ui5validator": "Boolean", @@ -3987,25 +3987,14 @@ "type": { "text": "number" }, - "description": "Defines the delay in milliseconds, after which the busy indicator will show up for this component.", "default": "1000", + "description": "Defines the delay in milliseconds, after which the busy indicator will show up for this component.", "privacy": "public", - "_ui5validator": "Integer", + "_ui5validator": "Number", "inheritedFrom": { "name": "NotificationListItemBase", "module": "dist/NotificationListItemBase.js" } - }, - { - "kind": "field", - "name": "selected", - "type": { - "text": "boolean" - }, - "description": "Defines the selected state of the component.", - "default": "false", - "privacy": "public", - "_ui5validator": "Boolean" } ], "events": [ @@ -4152,11 +4141,11 @@ } ] }, - "description": "Defines if the `titleText` and `description` should wrap,\nthey truncate by default.\n\n**Note:** by default the `titleText` and `description`,\nand a `ShowMore/Less` button would be displayed.", "default": "\"None\"", + "description": "Defines if the `titleText` and `description` should wrap,\nthey truncate by default.\n\n**Note:** by default the `titleText` and `description`,\nand a `ShowMore/Less` button would be displayed.", "privacy": "public", "_ui5since": "1.0.0-rc.15", - "_ui5validator": "WrappingType" + "_ui5validator": "String" }, { "kind": "field", @@ -4171,10 +4160,10 @@ } ] }, - "description": "Defines the status indicator of the item.", "default": "\"None\"", + "description": "Defines the status indicator of the item.", "privacy": "public", - "_ui5validator": "ValueState" + "_ui5validator": "String" }, { "kind": "field", @@ -4182,8 +4171,8 @@ "type": { "text": "boolean" }, - "description": "Defines if the `Close` button would be displayed.", "default": "false", + "description": "Defines if the `Close` button would be displayed.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -4200,19 +4189,19 @@ } ] }, - "description": "Defines the `Important` label of the item.", "default": "\"Standard\"", + "description": "Defines the `Important` label of the item.", "privacy": "public", - "_ui5validator": "NotificationListItemImportance" + "_ui5validator": "String" }, { "kind": "field", "name": "titleText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the `titleText` of the item.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String", "inheritedFrom": { @@ -4226,8 +4215,8 @@ "type": { "text": "boolean" }, - "description": "Defines if the `notification` is new or has been already read.\n\n**Note:** if set to `false` the `titleText` has bold font,\nif set to true - it has a normal font.", "default": "false", + "description": "Defines if the `notification` is new or has been already read.\n\n**Note:** if set to `false` the `titleText` has bold font,\nif set to true - it has a normal font.", "privacy": "public", "_ui5validator": "Boolean", "inheritedFrom": { @@ -4241,8 +4230,8 @@ "type": { "text": "boolean" }, - "description": "Defines if a busy indicator would be displayed over the item.", "default": "false", + "description": "Defines if a busy indicator would be displayed over the item.", "privacy": "public", "_ui5since": "1.0.0-rc.8", "_ui5validator": "Boolean", @@ -4257,25 +4246,14 @@ "type": { "text": "number" }, - "description": "Defines the delay in milliseconds, after which the busy indicator will show up for this component.", "default": "1000", + "description": "Defines the delay in milliseconds, after which the busy indicator will show up for this component.", "privacy": "public", - "_ui5validator": "Integer", + "_ui5validator": "Number", "inheritedFrom": { "name": "NotificationListItemBase", "module": "dist/NotificationListItemBase.js" } - }, - { - "kind": "field", - "name": "selected", - "type": { - "text": "boolean" - }, - "description": "Defines the selected state of the component.", - "default": "false", - "privacy": "public", - "_ui5validator": "Boolean" } ], "events": [ @@ -4386,10 +4364,10 @@ "kind": "field", "name": "titleText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the `titleText` of the item.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -4399,8 +4377,8 @@ "type": { "text": "boolean" }, - "description": "Defines if the `notification` is new or has been already read.\n\n**Note:** if set to `false` the `titleText` has bold font,\nif set to true - it has a normal font.", "default": "false", + "description": "Defines if the `notification` is new or has been already read.\n\n**Note:** if set to `false` the `titleText` has bold font,\nif set to true - it has a normal font.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -4410,8 +4388,8 @@ "type": { "text": "boolean" }, - "description": "Defines if a busy indicator would be displayed over the item.", "default": "false", + "description": "Defines if a busy indicator would be displayed over the item.", "privacy": "public", "_ui5since": "1.0.0-rc.8", "_ui5validator": "Boolean" @@ -4422,21 +4400,10 @@ "type": { "text": "number" }, - "description": "Defines the delay in milliseconds, after which the busy indicator will show up for this component.", "default": "1000", + "description": "Defines the delay in milliseconds, after which the busy indicator will show up for this component.", "privacy": "public", - "_ui5validator": "Integer" - }, - { - "kind": "field", - "name": "selected", - "type": { - "text": "boolean" - }, - "description": "Defines the selected state of the component.", - "default": "false", - "privacy": "public", - "_ui5validator": "Boolean" + "_ui5validator": "Number" } ], "superclass": { @@ -4514,10 +4481,10 @@ } ] }, - "description": "Defines the background color of the `ui5-page`.\n\n**Note:** When a ui5-list is placed inside the page, we recommend using “List” to ensure better color contrast.", "default": "\"Solid\"", + "description": "Defines the background color of the `ui5-page`.\n\n**Note:** When a ui5-list is placed inside the page, we recommend using “List” to ensure better color contrast.", "privacy": "public", - "_ui5validator": "PageBackgroundDesign" + "_ui5validator": "String" }, { "kind": "field", @@ -4525,8 +4492,8 @@ "type": { "text": "boolean" }, - "description": "Disables vertical scrolling of page content.\nIf set to true, there will be no vertical scrolling at all.", "default": "false", + "description": "Disables vertical scrolling of page content.\nIf set to true, there will be no vertical scrolling at all.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -4536,8 +4503,8 @@ "type": { "text": "boolean" }, - "description": "Defines if the footer is fixed at the very bottom of the page.\n\n**Note:** When set to true the footer is fixed at the very bottom of the page, otherwise it floats over the content with a slight offset from the bottom.", "default": "false", + "description": "Defines if the footer is fixed at the very bottom of the page.\n\n**Note:** When set to true the footer is fixed at the very bottom of the page, otherwise it floats over the content with a slight offset from the bottom.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -4547,8 +4514,8 @@ "type": { "text": "boolean" }, - "description": "Defines the footer visibility.", "default": "false", + "description": "Defines the footer visibility.", "privacy": "public", "_ui5validator": "Boolean" } @@ -4697,10 +4664,10 @@ "kind": "field", "name": "titleText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the title of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15", "_ui5validator": "String" @@ -4709,10 +4676,10 @@ "kind": "field", "name": "subtitleText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the subtitle of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15", "_ui5validator": "String" @@ -4721,10 +4688,10 @@ "kind": "field", "name": "icon", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the icon to be displayed as a graphical element within the component.\n\nExample:\n\n``\n\nSee all the available icons in the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -4732,10 +4699,10 @@ "kind": "field", "name": "target", "type": { - "text": "string" + "text": "string | undefined" }, - "description": "Defines a target where the `targetSrc` content must be open.\n\nAvailable options are:\n\n- `_self`\n- `_top`\n- `_blank`\n- `_parent`\n- `_search`", - "default": "\"_self\"", + "description": "Defines a target where the `targetSrc` content must be open.\n\nAvailable options are:\n\n- `_self`\n- `_top`\n- `_blank`\n- `_parent`\n- `_search`\n\n**Note:** By default target will be open in the same frame as it was clicked.", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -4743,10 +4710,10 @@ "kind": "field", "name": "targetSrc", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the component target URI. Supports standard hyperlink behavior.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" } @@ -4765,46 +4732,46 @@ { "description": "Defines the title of the component.", "name": "title-text", - "default": "\"\"", + "default": "undefined", "fieldName": "titleText", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the subtitle of the component.", "name": "subtitle-text", - "default": "\"\"", + "default": "undefined", "fieldName": "subtitleText", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the icon to be displayed as a graphical element within the component.\n\nExample:\n\n``\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": "\"\"", + "default": "undefined", "fieldName": "icon", "type": { - "text": "string" + "text": "string | undefined" } }, { - "description": "Defines a target where the `targetSrc` content must be open.\n\nAvailable options are:\n\n- `_self`\n- `_top`\n- `_blank`\n- `_parent`\n- `_search`", + "description": "Defines a target where the `targetSrc` content must be open.\n\nAvailable options are:\n\n- `_self`\n- `_top`\n- `_blank`\n- `_parent`\n- `_search`\n\n**Note:** By default target will be open in the same frame as it was clicked.", "name": "target", - "default": "\"_self\"", + "default": "undefined", "fieldName": "target", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the component target URI. Supports standard hyperlink behavior.", "name": "target-src", - "default": "\"\"", + "default": "undefined", "fieldName": "targetSrc", "type": { - "text": "string" + "text": "string | undefined" } } ], @@ -4962,10 +4929,10 @@ "kind": "field", "name": "primaryTitle", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the `primaryTitle`.\n\n**Note:** The `primaryTitle` would be hidden on S screen size (less than approx. 700px).", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -4973,10 +4940,10 @@ "kind": "field", "name": "secondaryTitle", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the `secondaryTitle`.\n\n**Note:** The `secondaryTitle` would be hidden on S and M screen sizes (less than approx. 1300px).", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -4984,10 +4951,10 @@ "kind": "field", "name": "notificationsCount", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the `notificationsCount`,\ndisplayed in the notification icon top-right corner.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -4997,8 +4964,8 @@ "type": { "text": "boolean" }, - "description": "Defines, if the notification icon would be displayed.", "default": "false", + "description": "Defines, if the notification icon would be displayed.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -5008,8 +4975,8 @@ "type": { "text": "boolean" }, - "description": "Defines, if the product switch icon would be displayed.", "default": "false", + "description": "Defines, if the product switch icon would be displayed.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -5019,8 +4986,8 @@ "type": { "text": "boolean" }, - "description": "Defines, if the Search Field would be displayed when there is a valid `searchField` slot.\n\n**Note:** By default the Search Field is not displayed.", "default": "false", + "description": "Defines, if the Search Field would be displayed when there is a valid `searchField` slot.\n\n**Note:** By default the Search Field is not displayed.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -5037,8 +5004,8 @@ } ] }, - "description": "Defines additional accessibility attributes on different areas of the component.\n\nThe accessibilityAttributes object has the following fields,\nwhere each field is an object supporting one or more accessibility attributes:\n\n- **logo** - `logo.role` and `logo.name`.\n- **notifications** - `notifications.expanded` and `notifications.hasPopup`.\n- **profile** - `profile.expanded`, `profile.hasPopup` and `profile.name`.\n- **product** - `product.expanded` and `product.hasPopup`.\n- **search** - `search.expanded` and `search.hasPopup`.\n- **overflow** - `overflow.expanded` and `overflow.hasPopup`.\n\nThe accessibility attributes support the following values:\n\n- **role**: Defines the accessible ARIA role of the logo area.\nAccepts the following string values: `button` or `link`.\n\n- **expanded**: Indicates whether the button, or another grouping element it controls,\nis currently expanded or collapsed.\nAccepts the following string values: `true` or `false`.\n\n- **hasPopup**: Indicates the availability and type of interactive popup element,\nsuch as menu or dialog, that can be triggered by the button.\n\nAccepts the following string values: `dialog`, `grid`, `listbox`, `menu` or `tree`.\n- **name**: Defines the accessible ARIA name of the area.\nAccepts any string.", "default": "{}", + "description": "Defines additional accessibility attributes on different areas of the component.\n\nThe accessibilityAttributes object has the following fields,\nwhere each field is an object supporting one or more accessibility attributes:\n\n- **logo** - `logo.role` and `logo.name`.\n- **notifications** - `notifications.expanded` and `notifications.hasPopup`.\n- **profile** - `profile.expanded`, `profile.hasPopup` and `profile.name`.\n- **product** - `product.expanded` and `product.hasPopup`.\n- **search** - `search.expanded` and `search.hasPopup`.\n- **overflow** - `overflow.expanded` and `overflow.hasPopup`.\n\nThe accessibility attributes support the following values:\n\n- **role**: Defines the accessible ARIA role of the logo area.\nAccepts the following string values: `button` or `link`.\n\n- **expanded**: Indicates whether the button, or another grouping element it controls,\nis currently expanded or collapsed.\nAccepts the following string values: `true` or `false`.\n\n- **hasPopup**: Indicates the availability and type of interactive popup element,\nsuch as menu or dialog, that can be triggered by the button.\n\nAccepts the following string values: `dialog`, `grid`, `listbox`, `menu` or `tree`.\n- **name**: Defines the accessible ARIA name of the area.\nAccepts any string.", "privacy": "public", "_ui5since": "1.10.0", "_ui5validator": "Object" @@ -5266,28 +5233,28 @@ { "description": "Defines the `primaryTitle`.\n\n**Note:** The `primaryTitle` would be hidden on S screen size (less than approx. 700px).", "name": "primary-title", - "default": "\"\"", + "default": "undefined", "fieldName": "primaryTitle", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the `secondaryTitle`.\n\n**Note:** The `secondaryTitle` would be hidden on S and M screen sizes (less than approx. 1300px).", "name": "secondary-title", - "default": "\"\"", + "default": "undefined", "fieldName": "secondaryTitle", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the `notificationsCount`,\ndisplayed in the notification icon top-right corner.", "name": "notifications-count", - "default": "\"\"", + "default": "undefined", "fieldName": "notificationsCount", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -5406,10 +5373,10 @@ "kind": "field", "name": "icon", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the name of the item's icon.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -5417,10 +5384,10 @@ "kind": "field", "name": "text", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the item text.\n \n **Note:** The text is only displayed inside the overflow popover list view.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -5428,10 +5395,10 @@ "kind": "field", "name": "count", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the count displayed in the top-right corner.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.6", "_ui5validator": "String" @@ -5459,28 +5426,28 @@ { "description": "Defines the name of the item's icon.", "name": "icon", - "default": "\"\"", + "default": "undefined", "fieldName": "icon", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the item text.\n \n **Note:** The text is only displayed inside the overflow popover list view.", "name": "text", - "default": "\"\"", + "default": "undefined", "fieldName": "text", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the count displayed in the top-right corner.", "name": "count", - "default": "\"\"", + "default": "undefined", "fieldName": "count", "type": { - "text": "string" + "text": "string | undefined" } } ], @@ -5571,9 +5538,9 @@ "type": { "text": "boolean" }, + "default": "false", "description": "Defines whether the `ui5-side-navigation` is expanded or collapsed.", "privacy": "public", - "default": "false", "_ui5validator": "Boolean" } ], @@ -5686,20 +5653,20 @@ "type": { "text": "boolean" }, + "default": "false", "description": "Defines if the item is expanded", "privacy": "public", - "default": "false", "_ui5validator": "Boolean" }, { "kind": "field", "name": "text", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text of the item.", "privacy": "public", - "default": "\"\"", + "default": "undefined", "_ui5validator": "String", "inheritedFrom": { "name": "SideNavigationItemBase", @@ -5712,8 +5679,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is disabled.\nA disabled component can't be pressed or\nfocused, and it is not in the tab chain.", "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", "_ui5since": "1.19.0", "_ui5validator": "Boolean", @@ -5726,10 +5693,10 @@ "kind": "field", "name": "tooltip", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the tooltip of the component.\n\nA tooltip attribute should be provided, in order to represent meaning/function, when the component is collapsed(icon only is visualized).", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "2.0.0", "_ui5validator": "String", @@ -5752,10 +5719,10 @@ { "description": "Defines the text of the item.", "name": "text", - "default": "\"\"", + "default": "undefined", "fieldName": "text", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "SideNavigationItemBase", @@ -5778,10 +5745,10 @@ { "description": "Defines the tooltip of the component.\n\nA tooltip attribute should be provided, in order to represent meaning/function, when the component is collapsed(icon only is visualized).", "name": "tooltip", - "default": "\"\"", + "default": "undefined", "fieldName": "tooltip", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "SideNavigationItemBase", @@ -5853,20 +5820,20 @@ "type": { "text": "boolean" }, + "default": "false", "description": "Defines if the item is expanded", "privacy": "public", - "default": "false", "_ui5validator": "Boolean" }, { "kind": "field", "name": "icon", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the icon of the item.\n\nThe SAP-icons font provides numerous options.\n\nSee all the available icons in the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).", "privacy": "public", - "default": "\"\"", + "default": "undefined", "_ui5validator": "String", "inheritedFrom": { "name": "SideNavigationSelectableItemBase", @@ -5879,9 +5846,9 @@ "type": { "text": "boolean" }, + "default": "false", "description": "Defines whether the item is selected", "privacy": "public", - "default": "false", "_ui5validator": "Boolean", "inheritedFrom": { "name": "SideNavigationSelectableItemBase", @@ -5892,11 +5859,11 @@ "kind": "field", "name": "href", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the link target URI. Supports standard hyperlink behavior.\nIf a JavaScript action should be triggered,\nthis should not be set, but instead an event handler\nfor the `click` event should be registered.", "privacy": "public", - "default": "\"\"", + "default": "undefined", "_ui5since": "1.19.0", "_ui5validator": "String", "inheritedFrom": { @@ -5908,11 +5875,11 @@ "kind": "field", "name": "target", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the component target.\n\n**Notes:**\n\n- `_self`\n- `_top`\n- `_blank`\n- `_parent`\n- `_search`\n\n**This property must only be used when the `href` property is set.**", "privacy": "public", - "default": "\"\"", + "default": "undefined", "_ui5since": "1.19.0", "_ui5validator": "String", "inheritedFrom": { @@ -5924,11 +5891,11 @@ "kind": "field", "name": "text", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text of the item.", "privacy": "public", - "default": "\"\"", + "default": "undefined", "_ui5validator": "String", "inheritedFrom": { "name": "SideNavigationItemBase", @@ -5941,8 +5908,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is disabled.\nA disabled component can't be pressed or\nfocused, and it is not in the tab chain.", "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", "_ui5since": "1.19.0", "_ui5validator": "Boolean", @@ -5955,10 +5922,10 @@ "kind": "field", "name": "tooltip", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the tooltip of the component.\n\nA tooltip attribute should be provided, in order to represent meaning/function, when the component is collapsed(icon only is visualized).", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "2.0.0", "_ui5validator": "String", @@ -5981,10 +5948,10 @@ { "description": "Defines the icon of the item.\n\nThe SAP-icons font provides numerous options.\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": "\"\"", + "default": "undefined", "fieldName": "icon", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "SideNavigationSelectableItemBase", @@ -6007,10 +5974,10 @@ { "description": "Defines the link target URI. Supports standard hyperlink behavior.\nIf a JavaScript action should be triggered,\nthis should not be set, but instead an event handler\nfor the `click` event should be registered.", "name": "href", - "default": "\"\"", + "default": "undefined", "fieldName": "href", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "SideNavigationSelectableItemBase", @@ -6020,10 +5987,10 @@ { "description": "Defines the component target.\n\n**Notes:**\n\n- `_self`\n- `_top`\n- `_blank`\n- `_parent`\n- `_search`\n\n**This property must only be used when the `href` property is set.**", "name": "target", - "default": "\"\"", + "default": "undefined", "fieldName": "target", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "SideNavigationSelectableItemBase", @@ -6033,10 +6000,10 @@ { "description": "Defines the text of the item.", "name": "text", - "default": "\"\"", + "default": "undefined", "fieldName": "text", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "SideNavigationItemBase", @@ -6059,10 +6026,10 @@ { "description": "Defines the tooltip of the component.\n\nA tooltip attribute should be provided, in order to represent meaning/function, when the component is collapsed(icon only is visualized).", "name": "tooltip", - "default": "\"\"", + "default": "undefined", "fieldName": "tooltip", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "SideNavigationItemBase", @@ -6128,11 +6095,11 @@ "kind": "field", "name": "text", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text of the item.", "privacy": "public", - "default": "\"\"", + "default": "undefined", "_ui5validator": "String" }, { @@ -6141,8 +6108,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is disabled.\nA disabled component can't be pressed or\nfocused, and it is not in the tab chain.", "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", "_ui5since": "1.19.0", "_ui5validator": "Boolean" @@ -6151,10 +6118,10 @@ "kind": "field", "name": "tooltip", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the tooltip of the component.\n\nA tooltip attribute should be provided, in order to represent meaning/function, when the component is collapsed(icon only is visualized).", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "2.0.0", "_ui5validator": "String" @@ -6164,10 +6131,10 @@ { "description": "Defines the text of the item.", "name": "text", - "default": "\"\"", + "default": "undefined", "fieldName": "text", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -6182,10 +6149,10 @@ { "description": "Defines the tooltip of the component.\n\nA tooltip attribute should be provided, in order to represent meaning/function, when the component is collapsed(icon only is visualized).", "name": "tooltip", - "default": "\"\"", + "default": "undefined", "fieldName": "tooltip", "type": { - "text": "string" + "text": "string | undefined" } } ], @@ -6224,11 +6191,11 @@ "kind": "field", "name": "icon", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the icon of the item.\n\nThe SAP-icons font provides numerous options.\n\nSee all the available icons in the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).", "privacy": "public", - "default": "\"\"", + "default": "undefined", "_ui5validator": "String" }, { @@ -6237,20 +6204,20 @@ "type": { "text": "boolean" }, + "default": "false", "description": "Defines whether the item is selected", "privacy": "public", - "default": "false", "_ui5validator": "Boolean" }, { "kind": "field", "name": "href", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the link target URI. Supports standard hyperlink behavior.\nIf a JavaScript action should be triggered,\nthis should not be set, but instead an event handler\nfor the `click` event should be registered.", "privacy": "public", - "default": "\"\"", + "default": "undefined", "_ui5since": "1.19.0", "_ui5validator": "String" }, @@ -6258,11 +6225,11 @@ "kind": "field", "name": "target", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the component target.\n\n**Notes:**\n\n- `_self`\n- `_top`\n- `_blank`\n- `_parent`\n- `_search`\n\n**This property must only be used when the `href` property is set.**", "privacy": "public", - "default": "\"\"", + "default": "undefined", "_ui5since": "1.19.0", "_ui5validator": "String" }, @@ -6270,11 +6237,11 @@ "kind": "field", "name": "text", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text of the item.", "privacy": "public", - "default": "\"\"", + "default": "undefined", "_ui5validator": "String", "inheritedFrom": { "name": "SideNavigationItemBase", @@ -6287,8 +6254,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is disabled.\nA disabled component can't be pressed or\nfocused, and it is not in the tab chain.", "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", "_ui5since": "1.19.0", "_ui5validator": "Boolean", @@ -6301,10 +6268,10 @@ "kind": "field", "name": "tooltip", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the tooltip of the component.\n\nA tooltip attribute should be provided, in order to represent meaning/function, when the component is collapsed(icon only is visualized).", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "2.0.0", "_ui5validator": "String", @@ -6328,10 +6295,10 @@ { "description": "Defines the icon of the item.\n\nThe SAP-icons font provides numerous options.\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": "\"\"", + "default": "undefined", "fieldName": "icon", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -6346,28 +6313,28 @@ { "description": "Defines the link target URI. Supports standard hyperlink behavior.\nIf a JavaScript action should be triggered,\nthis should not be set, but instead an event handler\nfor the `click` event should be registered.", "name": "href", - "default": "\"\"", + "default": "undefined", "fieldName": "href", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the component target.\n\n**Notes:**\n\n- `_self`\n- `_top`\n- `_blank`\n- `_parent`\n- `_search`\n\n**This property must only be used when the `href` property is set.**", "name": "target", - "default": "\"\"", + "default": "undefined", "fieldName": "target", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the text of the item.", "name": "text", - "default": "\"\"", + "default": "undefined", "fieldName": "text", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "SideNavigationItemBase", @@ -6390,10 +6357,10 @@ { "description": "Defines the tooltip of the component.\n\nA tooltip attribute should be provided, in order to represent meaning/function, when the component is collapsed(icon only is visualized).", "name": "tooltip", - "default": "\"\"", + "default": "undefined", "fieldName": "tooltip", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "SideNavigationItemBase", @@ -6445,10 +6412,10 @@ { "description": "Defines the icon of the item.\n\nThe SAP-icons font provides numerous options.\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": "\"\"", + "default": "undefined", "fieldName": "icon", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "SideNavigationSelectableItemBase", @@ -6471,10 +6438,10 @@ { "description": "Defines the link target URI. Supports standard hyperlink behavior.\nIf a JavaScript action should be triggered,\nthis should not be set, but instead an event handler\nfor the `click` event should be registered.", "name": "href", - "default": "\"\"", + "default": "undefined", "fieldName": "href", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "SideNavigationSelectableItemBase", @@ -6484,10 +6451,10 @@ { "description": "Defines the component target.\n\n**Notes:**\n\n- `_self`\n- `_top`\n- `_blank`\n- `_parent`\n- `_search`\n\n**This property must only be used when the `href` property is set.**", "name": "target", - "default": "\"\"", + "default": "undefined", "fieldName": "target", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "SideNavigationSelectableItemBase", @@ -6497,10 +6464,10 @@ { "description": "Defines the text of the item.", "name": "text", - "default": "\"\"", + "default": "undefined", "fieldName": "text", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "SideNavigationItemBase", @@ -6523,10 +6490,10 @@ { "description": "Defines the tooltip of the component.\n\nA tooltip attribute should be provided, in order to represent meaning/function, when the component is collapsed(icon only is visualized).", "name": "tooltip", - "default": "\"\"", + "default": "undefined", "fieldName": "tooltip", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "SideNavigationItemBase", @@ -6539,11 +6506,11 @@ "kind": "field", "name": "icon", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the icon of the item.\n\nThe SAP-icons font provides numerous options.\n\nSee all the available icons in the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).", "privacy": "public", - "default": "\"\"", + "default": "undefined", "_ui5validator": "String", "inheritedFrom": { "name": "SideNavigationSelectableItemBase", @@ -6556,9 +6523,9 @@ "type": { "text": "boolean" }, + "default": "false", "description": "Defines whether the item is selected", "privacy": "public", - "default": "false", "_ui5validator": "Boolean", "inheritedFrom": { "name": "SideNavigationSelectableItemBase", @@ -6569,11 +6536,11 @@ "kind": "field", "name": "href", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the link target URI. Supports standard hyperlink behavior.\nIf a JavaScript action should be triggered,\nthis should not be set, but instead an event handler\nfor the `click` event should be registered.", "privacy": "public", - "default": "\"\"", + "default": "undefined", "_ui5since": "1.19.0", "_ui5validator": "String", "inheritedFrom": { @@ -6585,11 +6552,11 @@ "kind": "field", "name": "target", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the component target.\n\n**Notes:**\n\n- `_self`\n- `_top`\n- `_blank`\n- `_parent`\n- `_search`\n\n**This property must only be used when the `href` property is set.**", "privacy": "public", - "default": "\"\"", + "default": "undefined", "_ui5since": "1.19.0", "_ui5validator": "String", "inheritedFrom": { @@ -6601,11 +6568,11 @@ "kind": "field", "name": "text", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text of the item.", "privacy": "public", - "default": "\"\"", + "default": "undefined", "_ui5validator": "String", "inheritedFrom": { "name": "SideNavigationItemBase", @@ -6618,8 +6585,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is disabled.\nA disabled component can't be pressed or\nfocused, and it is not in the tab chain.", "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", "_ui5since": "1.19.0", "_ui5validator": "Boolean", @@ -6632,10 +6599,10 @@ "kind": "field", "name": "tooltip", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the tooltip of the component.\n\nA tooltip attribute should be provided, in order to represent meaning/function, when the component is collapsed(icon only is visualized).", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "2.0.0", "_ui5validator": "String", @@ -6693,10 +6660,10 @@ "kind": "field", "name": "text", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -6706,8 +6673,8 @@ "type": { "text": "boolean" }, - "description": "Defines if the component is selected.", "default": "false", + "description": "Defines if the component is selected.", "privacy": "public", "_ui5validator": "Boolean" } @@ -6716,10 +6683,10 @@ { "description": "Defines the text of the component.", "name": "text", - "default": "\"\"", + "default": "undefined", "fieldName": "text", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -6809,20 +6776,20 @@ } ] }, - "description": "Defines the items orientation.", "default": "\"Vertical\"", + "description": "Defines the items orientation.", "privacy": "public", "_ui5since": "1.0.0-rc.15", - "_ui5validator": "TimelineLayout" + "_ui5validator": "String" }, { "kind": "field", "name": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the accessible ARIA name of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.2.0", "_ui5validator": "String" @@ -6841,10 +6808,10 @@ { "description": "Defines the accessible ARIA name of the component.", "name": "accessible-name", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" } } ], @@ -6901,10 +6868,10 @@ "kind": "field", "name": "icon", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the icon to be displayed as graphical element within the `ui5-timeline-item`.\nSAP-icons font provides numerous options.\n\nSee all the available icons in the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -6912,10 +6879,10 @@ "kind": "field", "name": "name", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the name of the item, displayed before the `title-text`.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -6925,8 +6892,8 @@ "type": { "text": "boolean" }, - "description": "Defines if the `name` is clickable.", "default": "false", + "description": "Defines if the `name` is clickable.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -6934,10 +6901,10 @@ "kind": "field", "name": "titleText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the title text of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -6945,10 +6912,10 @@ "kind": "field", "name": "subtitleText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the subtitle text of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" } @@ -6967,19 +6934,19 @@ { "description": "Defines the icon to be displayed as graphical element within the `ui5-timeline-item`.\nSAP-icons font provides numerous options.\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": "\"\"", + "default": "undefined", "fieldName": "icon", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the name of the item, displayed before the `title-text`.", "name": "name", - "default": "\"\"", + "default": "undefined", "fieldName": "name", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -6994,19 +6961,19 @@ { "description": "Defines the title text of the component.", "name": "title-text", - "default": "\"\"", + "default": "undefined", "fieldName": "titleText", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the subtitle text of the component.", "name": "subtitle-text", - "default": "\"\"", + "default": "undefined", "fieldName": "subtitleText", "type": { - "text": "string" + "text": "string | undefined" } } ], @@ -7094,19 +7061,19 @@ } ] }, - "description": "Defines the selection mode of the `ui5-upload-collection`.", "default": "\"None\"", + "description": "Defines the selection mode of the `ui5-upload-collection`.", "privacy": "public", - "_ui5validator": "UploadCollectionSelectionMode" + "_ui5validator": "String" }, { "kind": "field", "name": "noDataDescription", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Allows you to set your own text for the 'No data' description.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -7114,10 +7081,10 @@ "kind": "field", "name": "noDataText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Allows you to set your own text for the 'No data' text.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -7127,8 +7094,8 @@ "type": { "text": "boolean" }, - "description": "By default there will be drag and drop overlay shown over the `ui5-upload-collection` when files\nare dragged. If you don't intend to use drag and drop, set this property.\n\n**Note:** It is up to the application developer to add handler for `drop` event and handle it.\n`ui5-upload-collection` only displays an overlay.", "default": "false", + "description": "By default there will be drag and drop overlay shown over the `ui5-upload-collection` when files\nare dragged. If you don't intend to use drag and drop, set this property.\n\n**Note:** It is up to the application developer to add handler for `drop` event and handle it.\n`ui5-upload-collection` only displays an overlay.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -7136,10 +7103,10 @@ "kind": "field", "name": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the accessible ARIA name of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.16", "_ui5validator": "String" @@ -7218,19 +7185,19 @@ { "description": "Allows you to set your own text for the 'No data' description.", "name": "no-data-description", - "default": "\"\"", + "default": "undefined", "fieldName": "noDataDescription", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Allows you to set your own text for the 'No data' text.", "name": "no-data-text", - "default": "\"\"", + "default": "undefined", "fieldName": "noDataText", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -7245,10 +7212,10 @@ { "description": "Defines the accessible ARIA name of the component.", "name": "accessible-name", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" } } ], @@ -7329,10 +7296,10 @@ "kind": "field", "name": "file", "type": { - "text": "File | null | undefined" + "text": "File | null" }, - "description": "Holds an instance of `File` associated with this item.", "default": "null", + "description": "Holds an instance of `File` associated with this item.", "privacy": "public", "_ui5validator": "Object", "_ui5noAttribute": true @@ -7343,8 +7310,8 @@ "type": { "text": "string" }, - "description": "The name of the file.", "default": "\"\"", + "description": "The name of the file.", "privacy": "public", "_ui5validator": "String" }, @@ -7354,17 +7321,14 @@ "type": { "text": "boolean" }, - "description": "If set to `true` the file name will be clickable and it will fire `file-name-click` event upon click.", "default": "false", + "description": "If set to `true` the file name will be clickable and it will fire `file-name-click` event upon click.", "privacy": "public", "_ui5validator": "Boolean" }, { "kind": "field", "name": "disableDeleteButton", - "type": { - "text": "boolean" - }, "description": "Disables the delete button.", "default": "false", "privacy": "public", @@ -7376,8 +7340,8 @@ "type": { "text": "boolean" }, - "description": "Hides the delete button.", "default": "false", + "description": "Hides the delete button.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -7387,8 +7351,8 @@ "type": { "text": "boolean" }, - "description": "Hides the retry button when `uploadState` property is `Error`.", "default": "false", + "description": "Hides the retry button when `uploadState` property is `Error`.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -7398,8 +7362,8 @@ "type": { "text": "boolean" }, - "description": "Hides the terminate button when `uploadState` property is `Uploading`.", "default": "false", + "description": "Hides the terminate button when `uploadState` property is `Uploading`.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -7409,10 +7373,10 @@ "type": { "text": "number" }, - "description": "The upload progress in percentage.\n\n**Note:** Expected values are in the interval [0, 100].", "default": "0", + "description": "The upload progress in percentage.\n\n**Note:** Expected values are in the interval [0, 100].", "privacy": "public", - "_ui5validator": "Integer" + "_ui5validator": "Number" }, { "kind": "field", @@ -7427,10 +7391,10 @@ } ] }, - "description": "Upload state.\n\nDepending on this property, the item displays the following:\n\n- `Ready` - progress indicator is displayed.\n- `Uploading` - progress indicator and terminate button are displayed. When the terminate button is pressed, `terminate` event is fired.\n- `Error` - progress indicator and retry button are displayed. When the retry button is pressed, `retry` event is fired.\n- `Complete` - progress indicator is not displayed.", "default": "\"Ready\"", + "description": "Upload state.\n\nDepending on this property, the item displays the following:\n\n- `Ready` - progress indicator is displayed.\n- `Uploading` - progress indicator and terminate button are displayed. When the terminate button is pressed, `terminate` event is fired.\n- `Error` - progress indicator and retry button are displayed. When the retry button is pressed, `retry` event is fired.\n- `Complete` - progress indicator is not displayed.", "privacy": "public", - "_ui5validator": "UploadState" + "_ui5validator": "String" }, { "kind": "field", @@ -7445,10 +7409,10 @@ } ] }, - "description": "Defines the visual indication and behavior of the list items.\nAvailable options are `Active` (by default), `Inactive`, `Detail` and `Navigation`.\n\n**Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and hover,\nwhile with type `Inactive` and `Detail` - will not.", "default": "\"Active\"", + "description": "Defines the visual indication and behavior of the list items.\nAvailable options are `Active` (by default), `Inactive`, `Detail` and `Navigation`.\n\n**Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and hover,\nwhile with type `Inactive` and `Detail` - will not.", "privacy": "public", - "_ui5validator": "ListItemType" + "_ui5validator": "String" }, { "kind": "field", @@ -7463,8 +7427,8 @@ } ] }, - "description": "Defines the additional accessibility attributes that will be applied to the component.\nThe following fields are supported:\n\n- **ariaSetsize**: Defines the number of items in the current set when not all items in the set are present in the DOM.\n**Note:** The value is an integer reflecting the number of items in the complete set. If the size of the entire set is unknown, set `-1`.\n\n\t- **ariaPosinset**: Defines an element's number or position in the current set when not all items are present in the DOM.\n\t**Note:** The value is an integer greater than or equal to 1, and less than or equal to the size of the set when that size is known.", "default": "{}", + "description": "Defines the additional accessibility attributes that will be applied to the component.\nThe following fields are supported:\n\n- **ariaSetsize**: Defines the number of items in the current set when not all items in the set are present in the DOM.\n**Note:** The value is an integer reflecting the number of items in the complete set. If the size of the entire set is unknown, set `-1`.\n\n\t- **ariaPosinset**: Defines an element's number or position in the current set when not all items are present in the DOM.\n\t**Note:** The value is an integer greater than or equal to 1, and less than or equal to the size of the set when that size is known.", "privacy": "public", "_ui5since": "1.15.0", "_ui5validator": "Object" @@ -7475,8 +7439,8 @@ "type": { "text": "boolean" }, - "description": "The navigated state of the list item.\nIf set to `true`, a navigation indicator is displayed at the end of the list item.", "default": "false", + "description": "The navigated state of the list item.\nIf set to `true`, a navigation indicator is displayed at the end of the list item.", "privacy": "public", "_ui5since": "1.10.0", "_ui5validator": "Boolean" @@ -7485,10 +7449,10 @@ "kind": "field", "name": "tooltip", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text of the tooltip that would be displayed for the list item.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.23.0", "_ui5validator": "String" @@ -7506,11 +7470,11 @@ } ] }, - "description": "Defines the highlight state of the list items.\nAvailable options are: `\"None\"` (by default), `\"Positive\"`, `\"Critical\"`, `\"Information\"` and `\"Negative\"`.", "default": "\"None\"", + "description": "Defines the highlight state of the list items.\nAvailable options are: `\"None\"` (by default), `\"Positive\"`, `\"Critical\"`, `\"Information\"` and `\"Negative\"`.", "privacy": "public", "_ui5since": "1.24", - "_ui5validator": "Highlight" + "_ui5validator": "String" }, { "kind": "field", @@ -7521,11 +7485,7 @@ "description": "Defines the selected state of the component.", "default": "false", "privacy": "public", - "_ui5validator": "Boolean", - "inheritedFrom": { - "name": "ListItemBase", - "module": "dist/ListItemBase.js" - } + "_ui5validator": "Boolean" } ], "events": [ @@ -7595,7 +7555,7 @@ "default": "false", "fieldName": "disableDeleteButton", "type": { - "text": "boolean" + "text": "any" } }, { @@ -7721,21 +7681,22 @@ "type": { "text": "boolean" }, - "description": "Defines the initial sort order.", "default": "false", + "description": "Defines the initial sort order.", "privacy": "public", "_ui5validator": "Boolean" }, { - "kind": "method", - "name": "show", - "return": { - "type": { - "text": "void" - } + "kind": "field", + "name": "open", + "type": { + "text": "boolean" }, - "description": "Shows the dialog.", - "privacy": "public" + "default": "false", + "description": "Indicates if the dialog is open.", + "privacy": "public", + "_ui5since": "2.0.0", + "_ui5validator": "Boolean" }, { "kind": "method", @@ -7888,6 +7849,24 @@ "text": "CustomEvent" }, "description": "Fired before the component is opened. **This event does not bubble.**" + }, + { + "name": "open", + "_ui5privacy": "public", + "type": { + "text": "CustomEvent" + }, + "description": "Fired after the dialog is opened.", + "_ui5since": "2.0.0" + }, + { + "name": "close", + "_ui5privacy": "public", + "type": { + "text": "CustomEvent" + }, + "description": "Fired after the dialog is closed.", + "_ui5since": "2.0.0" } ], "attributes": [ @@ -7899,6 +7878,15 @@ "type": { "text": "boolean" } + }, + { + "description": "Indicates if the dialog is open.", + "name": "open", + "default": "false", + "fieldName": "open", + "type": { + "text": "boolean" + } } ], "superclass": { @@ -7981,11 +7969,11 @@ } ] }, + "default": "\"MultipleSteps\"", "description": "Defines how the content of the `ui5-wizard` would be visualized.", "privacy": "public", - "default": "\"MultipleSteps\"", "_ui5since": "1.14.0", - "_ui5validator": "WizardContentLayout" + "_ui5validator": "String" } ], "events": [ @@ -8052,7 +8040,7 @@ "default": "\"MultipleSteps\"", "fieldName": "contentLayout", "type": { - "text": "WizardContentLayout" + "text": "\"MultipleSteps\" | \"SingleStep\"" } } ], @@ -8109,10 +8097,10 @@ "kind": "field", "name": "titleText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the `titleText` of the step.\n\n**Note:** The text is displayed in the `ui5-wizard` navigation header.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15", "_ui5validator": "String" @@ -8121,10 +8109,10 @@ "kind": "field", "name": "subtitleText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the `subtitleText` of the step.\n\n**Note:** the text is displayed in the `ui5-wizard` navigation header.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15", "_ui5validator": "String" @@ -8133,10 +8121,10 @@ "kind": "field", "name": "icon", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the `icon` of the step.\n\n**Note:** The icon is displayed in the `ui5-wizard` navigation header.\n\nThe SAP-icons font provides numerous options.\nSee all the available icons in the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -8146,8 +8134,8 @@ "type": { "text": "boolean" }, - "description": "Defines if the step is `disabled`. When disabled the step is displayed,\nbut the user can't select the step by clicking or navigate to it with scrolling.\n\n**Note:** Step can't be `selected` and `disabled` at the same time.\nIn this case the `selected` property would take precedence.", "default": "false", + "description": "Defines if the step is `disabled`. When disabled the step is displayed,\nbut the user can't select the step by clicking or navigate to it with scrolling.\n\n**Note:** Step can't be `selected` and `disabled` at the same time.\nIn this case the `selected` property would take precedence.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -8157,8 +8145,8 @@ "type": { "text": "boolean" }, - "description": "Defines the step's `selected` state - the step that is currently active.\n\n**Note:** Step can't be `selected` and `disabled` at the same time.\nIn this case the `selected` property would take precedence.", "default": "false", + "description": "Defines the step's `selected` state - the step that is currently active.\n\n**Note:** Step can't be `selected` and `disabled` at the same time.\nIn this case the `selected` property would take precedence.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -8168,8 +8156,8 @@ "type": { "text": "boolean" }, - "description": "When `branching` is enabled a dashed line would be displayed after the step,\nmeant to indicate that the next step is not yet known and depends on user choice in the current step.\n\n**Note:** It is recommended to use `branching` on the last known step\nand later add new steps when it becomes clear how the wizard flow should continue.", "default": "false", + "description": "When `branching` is enabled a dashed line would be displayed after the step,\nmeant to indicate that the next step is not yet known and depends on user choice in the current step.\n\n**Note:** It is recommended to use `branching` on the last known step\nand later add new steps when it becomes clear how the wizard flow should continue.", "privacy": "public", "_ui5validator": "Boolean" } @@ -8178,28 +8166,28 @@ { "description": "Defines the `titleText` of the step.\n\n**Note:** The text is displayed in the `ui5-wizard` navigation header.", "name": "title-text", - "default": "\"\"", + "default": "undefined", "fieldName": "titleText", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the `subtitleText` of the step.\n\n**Note:** the text is displayed in the `ui5-wizard` navigation header.", "name": "subtitle-text", - "default": "\"\"", + "default": "undefined", "fieldName": "subtitleText", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the `icon` of the step.\n\n**Note:** The icon is displayed in the `ui5-wizard` navigation header.\n\nThe SAP-icons font provides numerous options.\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": "\"\"", + "default": "undefined", "fieldName": "icon", "type": { - "text": "string" + "text": "string | undefined" } }, { diff --git a/.storybook/custom-element-manifests/main.json b/.storybook/custom-element-manifests/main.json index 1240b5d2ca0..52694083f77 100644 --- a/.storybook/custom-element-manifests/main.json +++ b/.storybook/custom-element-manifests/main.json @@ -1522,7 +1522,7 @@ "kind": "field", "static": true, "privacy": "public", - "description": "Decorative mode.\nConfigures the component to internally render role=\"button\".\nThis mode also supports focus and press handling to enhance interactivity.", + "description": "Decorative mode.\nConfigures the component to internally render role=\"presentation\" and aria-hidden=\"true\",\nmaking it purely decorative without semantic content or interactivity.", "default": "Decorative", "name": "Decorative", "readonly": true @@ -1531,7 +1531,7 @@ "kind": "field", "static": true, "privacy": "public", - "description": "Interactive mode.\nConfigures the component to internally render role=\"presentation\" and aria-hidden=\"true\",\nmaking it purely decorative without semantic content or interactivity.", + "description": "Interactive mode.\nConfigures the component to internally render role=\"button\".\nThis mode also supports focus and press handling to enhance interactivity.", "default": "Interactive", "name": "Interactive", "readonly": true @@ -2063,13 +2063,14 @@ }, { "kind": "javascript-module", - "path": "dist/types/ListSeparators.js", + "path": "dist/types/ListSeparator.js", "declarations": [ { "kind": "enum", - "name": "ListSeparators", + "name": "ListSeparator", "description": "Different types of list items separators.", "_ui5privacy": "public", + "_ui5since": "2.0.0", "members": [ { "kind": "field", @@ -2106,8 +2107,8 @@ "kind": "js", "name": "default", "declaration": { - "name": "ListSeparators", - "module": "dist/types/ListSeparators.js" + "name": "ListSeparator", + "module": "dist/types/ListSeparator.js" } } ] @@ -3450,8 +3451,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is disabled.\nA disabled component can't be pressed or\nfocused, and it is not in the tab chain.", "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", "_ui5validator": "Boolean" }, @@ -3461,8 +3462,8 @@ "type": { "text": "boolean" }, - "description": "Defines if the avatar is interactive (focusable and pressable).\n\n**Note:** This property won't have effect if the `disabled`\nproperty is set to `true`.", "default": "false", + "description": "Defines if the avatar is interactive (focusable and pressable).\n\n**Note:** This property won't have effect if the `disabled`\nproperty is set to `true`.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -3470,10 +3471,10 @@ "kind": "field", "name": "icon", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the name of the UI5 Icon, that will be displayed.\n\n**Note:** If `image` slot is provided, the property will be ignored.\n\n**Note:** You should import the desired icon first, then use its name as \"icon\".\n\n`import \"@ui5/webcomponents-icons/dist/{icon_name}.js\"`\n\n``\n\n**Note:** If no icon or an empty one is provided, by default the \"employee\" icon should be displayed.\n\nSee all the available icons in the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -3483,8 +3484,8 @@ "type": { "text": "string" }, + "default": "\"employee\"", "description": "Defines the name of the fallback icon, which should be displayed in the following cases:\n\n\t- If the initials are not valid (more than 3 letters, unsupported languages or empty initials).\n\t- If there are three initials and they do not fit in the shape (e.g. WWW for some of the sizes).\n\t- If the image src is wrong.\n\n**Note:** If not set, a default fallback icon \"employee\" is displayed.\n\n**Note:** You should import the desired icon first, then use its name as \"fallback-icon\".\n\n`import \"@ui5/webcomponents-icons/dist/{icon_name}.js\"`\n\n``\n\nSee all the available icons in the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).", - "default": "\"\"", "privacy": "public", "_ui5validator": "String" }, @@ -3492,10 +3493,10 @@ "kind": "field", "name": "initials", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the displayed initials.\n\nUp to three Latin letters can be displayed as initials.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -3512,10 +3513,10 @@ } ] }, - "description": "Defines the shape of the component.", "default": "\"Circle\"", + "description": "Defines the shape of the component.", "privacy": "public", - "_ui5validator": "AvatarShape" + "_ui5validator": "String" }, { "kind": "field", @@ -3530,10 +3531,10 @@ } ] }, - "description": "Defines predefined size of the component.", "default": "\"S\"", + "description": "Defines predefined size of the component.", "privacy": "public", - "_ui5validator": "AvatarSize" + "_ui5validator": "String" }, { "kind": "field", @@ -3548,19 +3549,19 @@ } ] }, - "description": "Defines the background color of the desired image.", "default": "\"Accent6\"", + "description": "Defines the background color of the desired image.", "privacy": "public", - "_ui5validator": "AvatarColorScheme" + "_ui5validator": "String" }, { "kind": "field", "name": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text alternative of the component.\nIf not provided a default text alternative will be set, if present.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.7", "_ui5validator": "String" @@ -3578,9 +3579,9 @@ } ] }, + "default": "{}", "description": "Defines the additional accessibility attributes that will be applied to the component.\nThe following field is supported:\n\n- **hasPopup**: Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by the button.\nAccepts the following string values: `dialog`, `grid`, `listbox`, `menu` or `tree`.", "privacy": "public", - "default": "{}", "_ui5since": "2.0.0", "_ui5validator": "Object" } @@ -3607,16 +3608,16 @@ { "description": "Defines the name of the UI5 Icon, that will be displayed.\n\n**Note:** If `image` slot is provided, the property will be ignored.\n\n**Note:** You should import the desired icon first, then use its name as \"icon\".\n\n`import \"@ui5/webcomponents-icons/dist/{icon_name}.js\"`\n\n``\n\n**Note:** If no icon or an empty one is provided, by default the \"employee\" icon should be displayed.\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": "\"\"", + "default": "undefined", "fieldName": "icon", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the name of the fallback icon, which should be displayed in the following cases:\n\n\t- If the initials are not valid (more than 3 letters, unsupported languages or empty initials).\n\t- If there are three initials and they do not fit in the shape (e.g. WWW for some of the sizes).\n\t- If the image src is wrong.\n\n**Note:** If not set, a default fallback icon \"employee\" is displayed.\n\n**Note:** You should import the desired icon first, then use its name as \"fallback-icon\".\n\n`import \"@ui5/webcomponents-icons/dist/{icon_name}.js\"`\n\n``\n\nSee all the available icons in the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).", "name": "fallback-icon", - "default": "\"\"", + "default": "\"employee\"", "fieldName": "fallbackIcon", "type": { "text": "string" @@ -3625,10 +3626,10 @@ { "description": "Defines the displayed initials.\n\nUp to three Latin letters can be displayed as initials.", "name": "initials", - "default": "\"\"", + "default": "undefined", "fieldName": "initials", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -3661,10 +3662,10 @@ { "description": "Defines the text alternative of the component.\nIf not provided a default text alternative will be set, if present.", "name": "accessible-name", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" } } ], @@ -3767,10 +3768,10 @@ } ] }, - "description": "Defines the mode of the `AvatarGroup`.", "default": "\"Group\"", + "description": "Defines the mode of the `AvatarGroup`.", "privacy": "public", - "_ui5validator": "AvatarGroupType" + "_ui5validator": "String" }, { "kind": "field", @@ -3785,9 +3786,9 @@ } ] }, + "default": "{}", "description": "Defines the additional accessibility attributes that will be applied to the component.\nThe following field is supported:\n\n- **hasPopup**: Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by the button.\nAccepts the following string values: `dialog`, `grid`, `listbox`, `menu` or `tree`.", "privacy": "public", - "default": "{}", "_ui5since": "2.0.0", "_ui5validator": "Object" }, @@ -3987,10 +3988,10 @@ } ] }, - "description": "Defines the component's design.", "default": "\"Header\"", + "description": "Defines the component's design.", "privacy": "public", - "_ui5validator": "BarDesign" + "_ui5validator": "String" } ], "attributes": [ @@ -4074,10 +4075,10 @@ } ] }, - "description": "Defines the visual appearance of the last BreadcrumbsItem.\n\nThe Breadcrumbs supports two visual appearances for the last BreadcrumbsItem:\n- \"Standard\" - displaying the last item as \"current page\" (bold and without separator)\n- \"NoCurrentPage\" - displaying the last item as a regular BreadcrumbsItem, followed by separator", "default": "\"Standard\"", + "description": "Defines the visual appearance of the last BreadcrumbsItem.\n\nThe Breadcrumbs supports two visual appearances for the last BreadcrumbsItem:\n- \"Standard\" - displaying the last item as \"current page\" (bold and without separator)\n- \"NoCurrentPage\" - displaying the last item as a regular BreadcrumbsItem, followed by separator", "privacy": "public", - "_ui5validator": "BreadcrumbsDesign" + "_ui5validator": "String" }, { "kind": "field", @@ -4092,10 +4093,10 @@ } ] }, - "description": "Determines the visual style of the separator between the breadcrumb items.", "default": "\"Slash\"", + "description": "Determines the visual style of the separator between the breadcrumb items.", "privacy": "public", - "_ui5validator": "BreadcrumbsSeparator" + "_ui5validator": "String" } ], "events": [ @@ -4232,10 +4233,10 @@ "kind": "field", "name": "href", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the link href.\n\n**Note:** Standard hyperlink behavior is supported.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -4254,7 +4255,7 @@ "kind": "field", "name": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the accessible ARIA name of the item.", "default": "undefined", @@ -4266,10 +4267,10 @@ { "description": "Defines the link href.\n\n**Note:** Standard hyperlink behavior is supported.", "name": "href", - "default": "\"\"", + "default": "undefined", "fieldName": "href", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -4287,7 +4288,7 @@ "default": "undefined", "fieldName": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" } } ], @@ -4345,11 +4346,11 @@ "kind": "field", "name": "text", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines text to be displayed below the component. It can be used to inform the user of the current operation.", "privacy": "public", - "default": "\"\"", + "default": "undefined", "_ui5since": "1.0.0-rc.7", "_ui5validator": "String" }, @@ -4366,10 +4367,10 @@ } ] }, - "description": "Defines the size of the component.", "default": "\"M\"", + "description": "Defines the size of the component.", "privacy": "public", - "_ui5validator": "BusyIndicatorSize" + "_ui5validator": "String" }, { "kind": "field", @@ -4377,8 +4378,8 @@ "type": { "text": "boolean" }, - "description": "Defines if the busy indicator is visible on the screen. By default it is not.", "default": "false", + "description": "Defines if the busy indicator is visible on the screen. By default it is not.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -4388,10 +4389,10 @@ "type": { "text": "number" }, - "description": "Defines the delay in milliseconds, after which the busy indicator will be visible on the screen.", "default": "1000", + "description": "Defines the delay in milliseconds, after which the busy indicator will be visible on the screen.", "privacy": "public", - "_ui5validator": "Integer" + "_ui5validator": "Number" }, { "kind": "field", @@ -4406,20 +4407,20 @@ } ] }, - "description": "Defines the placement of the text.", "default": "\"Bottom\"", + "description": "Defines the placement of the text.", "privacy": "public", - "_ui5validator": "BusyIndicatorTextPlacement" + "_ui5validator": "String" } ], "attributes": [ { "description": "Defines text to be displayed below the component. It can be used to inform the user of the current operation.", "name": "text", - "default": "\"\"", + "default": "undefined", "fieldName": "text", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -4534,10 +4535,10 @@ } ] }, - "description": "Defines the component design.", "default": "\"Default\"", + "description": "Defines the component design.", "privacy": "public", - "_ui5validator": "ButtonDesign" + "_ui5validator": "String" }, { "kind": "field", @@ -4545,8 +4546,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is disabled.\nA disabled component can't be pressed or\nfocused, and it is not in the tab chain.", "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", "_ui5validator": "Boolean" }, @@ -4554,10 +4555,10 @@ "kind": "field", "name": "icon", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the icon, displayed as graphical element within the component.\nThe SAP-icons font provides numerous options.\n\nExample:\nSee all the available icons within the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -4565,10 +4566,10 @@ "kind": "field", "name": "endIcon", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the icon, displayed as graphical element within the component after the button text.\n\n**Note:** It is highly recommended to use `endIcon` property only together with `icon` and/or `text` properties.\nUsage of `endIcon` only should be avoided.\n\nThe SAP-icons font provides numerous options.\n\nExample:\nSee all the available icons within the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -4578,8 +4579,8 @@ "type": { "text": "boolean" }, - "description": "When set to `true`, the component will\nautomatically submit the nearest HTML form element on `press`.\n\n**Note:** This property is only applicable within the context of an HTML Form element.`", "default": "false", + "description": "When set to `true`, the component will\nautomatically submit the nearest HTML form element on `press`.\n\n**Note:** This property is only applicable within the context of an HTML Form element.`", "privacy": "public", "deprecated": "Set the \"type\" property to \"Submit\" to achieve the same result. The \"submits\" property is ignored if \"type\" is set to any value other than \"Button\".", "_ui5validator": "Boolean" @@ -4588,10 +4589,10 @@ "kind": "field", "name": "tooltip", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the tooltip of the component.\n\n**Note:** A tooltip attribute should be provided for icon-only buttons, in order to represent their exact meaning/function.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.2.0", "_ui5validator": "String" @@ -4612,10 +4613,10 @@ "kind": "field", "name": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Receives id(or many ids) of the elements that label the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.1.0", "_ui5validator": "String" @@ -4633,9 +4634,9 @@ } ] }, + "default": "{}", "description": "Defines the additional accessibility attributes that will be applied to the component.\nThe following fields are supported:\n\n- **expanded**: Indicates whether the button, or another grouping element it controls, is currently expanded or collapsed.\nAccepts the following string values: `true` or `false`\n\n- **hasPopup**: Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by the button.\nAccepts the following string values: `dialog`, `grid`, `listbox`, `menu` or `tree`.\n\n- **controls**: Identifies the element (or elements) whose contents or presence are controlled by the button element.\nAccepts a lowercase string value.", "privacy": "public", - "default": "{}", "_ui5since": "1.2.0", "_ui5validator": "Object" }, @@ -4652,11 +4653,11 @@ } ] }, - "description": "Defines whether the button has special form-related functionality.\n\n**Note:** This property is only applicable within the context of an HTML Form element.", "default": "\"Button\"", + "description": "Defines whether the button has special form-related functionality.\n\n**Note:** This property is only applicable within the context of an HTML Form element.", "privacy": "public", "_ui5since": "1.15.0", - "_ui5validator": "ButtonType" + "_ui5validator": "String" }, { "kind": "field", @@ -4671,11 +4672,11 @@ } ] }, - "description": "Describes the accessibility role of the button.\n\n**Note:** Use ButtonAccessibleRole.Link role only with a press handler, which performs a navigation. In all other scenarios the default button semantics are recommended.", "default": "\"Button\"", + "description": "Describes the accessibility role of the button.\n\n**Note:** Use ButtonAccessibleRole.Link role only with a press handler, which performs a navigation. In all other scenarios the default button semantics are recommended.", "privacy": "public", "_ui5since": "1.23", - "_ui5validator": "ButtonAccessibleRole" + "_ui5validator": "String" } ], "events": [ @@ -4710,19 +4711,19 @@ { "description": "Defines the icon, displayed as graphical element within the component.\nThe SAP-icons font provides numerous options.\n\nExample:\nSee all the available icons within the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).", "name": "icon", - "default": "\"\"", + "default": "undefined", "fieldName": "icon", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the icon, displayed as graphical element within the component after the button text.\n\n**Note:** It is highly recommended to use `endIcon` property only together with `icon` and/or `text` properties.\nUsage of `endIcon` only should be avoided.\n\nThe SAP-icons font provides numerous options.\n\nExample:\nSee all the available icons within the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).", "name": "end-icon", - "default": "\"\"", + "default": "undefined", "fieldName": "endIcon", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -4738,10 +4739,10 @@ { "description": "Defines the tooltip of the component.\n\n**Note:** A tooltip attribute should be provided for icon-only buttons, in order to represent their exact meaning/function.", "name": "tooltip", - "default": "\"\"", + "default": "undefined", "fieldName": "tooltip", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -4756,10 +4757,10 @@ { "description": "Receives id(or many ids) of the elements that label the component.", "name": "accessible-name-ref", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -4821,6 +4822,12 @@ "kind": "javascript-module", "path": "dist/Calendar.js", "declarations": [ + { + "kind": "interface", + "name": "ICalendarSelectedDates", + "description": "Interface for components that may be slotted inside a `ui5-calendar`.\n\n**Note:** Use with `ui5-date` or `ui5-date-range` as calendar date selection types.", + "_ui5privacy": "public" + }, { "kind": "class", "description": "### Overview\n\nThe `ui5-calendar` component allows users to select one or more dates.\n\nCurrently selected dates are represented with instances of `ui5-date` as\nchildren of the `ui5-calendar`. The value property of each `ui5-date` must be a\ndate string, correctly formatted according to the `ui5-calendar`'s `formatPattern` property.\nWhenever the user changes the date selection, `ui5-calendar` will automatically create/remove instances\nof `ui5-date` in itself, unless you prevent this behavior by calling `preventDefault()` for the\n`selection-change` event. This is useful if you want to control the selected dates externally.\n\n### Usage\n\nThe user can navigate to a particular date by:\n\n- Pressing over a month inside the months view\n- Pressing over an year inside the years view\n\nThe user can confirm a date selection by pressing over a date inside the days view.\n\n### Keyboard Handling\nThe `ui5-calendar` provides advanced keyboard handling.\nWhen a picker is showed and focused the user can use the following keyboard\nshortcuts in order to perform a navigation:\n\n- Day picker:\n\n- [F4] - Shows month picker\n- [Shift] + [F4] - Shows year picker\n- [Page Up] - Navigate to the previous month\n- [Page Down] - Navigate to the next month\n- [Shift] + [Page Up] - Navigate to the previous year\n- [Shift] + [Page Down] - Navigate to the next year\n- [Ctrl] + [Shift] + [Page Up] - Navigate ten years backwards\n- [Ctrl] + [Shift] + [Page Down] - Navigate ten years forwards\n- [Home] - Navigate to the first day of the week\n- [End] - Navigate to the last day of the week\n- [Ctrl] + [Home] - Navigate to the first day of the month\n- [Ctrl] + [End] - Navigate to the last day of the month\n\n- Month picker:\n\n- [Page Up] - Navigate to the previous year\n- [Page Down] - Navigate to the next year\n- [Home] - Navigate to the first month of the current row\n- [End] - Navigate to the last month of the current row\n- [Ctrl] + [Home] - Navigate to the first month of the current year\n- [Ctrl] + [End] - Navigate to the last month of the year\n\n- Year picker:\n\n- [Page Up] - Navigate to the previous year range\n- [Page Down] - Navigate the next year range\n- [Home] - Navigate to the first year of the current row\n- [End] - Navigate to the last year of the current row\n- [Ctrl] + [Home] - Navigate to the first year of the current year range\n- [Ctrl] + [End] - Navigate to the last year of the current year range\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### Calendar types\nThe component supports several calendar types - Gregorian, Buddhist, Islamic, Japanese and Persian.\nBy default the Gregorian Calendar is used. In order to use the Buddhist, Islamic, Japanese or Persian calendar,\nyou need to set the `primaryCalendarType` property and import one or more of the following modules:\n\n`import \"@ui5/webcomponents-localization/dist/features/calendar/Buddhist.js\";`\n\n`import \"@ui5/webcomponents-localization/dist/features/calendar/Islamic.js\";`\n\n`import \"@ui5/webcomponents-localization/dist/features/calendar/Japanese.js\";`\n\n`import \"@ui5/webcomponents-localization/dist/features/calendar/Persian.js\";`\n\nOr, you can use the global configuration and set the `calendarType` key:\n\n```html\n\n```\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents/dist/Calendar.js\";`", @@ -4844,7 +4851,7 @@ }, { "name": "default", - "description": "Defines the selected date or dates (depending on the `selectionMode` property)\nfor this calendar as instances of `ui5-date`.", + "description": "Defines the selected date or dates (depending on the `selectionMode` property)\nfor this calendar as instances of `ui5-date` or `ui5-date-range`.\nUse `ui5-date` for single or multiple selection, and `ui5-date-range` for range selection.", "_ui5propertyName": "dates", "_ui5type": { "text": "Array", @@ -4889,10 +4896,10 @@ } ] }, - "description": "Defines the type of selection used in the calendar component.\nAccepted property values are:\n\n- `CalendarSelectionMode.Single` - enables a single date selection.(default value)\n- `CalendarSelectionMode.Range` - enables selection of a date range.\n- `CalendarSelectionMode.Multiple` - enables selection of multiple dates.", "default": "\"Single\"", + "description": "Defines the type of selection used in the calendar component.\nAccepted property values are:\n\n- `CalendarSelectionMode.Single` - enables a single date selection.(default value)\n- `CalendarSelectionMode.Range` - enables selection of a date range.\n- `CalendarSelectionMode.Multiple` - enables selection of multiple dates.", "privacy": "public", - "_ui5validator": "CalendarSelectionMode" + "_ui5validator": "String" }, { "kind": "field", @@ -4900,8 +4907,8 @@ "type": { "text": "boolean" }, - "description": "Defines the visibility of the week numbers column.\n\n**Note:** For calendars other than Gregorian,\nthe week numbers are not displayed regardless of what is set.", "default": "false", + "description": "Defines the visibility of the week numbers column.\n\n**Note:** For calendars other than Gregorian,\nthe week numbers are not displayed regardless of what is set.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -4921,7 +4928,7 @@ "description": "Sets a calendar type used for display.\nIf not set, the calendar type of the global configuration is used.", "default": "undefined", "privacy": "public", - "_ui5validator": "CalendarType", + "_ui5validator": "String", "inheritedFrom": { "name": "DateComponentBase", "module": "dist/DateComponentBase.js" @@ -4944,7 +4951,7 @@ "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.16", - "_ui5validator": "CalendarType", + "_ui5validator": "String", "inheritedFrom": { "name": "DateComponentBase", "module": "dist/DateComponentBase.js" @@ -4954,10 +4961,10 @@ "kind": "field", "name": "formatPattern", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Determines the format, displayed in the input field.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String", "inheritedFrom": { @@ -4971,8 +4978,8 @@ "type": { "text": "string" }, - "description": "Determines the minimum date available for selection.\n\n**Note:** If the formatPattern property is not set, the minDate value must be provided in the ISO date format (YYYY-MM-dd).", "default": "\"\"", + "description": "Determines the minimum date available for selection.\n\n**Note:** If the formatPattern property is not set, the minDate value must be provided in the ISO date format (YYYY-MM-dd).", "privacy": "public", "_ui5since": "1.0.0-rc.6", "_ui5validator": "String", @@ -4987,8 +4994,8 @@ "type": { "text": "string" }, - "description": "Determines the maximum date available for selection.\n\n**Note:** If the formatPattern property is not set, the maxDate value must be provided in the ISO date format (YYYY-MM-dd).", "default": "\"\"", + "description": "Determines the maximum date available for selection.\n\n**Note:** If the formatPattern property is not set, the maxDate value must be provided in the ISO date format (YYYY-MM-dd).", "privacy": "public", "_ui5since": "1.0.0-rc.6", "_ui5validator": "String", @@ -5082,10 +5089,10 @@ { "description": "Determines the format, displayed in the input field.", "name": "format-pattern", - "default": "\"\"", + "default": "undefined", "fieldName": "formatPattern", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "DateComponentBase", @@ -5164,8 +5171,8 @@ "type": { "text": "string" }, - "description": "The date formatted according to the `formatPattern` property\nof the `ui5-calendar` that hosts the component.", "default": "\"\"", + "description": "The date formatted according to the `formatPattern` property\nof the `ui5-calendar` that hosts the component.", "privacy": "public", "_ui5validator": "String" } @@ -5189,7 +5196,14 @@ "tagName": "ui5-date", "customElement": true, "_ui5privacy": "public", - "_ui5abstract": true + "_ui5abstract": true, + "_ui5implements": [ + { + "name": "ICalendarSelectedDates", + "package": "@ui5/webcomponents", + "module": "dist/Calendar.js" + } + ] } ], "exports": [ @@ -5226,8 +5240,8 @@ "type": { "text": "string" }, - "description": "Start of date range formatted according to the `formatPattern` property\nof the `ui5-calendar` that hosts the component.", "default": "\"\"", + "description": "Start of date range formatted according to the `formatPattern` property\nof the `ui5-calendar` that hosts the component.", "privacy": "public", "_ui5validator": "String" }, @@ -5237,8 +5251,8 @@ "type": { "text": "string" }, - "description": "End of date range formatted according to the `formatPattern` property\nof the `ui5-calendar` that hosts the component.", "default": "\"\"", + "description": "End of date range formatted according to the `formatPattern` property\nof the `ui5-calendar` that hosts the component.", "privacy": "public", "_ui5validator": "String" } @@ -5272,7 +5286,14 @@ "customElement": true, "_ui5since": "2.0", "_ui5privacy": "public", - "_ui5abstract": true + "_ui5abstract": true, + "_ui5implements": [ + { + "name": "ICalendarSelectedDates", + "package": "@ui5/webcomponents", + "module": "dist/Calendar.js" + } + ] } ], "exports": [ @@ -5294,21 +5315,6 @@ } ] }, - { - "kind": "javascript-module", - "path": "dist/CalendarHeader.js", - "declarations": [], - "exports": [ - { - "kind": "js", - "name": "default", - "declaration": { - "name": "CalendarHeader", - "module": "dist/CalendarHeader.js" - } - } - ] - }, { "kind": "javascript-module", "path": "dist/CalendarLegend.js", @@ -5342,8 +5348,8 @@ "type": { "text": "boolean" }, - "description": "Hides the Today item in the legend.", "default": "false", + "description": "Hides the Today item in the legend.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -5353,8 +5359,8 @@ "type": { "text": "boolean" }, - "description": "Hides the Selected day item in the legend.", "default": "false", + "description": "Hides the Selected day item in the legend.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -5364,8 +5370,8 @@ "type": { "text": "boolean" }, - "description": "Hides the Non-Working day item in the legend.", "default": "false", + "description": "Hides the Non-Working day item in the legend.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -5375,8 +5381,8 @@ "type": { "text": "boolean" }, - "description": "Hides the Working day item in the legend.", "default": "false", + "description": "Hides the Working day item in the legend.", "privacy": "public", "_ui5validator": "Boolean" } @@ -5462,10 +5468,10 @@ "kind": "field", "name": "text", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text content of the Calendar Legend Item.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -5482,20 +5488,20 @@ } ] }, - "description": "Defines the type of the Calendar Legend Item.", "default": "\"None\"", + "description": "Defines the type of the Calendar Legend Item.", "privacy": "public", - "_ui5validator": "CalendarLegendItemType" + "_ui5validator": "String" } ], "attributes": [ { "description": "Defines the text content of the Calendar Legend Item.", "name": "text", - "default": "\"\"", + "default": "undefined", "fieldName": "text", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -5583,10 +5589,10 @@ { "description": "Determines the format, displayed in the input field.", "name": "format-pattern", - "default": "\"\"", + "default": "undefined", "fieldName": "formatPattern", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "DateComponentBase", @@ -5637,7 +5643,7 @@ "description": "Sets a calendar type used for display.\nIf not set, the calendar type of the global configuration is used.", "default": "undefined", "privacy": "public", - "_ui5validator": "CalendarType", + "_ui5validator": "String", "inheritedFrom": { "name": "DateComponentBase", "module": "dist/DateComponentBase.js" @@ -5660,7 +5666,7 @@ "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.16", - "_ui5validator": "CalendarType", + "_ui5validator": "String", "inheritedFrom": { "name": "DateComponentBase", "module": "dist/DateComponentBase.js" @@ -5670,10 +5676,10 @@ "kind": "field", "name": "formatPattern", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Determines the format, displayed in the input field.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String", "inheritedFrom": { @@ -5687,8 +5693,8 @@ "type": { "text": "string" }, - "description": "Determines the minimum date available for selection.\n\n**Note:** If the formatPattern property is not set, the minDate value must be provided in the ISO date format (YYYY-MM-dd).", "default": "\"\"", + "description": "Determines the minimum date available for selection.\n\n**Note:** If the formatPattern property is not set, the minDate value must be provided in the ISO date format (YYYY-MM-dd).", "privacy": "public", "_ui5since": "1.0.0-rc.6", "_ui5validator": "String", @@ -5703,8 +5709,8 @@ "type": { "text": "string" }, - "description": "Determines the maximum date available for selection.\n\n**Note:** If the formatPattern property is not set, the maxDate value must be provided in the ISO date format (YYYY-MM-dd).", "default": "\"\"", + "description": "Determines the maximum date available for selection.\n\n**Note:** If the formatPattern property is not set, the maxDate value must be provided in the ISO date format (YYYY-MM-dd).", "privacy": "public", "_ui5since": "1.0.0-rc.6", "_ui5validator": "String", @@ -5777,10 +5783,10 @@ "kind": "field", "name": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the accessible name of the component, which is used as the name of the card region and should be unique per card.\n\n**Note:** `accessibleName` should be always set, unless `accessibleNameRef` is set.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.16", "_ui5validator": "String" @@ -5789,10 +5795,10 @@ "kind": "field", "name": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the IDs of the elements that label the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.16", "_ui5validator": "String" @@ -5802,19 +5808,19 @@ { "description": "Defines the accessible name of the component, which is used as the name of the card region and should be unique per card.\n\n**Note:** `accessibleName` should be always set, unless `accessibleNameRef` is set.", "name": "accessible-name", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the IDs of the elements that label the component.", "name": "accessible-name-ref", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" } } ], @@ -5896,10 +5902,10 @@ "kind": "field", "name": "titleText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the title text.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -5907,10 +5913,10 @@ "kind": "field", "name": "subtitleText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the subtitle text.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -5918,10 +5924,10 @@ "kind": "field", "name": "additionalText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the additional text.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -5931,8 +5937,8 @@ "type": { "text": "boolean" }, - "description": "Defines if the component would be interactive,\ne.g gets hover effect, gets focus outline and `click` event is fired, when pressed.", "default": "false", + "description": "Defines if the component would be interactive,\ne.g gets hover effect, gets focus outline and `click` event is fired, when pressed.", "privacy": "public", "_ui5validator": "Boolean" } @@ -5951,28 +5957,28 @@ { "description": "Defines the title text.", "name": "title-text", - "default": "\"\"", + "default": "undefined", "fieldName": "titleText", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the subtitle text.", "name": "subtitle-text", - "default": "\"\"", + "default": "undefined", "fieldName": "subtitleText", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the additional text.", "name": "additional-text", - "default": "\"\"", + "default": "undefined", "fieldName": "additionalText", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -6045,10 +6051,10 @@ "kind": "field", "name": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the accessible name of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.24", "_ui5validator": "String" @@ -6057,10 +6063,10 @@ "kind": "field", "name": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the IDs of the elements that label the input.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.24", "_ui5validator": "String" @@ -6071,8 +6077,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the carousel should loop, i.e show the first page after the last page is reached and vice versa.", "default": "false", + "description": "Defines whether the carousel should loop, i.e show the first page after the last page is reached and vice versa.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -6082,8 +6088,8 @@ "type": { "text": "string" }, - "description": "Defines the number of items per page depending on the carousel width.\n\n- 'S' for screens smaller than 600 pixels.\n- 'M' for screens greater than or equal to 600 pixels and smaller than 1024 pixels.\n- 'L' for screens greater than or equal to 1024 pixels and smaller than 1440 pixels.\n- 'XL' for screens greater than or equal to 1440 pixels.\n\nOne item per page is shown by default.", "default": "\"S1 M1 L1 XL1\"", + "description": "Defines the number of items per page depending on the carousel width.\n\n- 'S' for screens smaller than 600 pixels.\n- 'M' for screens greater than or equal to 600 pixels and smaller than 1024 pixels.\n- 'L' for screens greater than or equal to 1024 pixels and smaller than 1440 pixels.\n- 'XL' for screens greater than or equal to 1440 pixels.\n\nOne item per page is shown by default.", "privacy": "public", "_ui5validator": "String" }, @@ -6093,8 +6099,8 @@ "type": { "text": "boolean" }, - "description": "Defines the visibility of the navigation arrows.\nIf set to true the navigation arrows will be hidden.\n\n**Note:** The navigation arrows are never displayed on touch devices.\nIn this case, the user can swipe to navigate through the items.", "default": "false", + "description": "Defines the visibility of the navigation arrows.\nIf set to true the navigation arrows will be hidden.\n\n**Note:** The navigation arrows are never displayed on touch devices.\nIn this case, the user can swipe to navigate through the items.", "privacy": "public", "_ui5since": "1.0.0-rc.15", "_ui5validator": "Boolean" @@ -6105,8 +6111,8 @@ "type": { "text": "boolean" }, - "description": "Defines the visibility of the page indicator.\nIf set to true the page indicator will be hidden.", "default": "false", + "description": "Defines the visibility of the page indicator.\nIf set to true the page indicator will be hidden.", "privacy": "public", "_ui5since": "1.0.0-rc.15", "_ui5validator": "Boolean" @@ -6124,11 +6130,11 @@ } ] }, - "description": "Defines the style of the page indicator.\nAvailable options are:\n\n- `Default` - The page indicator will be visualized as dots if there are fewer than 9 pages. If there are more pages, the page indicator will switch to displaying the current page and the total number of pages. (e.g. X of Y)\n- `Numeric` - The page indicator will display the current page and the total number of pages. (e.g. X of Y)", "default": "\"Default\"", + "description": "Defines the style of the page indicator.\nAvailable options are:\n\n- `Default` - The page indicator will be visualized as dots if there are fewer than 9 pages. If there are more pages, the page indicator will switch to displaying the current page and the total number of pages. (e.g. X of Y)\n- `Numeric` - The page indicator will display the current page and the total number of pages. (e.g. X of Y)", "privacy": "public", "_ui5since": "1.10", - "_ui5validator": "CarouselPageIndicatorType" + "_ui5validator": "String" }, { "kind": "field", @@ -6143,11 +6149,11 @@ } ] }, - "description": "Defines the carousel's background design.", "default": "\"Translucent\"", + "description": "Defines the carousel's background design.", "privacy": "public", "_ui5since": "1.14", - "_ui5validator": "BackgroundDesign" + "_ui5validator": "String" }, { "kind": "field", @@ -6162,11 +6168,11 @@ } ] }, - "description": "Defines the page indicator background design.", "default": "\"Solid\"", + "description": "Defines the page indicator background design.", "privacy": "public", "_ui5since": "1.14", - "_ui5validator": "BackgroundDesign" + "_ui5validator": "String" }, { "kind": "field", @@ -6181,11 +6187,11 @@ } ] }, - "description": "Defines the page indicator border design.", "default": "\"Solid\"", + "description": "Defines the page indicator border design.", "privacy": "public", "_ui5since": "1.14", - "_ui5validator": "BorderDesign" + "_ui5validator": "String" }, { "kind": "field", @@ -6200,10 +6206,10 @@ } ] }, - "description": "Defines the position of arrows.\n\nAvailable options are:\n\n- `Content` - the arrows are placed on the sides of the current page.\n- `Navigation` - the arrows are placed on the sides of the page indicator.", "default": "\"Content\"", + "description": "Defines the position of arrows.\n\nAvailable options are:\n\n- `Content` - the arrows are placed on the sides of the current page.\n- `Navigation` - the arrows are placed on the sides of the page indicator.", "privacy": "public", - "_ui5validator": "CarouselArrowsPlacement" + "_ui5validator": "String" }, { "kind": "method", @@ -6259,14 +6265,7 @@ "_ui5parameters": [ { "type": { - "text": "Integer", - "references": [ - { - "name": "Integer", - "package": "@ui5/webcomponents-base", - "module": "dist/types/Integer.js" - } - ] + "text": "Integer" }, "name": "selectedIndex", "_ui5privacy": "public", @@ -6279,19 +6278,19 @@ { "description": "Defines the accessible name of the component.", "name": "accessible-name", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the IDs of the elements that label the input.", "name": "accessible-name-ref", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -6345,7 +6344,7 @@ "default": "\"Translucent\"", "fieldName": "backgroundDesign", "type": { - "text": "BackgroundDesign" + "text": "\"Transparent\" | \"Solid\" | \"Translucent\"" } }, { @@ -6354,7 +6353,7 @@ "default": "\"Solid\"", "fieldName": "pageIndicatorBackgroundDesign", "type": { - "text": "BackgroundDesign" + "text": "\"Transparent\" | \"Solid\" | \"Translucent\"" } }, { @@ -6363,7 +6362,7 @@ "default": "\"Solid\"", "fieldName": "pageIndicatorBorderDesign", "type": { - "text": "BorderDesign" + "text": "\"None\" | \"Solid\"" } }, { @@ -6442,10 +6441,10 @@ "kind": "field", "name": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Receives id(or many ids) of the elements that label the component", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.1.0", "_ui5validator": "String" @@ -6454,11 +6453,11 @@ "kind": "field", "name": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the accessible ARIA name of the component.", "privacy": "public", - "default": "\"\"", + "default": "undefined", "_ui5since": "1.1.0", "_ui5validator": "String" }, @@ -6468,8 +6467,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is disabled.\n\n**Note:** A disabled component is completely noninteractive.", "default": "false", + "description": "Defines whether the component is disabled.\n\n**Note:** A disabled component is completely noninteractive.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -6479,8 +6478,8 @@ "type": { "text": "boolean" }, - "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.", "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", "_ui5validator": "Boolean" }, @@ -6490,9 +6489,9 @@ "type": { "text": "boolean" }, + "default": "false", "description": "Determines whether the `ui5-checkbox` is in display only state.\n\nWhen set to `true`, the `ui5-checkbox` is not interactive, not editable, not focusable\nand not in the tab chain. This setting is used for forms in review mode.\n\n**Note:** When the property `disabled` is set to `true` this property has no effect.", "privacy": "public", - "default": "false", "_ui5since": "1.22.0", "_ui5validator": "Boolean" }, @@ -6502,8 +6501,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is required.", "default": "false", + "description": "Defines whether the component is required.", "privacy": "public", "_ui5since": "1.3.0", "_ui5validator": "Boolean" @@ -6514,8 +6513,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is displayed as partially checked.\n\n**Note:** The indeterminate state can be set only programmatically and can’t be achieved by user\ninteraction and the resulting visual state depends on the values of the `indeterminate`\nand `checked` properties:\n\n- If the component is checked and indeterminate, it will be displayed as partially checked\n- If the component is checked and it is not indeterminate, it will be displayed as checked\n- If the component is not checked, it will be displayed as not checked regardless value of the indeterminate attribute", "default": "false", + "description": "Defines whether the component is displayed as partially checked.\n\n**Note:** The indeterminate state can be set only programmatically and can’t be achieved by user\ninteraction and the resulting visual state depends on the values of the `indeterminate`\nand `checked` properties:\n\n- If the component is checked and indeterminate, it will be displayed as partially checked\n- If the component is checked and it is not indeterminate, it will be displayed as checked\n- If the component is not checked, it will be displayed as not checked regardless value of the indeterminate attribute", "privacy": "public", "_ui5since": "1.0.0-rc.15", "_ui5validator": "Boolean" @@ -6526,8 +6525,8 @@ "type": { "text": "boolean" }, - "description": "Defines if the component is checked.\n\n**Note:** The property can be changed with user interaction,\neither by cliking/tapping on the component, or by\npressing the Enter or Space key.", "default": "false", + "description": "Defines if the component is checked.\n\n**Note:** The property can be changed with user interaction,\neither by cliking/tapping on the component, or by\npressing the Enter or Space key.", "privacy": "public", "_ui5validator": "Boolean", "_ui5formProperty": true, @@ -6537,10 +6536,10 @@ "kind": "field", "name": "text", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -6557,10 +6556,10 @@ } ] }, - "description": "Defines the value state of the component.", "default": "\"None\"", + "description": "Defines the value state of the component.", "privacy": "public", - "_ui5validator": "ValueState" + "_ui5validator": "String" }, { "kind": "field", @@ -6575,19 +6574,19 @@ } ] }, - "description": "Defines whether the component text wraps when there is not enough space.\n\n**Note:** for option \"Normal\" the text will wrap and the words will not be broken based on hyphenation.\n**Note:** for option \"None\" the text will be truncated with an ellipsis.", "default": "\"Normal\"", + "description": "Defines whether the component text wraps when there is not enough space.\n\n**Note:** for option \"Normal\" the text will wrap and the words will not be broken based on hyphenation.\n**Note:** for option \"None\" the text will be truncated with an ellipsis.", "privacy": "public", - "_ui5validator": "WrappingType" + "_ui5validator": "String" }, { "kind": "field", "name": "name", "type": { - "text": "string" + "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": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" } @@ -6607,19 +6606,19 @@ { "description": "Receives id(or many ids) of the elements that label the component", "name": "accessible-name-ref", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the accessible ARIA name of the component.", "name": "accessible-name", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -6679,10 +6678,10 @@ { "description": "Defines the text of the component.", "name": "text", - "default": "\"\"", + "default": "undefined", "fieldName": "text", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -6706,10 +6705,10 @@ { "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": "\"\"", + "default": "undefined", "fieldName": "name", "type": { - "text": "string" + "text": "string | undefined" } } ], @@ -6846,12 +6845,12 @@ "kind": "field", "name": "value", "type": { - "text": "string | undefined" + "text": "string" }, + "default": "\"\"", "description": "Defines the colour of the component.\n\n**Note:** The value should be a valid CSS color.", - "default": "undefined", "privacy": "public", - "_ui5validator": "CSSColor" + "_ui5validator": "String" }, { "kind": "field", @@ -6859,9 +6858,9 @@ "type": { "text": "boolean" }, + "default": "false", "description": "Defines if the component is selected.\n\n**Note:** Only one item must be selected per ui5-color-palette.\nIf more than one item is defined as selected, the last one would be considered as the selected one.", "privacy": "public", - "default": "false", "_ui5since": "2.0.0", "_ui5validator": "Boolean" } @@ -6870,10 +6869,10 @@ { "description": "Defines the colour of the component.\n\n**Note:** The value should be a valid CSS color.", "name": "value", - "default": "undefined", + "default": "\"\"", "fieldName": "value", "type": { - "text": "string | undefined" + "text": "string" } }, { @@ -6956,8 +6955,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the user can see the last used colors in the bottom of the component", "default": "false", + "description": "Defines whether the user can see the last used colors in the bottom of the component", "privacy": "public", "_ui5validator": "Boolean" }, @@ -6967,8 +6966,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the user can choose a custom color from a component.\n\n**Note:** In order to use this property you need to import the following module: `\"@ui5/webcomponents/dist/features/ColorPaletteMoreColors.js\"`", "default": "false", + "description": "Defines whether the user can choose a custom color from a component.\n\n**Note:** In order to use this property you need to import the following module: `\"@ui5/webcomponents/dist/features/ColorPaletteMoreColors.js\"`", "privacy": "public", "_ui5validator": "Boolean" }, @@ -6978,8 +6977,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the user can choose the default color from a button.", "default": "false", + "description": "Defines whether the user can choose the default color from a button.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -6992,7 +6991,7 @@ "description": "Defines the default color of the component.\n\n**Note:** The default color should be a part of the ColorPalette colors`", "default": "undefined", "privacy": "public", - "_ui5validator": "CSSColor" + "_ui5validator": "String" }, { "kind": "field", @@ -7000,9 +6999,9 @@ "type": { "text": "boolean" }, + "default": "false", "description": "Defines the open | closed state of the popover.", "privacy": "public", - "default": "false", "_ui5since": "1.21.0", "_ui5validator": "Boolean" }, @@ -7016,7 +7015,7 @@ "privacy": "public", "default": "undefined", "_ui5since": "1.21.0", - "_ui5validator": "DOMReference" + "_ui5validator": "String" } ], "events": [ @@ -7156,19 +7155,19 @@ "type": { "text": "string" }, + "default": "\"rgba(255,255,255,1)\"", "description": "Defines the currently selected color of the component.\n\n**Note**: use HEX, RGB, RGBA, HSV formats or a CSS color name when modifying this property.", - "default": "\"rgba(255, 255, 255, 1)\"", "privacy": "public", - "_ui5validator": "CSSColor" + "_ui5validator": "String" }, { "kind": "field", "name": "name", "type": { - "text": "string" + "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": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "2.0.0", "_ui5validator": "String" @@ -7188,7 +7187,7 @@ { "description": "Defines the currently selected color of the component.\n\n**Note**: use HEX, RGB, RGBA, HSV formats or a CSS color name when modifying this property.", "name": "value", - "default": "\"rgba(255, 255, 255, 1)\"", + "default": "\"rgba(255,255,255,1)\"", "fieldName": "value", "type": { "text": "string" @@ -7197,10 +7196,10 @@ { "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": "\"\"", + "default": "undefined", "fieldName": "name", "type": { - "text": "string" + "text": "string | undefined" } } ], @@ -7298,8 +7297,8 @@ "type": { "text": "string" }, - "description": "Defines the value of the component.", "default": "\"\"", + "description": "Defines the value of the component.", "privacy": "public", "_ui5validator": "String", "_ui5formProperty": true, @@ -7309,10 +7308,10 @@ "kind": "field", "name": "name", "type": { - "text": "string" + "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": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "2.0.0", "_ui5validator": "String" @@ -7323,8 +7322,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the value will be autocompleted to match an item", "default": "false", + "description": "Defines whether the value will be autocompleted to match an item", "privacy": "public", "_ui5since": "1.19.0", "_ui5validator": "Boolean" @@ -7333,10 +7332,10 @@ "kind": "field", "name": "placeholder", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines a short hint intended to aid the user with data entry when the\ncomponent has no value.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -7346,8 +7345,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is in disabled state.\n\n**Note:** A disabled component is completely noninteractive.", "default": "false", + "description": "Defines whether the component is in disabled state.\n\n**Note:** A disabled component is completely noninteractive.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -7364,10 +7363,10 @@ } ] }, - "description": "Defines the value state of the component.", "default": "\"None\"", + "description": "Defines the value state of the component.", "privacy": "public", - "_ui5validator": "ValueState" + "_ui5validator": "String" }, { "kind": "field", @@ -7375,8 +7374,8 @@ "type": { "text": "boolean" }, - "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.", "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", "_ui5validator": "Boolean" }, @@ -7386,8 +7385,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is required.", "default": "false", + "description": "Defines whether the component is required.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -7397,8 +7396,8 @@ "type": { "text": "boolean" }, - "description": "Indicates whether a loading indicator should be shown in the picker.", "default": "false", + "description": "Indicates whether a loading indicator should be shown in the picker.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -7415,10 +7414,10 @@ } ] }, - "description": "Defines the filter type of the component.", "default": "\"StartsWithPerTerm\"", + "description": "Defines the filter type of the component.", "privacy": "public", - "_ui5validator": "ComboBoxFilter" + "_ui5validator": "String" }, { "kind": "field", @@ -7426,8 +7425,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the clear icon of the combobox will be shown.", "default": "false", + "description": "Defines whether the clear icon of the combobox will be shown.", "privacy": "public", "_ui5since": "1.20.1", "_ui5validator": "Boolean" @@ -7436,10 +7435,10 @@ "kind": "field", "name": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the accessible ARIA name of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15", "_ui5validator": "String" @@ -7448,10 +7447,10 @@ "kind": "field", "name": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Receives id(or many ids) of the elements that label the component", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15", "_ui5validator": "String" @@ -7520,10 +7519,10 @@ { "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": "\"\"", + "default": "undefined", "fieldName": "name", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -7538,10 +7537,10 @@ { "description": "Defines a short hint intended to aid the user with data entry when the\ncomponent has no value.", "name": "placeholder", - "default": "\"\"", + "default": "undefined", "fieldName": "placeholder", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -7610,19 +7609,19 @@ { "description": "Defines the accessible ARIA name of the component.", "name": "accessible-name", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Receives id(or many ids) of the elements that label the component", "name": "accessible-name-ref", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" } } ], @@ -7669,10 +7668,10 @@ "kind": "field", "name": "text", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -7680,10 +7679,10 @@ "kind": "field", "name": "additionalText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the additional text of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.11", "_ui5validator": "String" @@ -7693,19 +7692,19 @@ { "description": "Defines the text of the component.", "name": "text", - "default": "\"\"", + "default": "undefined", "fieldName": "text", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the additional text of the component.", "name": "additional-text", - "default": "\"\"", + "default": "undefined", "fieldName": "additionalText", "type": { - "text": "string" + "text": "string | undefined" } } ], @@ -7775,12 +7774,12 @@ "members": [ { "kind": "field", - "name": "text", + "name": "headerText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" } @@ -7788,11 +7787,11 @@ "attributes": [ { "description": "Defines the text of the component.", - "name": "text", - "default": "\"\"", - "fieldName": "text", + "name": "header-text", + "default": "undefined", + "fieldName": "headerText", "type": { - "text": "string" + "text": "string | undefined" } } ], @@ -7859,7 +7858,7 @@ "description": "Sets a calendar type used for display.\nIf not set, the calendar type of the global configuration is used.", "default": "undefined", "privacy": "public", - "_ui5validator": "CalendarType" + "_ui5validator": "String" }, { "kind": "field", @@ -7878,16 +7877,16 @@ "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.16", - "_ui5validator": "CalendarType" + "_ui5validator": "String" }, { "kind": "field", "name": "formatPattern", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Determines the format, displayed in the input field.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -7897,8 +7896,8 @@ "type": { "text": "string" }, - "description": "Determines the minimum date available for selection.\n\n**Note:** If the formatPattern property is not set, the minDate value must be provided in the ISO date format (YYYY-MM-dd).", "default": "\"\"", + "description": "Determines the minimum date available for selection.\n\n**Note:** If the formatPattern property is not set, the minDate value must be provided in the ISO date format (YYYY-MM-dd).", "privacy": "public", "_ui5since": "1.0.0-rc.6", "_ui5validator": "String" @@ -7909,8 +7908,8 @@ "type": { "text": "string" }, - "description": "Determines the maximum date available for selection.\n\n**Note:** If the formatPattern property is not set, the maxDate value must be provided in the ISO date format (YYYY-MM-dd).", "default": "\"\"", + "description": "Determines the maximum date available for selection.\n\n**Note:** If the formatPattern property is not set, the maxDate value must be provided in the ISO date format (YYYY-MM-dd).", "privacy": "public", "_ui5since": "1.0.0-rc.6", "_ui5validator": "String" @@ -7938,10 +7937,10 @@ { "description": "Determines the format, displayed in the input field.", "name": "format-pattern", - "default": "\"\"", + "default": "undefined", "fieldName": "formatPattern", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -8010,8 +8009,8 @@ "type": { "text": "string" }, - "description": "Defines a formatted date value.", "default": "\"\"", + "description": "Defines a formatted date value.", "privacy": "public", "_ui5validator": "String", "_ui5formProperty": true, @@ -8030,10 +8029,10 @@ } ] }, - "description": "Defines the value state of the component.", "default": "\"None\"", + "description": "Defines the value state of the component.", "privacy": "public", - "_ui5validator": "ValueState" + "_ui5validator": "String" }, { "kind": "field", @@ -8041,8 +8040,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is required.", "default": "false", + "description": "Defines whether the component is required.", "privacy": "public", "_ui5since": "1.0.0-rc.9", "_ui5validator": "Boolean" @@ -8053,8 +8052,8 @@ "type": { "text": "boolean" }, - "description": "Determines whether the component is displayed as disabled.", "default": "false", + "description": "Determines whether the component is displayed as disabled.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -8064,8 +8063,8 @@ "type": { "text": "boolean" }, - "description": "Determines whether the component is displayed as read-only.", "default": "false", + "description": "Determines whether the component is displayed as read-only.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -8084,10 +8083,10 @@ "kind": "field", "name": "name", "type": { - "text": "string" + "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": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -8097,8 +8096,8 @@ "type": { "text": "boolean" }, - "description": "Defines the visibility of the week numbers column.\n\n**Note:** For calendars other than Gregorian,\nthe week numbers are not displayed regardless of what is set.", "default": "false", + "description": "Defines the visibility of the week numbers column.\n\n**Note:** For calendars other than Gregorian,\nthe week numbers are not displayed regardless of what is set.", "privacy": "public", "_ui5since": "1.0.0-rc.8", "_ui5validator": "Boolean" @@ -8109,9 +8108,9 @@ "type": { "text": "boolean" }, + "default": "false", "description": "Defines the open or closed state of the popover.", "privacy": "public", - "default": "false", "_ui5since": "2.0.0", "_ui5validator": "Boolean" }, @@ -8119,10 +8118,10 @@ "kind": "field", "name": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the aria-label attribute for the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15", "_ui5validator": "String" @@ -8131,10 +8130,10 @@ "kind": "field", "name": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Receives id(or many ids) of the elements that label the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15", "_ui5validator": "String" @@ -8230,7 +8229,7 @@ "description": "Sets a calendar type used for display.\nIf not set, the calendar type of the global configuration is used.", "default": "undefined", "privacy": "public", - "_ui5validator": "CalendarType", + "_ui5validator": "String", "inheritedFrom": { "name": "DateComponentBase", "module": "dist/DateComponentBase.js" @@ -8253,7 +8252,7 @@ "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.16", - "_ui5validator": "CalendarType", + "_ui5validator": "String", "inheritedFrom": { "name": "DateComponentBase", "module": "dist/DateComponentBase.js" @@ -8263,10 +8262,10 @@ "kind": "field", "name": "formatPattern", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Determines the format, displayed in the input field.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String", "inheritedFrom": { @@ -8280,8 +8279,8 @@ "type": { "text": "string" }, - "description": "Determines the minimum date available for selection.\n\n**Note:** If the formatPattern property is not set, the minDate value must be provided in the ISO date format (YYYY-MM-dd).", "default": "\"\"", + "description": "Determines the minimum date available for selection.\n\n**Note:** If the formatPattern property is not set, the minDate value must be provided in the ISO date format (YYYY-MM-dd).", "privacy": "public", "_ui5since": "1.0.0-rc.6", "_ui5validator": "String", @@ -8296,8 +8295,8 @@ "type": { "text": "string" }, - "description": "Determines the maximum date available for selection.\n\n**Note:** If the formatPattern property is not set, the maxDate value must be provided in the ISO date format (YYYY-MM-dd).", "default": "\"\"", + "description": "Determines the maximum date available for selection.\n\n**Note:** If the formatPattern property is not set, the maxDate value must be provided in the ISO date format (YYYY-MM-dd).", "privacy": "public", "_ui5since": "1.0.0-rc.6", "_ui5validator": "String", @@ -8469,10 +8468,10 @@ { "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": "\"\"", + "default": "undefined", "fieldName": "name", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -8496,19 +8495,19 @@ { "description": "Defines the aria-label attribute for the component.", "name": "accessible-name", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Receives id(or many ids) of the elements that label the component.", "name": "accessible-name-ref", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -8549,10 +8548,10 @@ { "description": "Determines the format, displayed in the input field.", "name": "format-pattern", - "default": "\"\"", + "default": "undefined", "fieldName": "formatPattern", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "DateComponentBase", @@ -8627,11 +8626,8 @@ { "kind": "field", "name": "delimiter", - "type": { - "text": "string" - }, - "description": "Determines the symbol which separates the dates.\nIf not supplied, the default time interval delimiter for the current locale will be used.", "default": "\"-\"", + "description": "Determines the symbol which separates the dates.\nIf not supplied, the default time interval delimiter for the current locale will be used.", "privacy": "public", "_ui5validator": "String" }, @@ -8689,8 +8685,8 @@ "type": { "text": "string" }, - "description": "Defines a formatted date value.", "default": "\"\"", + "description": "Defines a formatted date value.", "privacy": "public", "_ui5validator": "String", "_ui5formProperty": true, @@ -8713,10 +8709,10 @@ } ] }, - "description": "Defines the value state of the component.", "default": "\"None\"", + "description": "Defines the value state of the component.", "privacy": "public", - "_ui5validator": "ValueState", + "_ui5validator": "String", "inheritedFrom": { "name": "DatePicker", "module": "dist/DatePicker.js" @@ -8728,8 +8724,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is required.", "default": "false", + "description": "Defines whether the component is required.", "privacy": "public", "_ui5since": "1.0.0-rc.9", "_ui5validator": "Boolean", @@ -8744,8 +8740,8 @@ "type": { "text": "boolean" }, - "description": "Determines whether the component is displayed as disabled.", "default": "false", + "description": "Determines whether the component is displayed as disabled.", "privacy": "public", "_ui5validator": "Boolean", "inheritedFrom": { @@ -8759,8 +8755,8 @@ "type": { "text": "boolean" }, - "description": "Determines whether the component is displayed as read-only.", "default": "false", + "description": "Determines whether the component is displayed as read-only.", "privacy": "public", "_ui5validator": "Boolean", "inheritedFrom": { @@ -8787,10 +8783,10 @@ "kind": "field", "name": "name", "type": { - "text": "string" + "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": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String", "inheritedFrom": { @@ -8804,8 +8800,8 @@ "type": { "text": "boolean" }, - "description": "Defines the visibility of the week numbers column.\n\n**Note:** For calendars other than Gregorian,\nthe week numbers are not displayed regardless of what is set.", "default": "false", + "description": "Defines the visibility of the week numbers column.\n\n**Note:** For calendars other than Gregorian,\nthe week numbers are not displayed regardless of what is set.", "privacy": "public", "_ui5since": "1.0.0-rc.8", "_ui5validator": "Boolean", @@ -8820,9 +8816,9 @@ "type": { "text": "boolean" }, + "default": "false", "description": "Defines the open or closed state of the popover.", "privacy": "public", - "default": "false", "_ui5since": "2.0.0", "_ui5validator": "Boolean", "inheritedFrom": { @@ -8834,10 +8830,10 @@ "kind": "field", "name": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the aria-label attribute for the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15", "_ui5validator": "String", @@ -8850,10 +8846,10 @@ "kind": "field", "name": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Receives id(or many ids) of the elements that label the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15", "_ui5validator": "String", @@ -8954,7 +8950,7 @@ "description": "Sets a calendar type used for display.\nIf not set, the calendar type of the global configuration is used.", "default": "undefined", "privacy": "public", - "_ui5validator": "CalendarType", + "_ui5validator": "String", "inheritedFrom": { "name": "DateComponentBase", "module": "dist/DateComponentBase.js" @@ -8977,7 +8973,7 @@ "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.16", - "_ui5validator": "CalendarType", + "_ui5validator": "String", "inheritedFrom": { "name": "DateComponentBase", "module": "dist/DateComponentBase.js" @@ -8987,10 +8983,10 @@ "kind": "field", "name": "formatPattern", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Determines the format, displayed in the input field.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String", "inheritedFrom": { @@ -9004,8 +9000,8 @@ "type": { "text": "string" }, - "description": "Determines the minimum date available for selection.\n\n**Note:** If the formatPattern property is not set, the minDate value must be provided in the ISO date format (YYYY-MM-dd).", "default": "\"\"", + "description": "Determines the minimum date available for selection.\n\n**Note:** If the formatPattern property is not set, the minDate value must be provided in the ISO date format (YYYY-MM-dd).", "privacy": "public", "_ui5since": "1.0.0-rc.6", "_ui5validator": "String", @@ -9020,8 +9016,8 @@ "type": { "text": "string" }, - "description": "Determines the maximum date available for selection.\n\n**Note:** If the formatPattern property is not set, the maxDate value must be provided in the ISO date format (YYYY-MM-dd).", "default": "\"\"", + "description": "Determines the maximum date available for selection.\n\n**Note:** If the formatPattern property is not set, the maxDate value must be provided in the ISO date format (YYYY-MM-dd).", "privacy": "public", "_ui5since": "1.0.0-rc.6", "_ui5validator": "String", @@ -9035,7 +9031,7 @@ { "description": "Determines the symbol which separates the dates.\nIf not supplied, the default time interval delimiter for the current locale will be used.", "name": "delimiter", - "default": "\"-\"", + "default": "DEFAULT_DELIMITER", "fieldName": "delimiter", "type": { "text": "string" @@ -9162,10 +9158,10 @@ { "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": "\"\"", + "default": "undefined", "fieldName": "name", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "DatePicker", @@ -9201,10 +9197,10 @@ { "description": "Defines the aria-label attribute for the component.", "name": "accessible-name", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "DatePicker", @@ -9214,10 +9210,10 @@ { "description": "Receives id(or many ids) of the elements that label the component.", "name": "accessible-name-ref", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "DatePicker", @@ -9253,10 +9249,10 @@ { "description": "Determines the format, displayed in the input field.", "name": "format-pattern", - "default": "\"\"", + "default": "undefined", "fieldName": "formatPattern", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "DateComponentBase", @@ -9546,10 +9542,10 @@ { "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": "\"\"", + "default": "undefined", "fieldName": "name", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "DatePicker", @@ -9585,10 +9581,10 @@ { "description": "Defines the aria-label attribute for the component.", "name": "accessible-name", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "DatePicker", @@ -9598,10 +9594,10 @@ { "description": "Receives id(or many ids) of the elements that label the component.", "name": "accessible-name-ref", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "DatePicker", @@ -9650,10 +9646,10 @@ { "description": "Determines the format, displayed in the input field.", "name": "format-pattern", - "default": "\"\"", + "default": "undefined", "fieldName": "formatPattern", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "DateComponentBase", @@ -9694,8 +9690,8 @@ "type": { "text": "string" }, - "description": "Defines a formatted date value.", "default": "\"\"", + "description": "Defines a formatted date value.", "privacy": "public", "_ui5validator": "String", "_ui5formProperty": true, @@ -9718,10 +9714,10 @@ } ] }, - "description": "Defines the value state of the component.", "default": "\"None\"", + "description": "Defines the value state of the component.", "privacy": "public", - "_ui5validator": "ValueState", + "_ui5validator": "String", "inheritedFrom": { "name": "DatePicker", "module": "dist/DatePicker.js" @@ -9733,8 +9729,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is required.", "default": "false", + "description": "Defines whether the component is required.", "privacy": "public", "_ui5since": "1.0.0-rc.9", "_ui5validator": "Boolean", @@ -9749,8 +9745,8 @@ "type": { "text": "boolean" }, - "description": "Determines whether the component is displayed as disabled.", "default": "false", + "description": "Determines whether the component is displayed as disabled.", "privacy": "public", "_ui5validator": "Boolean", "inheritedFrom": { @@ -9764,8 +9760,8 @@ "type": { "text": "boolean" }, - "description": "Determines whether the component is displayed as read-only.", "default": "false", + "description": "Determines whether the component is displayed as read-only.", "privacy": "public", "_ui5validator": "Boolean", "inheritedFrom": { @@ -9792,10 +9788,10 @@ "kind": "field", "name": "name", "type": { - "text": "string" + "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": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String", "inheritedFrom": { @@ -9809,8 +9805,8 @@ "type": { "text": "boolean" }, - "description": "Defines the visibility of the week numbers column.\n\n**Note:** For calendars other than Gregorian,\nthe week numbers are not displayed regardless of what is set.", "default": "false", + "description": "Defines the visibility of the week numbers column.\n\n**Note:** For calendars other than Gregorian,\nthe week numbers are not displayed regardless of what is set.", "privacy": "public", "_ui5since": "1.0.0-rc.8", "_ui5validator": "Boolean", @@ -9825,9 +9821,9 @@ "type": { "text": "boolean" }, + "default": "false", "description": "Defines the open or closed state of the popover.", "privacy": "public", - "default": "false", "_ui5since": "2.0.0", "_ui5validator": "Boolean", "inheritedFrom": { @@ -9839,10 +9835,10 @@ "kind": "field", "name": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the aria-label attribute for the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15", "_ui5validator": "String", @@ -9855,10 +9851,10 @@ "kind": "field", "name": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Receives id(or many ids) of the elements that label the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15", "_ui5validator": "String", @@ -9974,7 +9970,7 @@ "description": "Sets a calendar type used for display.\nIf not set, the calendar type of the global configuration is used.", "default": "undefined", "privacy": "public", - "_ui5validator": "CalendarType", + "_ui5validator": "String", "inheritedFrom": { "name": "DateComponentBase", "module": "dist/DateComponentBase.js" @@ -9997,7 +9993,7 @@ "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.16", - "_ui5validator": "CalendarType", + "_ui5validator": "String", "inheritedFrom": { "name": "DateComponentBase", "module": "dist/DateComponentBase.js" @@ -10007,10 +10003,10 @@ "kind": "field", "name": "formatPattern", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Determines the format, displayed in the input field.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String", "inheritedFrom": { @@ -10024,8 +10020,8 @@ "type": { "text": "string" }, - "description": "Determines the minimum date available for selection.\n\n**Note:** If the formatPattern property is not set, the minDate value must be provided in the ISO date format (YYYY-MM-dd).", "default": "\"\"", + "description": "Determines the minimum date available for selection.\n\n**Note:** If the formatPattern property is not set, the minDate value must be provided in the ISO date format (YYYY-MM-dd).", "privacy": "public", "_ui5since": "1.0.0-rc.6", "_ui5validator": "String", @@ -10040,8 +10036,8 @@ "type": { "text": "string" }, - "description": "Determines the maximum date available for selection.\n\n**Note:** If the formatPattern property is not set, the maxDate value must be provided in the ISO date format (YYYY-MM-dd).", "default": "\"\"", + "description": "Determines the maximum date available for selection.\n\n**Note:** If the formatPattern property is not set, the maxDate value must be provided in the ISO date format (YYYY-MM-dd).", "privacy": "public", "_ui5since": "1.0.0-rc.6", "_ui5validator": "String", @@ -10268,10 +10264,10 @@ "kind": "field", "name": "headerText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the header text.\n\n**Note:** If `header` slot is provided, the `headerText` is ignored.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -10281,8 +10277,8 @@ "type": { "text": "boolean" }, - "description": "Determines whether the component should be stretched to fullscreen.\n\n**Note:** The component will be stretched to approximately\n90% of the viewport.", "default": "false", + "description": "Determines whether the component should be stretched to fullscreen.\n\n**Note:** The component will be stretched to approximately\n90% of the viewport.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -10292,8 +10288,8 @@ "type": { "text": "boolean" }, - "description": "Determines whether the component is draggable.\nIf this property is set to true, the Dialog will be draggable by its header.\n\n**Note:** The component can be draggable only in desktop mode.\n\n**Note:** This property overrides the default HTML \"draggable\" attribute native behavior.\nWhen \"draggable\" is set to true, the native browser \"draggable\"\nbehavior is prevented and only the Dialog custom logic (\"draggable by its header\") works.", "default": "false", + "description": "Determines whether the component is draggable.\nIf this property is set to true, the Dialog will be draggable by its header.\n\n**Note:** The component can be draggable only in desktop mode.\n\n**Note:** This property overrides the default HTML \"draggable\" attribute native behavior.\nWhen \"draggable\" is set to true, the native browser \"draggable\"\nbehavior is prevented and only the Dialog custom logic (\"draggable by its header\") works.", "privacy": "public", "_ui5since": "1.0.0-rc.9", "_ui5validator": "Boolean" @@ -10304,8 +10300,8 @@ "type": { "text": "boolean" }, - "description": "Configures the component to be resizable.\nIf this property is set to true, the Dialog will have a resize handle in its bottom right corner in LTR languages.\nIn RTL languages, the resize handle will be placed in the bottom left corner.\n\n**Note:** The component can be resizable only in desktop mode.\n\n**Note:** Upon resizing, externally defined height and width styling will be ignored.", "default": "false", + "description": "Configures the component to be resizable.\nIf this property is set to true, the Dialog will have a resize handle in its bottom right corner in LTR languages.\nIn RTL languages, the resize handle will be placed in the bottom left corner.\n\n**Note:** The component can be resizable only in desktop mode.\n\n**Note:** Upon resizing, externally defined height and width styling will be ignored.", "privacy": "public", "_ui5since": "1.0.0-rc.10", "_ui5validator": "Boolean" @@ -10323,20 +10319,20 @@ } ] }, - "description": "Defines the state of the `Dialog`.\n\n**Note:** If `\"Negative\"` and `\"Critical\"` states is set, it will change the\naccessibility role to \"alertdialog\", if the accessibleRole property is set to `\"Dialog\"`.", "default": "\"None\"", + "description": "Defines the state of the `Dialog`.\n\n**Note:** If `\"Negative\"` and `\"Critical\"` states is set, it will change the\naccessibility role to \"alertdialog\", if the accessibleRole property is set to `\"Dialog\"`.", "privacy": "public", "_ui5since": "1.0.0-rc.15", - "_ui5validator": "ValueState" + "_ui5validator": "String" }, { "kind": "field", "name": "initialFocus", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the ID of the HTML Element, which will get the initial focus.\n\n**Note:** If an element with `autofocus` attribute is added inside the component,\n`initialFocus` won't take effect.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String", "inheritedFrom": { @@ -10350,8 +10346,8 @@ "type": { "text": "boolean" }, - "description": "Defines if the focus should be returned to the previously focused element,\nwhen the popup closes.", "default": "false", + "description": "Defines if the focus should be returned to the previously focused element,\nwhen the popup closes.", "privacy": "public", "_ui5since": "1.0.0-rc.8", "_ui5validator": "Boolean", @@ -10380,10 +10376,10 @@ "kind": "field", "name": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the IDs of the elements that label the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.1.0", "_ui5validator": "String", @@ -10405,11 +10401,11 @@ } ] }, - "description": "Allows setting a custom role.", "default": "\"Dialog\"", + "description": "Allows setting a custom role.", "privacy": "public", "_ui5since": "1.10.0", - "_ui5validator": "PopupAccessibleRole", + "_ui5validator": "String", "inheritedFrom": { "name": "Popup", "module": "dist/Popup.js" @@ -10421,9 +10417,9 @@ "type": { "text": "boolean" }, + "default": "false", "description": "Indicates whether initial focus should be prevented.", "privacy": "public", - "default": "false", "_ui5since": "2.0.0", "_ui5validator": "Boolean", "inheritedFrom": { @@ -10468,10 +10464,10 @@ { "description": "Defines the header text.\n\n**Note:** If `header` slot is provided, the `headerText` is ignored.", "name": "header-text", - "default": "\"\"", + "default": "undefined", "fieldName": "headerText", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -10513,10 +10509,10 @@ { "description": "Defines the ID of the HTML Element, which will get the initial focus.\n\n**Note:** If an element with `autofocus` attribute is added inside the component,\n`initialFocus` won't take effect.", "name": "initial-focus", - "default": "\"\"", + "default": "undefined", "fieldName": "initialFocus", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "Popup", @@ -10552,10 +10548,10 @@ { "description": "Defines the IDs of the elements that label the component.", "name": "accessible-name-ref", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "Popup", @@ -10748,7 +10744,7 @@ "kind": "field", "name": "accept", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Comma-separated list of file types that the component should accept.\n\n**Note:** Please make sure you are adding the `.` in front on the file type, e.g. `.png` in case you want to accept png's only.", "default": "\"\"", @@ -10761,8 +10757,8 @@ "type": { "text": "boolean" }, - "description": "If set to \"true\", the input field of component will not be rendered. Only the default slot that is passed will be rendered.", "default": "false", + "description": "If set to \"true\", the input field of component will not be rendered. Only the default slot that is passed will be rendered.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -10772,8 +10768,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is in disabled state.\n\n**Note:** A disabled component is completely noninteractive.", "default": "false", + "description": "Defines whether the component is in disabled state.\n\n**Note:** A disabled component is completely noninteractive.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -10783,8 +10779,8 @@ "type": { "text": "boolean" }, - "description": "Allows multiple files to be chosen.", "default": "false", + "description": "Allows multiple files to be chosen.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -10792,10 +10788,10 @@ "kind": "field", "name": "name", "type": { - "text": "string" + "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": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -10803,10 +10799,10 @@ "kind": "field", "name": "placeholder", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines a short hint intended to aid the user with data entry when the component has no value.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -10816,8 +10812,8 @@ "type": { "text": "string" }, - "description": "Defines the name/names of the file/files to upload.", "default": "\"\"", + "description": "Defines the name/names of the file/files to upload.", "privacy": "public", "_ui5validator": "String", "_ui5formProperty": true, @@ -10836,10 +10832,10 @@ } ] }, - "description": "Defines the value state of the component.", "default": "\"None\"", + "description": "Defines the value state of the component.", "privacy": "public", - "_ui5validator": "ValueState" + "_ui5validator": "String" }, { "kind": "field", @@ -10887,7 +10883,7 @@ "default": "\"\"", "fieldName": "accept", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -10920,19 +10916,19 @@ { "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": "\"\"", + "default": "undefined", "fieldName": "name", "type": { - "text": "string" + "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": "\"\"", + "default": "undefined", "fieldName": "placeholder", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -11007,6 +11003,7 @@ "kind": "interface", "name": "IFormItem", "description": "Interface for components that can be slotted inside `ui5-form` as items.", + "_ui5experimental": true, "_ui5privacy": "public", "_ui5since": "2.0.0" }, @@ -11061,8 +11058,8 @@ "type": { "text": "string" }, - "description": "Defines the number of columns to distribute the form content by breakpoint.\n\nSupported values:\n- `S` - 1 column by default (1 column is recommended)\n- `M` - 1 column by default (up to 2 columns are recommended)\n- `L` - 2 columns by default (up to 3 columns are recommended)\n- `XL` - 2 columns by default (up to 6 columns are recommended)", "default": "\"S1 M1 L2 XL2\"", + "description": "Defines the number of columns to distribute the form content by breakpoint.\n\nSupported values:\n- `S` - 1 column by default (1 column is recommended)\n- `M` - 1 column by default (up to 2 columns are recommended)\n- `L` - 2 columns by default (up to 3 columns are recommended)\n- `XL` - 2 columns by default (up to 6 columns are recommended)", "privacy": "public", "_ui5validator": "String" }, @@ -11072,8 +11069,8 @@ "type": { "text": "string" }, - "description": "Defines the width proportion of the labels and fields of a FormItem by breakpoint.\n\nBy default, the labels take 4/12 (or 1/3) of the form item in M,L and XL sizes,\nand 12/12 in S size, e.g in S the label is on top of its associated field.\n\nThe supported values are between 1 and 12. Greater the number, more space the label will use.\n\n**Note:** If \"12\" is set, the label will be displayed on top of its assosiated field.", "default": "\"S12 M4 L4 XL4\"", + "description": "Defines the width proportion of the labels and fields of a FormItem by breakpoint.\n\nBy default, the labels take 4/12 (or 1/3) of the form item in M,L and XL sizes,\nand 12/12 in S size, e.g in S the label is on top of its associated field.\n\nThe supported values are between 1 and 12. Greater the number, more space the label will use.\n\n**Note:** If \"12\" is set, the label will be displayed on top of its assosiated field.", "privacy": "public", "_ui5validator": "String" }, @@ -11081,10 +11078,10 @@ "kind": "field", "name": "headerText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the header text of the component.\n\n**Note:** The property gets overridden by the `header` slot.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -11101,10 +11098,10 @@ } ] }, - "description": "Defines the vertical spacing between form items.\n\n**Note:** If the Form is meant to be switched between \"non-edit\" and \"edit\" modes,\nwe recommend using \"Large\" item spacing in \"non-edit\" mode, and \"Normal\" - for \"edit\" mode,\nto avoid \"jumping\" effect, caused by the hight difference between texts in \"non-edit\" mode and the input fields in \"edit\" mode.", "default": "\"Normal\"", + "description": "Defines the vertical spacing between form items.\n\n**Note:** If the Form is meant to be switched between \"non-edit\" and \"edit\" modes,\nwe recommend using \"Large\" item spacing in \"non-edit\" mode, and \"Normal\" - for \"edit\" mode,\nto avoid \"jumping\" effect, caused by the hight difference between texts in \"non-edit\" mode and the input fields in \"edit\" mode.", "privacy": "public", - "_ui5validator": "FormItemSpacing" + "_ui5validator": "String" } ], "attributes": [ @@ -11129,10 +11126,10 @@ { "description": "Defines the header text of the component.\n\n**Note:** The property gets overridden by the `header` slot.", "name": "header-text", - "default": "\"\"", + "default": "undefined", "fieldName": "headerText", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -11152,6 +11149,7 @@ }, "tagName": "ui5-form", "customElement": true, + "_ui5experimental": "This component is availabe since 2.0 under an experimental flag and its API and behaviour are subject to change.", "_ui5since": "2.0.0", "_ui5privacy": "public" } @@ -11206,10 +11204,10 @@ "kind": "field", "name": "headerText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines header text of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -11222,17 +11220,17 @@ "description": "Defines column span of the component,\ne.g how many columns the group should span to.", "default": "undefined", "privacy": "public", - "_ui5validator": "Integer" + "_ui5validator": "Number" } ], "attributes": [ { "description": "Defines header text of the component.", "name": "header-text", - "default": "\"\"", + "default": "undefined", "fieldName": "headerText", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -11252,6 +11250,7 @@ }, "tagName": "ui5-form-group", "customElement": true, + "_ui5experimental": "This component is availabe since 2.0 under an experimental flag and its API and behaviour are subject to change.", "_ui5since": "2.0.0", "_ui5privacy": "public", "_ui5implements": [ @@ -11333,7 +11332,7 @@ "description": "Defines the column span of the component,\ne.g how many columns the component should span to.\n\n**Note:** The column span should be a number between 1 and the available columns of the FormGroup (when items are placed in a group)\nor the Form. The available columns can be affected by the FormGroup#columnSpan and/or the Form#layout.\nA number bigger than the available columns won't take effect.", "default": "undefined", "privacy": "public", - "_ui5validator": "Integer" + "_ui5validator": "Number" } ], "attributes": [ @@ -11354,6 +11353,7 @@ }, "tagName": "ui5-form-item", "customElement": true, + "_ui5experimental": "This component is availabe since 2.0 under an experimental flag and its API and behaviour are subject to change.", "_ui5since": "2.0.0", "_ui5privacy": "public", "_ui5implements": [ @@ -11433,20 +11433,20 @@ } ] }, - "description": "Defines the component semantic design.", "default": "\"Default\"", + "description": "Defines the component semantic design.", "privacy": "public", "_ui5since": "1.9.2", - "_ui5validator": "IconDesign" + "_ui5validator": "String" }, { "kind": "field", "name": "name", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the unique identifier (icon name) of the component.\n\nTo browse all available icons, see the\n[SAP Icons](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html),\n[SAP Fiori Tools](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html#/overview/SAP-icons-TNT) and\n[SAP Business Suite](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html)\n\nExample:\n`name='add'`, `name='delete'`, `name='employee'`.\n\n**Note:** To use the SAP Fiori Tools icons,\nyou need to set the `tnt` prefix in front of the icon's name.\n\nExample:\n`name='tnt/antenna'`, `name='tnt/actor'`, `name='tnt/api'`.\n\n**Note:** To use the SAP Business Suite icons,\nyou need to set the `business-suite` prefix in front of the icon's name.\n\nExample:\n`name='business-suite/3d'`, `name='business-suite/1x2-grid-layout'`, `name='business-suite/4x4-grid-layout'`.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -11454,10 +11454,10 @@ "kind": "field", "name": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text alternative of the component.\nIf not provided a default text alternative will be set, if present.\n\n**Note:** Every icon should have a text alternative in order to\ncalculate its accessible name.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -11467,8 +11467,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component should have a tooltip.\n\n**Note:** The tooltip text should be provided via the `accessible-name` property.", "default": "false", + "description": "Defines whether the component should have a tooltip.\n\n**Note:** The tooltip text should be provided via the `accessible-name` property.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -11485,11 +11485,11 @@ } ] }, - "description": "Defines the mode of the component.", "default": "\"Image\"", + "description": "Defines the mode of the component.", "privacy": "public", "_ui5since": "2.0.0", - "_ui5validator": "IconMode" + "_ui5validator": "String" } ], "attributes": [ @@ -11505,19 +11505,19 @@ { "description": "Defines the unique identifier (icon name) of the component.\n\nTo browse all available icons, see the\n[SAP Icons](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html),\n[SAP Fiori Tools](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html#/overview/SAP-icons-TNT) and\n[SAP Business Suite](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html)\n\nExample:\n`name='add'`, `name='delete'`, `name='employee'`.\n\n**Note:** To use the SAP Fiori Tools icons,\nyou need to set the `tnt` prefix in front of the icon's name.\n\nExample:\n`name='tnt/antenna'`, `name='tnt/actor'`, `name='tnt/api'`.\n\n**Note:** To use the SAP Business Suite icons,\nyou need to set the `business-suite` prefix in front of the icon's name.\n\nExample:\n`name='business-suite/3d'`, `name='business-suite/1x2-grid-layout'`, `name='business-suite/4x4-grid-layout'`.", "name": "name", - "default": "\"\"", + "default": "undefined", "fieldName": "name", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the text alternative of the component.\nIf not provided a default text alternative will be set, if present.\n\n**Note:** Every icon should have a text alternative in order to\ncalculate its accessible name.", "name": "accessible-name", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -11592,7 +11592,7 @@ "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 `` are recommended to be used as suggestion items.\n\n**Note:** Importing the Input Suggestions Support feature:\n\n`import \"@ui5/webcomponents/dist/features/InputSuggestions.js\";`\n\nautomatically imports the `` and `` for your convenience.", + "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.\n\n**Note:** Importing the Input Suggestions Support feature:\n\n`import \"@ui5/webcomponents/dist/features/InputSuggestions.js\";`\n\nautomatically imports the `` and `` for your convenience.", "_ui5propertyName": "suggestionItems", "_ui5type": { "text": "Array", @@ -11638,8 +11638,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is in disabled state.\n\n**Note:** A disabled component is completely noninteractive.", "default": "false", + "description": "Defines whether the component is in disabled state.\n\n**Note:** A disabled component is completely noninteractive.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -11647,10 +11647,10 @@ "kind": "field", "name": "placeholder", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines a short hint intended to aid the user with data entry when the\ncomponent has no value.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -11660,8 +11660,8 @@ "type": { "text": "boolean" }, - "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.", "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", "_ui5validator": "Boolean" }, @@ -11671,8 +11671,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is required.", "default": "false", + "description": "Defines whether the component is required.", "privacy": "public", "_ui5since": "1.0.0-rc.3", "_ui5validator": "Boolean" @@ -11683,8 +11683,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the value will be autcompleted to match an item", "default": "false", + "description": "Defines whether the value will be autcompleted to match an item", "privacy": "public", "_ui5since": "1.4.0", "_ui5validator": "Boolean" @@ -11702,10 +11702,10 @@ } ] }, - "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.", "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", - "_ui5validator": "InputType" + "_ui5validator": "String" }, { "kind": "field", @@ -11713,8 +11713,8 @@ "type": { "text": "string" }, - "description": "Defines the value of the component.\n\n**Note:** The property is updated upon typing.", "default": "\"\"", + "description": "Defines the value of the component.\n\n**Note:** The property is updated upon typing.", "privacy": "public", "_ui5validator": "String", "_ui5formProperty": true, @@ -11733,19 +11733,19 @@ } ] }, - "description": "Defines the value state of the component.", "default": "\"None\"", + "description": "Defines the value state of the component.", "privacy": "public", - "_ui5validator": "ValueState" + "_ui5validator": "String" }, { "kind": "field", "name": "name", "type": { - "text": "string" + "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": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -11755,8 +11755,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component should show suggestions, if such are present.\n\n**Note:** You need to import the `InputSuggestions` module\nfrom `\"@ui5/webcomponents/dist/features/InputSuggestions.js\"` to enable this functionality.", "default": "false", + "description": "Defines whether the component should show suggestions, if such are present.\n\n**Note:** You need to import the `InputSuggestions` module\nfrom `\"@ui5/webcomponents/dist/features/InputSuggestions.js\"` to enable this functionality.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -11770,16 +11770,16 @@ "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.5", - "_ui5validator": "Integer" + "_ui5validator": "Number" }, { "kind": "field", "name": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the accessible ARIA name of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15", "_ui5validator": "String" @@ -11788,10 +11788,10 @@ "kind": "field", "name": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Receives id(or many ids) of the elements that label the input.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15", "_ui5validator": "String" @@ -11802,8 +11802,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the clear icon of the input will be shown.", "default": "false", + "description": "Defines whether the clear icon of the input will be shown.", "privacy": "public", "_ui5since": "1.2.0", "_ui5validator": "Boolean" @@ -11814,8 +11814,8 @@ "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.", "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", "_ui5validator": "Boolean" @@ -11861,14 +11861,6 @@ "name": "item", "_ui5privacy": "public", "description": "The previewed suggestion item." - }, - { - "type": { - "text": "HTMLElement" - }, - "name": "targetRef", - "_ui5privacy": "public", - "description": "The DOM ref of the suggestion item." } ] }, @@ -11904,10 +11896,10 @@ { "description": "Defines a short hint intended to aid the user with data entry when the\ncomponent has no value.", "name": "placeholder", - "default": "\"\"", + "default": "undefined", "fieldName": "placeholder", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -11967,10 +11959,10 @@ { "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": "\"\"", + "default": "undefined", "fieldName": "name", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -11994,19 +11986,19 @@ { "description": "Defines the accessible ARIA name of the component.", "name": "accessible-name", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Receives id(or many ids) of the elements that label the input.", "name": "accessible-name-ref", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -12080,10 +12072,10 @@ "kind": "field", "name": "for", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the labeled input by providing its ID.\n\n**Note:** Can be used with both `ui5-input` and native input.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -12093,8 +12085,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether colon is added to the component text.\n\n**Note:** Usually used in forms.", "default": "false", + "description": "Defines whether colon is added to the component text.\n\n**Note:** Usually used in forms.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -12104,8 +12096,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether an asterisk character is added to the component text.\n\n**Note:** Usually indicates that user input (bound with the `for` property) is required.\nIn that case the `required` property of\nthe corresponding input should also be set.", "default": "false", + "description": "Defines whether an asterisk character is added to the component text.\n\n**Note:** Usually indicates that user input (bound with the `for` property) is required.\nIn that case the `required` property of\nthe corresponding input should also be set.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -12122,20 +12114,20 @@ } ] }, - "description": "Defines how the text of a component will be displayed when there is not enough space.\n\n**Note:** for option \"Normal\" the text will wrap and the words will not be broken based on hyphenation.", "default": "\"Normal\"", + "description": "Defines how the text of a component will be displayed when there is not enough space.\n\n**Note:** for option \"Normal\" the text will wrap and the words will not be broken based on hyphenation.", "privacy": "public", - "_ui5validator": "WrappingType" + "_ui5validator": "String" } ], "attributes": [ { "description": "Defines the labeled input by providing its ID.\n\n**Note:** Can be used with both `ui5-input` and native input.", "name": "for", - "default": "\"\"", + "default": "undefined", "fieldName": "for", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -12230,8 +12222,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is disabled.\n\n**Note:** When disabled, the click event cannot be triggered by the user.", "default": "false", + "description": "Defines whether the component is disabled.\n\n**Note:** When disabled, the click event cannot be triggered by the user.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -12239,10 +12231,10 @@ "kind": "field", "name": "tooltip", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the tooltip of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "2.0.0", "_ui5validator": "String" @@ -12251,10 +12243,10 @@ "kind": "field", "name": "href", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the component href.\n\n**Note:** Standard hyperlink behavior is supported.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -12262,10 +12254,10 @@ "kind": "field", "name": "target", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the component target.\n\n**Notes:**\n\n- `_self`\n- `_top`\n- `_blank`\n- `_parent`\n- `_search`\n\n**This property must only be used when the `href` property is set.**", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -12282,10 +12274,10 @@ } ] }, - "description": "Defines the component design.\n\n**Note:** Avaialble options are `Default`, `Subtle`, and `Emphasized`.", "default": "\"Default\"", + "description": "Defines the component design.\n\n**Note:** Avaialble options are `Default`, `Subtle`, and `Emphasized`.", "privacy": "public", - "_ui5validator": "LinkDesign" + "_ui5validator": "String" }, { "kind": "field", @@ -12300,19 +12292,19 @@ } ] }, - "description": "Defines how the text of a component will be displayed when there is not enough space.\n\n**Note:** By default the text will wrap. If \"None\" is set - the text will truncate.", "default": "\"Normal\"", + "description": "Defines how the text of a component will be displayed when there is not enough space.\n\n**Note:** By default the text will wrap. If \"None\" is set - the text will truncate.", "privacy": "public", - "_ui5validator": "WrappingType" + "_ui5validator": "String" }, { "kind": "field", "name": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the accessible ARIA name of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.2.0", "_ui5validator": "String" @@ -12321,10 +12313,10 @@ "kind": "field", "name": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Receives id(or many ids) of the elements that label the input", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15", "_ui5validator": "String" @@ -12342,11 +12334,11 @@ } ] }, + "default": "\"Link\"", "description": "Defines the ARIA role of the component.\n\n**Note:** Use the LinkAccessibleRole.Button role in cases when navigation is not expected to occur and the href property is not defined.", - "default": "\"link\"", "privacy": "public", "_ui5since": "1.9.0", - "_ui5validator": "LinkAccessibleRole" + "_ui5validator": "String" }, { "kind": "field", @@ -12361,9 +12353,9 @@ } ] }, + "default": "{}", "description": "Defines the additional accessibility attributes that will be applied to the component.\nThe following fields are supported:\n\n- **expanded**: Indicates whether the button, or another grouping element it controls, is currently expanded or collapsed.\nAccepts the following string values: `true` or `false`.\n\n- **hasPopup**: Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by the button.\nAccepts the following string values: `dialog`, `grid`, `listbox`, `menu` or `tree`.", "privacy": "public", - "default": "{}", "_ui5since": "1.1.0", "_ui5validator": "Object" }, @@ -12371,10 +12363,10 @@ "kind": "field", "name": "icon", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the icon, displayed as graphical element within the component before the link's text.\nThe SAP-icons font provides numerous options.\n\n**Note:** Usage of icon-only link is not supported, the link must always have a text.\n\n**Note:** We recommend using аn icon in the beginning or the end only, and with text.\n\nSee all the available icons within the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "2.0.0", "_ui5validator": "String" @@ -12383,10 +12375,10 @@ "kind": "field", "name": "endIcon", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the icon, displayed as graphical element within the component after the link's text.\nThe SAP-icons font provides numerous options.\n\n**Note:** Usage of icon-only link is not supported, the link must always have a text.\n\n**Note:** We recommend using аn icon in the beginning or the end only, and with text.\n\nSee all the available icons within the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "2.0.0", "_ui5validator": "String" @@ -12457,28 +12449,28 @@ { "description": "Defines the tooltip of the component.", "name": "tooltip", - "default": "\"\"", + "default": "undefined", "fieldName": "tooltip", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the component href.\n\n**Note:** Standard hyperlink behavior is supported.", "name": "href", - "default": "\"\"", + "default": "undefined", "fieldName": "href", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the component target.\n\n**Notes:**\n\n- `_self`\n- `_top`\n- `_blank`\n- `_parent`\n- `_search`\n\n**This property must only be used when the `href` property is set.**", "name": "target", - "default": "\"\"", + "default": "undefined", "fieldName": "target", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -12502,25 +12494,25 @@ { "description": "Defines the accessible ARIA name of the component.", "name": "accessible-name", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Receives id(or many ids) of the elements that label the input", "name": "accessible-name-ref", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the ARIA role of the component.\n\n**Note:** Use the LinkAccessibleRole.Button role in cases when navigation is not expected to occur and the href property is not defined.", "name": "accessible-role", - "default": "\"link\"", + "default": "\"Link\"", "fieldName": "accessibleRole", "type": { "text": "\"Button\" | \"Link\"" @@ -12529,19 +12521,19 @@ { "description": "Defines the icon, displayed as graphical element within the component before the link's text.\nThe SAP-icons font provides numerous options.\n\n**Note:** Usage of icon-only link is not supported, the link must always have a text.\n\n**Note:** We recommend using аn icon in the beginning or the end only, and with text.\n\nSee all the available icons within the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).", "name": "icon", - "default": "\"\"", + "default": "undefined", "fieldName": "icon", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the icon, displayed as graphical element within the component after the link's text.\nThe SAP-icons font provides numerous options.\n\n**Note:** Usage of icon-only link is not supported, the link must always have a text.\n\n**Note:** We recommend using аn icon in the beginning or the end only, and with text.\n\nSee all the available icons within the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).", "name": "end-icon", - "default": "\"\"", + "default": "undefined", "fieldName": "endIcon", "type": { - "text": "string" + "text": "string | undefined" } } ], @@ -12606,10 +12598,10 @@ "kind": "field", "name": "headerText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the component header text.\n\n**Note:** If `header` is set this property is ignored.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -12617,10 +12609,10 @@ "kind": "field", "name": "footerText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the footer text.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -12630,8 +12622,8 @@ "type": { "text": "boolean" }, - "description": "Determines whether the component is indented.", "default": "false", + "description": "Determines whether the component is indented.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -12648,19 +12640,19 @@ } ] }, - "description": "Defines the selection mode of the component.", "default": "\"None\"", + "description": "Defines the selection mode of the component.", "privacy": "public", - "_ui5validator": "ListSelectionMode" + "_ui5validator": "String" }, { "kind": "field", "name": "noDataText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text that is displayed when the component contains no items.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -12668,19 +12660,19 @@ "kind": "field", "name": "separators", "type": { - "text": "ListSeparators", + "text": "ListSeparator", "references": [ { - "name": "ListSeparators", + "name": "ListSeparator", "package": "@ui5/webcomponents", - "module": "dist/types/ListSeparators.js" + "module": "dist/types/ListSeparator.js" } ] }, - "description": "Defines the item separator style that is used.", "default": "\"All\"", + "description": "Defines the item separator style that is used.", "privacy": "public", - "_ui5validator": "ListSeparators" + "_ui5validator": "String" }, { "kind": "field", @@ -12695,20 +12687,20 @@ } ] }, - "description": "Defines whether the component will have growing capability either by pressing a `More` button,\nor via user scroll. In both cases `load-more` event is fired.\n\n**Restrictions:** `growing=\"Scroll\"` is not supported for Internet Explorer,\non IE the component will fallback to `growing=\"Button\"`.", "default": "\"None\"", + "description": "Defines whether the component will have growing capability either by pressing a `More` button,\nor via user scroll. In both cases `load-more` event is fired.\n\n**Restrictions:** `growing=\"Scroll\"` is not supported for Internet Explorer,\non IE the component will fallback to `growing=\"Button\"`.", "privacy": "public", "_ui5since": "1.0.0-rc.13", - "_ui5validator": "ListGrowingMode" + "_ui5validator": "String" }, { "kind": "field", "name": "growingButtonText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text that will be displayed inside the growing button.\n\n**Note:** If not specified a built-in text will be displayed.\n\n**Note:** This property takes effect if the `growing` property is set to the `Button`.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.24", "_ui5validator": "String" @@ -12719,8 +12711,8 @@ "type": { "text": "boolean" }, - "description": "Defines if the component would display a loading indicator over the list.", "default": "false", + "description": "Defines if the component would display a loading indicator over the list.", "privacy": "public", "_ui5since": "1.0.0-rc.6", "_ui5validator": "Boolean" @@ -12731,19 +12723,19 @@ "type": { "text": "number" }, - "description": "Defines the delay in milliseconds, after which the loading indicator will show up for this component.", "default": "1000", + "description": "Defines the delay in milliseconds, after which the loading indicator will show up for this component.", "privacy": "public", - "_ui5validator": "Integer" + "_ui5validator": "Number" }, { "kind": "field", "name": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the accessible name of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15", "_ui5validator": "String" @@ -12752,10 +12744,10 @@ "kind": "field", "name": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the IDs of the elements that label the input.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15", "_ui5validator": "String" @@ -12773,11 +12765,11 @@ } ] }, + "default": "\"List\"", "description": "Defines the accessible role of the component.", "privacy": "public", - "default": "\"List\"", "_ui5since": "1.0.0-rc.15", - "_ui5validator": "ListAccessibleRole" + "_ui5validator": "String" }, { "kind": "field", @@ -13034,19 +13026,19 @@ { "description": "Defines the component header text.\n\n**Note:** If `header` is set this property is ignored.", "name": "header-text", - "default": "\"\"", + "default": "undefined", "fieldName": "headerText", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the footer text.", "name": "footer-text", - "default": "\"\"", + "default": "undefined", "fieldName": "footerText", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -13070,10 +13062,10 @@ { "description": "Defines the text that is displayed when the component contains no items.", "name": "no-data-text", - "default": "\"\"", + "default": "undefined", "fieldName": "noDataText", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -13097,10 +13089,10 @@ { "description": "Defines the text that will be displayed inside the growing button.\n\n**Note:** If not specified a built-in text will be displayed.\n\n**Note:** This property takes effect if the `growing` property is set to the `Button`.", "name": "growing-button-text", - "default": "\"\"", + "default": "undefined", "fieldName": "growingButtonText", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -13124,19 +13116,19 @@ { "description": "Defines the accessible name of the component.", "name": "accessible-name", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the IDs of the elements that label the input.", "name": "accessible-name-ref", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -13227,10 +13219,10 @@ } ] }, - "description": "Defines the visual indication and behavior of the list items.\nAvailable options are `Active` (by default), `Inactive`, `Detail` and `Navigation`.\n\n**Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and hover,\nwhile with type `Inactive` and `Detail` - will not.", "default": "\"Active\"", + "description": "Defines the visual indication and behavior of the list items.\nAvailable options are `Active` (by default), `Inactive`, `Detail` and `Navigation`.\n\n**Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and hover,\nwhile with type `Inactive` and `Detail` - will not.", "privacy": "public", - "_ui5validator": "ListItemType" + "_ui5validator": "String" }, { "kind": "field", @@ -13245,8 +13237,8 @@ } ] }, - "description": "Defines the additional accessibility attributes that will be applied to the component.\nThe following fields are supported:\n\n- **ariaSetsize**: Defines the number of items in the current set when not all items in the set are present in the DOM.\n**Note:** The value is an integer reflecting the number of items in the complete set. If the size of the entire set is unknown, set `-1`.\n\n\t- **ariaPosinset**: Defines an element's number or position in the current set when not all items are present in the DOM.\n\t**Note:** The value is an integer greater than or equal to 1, and less than or equal to the size of the set when that size is known.", "default": "{}", + "description": "Defines the additional accessibility attributes that will be applied to the component.\nThe following fields are supported:\n\n- **ariaSetsize**: Defines the number of items in the current set when not all items in the set are present in the DOM.\n**Note:** The value is an integer reflecting the number of items in the complete set. If the size of the entire set is unknown, set `-1`.\n\n\t- **ariaPosinset**: Defines an element's number or position in the current set when not all items are present in the DOM.\n\t**Note:** The value is an integer greater than or equal to 1, and less than or equal to the size of the set when that size is known.", "privacy": "public", "_ui5since": "1.15.0", "_ui5validator": "Object" @@ -13257,8 +13249,8 @@ "type": { "text": "boolean" }, - "description": "The navigated state of the list item.\nIf set to `true`, a navigation indicator is displayed at the end of the list item.", "default": "false", + "description": "The navigated state of the list item.\nIf set to `true`, a navigation indicator is displayed at the end of the list item.", "privacy": "public", "_ui5since": "1.10.0", "_ui5validator": "Boolean" @@ -13267,10 +13259,10 @@ "kind": "field", "name": "tooltip", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text of the tooltip that would be displayed for the list item.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.23.0", "_ui5validator": "String" @@ -13288,11 +13280,11 @@ } ] }, - "description": "Defines the highlight state of the list items.\nAvailable options are: `\"None\"` (by default), `\"Positive\"`, `\"Critical\"`, `\"Information\"` and `\"Negative\"`.", "default": "\"None\"", + "description": "Defines the highlight state of the list items.\nAvailable options are: `\"None\"` (by default), `\"Positive\"`, `\"Critical\"`, `\"Information\"` and `\"Negative\"`.", "privacy": "public", "_ui5since": "1.24", - "_ui5validator": "Highlight" + "_ui5validator": "String" }, { "kind": "field", @@ -13303,11 +13295,7 @@ "description": "Defines the selected state of the component.", "default": "false", "privacy": "public", - "_ui5validator": "Boolean", - "inheritedFrom": { - "name": "ListItemBase", - "module": "dist/ListItemBase.js" - } + "_ui5validator": "Boolean" } ], "events": [ @@ -13342,10 +13330,10 @@ { "description": "Defines the text of the tooltip that would be displayed for the list item.", "name": "tooltip", - "default": "\"\"", + "default": "undefined", "fieldName": "tooltip", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -13364,10 +13352,6 @@ "fieldName": "selected", "type": { "text": "boolean" - }, - "inheritedFrom": { - "name": "ListItemBase", - "module": "dist/ListItemBase.js" } } ], @@ -13400,30 +13384,6 @@ "kind": "class", "description": "A class to serve as a foundation\nfor the `ListItem` and `ListItemGroupHeader` classes.", "name": "ListItemBase", - "members": [ - { - "kind": "field", - "name": "selected", - "type": { - "text": "boolean" - }, - "description": "Defines the selected state of the component.", - "default": "false", - "privacy": "public", - "_ui5validator": "Boolean" - } - ], - "attributes": [ - { - "description": "Defines the selected state of the component.", - "name": "selected", - "default": "false", - "fieldName": "selected", - "type": { - "text": "boolean" - } - } - ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", @@ -13431,7 +13391,8 @@ }, "customElement": true, "_ui5privacy": "public", - "_ui5abstract": true + "_ui5abstract": true, + "members": [] } ], "exports": [ @@ -13512,8 +13473,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the item is movable.", "default": "false", + "description": "Defines whether the item is movable.", "privacy": "public", "_ui5since": "2.0.0", "_ui5validator": "Boolean" @@ -13522,10 +13483,10 @@ "kind": "field", "name": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text alternative of the component.\n\n**Note**: If not provided a default text alternative will be set, if present.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15", "_ui5validator": "String" @@ -13543,10 +13504,10 @@ } ] }, - "description": "Defines the visual indication and behavior of the list items.\nAvailable options are `Active` (by default), `Inactive`, `Detail` and `Navigation`.\n\n**Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and hover,\nwhile with type `Inactive` and `Detail` - will not.", "default": "\"Active\"", + "description": "Defines the visual indication and behavior of the list items.\nAvailable options are `Active` (by default), `Inactive`, `Detail` and `Navigation`.\n\n**Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and hover,\nwhile with type `Inactive` and `Detail` - will not.", "privacy": "public", - "_ui5validator": "ListItemType", + "_ui5validator": "String", "inheritedFrom": { "name": "ListItem", "module": "dist/ListItem.js" @@ -13565,8 +13526,8 @@ } ] }, - "description": "Defines the additional accessibility attributes that will be applied to the component.\nThe following fields are supported:\n\n- **ariaSetsize**: Defines the number of items in the current set when not all items in the set are present in the DOM.\n**Note:** The value is an integer reflecting the number of items in the complete set. If the size of the entire set is unknown, set `-1`.\n\n\t- **ariaPosinset**: Defines an element's number or position in the current set when not all items are present in the DOM.\n\t**Note:** The value is an integer greater than or equal to 1, and less than or equal to the size of the set when that size is known.", "default": "{}", + "description": "Defines the additional accessibility attributes that will be applied to the component.\nThe following fields are supported:\n\n- **ariaSetsize**: Defines the number of items in the current set when not all items in the set are present in the DOM.\n**Note:** The value is an integer reflecting the number of items in the complete set. If the size of the entire set is unknown, set `-1`.\n\n\t- **ariaPosinset**: Defines an element's number or position in the current set when not all items are present in the DOM.\n\t**Note:** The value is an integer greater than or equal to 1, and less than or equal to the size of the set when that size is known.", "privacy": "public", "_ui5since": "1.15.0", "_ui5validator": "Object", @@ -13581,8 +13542,8 @@ "type": { "text": "boolean" }, - "description": "The navigated state of the list item.\nIf set to `true`, a navigation indicator is displayed at the end of the list item.", "default": "false", + "description": "The navigated state of the list item.\nIf set to `true`, a navigation indicator is displayed at the end of the list item.", "privacy": "public", "_ui5since": "1.10.0", "_ui5validator": "Boolean", @@ -13595,10 +13556,10 @@ "kind": "field", "name": "tooltip", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text of the tooltip that would be displayed for the list item.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.23.0", "_ui5validator": "String", @@ -13620,11 +13581,11 @@ } ] }, - "description": "Defines the highlight state of the list items.\nAvailable options are: `\"None\"` (by default), `\"Positive\"`, `\"Critical\"`, `\"Information\"` and `\"Negative\"`.", "default": "\"None\"", + "description": "Defines the highlight state of the list items.\nAvailable options are: `\"None\"` (by default), `\"Positive\"`, `\"Critical\"`, `\"Information\"` and `\"Negative\"`.", "privacy": "public", "_ui5since": "1.24", - "_ui5validator": "Highlight", + "_ui5validator": "String", "inheritedFrom": { "name": "ListItem", "module": "dist/ListItem.js" @@ -13641,8 +13602,8 @@ "privacy": "public", "_ui5validator": "Boolean", "inheritedFrom": { - "name": "ListItemBase", - "module": "dist/ListItemBase.js" + "name": "ListItem", + "module": "dist/ListItem.js" } } ], @@ -13659,10 +13620,10 @@ { "description": "Defines the text alternative of the component.\n\n**Note**: If not provided a default text alternative will be set, if present.", "name": "accessible-name", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -13694,10 +13655,10 @@ { "description": "Defines the text of the tooltip that would be displayed for the list item.", "name": "tooltip", - "default": "\"\"", + "default": "undefined", "fieldName": "tooltip", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "ListItem", @@ -13726,8 +13687,8 @@ "text": "boolean" }, "inheritedFrom": { - "name": "ListItemBase", - "module": "dist/ListItemBase.js" + "name": "ListItem", + "module": "dist/ListItem.js" } } ], @@ -13826,22 +13787,22 @@ "kind": "field", "name": "headerText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the header text of the ui5-li-group.", "privacy": "public", - "default": "\"\"", + "default": "undefined", "_ui5validator": "String" }, { "kind": "field", "name": "headerAccessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the accessible name of the header.", "privacy": "public", - "default": "\"\"", + "default": "undefined", "_ui5validator": "String" } ], @@ -13849,19 +13810,19 @@ { "description": "Defines the header text of the ui5-li-group.", "name": "header-text", - "default": "\"\"", + "default": "undefined", "fieldName": "headerText", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the accessible name of the header.", "name": "header-accessible-name", - "default": "\"\"", + "default": "undefined", "fieldName": "headerAccessibleName", "type": { - "text": "string" + "text": "string | undefined" } } ], @@ -13970,9 +13931,9 @@ } }, { - "name": "imageContent", + "name": "image", "description": "**Note:** While the slot allows option for setting custom avatar, to match the\ndesign guidelines, please use the `ui5-avatar` with it's default size - S.\n\n**Note:** If bigger `ui5-avatar` needs to be used, then the size of the\n`ui5-li` should be customized in order to fit.", - "_ui5since": "1.10.0", + "_ui5since": "2.0.0", "_ui5type": { "text": "Array" }, @@ -14000,10 +13961,10 @@ "kind": "field", "name": "description", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the description displayed right under the item text, if such is present.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "0.8.0", "_ui5validator": "String" @@ -14012,10 +13973,10 @@ "kind": "field", "name": "icon", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the `icon` source URI.\n\n**Note:**\nSAP-icons font provides numerous built-in icons. To find all the available icons, see the\n[Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -14025,30 +13986,19 @@ "type": { "text": "boolean" }, - "description": "Defines whether the `icon` should be displayed in the beginning of the list item or in the end.\n\n**Note:** If `image` is set, the `icon` would be displayed after the `image`.", "default": "false", + "description": "Defines whether the `icon` should be displayed in the beginning of the list item or in the end.", "privacy": "public", "_ui5validator": "Boolean" }, - { - "kind": "field", - "name": "image", - "type": { - "text": "string" - }, - "description": "Defines the `image` source URI.\n\n**Note:** The `image` would be displayed in the beginning of the list item.", - "default": "\"\"", - "privacy": "public", - "_ui5validator": "String" - }, { "kind": "field", "name": "additionalText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the `additionalText`, displayed in the end of the list item.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15", "_ui5validator": "String" @@ -14066,11 +14016,11 @@ } ] }, - "description": "Defines the state of the `additionalText`.\n\nAvailable options are: `\"None\"` (by default), `\"Positive\"`, `\"Critical\"`, `\"Information\"` and `\"Negative\"`.", "default": "\"None\"", + "description": "Defines the state of the `additionalText`.\n\nAvailable options are: `\"None\"` (by default), `\"Positive\"`, `\"Critical\"`, `\"Information\"` and `\"Negative\"`.", "privacy": "public", "_ui5since": "1.0.0-rc.15", - "_ui5validator": "ValueState" + "_ui5validator": "String" }, { "kind": "field", @@ -14078,8 +14028,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the item is movable.", "default": "false", + "description": "Defines whether the item is movable.", "privacy": "public", "_ui5since": "2.0.0", "_ui5validator": "Boolean" @@ -14088,10 +14038,10 @@ "kind": "field", "name": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text alternative of the component.\nNote: If not provided a default text alternative will be set, if present.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15", "_ui5validator": "String" @@ -14109,10 +14059,10 @@ } ] }, - "description": "Defines the visual indication and behavior of the list items.\nAvailable options are `Active` (by default), `Inactive`, `Detail` and `Navigation`.\n\n**Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and hover,\nwhile with type `Inactive` and `Detail` - will not.", "default": "\"Active\"", + "description": "Defines the visual indication and behavior of the list items.\nAvailable options are `Active` (by default), `Inactive`, `Detail` and `Navigation`.\n\n**Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and hover,\nwhile with type `Inactive` and `Detail` - will not.", "privacy": "public", - "_ui5validator": "ListItemType", + "_ui5validator": "String", "inheritedFrom": { "name": "ListItem", "module": "dist/ListItem.js" @@ -14131,8 +14081,8 @@ } ] }, - "description": "Defines the additional accessibility attributes that will be applied to the component.\nThe following fields are supported:\n\n- **ariaSetsize**: Defines the number of items in the current set when not all items in the set are present in the DOM.\n**Note:** The value is an integer reflecting the number of items in the complete set. If the size of the entire set is unknown, set `-1`.\n\n\t- **ariaPosinset**: Defines an element's number or position in the current set when not all items are present in the DOM.\n\t**Note:** The value is an integer greater than or equal to 1, and less than or equal to the size of the set when that size is known.", "default": "{}", + "description": "Defines the additional accessibility attributes that will be applied to the component.\nThe following fields are supported:\n\n- **ariaSetsize**: Defines the number of items in the current set when not all items in the set are present in the DOM.\n**Note:** The value is an integer reflecting the number of items in the complete set. If the size of the entire set is unknown, set `-1`.\n\n\t- **ariaPosinset**: Defines an element's number or position in the current set when not all items are present in the DOM.\n\t**Note:** The value is an integer greater than or equal to 1, and less than or equal to the size of the set when that size is known.", "privacy": "public", "_ui5since": "1.15.0", "_ui5validator": "Object", @@ -14147,8 +14097,8 @@ "type": { "text": "boolean" }, - "description": "The navigated state of the list item.\nIf set to `true`, a navigation indicator is displayed at the end of the list item.", "default": "false", + "description": "The navigated state of the list item.\nIf set to `true`, a navigation indicator is displayed at the end of the list item.", "privacy": "public", "_ui5since": "1.10.0", "_ui5validator": "Boolean", @@ -14161,10 +14111,10 @@ "kind": "field", "name": "tooltip", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text of the tooltip that would be displayed for the list item.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.23.0", "_ui5validator": "String", @@ -14186,11 +14136,11 @@ } ] }, - "description": "Defines the highlight state of the list items.\nAvailable options are: `\"None\"` (by default), `\"Positive\"`, `\"Critical\"`, `\"Information\"` and `\"Negative\"`.", "default": "\"None\"", + "description": "Defines the highlight state of the list items.\nAvailable options are: `\"None\"` (by default), `\"Positive\"`, `\"Critical\"`, `\"Information\"` and `\"Negative\"`.", "privacy": "public", "_ui5since": "1.24", - "_ui5validator": "Highlight", + "_ui5validator": "String", "inheritedFrom": { "name": "ListItem", "module": "dist/ListItem.js" @@ -14207,8 +14157,8 @@ "privacy": "public", "_ui5validator": "Boolean", "inheritedFrom": { - "name": "ListItemBase", - "module": "dist/ListItemBase.js" + "name": "ListItem", + "module": "dist/ListItem.js" } } ], @@ -14216,23 +14166,23 @@ { "description": "Defines the description displayed right under the item text, if such is present.", "name": "description", - "default": "\"\"", + "default": "undefined", "fieldName": "description", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the `icon` source URI.\n\n**Note:**\nSAP-icons font provides numerous built-in icons. To find all the available icons, see the\n[Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).", "name": "icon", - "default": "\"\"", + "default": "undefined", "fieldName": "icon", "type": { - "text": "string" + "text": "string | undefined" } }, { - "description": "Defines whether the `icon` should be displayed in the beginning of the list item or in the end.\n\n**Note:** If `image` is set, the `icon` would be displayed after the `image`.", + "description": "Defines whether the `icon` should be displayed in the beginning of the list item or in the end.", "name": "icon-end", "default": "false", "fieldName": "iconEnd", @@ -14240,22 +14190,13 @@ "text": "boolean" } }, - { - "description": "Defines the `image` source URI.\n\n**Note:** The `image` would be displayed in the beginning of the list item.", - "name": "image", - "default": "\"\"", - "fieldName": "image", - "type": { - "text": "string" - } - }, { "description": "Defines the `additionalText`, displayed in the end of the list item.", "name": "additional-text", - "default": "\"\"", + "default": "undefined", "fieldName": "additionalText", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -14279,10 +14220,10 @@ { "description": "Defines the text alternative of the component.\nNote: If not provided a default text alternative will be set, if present.", "name": "accessible-name", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -14314,10 +14255,10 @@ { "description": "Defines the text of the tooltip that would be displayed for the list item.", "name": "tooltip", - "default": "\"\"", + "default": "undefined", "fieldName": "tooltip", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "ListItem", @@ -14346,8 +14287,8 @@ "text": "boolean" }, "inheritedFrom": { - "name": "ListItemBase", - "module": "dist/ListItemBase.js" + "name": "ListItem", + "module": "dist/ListItem.js" } } ], @@ -14398,22 +14339,28 @@ "kind": "javascript-module", "path": "dist/Menu.js", "declarations": [ + { + "kind": "interface", + "name": "IMenuItem", + "description": "Interface for components that may be slotted inside a `ui5-menu`.\n\n**Note:** Use with `ui5-menu-item` or `ui5-menu-separator`. Implementing the interface does not guarantee that any other classes can work with the `ui5-menu`.", + "_ui5privacy": "public" + }, { "kind": "class", - "description": "### Overview\n\n`ui5-menu` component represents a hierarchical menu structure.\n\n### Usage\n\n`ui5-menu` contains `ui5-menu-item` components.\nAn arbitrary hierarchy structure can be represented by recursively nesting menu items.\n\n### Keyboard Handling\n\nThe `ui5-menu` provides advanced keyboard handling.\nThe user can use the following keyboard shortcuts in order to navigate trough the tree:\n\n- `Arrow Up` / `Arrow Down` - Navigates up and down the menu items that are currently visible.\n- `Arrow Right`, `Space` or `Enter` - Opens a sub-menu if there are menu items nested\nin the currently clicked menu item.\n- `Arrow Left` or `Escape` - Closes the currently opened sub-menu.\n\nNote: if the text ditrection is set to Right-to-left (RTL), `Arrow Right` and `Arrow Left` functionality is swapped.\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents/dist/Menu.js\";`", + "description": "### Overview\n\n`ui5-menu` component represents a hierarchical menu structure.\n\n### Structure\n\nThe `ui5-menu` can hold two types of entities:\n\n- `ui5-menu-item` components\n- `ui5-menu-separator` - used to separate menu items with a line\n\nAn arbitrary hierarchy structure can be represented by recursively nesting menu items.\n\n### Keyboard Handling\n\nThe `ui5-menu` provides advanced keyboard handling.\nThe user can use the following keyboard shortcuts in order to navigate trough the tree:\n\n- `Arrow Up` / `Arrow Down` - Navigates up and down the menu items that are currently visible.\n- `Arrow Right`, `Space` or `Enter` - Opens a sub-menu if there are menu items nested\nin the currently clicked menu item.\n- `Arrow Left` or `Escape` - Closes the currently opened sub-menu.\n\nNote: if the text ditrection is set to Right-to-left (RTL), `Arrow Right` and `Arrow Left` functionality is swapped.\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents/dist/Menu.js\";`", "name": "Menu", "slots": [ { "name": "default", - "description": "Defines the items of this component.\n\n**Note:** Use `ui5-menu-item` for the intended design.", + "description": "Defines the items of this component.\n\n**Note:** Use `ui5-menu-item` and `ui5-menu-separator` for their intended design.", "_ui5propertyName": "items", "_ui5type": { - "text": "Array", + "text": "Array", "references": [ { - "name": "MenuItem", + "name": "IMenuItem", "package": "@ui5/webcomponents", - "module": "dist/MenuItem.js" + "module": "dist/Menu.js" } ] }, @@ -14425,10 +14372,10 @@ "kind": "field", "name": "headerText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the header text of the menu (displayed on mobile).", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -14438,9 +14385,9 @@ "type": { "text": "boolean" }, + "default": "false", "description": "Indicates if the menu is open", "privacy": "public", - "default": "false", "_ui5since": "1.10.0", "_ui5validator": "Boolean" }, @@ -14450,8 +14397,8 @@ "type": { "text": "boolean" }, - "description": "Defines if a loading indicator would be displayed inside the corresponding ui5-menu popover.", "default": "false", + "description": "Defines if a loading indicator would be displayed inside the corresponding ui5-menu popover.", "privacy": "public", "_ui5since": "1.13.0", "_ui5validator": "Boolean" @@ -14462,23 +14409,23 @@ "type": { "text": "number" }, - "description": "Defines the delay in milliseconds, after which the loading indicator will be displayed inside the corresponding ui5-menu popover..", "default": "1000", + "description": "Defines the delay in milliseconds, after which the loading indicator will be displayed inside the corresponding ui5-menu popover..", "privacy": "public", "_ui5since": "1.13.0", - "_ui5validator": "Integer" + "_ui5validator": "Number" }, { "kind": "field", "name": "opener", "type": { - "text": "HTMLElement | string" + "text": "HTMLElement | string | undefined" }, "description": "Defines the ID or DOM Reference of the element at which the menu is shown.\nWhen using this attribute in a declarative way, you must only use the `id` (as a string) of the element at which you want to show the popover.\nYou can only set the `opener` attribute to a DOM Reference when using JavaScript.", "privacy": "public", - "default": "\"\"", + "default": "undefined", "_ui5since": "1.10.0", - "_ui5validator": "DOMReference" + "_ui5validator": "String" } ], "events": [ @@ -14594,10 +14541,10 @@ { "description": "Defines the header text of the menu (displayed on mobile).", "name": "header-text", - "default": "\"\"", + "default": "undefined", "fieldName": "headerText", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -14630,10 +14577,10 @@ { "description": "Defines the ID or DOM Reference of the element at which the menu is shown.\nWhen using this attribute in a declarative way, you must only use the `id` (as a string) of the element at which you want to show the popover.\nYou can only set the `opener` attribute to a DOM Reference when using JavaScript.", "name": "opener", - "default": "\"\"", + "default": "undefined", "fieldName": "opener", "type": { - "text": "string | HTMLElement" + "text": "string | HTMLElement | undefined" } } ], @@ -14678,15 +14625,15 @@ "slots": [ { "name": "default", - "description": "Defines the items of this component.\n\n**Note:** If there are items added to this slot, an arrow will be displayed at the end\nof the item in order to indicate that there are items added. In that case components added\nto `endContent` slot or `additionalText` content will not be displayed.\n\nThe priority of what will be displayed at the end of the menu item is as follows:\nsub-menu arrow (if there are items added in `items` slot) -> components added in `endContent` -> text set to `additionalText`.", + "description": "Defines the items of this component.\n\n**Note:** The slot can hold `ui5-menu-item` and `ui5-menu-separator` items.\n\nIf there are items added to this slot, an arrow will be displayed at the end\nof the item in order to indicate that there are items added. In that case components added\nto `endContent` slot or `additionalText` content will not be displayed.\n\nThe priority of what will be displayed at the end of the menu item is as follows:\nsub-menu arrow (if there are items added in `items` slot) -> components added in `endContent` -> text set to `additionalText`.", "_ui5propertyName": "items", "_ui5type": { - "text": "Array", + "text": "Array", "references": [ { - "name": "MenuItem", + "name": "IMenuItem", "package": "@ui5/webcomponents", - "module": "dist/MenuItem.js" + "module": "dist/Menu.js" } ] }, @@ -14723,10 +14670,10 @@ "kind": "field", "name": "text", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text of the tree item.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -14734,10 +14681,10 @@ "kind": "field", "name": "additionalText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the `additionalText`, displayed in the end of the menu item.\n\n**Note:** The additional text will not be displayed if there are items added in `items` slot or there are\ncomponents added to `endContent` slot.\n\nThe priority of what will be displayed at the end of the menu item is as follows:\nsub-menu arrow (if there are items added in `items` slot) -> components added in `endContent` -> text set to `additionalText`.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.8.0", "_ui5validator": "String" @@ -14746,32 +14693,21 @@ "kind": "field", "name": "icon", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the icon to be displayed as graphical element within the component.\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": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, - { - "kind": "field", - "name": "startsSection", - "type": { - "text": "boolean" - }, - "description": "Defines whether a visual separator should be rendered before the item.", - "default": "false", - "privacy": "public", - "_ui5validator": "Boolean" - }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, - "description": "Defines whether `ui5-menu-item` is in disabled state.\n\n**Note:** A disabled `ui5-menu-item` is noninteractive.", "default": "false", + "description": "Defines whether `ui5-menu-item` is in disabled state.\n\n**Note:** A disabled `ui5-menu-item` is noninteractive.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -14781,8 +14717,8 @@ "type": { "text": "boolean" }, - "description": "Defines the delay in milliseconds, after which the loading indicator will be displayed inside the corresponding ui5-menu popover.\n\n**Note:** If set to `true` a `ui5-busy-indicator` component will be displayed into the related one to the current `ui5-menu-item` sub-menu popover.", "default": "false", + "description": "Defines the delay in milliseconds, after which the loading indicator will be displayed inside the corresponding ui5-menu popover.\n\n**Note:** If set to `true` a `ui5-busy-indicator` component will be displayed into the related one to the current `ui5-menu-item` sub-menu popover.", "privacy": "public", "_ui5since": "1.13.0", "_ui5validator": "Boolean" @@ -14793,20 +14729,20 @@ "type": { "text": "number" }, - "description": "Defines the delay in milliseconds, after which the loading indicator will be displayed inside the corresponding ui5-menu popover.", "default": "1000", + "description": "Defines the delay in milliseconds, after which the loading indicator will be displayed inside the corresponding ui5-menu popover.", "privacy": "public", "_ui5since": "1.13.0", - "_ui5validator": "Integer" + "_ui5validator": "Number" }, { "kind": "field", "name": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the accessible ARIA name of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.7.0", "_ui5validator": "String" @@ -14815,10 +14751,10 @@ "kind": "field", "name": "tooltip", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text of the tooltip for the menu item.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.23.0", "_ui5validator": "String", @@ -14840,10 +14776,10 @@ } ] }, - "description": "Defines the visual indication and behavior of the list items.\nAvailable options are `Active` (by default), `Inactive`, `Detail` and `Navigation`.\n\n**Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and hover,\nwhile with type `Inactive` and `Detail` - will not.", "default": "\"Active\"", + "description": "Defines the visual indication and behavior of the list items.\nAvailable options are `Active` (by default), `Inactive`, `Detail` and `Navigation`.\n\n**Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and hover,\nwhile with type `Inactive` and `Detail` - will not.", "privacy": "public", - "_ui5validator": "ListItemType", + "_ui5validator": "String", "inheritedFrom": { "name": "ListItem", "module": "dist/ListItem.js" @@ -14862,8 +14798,8 @@ } ] }, - "description": "Defines the additional accessibility attributes that will be applied to the component.\nThe following fields are supported:\n\n- **ariaSetsize**: Defines the number of items in the current set when not all items in the set are present in the DOM.\n**Note:** The value is an integer reflecting the number of items in the complete set. If the size of the entire set is unknown, set `-1`.\n\n\t- **ariaPosinset**: Defines an element's number or position in the current set when not all items are present in the DOM.\n\t**Note:** The value is an integer greater than or equal to 1, and less than or equal to the size of the set when that size is known.", "default": "{}", + "description": "Defines the additional accessibility attributes that will be applied to the component.\nThe following fields are supported:\n\n- **ariaSetsize**: Defines the number of items in the current set when not all items in the set are present in the DOM.\n**Note:** The value is an integer reflecting the number of items in the complete set. If the size of the entire set is unknown, set `-1`.\n\n\t- **ariaPosinset**: Defines an element's number or position in the current set when not all items are present in the DOM.\n\t**Note:** The value is an integer greater than or equal to 1, and less than or equal to the size of the set when that size is known.", "privacy": "public", "_ui5since": "1.15.0", "_ui5validator": "Object", @@ -14878,8 +14814,8 @@ "type": { "text": "boolean" }, - "description": "The navigated state of the list item.\nIf set to `true`, a navigation indicator is displayed at the end of the list item.", "default": "false", + "description": "The navigated state of the list item.\nIf set to `true`, a navigation indicator is displayed at the end of the list item.", "privacy": "public", "_ui5since": "1.10.0", "_ui5validator": "Boolean", @@ -14901,11 +14837,11 @@ } ] }, - "description": "Defines the highlight state of the list items.\nAvailable options are: `\"None\"` (by default), `\"Positive\"`, `\"Critical\"`, `\"Information\"` and `\"Negative\"`.", "default": "\"None\"", + "description": "Defines the highlight state of the list items.\nAvailable options are: `\"None\"` (by default), `\"Positive\"`, `\"Critical\"`, `\"Information\"` and `\"Negative\"`.", "privacy": "public", "_ui5since": "1.24", - "_ui5validator": "Highlight", + "_ui5validator": "String", "inheritedFrom": { "name": "ListItem", "module": "dist/ListItem.js" @@ -14922,8 +14858,8 @@ "privacy": "public", "_ui5validator": "Boolean", "inheritedFrom": { - "name": "ListItemBase", - "module": "dist/ListItemBase.js" + "name": "ListItem", + "module": "dist/ListItem.js" } } ], @@ -14931,37 +14867,28 @@ { "description": "Defines the text of the tree item.", "name": "text", - "default": "\"\"", + "default": "undefined", "fieldName": "text", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the `additionalText`, displayed in the end of the menu item.\n\n**Note:** The additional text will not be displayed if there are items added in `items` slot or there are\ncomponents added to `endContent` slot.\n\nThe priority of what will be displayed at the end of the menu item is as follows:\nsub-menu arrow (if there are items added in `items` slot) -> components added in `endContent` -> text set to `additionalText`.", "name": "additional-text", - "default": "\"\"", + "default": "undefined", "fieldName": "additionalText", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the icon to be displayed as graphical element within the component.\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": "\"\"", + "default": "undefined", "fieldName": "icon", "type": { - "text": "string" - } - }, - { - "description": "Defines whether a visual separator should be rendered before the item.", - "name": "starts-section", - "default": "false", - "fieldName": "startsSection", - "type": { - "text": "boolean" + "text": "string | undefined" } }, { @@ -14994,19 +14921,19 @@ { "description": "Defines the accessible ARIA name of the component.", "name": "accessible-name", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the text of the tooltip for the menu item.", "name": "tooltip", - "default": "\"\"", + "default": "undefined", "fieldName": "tooltip", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "ListItem", @@ -15061,8 +14988,8 @@ "text": "boolean" }, "inheritedFrom": { - "name": "ListItemBase", - "module": "dist/ListItemBase.js" + "name": "ListItem", + "module": "dist/ListItem.js" } } ], @@ -15075,6 +15002,13 @@ "customElement": true, "_ui5since": "1.3.0", "_ui5privacy": "public", + "_ui5implements": [ + { + "name": "IMenuItem", + "package": "@ui5/webcomponents", + "module": "dist/Menu.js" + } + ], "events": [ { "name": "detail-click", @@ -15112,20 +15046,66 @@ }, { "kind": "javascript-module", - "path": "dist/MessageStrip.js", + "path": "dist/MenuSeparator.js", "declarations": [ { "kind": "class", - "description": "### Overview\n\nThe `ui5-message-strip` component enables the embedding of app-related messages.\nIt displays 4 designs of messages, each with corresponding semantic color and icon: Information, Positive, Critical and Negative.\nEach message can have a Close button, so that it can be removed from the UI, if needed.\n\n### Usage\n\nFor the `ui5-message-strip` component, you can define whether it displays\nan icon in the beginning and a close button. Moreover, its size and background\ncan be controlled with CSS.\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### ES6 Module Import\n\n`import \"@ui5/webcomponents/dist/MessageStrip.js\";`", - "name": "MessageStrip", - "slots": [ + "description": "The `ui5-menu-separator` represents a horizontal line to separate menu items inside a `ui5-menu`.", + "name": "MenuSeparator", + "superclass": { + "name": "ListItemBase", + "package": "@ui5/webcomponents", + "module": "dist/ListItemBase.js" + }, + "tagName": "ui5-menu-separator", + "customElement": true, + "_ui5since": "2.0", + "_ui5privacy": "public", + "_ui5implements": [ { - "description": "Defines the text of the component.\n\n**Note:** Although this slot accepts HTML Elements, it is strongly recommended that you only use text in order to preserve the intended design.", - "name": "default", - "_ui5privacy": "public", - "_ui5type": { - "text": "Array" - } + "name": "IMenuItem", + "package": "@ui5/webcomponents", + "module": "dist/Menu.js" + } + ], + "members": [] + } + ], + "exports": [ + { + "kind": "js", + "name": "default", + "declaration": { + "name": "MenuSeparator", + "module": "dist/MenuSeparator.js" + } + }, + { + "kind": "custom-element-definition", + "name": "ui5-menu-separator", + "declaration": { + "name": "MenuSeparator", + "module": "dist/MenuSeparator.js" + } + } + ] + }, + { + "kind": "javascript-module", + "path": "dist/MessageStrip.js", + "declarations": [ + { + "kind": "class", + "description": "### Overview\n\nThe `ui5-message-strip` component enables the embedding of app-related messages.\nIt displays 4 designs of messages, each with corresponding semantic color and icon: Information, Positive, Critical and Negative.\nEach message can have a Close button, so that it can be removed from the UI, if needed.\n\n### Usage\n\nFor the `ui5-message-strip` component, you can define whether it displays\nan icon in the beginning and a close button. Moreover, its size and background\ncan be controlled with CSS.\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### ES6 Module Import\n\n`import \"@ui5/webcomponents/dist/MessageStrip.js\";`", + "name": "MessageStrip", + "slots": [ + { + "description": "Defines the text of the component.\n\n**Note:** Although this slot accepts HTML Elements, it is strongly recommended that you only use text in order to preserve the intended design.", + "name": "default", + "_ui5privacy": "public", + "_ui5type": { + "text": "Array" + } }, { "name": "icon", @@ -15157,11 +15137,11 @@ } ] }, - "description": "Defines the component type.", "default": "\"Information\"", + "description": "Defines the component type.", "privacy": "public", "_ui5since": "1.0.0-rc.15", - "_ui5validator": "MessageStripDesign" + "_ui5validator": "String" }, { "kind": "field", @@ -15169,8 +15149,8 @@ "type": { "text": "string" }, - "description": "Defines the color scheme of the component.\nThere are 10 predefined schemes.\nTo use one you can set a number from `\"1\"` to `\"10\"`. The `colorScheme` `\"1\"` will be set by default.", "default": "\"1\"", + "description": "Defines the color scheme of the component.\nThere are 10 predefined schemes.\nTo use one you can set a number from `\"1\"` to `\"10\"`. The `colorScheme` `\"1\"` will be set by default.", "privacy": "public", "_ui5since": "2.0.0", "_ui5validator": "String" @@ -15181,8 +15161,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the MessageStrip will show an icon in the beginning.\nYou can directly provide an icon with the `icon` slot. Otherwise, the default icon for the type will be used.\n\n * **Note:** If MessageStripDesign.ColorSet1 or MessageStripDesign.ColorSet2 value is set to the design property, default icon will not be presented.", "default": "false", + "description": "Defines whether the MessageStrip will show an icon in the beginning.\nYou can directly provide an icon with the `icon` slot. Otherwise, the default icon for the type will be used.\n\n * **Note:** If MessageStripDesign.ColorSet1 or MessageStripDesign.ColorSet2 value is set to the design property, default icon will not be presented.", "privacy": "public", "_ui5since": "1.0.0-rc.15", "_ui5validator": "Boolean" @@ -15193,8 +15173,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the MessageStrip renders close button.", "default": "false", + "description": "Defines whether the MessageStrip renders close button.", "privacy": "public", "_ui5validator": "Boolean" } @@ -15362,8 +15342,8 @@ "type": { "text": "string" }, - "description": "Defines the value of the component.\n\n**Note:** The property is updated upon typing.", "default": "\"\"", + "description": "Defines the value of the component.\n\n**Note:** The property is updated upon typing.", "privacy": "public", "_ui5validator": "String", "_ui5formProperty": true, @@ -15373,10 +15353,10 @@ "kind": "field", "name": "name", "type": { - "text": "string" + "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.\n**Note:** When the component is used inside a form element,\nthe value is sent as the first element in the form data, even if it's empty.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "2.0.0", "_ui5validator": "String" @@ -15387,8 +15367,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the value will be autcompleted to match an item", "default": "false", + "description": "Defines whether the value will be autcompleted to match an item", "privacy": "public", "_ui5since": "1.4.0", "_ui5validator": "Boolean" @@ -15397,10 +15377,10 @@ "kind": "field", "name": "placeholder", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines a short hint intended to aid the user with data entry when the\ncomponent has no value.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -15410,8 +15390,8 @@ "type": { "text": "boolean" }, - "description": "Defines if the user input will be prevented, if no matching item has been found", "default": "false", + "description": "Defines if the user input will be prevented, if no matching item has been found", "privacy": "public", "_ui5validator": "Boolean" }, @@ -15421,8 +15401,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is in disabled state.\n\n**Note:** A disabled component is completely noninteractive.", "default": "false", + "description": "Defines whether the component is in disabled state.\n\n**Note:** A disabled component is completely noninteractive.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -15439,10 +15419,10 @@ } ] }, - "description": "Defines the value state of the component.", "default": "\"None\"", + "description": "Defines the value state of the component.", "privacy": "public", - "_ui5validator": "ValueState" + "_ui5validator": "String" }, { "kind": "field", @@ -15450,8 +15430,8 @@ "type": { "text": "boolean" }, - "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.", "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", "_ui5validator": "Boolean" }, @@ -15461,8 +15441,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is required.", "default": "false", + "description": "Defines whether the component is required.", "privacy": "public", "_ui5since": "1.0.0-rc.5", "_ui5validator": "Boolean" @@ -15480,10 +15460,10 @@ } ] }, - "description": "Defines the filter type of the component.", "default": "\"StartsWithPerTerm\"", + "description": "Defines the filter type of the component.", "privacy": "public", - "_ui5validator": "ComboBoxFilter" + "_ui5validator": "String" }, { "kind": "field", @@ -15491,8 +15471,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the clear icon of the multi-combobox will be shown.", "default": "false", + "description": "Defines whether the clear icon of the multi-combobox will be shown.", "privacy": "public", "_ui5since": "1.20.1", "_ui5validator": "Boolean" @@ -15501,10 +15481,10 @@ "kind": "field", "name": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the accessible ARIA name of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.4.0", "_ui5validator": "String" @@ -15513,10 +15493,10 @@ "kind": "field", "name": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Receives id(or many ids) of the elements that label the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.4.0", "_ui5validator": "String" @@ -15527,8 +15507,8 @@ "type": { "text": "boolean" }, - "description": "Determines if the select all checkbox is visible on top of suggestions.", "default": "false", + "description": "Determines if the select all checkbox is visible on top of suggestions.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -15626,10 +15606,10 @@ { "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.\n**Note:** When the component is used inside a form element,\nthe value is sent as the first element in the form data, even if it's empty.", "name": "name", - "default": "\"\"", + "default": "undefined", "fieldName": "name", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -15644,10 +15624,10 @@ { "description": "Defines a short hint intended to aid the user with data entry when the\ncomponent has no value.", "name": "placeholder", - "default": "\"\"", + "default": "undefined", "fieldName": "placeholder", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -15716,19 +15696,19 @@ { "description": "Defines the accessible ARIA name of the component.", "name": "accessible-name", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Receives id(or many ids) of the elements that label the component.", "name": "accessible-name-ref", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -15804,10 +15784,10 @@ "kind": "field", "name": "text", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String", "inheritedFrom": { @@ -15819,10 +15799,10 @@ "kind": "field", "name": "additionalText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the additional text of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.11", "_ui5validator": "String", @@ -15845,10 +15825,10 @@ { "description": "Defines the text of the component.", "name": "text", - "default": "\"\"", + "default": "undefined", "fieldName": "text", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "ComboBoxItem", @@ -15858,10 +15838,10 @@ { "description": "Defines the additional text of the component.", "name": "additional-text", - "default": "\"\"", + "default": "undefined", "fieldName": "additionalText", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "ComboBoxItem", @@ -15935,12 +15915,12 @@ "members": [ { "kind": "field", - "name": "text", + "name": "headerText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" } @@ -15948,11 +15928,11 @@ "attributes": [ { "description": "Defines the text of the component.", - "name": "text", - "default": "\"\"", - "fieldName": "text", + "name": "header-text", + "default": "undefined", + "fieldName": "headerText", "type": { - "text": "string" + "text": "string | undefined" } } ], @@ -16020,7 +16000,7 @@ }, { "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 `` are recommended to be used as suggestion items.\n\n**Note:** Importing the Input Suggestions Support feature:\n\n`import \"@ui5/webcomponents/dist/features/InputSuggestions.js\";`\n\nautomatically imports the `` and `` for your convenience.", + "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.\n\n**Note:** Importing the Input Suggestions Support feature:\n\n`import \"@ui5/webcomponents/dist/features/InputSuggestions.js\";`\n\nautomatically imports the `` and `` for your convenience.", "_ui5propertyName": "suggestionItems", "_ui5type": { "text": "Array", @@ -16066,8 +16046,8 @@ "type": { "text": "boolean" }, - "description": "Determines whether a value help icon will be visualized in the end of the input.\nPressing the icon will fire `value-help-trigger` event.", "default": "false", + "description": "Determines whether a value help icon will be visualized in the end of the input.\nPressing the icon will fire `value-help-trigger` event.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -16075,10 +16055,10 @@ "kind": "field", "name": "name", "type": { - "text": "string" + "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.\n**Note:** When the component is used inside a form element,\nthe value is sent as the first element in the form data, even if it's empty.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String", "inheritedFrom": { @@ -16092,8 +16072,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is in disabled state.\n\n**Note:** A disabled component is completely noninteractive.", "default": "false", + "description": "Defines whether the component is in disabled state.\n\n**Note:** A disabled component is completely noninteractive.", "privacy": "public", "_ui5validator": "Boolean", "inheritedFrom": { @@ -16105,10 +16085,10 @@ "kind": "field", "name": "placeholder", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines a short hint intended to aid the user with data entry when the\ncomponent has no value.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String", "inheritedFrom": { @@ -16122,8 +16102,8 @@ "type": { "text": "boolean" }, - "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.", "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", "_ui5validator": "Boolean", "inheritedFrom": { @@ -16137,8 +16117,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is required.", "default": "false", + "description": "Defines whether the component is required.", "privacy": "public", "_ui5since": "1.0.0-rc.3", "_ui5validator": "Boolean", @@ -16153,8 +16133,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the value will be autcompleted to match an item", "default": "false", + "description": "Defines whether the value will be autcompleted to match an item", "privacy": "public", "_ui5since": "1.4.0", "_ui5validator": "Boolean", @@ -16176,10 +16156,10 @@ } ] }, - "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.", "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", - "_ui5validator": "InputType", + "_ui5validator": "String", "inheritedFrom": { "name": "Input", "module": "dist/Input.js" @@ -16191,8 +16171,8 @@ "type": { "text": "string" }, - "description": "Defines the value of the component.\n\n**Note:** The property is updated upon typing.", "default": "\"\"", + "description": "Defines the value of the component.\n\n**Note:** The property is updated upon typing.", "privacy": "public", "_ui5validator": "String", "_ui5formProperty": true, @@ -16215,10 +16195,10 @@ } ] }, - "description": "Defines the value state of the component.", "default": "\"None\"", + "description": "Defines the value state of the component.", "privacy": "public", - "_ui5validator": "ValueState", + "_ui5validator": "String", "inheritedFrom": { "name": "Input", "module": "dist/Input.js" @@ -16230,8 +16210,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component should show suggestions, if such are present.\n\n**Note:** You need to import the `InputSuggestions` module\nfrom `\"@ui5/webcomponents/dist/features/InputSuggestions.js\"` to enable this functionality.", "default": "false", + "description": "Defines whether the component should show suggestions, if such are present.\n\n**Note:** You need to import the `InputSuggestions` module\nfrom `\"@ui5/webcomponents/dist/features/InputSuggestions.js\"` to enable this functionality.", "privacy": "public", "_ui5validator": "Boolean", "inheritedFrom": { @@ -16249,7 +16229,7 @@ "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.5", - "_ui5validator": "Integer", + "_ui5validator": "Number", "inheritedFrom": { "name": "Input", "module": "dist/Input.js" @@ -16259,10 +16239,10 @@ "kind": "field", "name": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the accessible ARIA name of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15", "_ui5validator": "String", @@ -16275,10 +16255,10 @@ "kind": "field", "name": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Receives id(or many ids) of the elements that label the input.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15", "_ui5validator": "String", @@ -16293,8 +16273,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the clear icon of the input will be shown.", "default": "false", + "description": "Defines whether the clear icon of the input will be shown.", "privacy": "public", "_ui5since": "1.2.0", "_ui5validator": "Boolean", @@ -16309,8 +16289,8 @@ "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.", "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", "_ui5validator": "Boolean", @@ -16401,14 +16381,6 @@ "name": "item", "_ui5privacy": "public", "description": "The previewed suggestion item." - }, - { - "type": { - "text": "HTMLElement" - }, - "name": "targetRef", - "_ui5privacy": "public", - "description": "The DOM ref of the suggestion item." } ], "inheritedFrom": { @@ -16456,10 +16428,10 @@ { "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.\n**Note:** When the component is used inside a form element,\nthe value is sent as the first element in the form data, even if it's empty.", "name": "name", - "default": "\"\"", + "default": "undefined", "fieldName": "name", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "Input", @@ -16482,10 +16454,10 @@ { "description": "Defines a short hint intended to aid the user with data entry when the\ncomponent has no value.", "name": "placeholder", - "default": "\"\"", + "default": "undefined", "fieldName": "placeholder", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "Input", @@ -16599,10 +16571,10 @@ { "description": "Defines the accessible ARIA name of the component.", "name": "accessible-name", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "Input", @@ -16612,10 +16584,10 @@ { "description": "Receives id(or many ids) of the elements that label the input.", "name": "accessible-name-ref", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "Input", @@ -16733,10 +16705,10 @@ "kind": "field", "name": "value", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the value of the `ui5-select` inside an HTML Form element when this component is selected.\nFor more information on HTML Form support, see the `name` property of `ui5-select`.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -16744,10 +16716,10 @@ "kind": "field", "name": "icon", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the `icon` source URI.\n\n**Note:**\nSAP-icons font provides numerous built-in icons. To find all the available icons, see the\n[Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -16755,10 +16727,10 @@ "kind": "field", "name": "additionalText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the `additionalText`, displayed in the end of the list item.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15", "_ui5validator": "String" @@ -16767,10 +16739,10 @@ "kind": "field", "name": "tooltip", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text of the tooltip that would be displayed for the list item.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.23.0", "_ui5validator": "String" @@ -16784,48 +16756,44 @@ "description": "Defines the selected state of the component.", "default": "false", "privacy": "public", - "_ui5validator": "Boolean", - "inheritedFrom": { - "name": "ListItemBase", - "module": "dist/ListItemBase.js" - } + "_ui5validator": "Boolean" } ], "attributes": [ { "description": "Defines the value of the `ui5-select` inside an HTML Form element when this component is selected.\nFor more information on HTML Form support, see the `name` property of `ui5-select`.", "name": "value", - "default": "\"\"", + "default": "undefined", "fieldName": "value", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the `icon` source URI.\n\n**Note:**\nSAP-icons font provides numerous built-in icons. To find all the available icons, see the\n[Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).", "name": "icon", - "default": "\"\"", + "default": "undefined", "fieldName": "icon", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the `additionalText`, displayed in the end of the list item.", "name": "additional-text", - "default": "\"\"", + "default": "undefined", "fieldName": "additionalText", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the text of the tooltip that would be displayed for the list item.", "name": "tooltip", - "default": "\"\"", + "default": "undefined", "fieldName": "tooltip", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -16835,10 +16803,6 @@ "fieldName": "selected", "type": { "text": "boolean" - }, - "inheritedFrom": { - "name": "ListItemBase", - "module": "dist/ListItemBase.js" } } ], @@ -16902,10 +16866,10 @@ "kind": "field", "name": "displayText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text, displayed inside the `ui5-select` input filed\nwhen the option gets selected.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -16913,10 +16877,10 @@ "kind": "field", "name": "value", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the value of the `ui5-select` inside an HTML Form element when this component is selected.\nFor more information on HTML Form support, see the `name` property of `ui5-select`.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -16924,10 +16888,10 @@ "kind": "field", "name": "tooltip", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text of the tooltip that would be displayed for the list item.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -16940,39 +16904,35 @@ "description": "Defines the selected state of the component.", "default": "false", "privacy": "public", - "_ui5validator": "Boolean", - "inheritedFrom": { - "name": "ListItemBase", - "module": "dist/ListItemBase.js" - } + "_ui5validator": "Boolean" } ], "attributes": [ { "description": "Defines the text, displayed inside the `ui5-select` input filed\nwhen the option gets selected.", "name": "display-text", - "default": "\"\"", + "default": "undefined", "fieldName": "displayText", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the value of the `ui5-select` inside an HTML Form element when this component is selected.\nFor more information on HTML Form support, see the `name` property of `ui5-select`.", "name": "value", - "default": "\"\"", + "default": "undefined", "fieldName": "value", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the text of the tooltip that would be displayed for the list item.", "name": "tooltip", - "default": "\"\"", + "default": "undefined", "fieldName": "tooltip", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -16982,10 +16942,6 @@ "fieldName": "selected", "type": { "text": "boolean" - }, - "inheritedFrom": { - "name": "ListItemBase", - "module": "dist/ListItemBase.js" } } ], @@ -17067,10 +17023,10 @@ "kind": "field", "name": "headerText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "This property is used to set the header text of the component.\nThe text is visible in both expanded and collapsed states.\n\n**Note:** This property is overridden by the `header` slot.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -17080,8 +17036,8 @@ "type": { "text": "boolean" }, - "description": "Determines whether the component is in a fixed state that is not\nexpandable/collapsible by user interaction.", "default": "false", + "description": "Determines whether the component is in a fixed state that is not\nexpandable/collapsible by user interaction.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -17091,8 +17047,8 @@ "type": { "text": "boolean" }, - "description": "Indicates whether the component is collapsed and only the header is displayed.", "default": "false", + "description": "Indicates whether the component is collapsed and only the header is displayed.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -17102,8 +17058,8 @@ "type": { "text": "boolean" }, - "description": "Indicates whether the transition between the expanded and the collapsed state of the component is animated. By default the animation is enabled.", "default": "false", + "description": "Indicates whether the transition between the expanded and the collapsed state of the component is animated. By default the animation is enabled.", "privacy": "public", "_ui5since": "1.0.0-rc.16", "_ui5validator": "Boolean" @@ -17121,10 +17077,10 @@ } ] }, - "description": "Sets the accessible ARIA role of the component.\nDepending on the usage, you can change the role from the default `Form`\nto `Region` or `Complementary`.", "default": "\"Form\"", + "description": "Sets the accessible ARIA role of the component.\nDepending on the usage, you can change the role from the default `Form`\nto `Region` or `Complementary`.", "privacy": "public", - "_ui5validator": "PanelAccessibleRole" + "_ui5validator": "String" }, { "kind": "field", @@ -17139,19 +17095,19 @@ } ] }, - "description": "Defines the \"aria-level\" of component heading,\nset by the `headerText`.", "default": "\"H2\"", + "description": "Defines the \"aria-level\" of component heading,\nset by the `headerText`.", "privacy": "public", - "_ui5validator": "TitleLevel" + "_ui5validator": "String" }, { "kind": "field", "name": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the accessible ARIA name of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15", "_ui5validator": "String" @@ -17162,8 +17118,8 @@ "type": { "text": "boolean" }, - "description": "Indicates whether the Panel header is sticky or not.\nIf stickyHeader is set to true, then whenever you scroll the content or\nthe application, the header of the panel will be always visible and\na solid color will be used for its design.", "default": "false", + "description": "Indicates whether the Panel header is sticky or not.\nIf stickyHeader is set to true, then whenever you scroll the content or\nthe application, the header of the panel will be always visible and\na solid color will be used for its design.", "privacy": "public", "_ui5since": "1.16.0-rc.1", "_ui5validator": "Boolean" @@ -17183,10 +17139,10 @@ { "description": "This property is used to set the header text of the component.\nThe text is visible in both expanded and collapsed states.\n\n**Note:** This property is overridden by the `header` slot.", "name": "header-text", - "default": "\"\"", + "default": "undefined", "fieldName": "headerText", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -17237,10 +17193,10 @@ { "description": "Defines the accessible ARIA name of the component.", "name": "accessible-name", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -17336,10 +17292,10 @@ "kind": "field", "name": "headerText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the header text.\n\n**Note:** If `header` slot is provided, the `headerText` is ignored.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -17356,10 +17312,10 @@ } ] }, - "description": "Determines on which side the component is placed at.", "default": "\"End\"", + "description": "Determines on which side the component is placed at.", "privacy": "public", - "_ui5validator": "PopoverPlacement" + "_ui5validator": "String" }, { "kind": "field", @@ -17374,10 +17330,10 @@ } ] }, - "description": "Determines the horizontal alignment of the component.", "default": "\"Center\"", + "description": "Determines the horizontal alignment of the component.", "privacy": "public", - "_ui5validator": "PopoverHorizontalAlign" + "_ui5validator": "String" }, { "kind": "field", @@ -17392,10 +17348,10 @@ } ] }, - "description": "Determines the vertical alignment of the component.", "default": "\"Center\"", + "description": "Determines the vertical alignment of the component.", "privacy": "public", - "_ui5validator": "PopoverVerticalAlign" + "_ui5validator": "String" }, { "kind": "field", @@ -17403,8 +17359,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component should close when\nclicking/tapping outside of the popover.\nIf enabled, it blocks any interaction with the background.", "default": "false", + "description": "Defines whether the component should close when\nclicking/tapping outside of the popover.\nIf enabled, it blocks any interaction with the background.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -17414,8 +17370,8 @@ "type": { "text": "boolean" }, - "description": "Determines whether the component arrow is hidden.", "default": "false", + "description": "Determines whether the component arrow is hidden.", "privacy": "public", "_ui5since": "1.0.0-rc.15", "_ui5validator": "Boolean" @@ -17426,8 +17382,8 @@ "type": { "text": "boolean" }, - "description": "Determines if there is no enough space, the component can be placed\nover the target.", "default": "false", + "description": "Determines if there is no enough space, the component can be placed\nover the target.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -17441,16 +17397,16 @@ "text": "HTMLElement | string | undefined" }, "_ui5since": "1.2.0", - "_ui5validator": "DOMReference" + "_ui5validator": "String" }, { "kind": "field", "name": "initialFocus", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the ID of the HTML Element, which will get the initial focus.\n\n**Note:** If an element with `autofocus` attribute is added inside the component,\n`initialFocus` won't take effect.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String", "inheritedFrom": { @@ -17464,8 +17420,8 @@ "type": { "text": "boolean" }, - "description": "Defines if the focus should be returned to the previously focused element,\nwhen the popup closes.", "default": "false", + "description": "Defines if the focus should be returned to the previously focused element,\nwhen the popup closes.", "privacy": "public", "_ui5since": "1.0.0-rc.8", "_ui5validator": "Boolean", @@ -17494,10 +17450,10 @@ "kind": "field", "name": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the IDs of the elements that label the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.1.0", "_ui5validator": "String", @@ -17519,11 +17475,11 @@ } ] }, - "description": "Allows setting a custom role.", "default": "\"Dialog\"", + "description": "Allows setting a custom role.", "privacy": "public", "_ui5since": "1.10.0", - "_ui5validator": "PopupAccessibleRole", + "_ui5validator": "String", "inheritedFrom": { "name": "Popup", "module": "dist/Popup.js" @@ -17535,9 +17491,9 @@ "type": { "text": "boolean" }, + "default": "false", "description": "Indicates whether initial focus should be prevented.", "privacy": "public", - "default": "false", "_ui5since": "2.0.0", "_ui5validator": "Boolean", "inheritedFrom": { @@ -17582,10 +17538,10 @@ { "description": "Defines the header text.\n\n**Note:** If `header` slot is provided, the `headerText` is ignored.", "name": "header-text", - "default": "\"\"", + "default": "undefined", "fieldName": "headerText", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -17654,10 +17610,10 @@ { "description": "Defines the ID of the HTML Element, which will get the initial focus.\n\n**Note:** If an element with `autofocus` attribute is added inside the component,\n`initialFocus` won't take effect.", "name": "initial-focus", - "default": "\"\"", + "default": "undefined", "fieldName": "initialFocus", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "Popup", @@ -17693,10 +17649,10 @@ { "description": "Defines the IDs of the elements that label the component.", "name": "accessible-name-ref", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "Popup", @@ -17866,10 +17822,10 @@ "kind": "field", "name": "initialFocus", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the ID of the HTML Element, which will get the initial focus.\n\n**Note:** If an element with `autofocus` attribute is added inside the component,\n`initialFocus` won't take effect.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -17879,8 +17835,8 @@ "type": { "text": "boolean" }, - "description": "Defines if the focus should be returned to the previously focused element,\nwhen the popup closes.", "default": "false", + "description": "Defines if the focus should be returned to the previously focused element,\nwhen the popup closes.", "privacy": "public", "_ui5since": "1.0.0-rc.8", "_ui5validator": "Boolean" @@ -17901,10 +17857,10 @@ "kind": "field", "name": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the IDs of the elements that label the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.1.0", "_ui5validator": "String" @@ -17922,11 +17878,11 @@ } ] }, - "description": "Allows setting a custom role.", "default": "\"Dialog\"", + "description": "Allows setting a custom role.", "privacy": "public", "_ui5since": "1.10.0", - "_ui5validator": "PopupAccessibleRole" + "_ui5validator": "String" }, { "kind": "field", @@ -17934,9 +17890,9 @@ "type": { "text": "boolean" }, + "default": "false", "description": "Indicates whether initial focus should be prevented.", "privacy": "public", - "default": "false", "_ui5since": "2.0.0", "_ui5validator": "Boolean" }, @@ -18022,10 +17978,10 @@ { "description": "Defines the ID of the HTML Element, which will get the initial focus.\n\n**Note:** If an element with `autofocus` attribute is added inside the component,\n`initialFocus` won't take effect.", "name": "initial-focus", - "default": "\"\"", + "default": "undefined", "fieldName": "initialFocus", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -18049,10 +18005,10 @@ { "description": "Defines the IDs of the elements that label the component.", "name": "accessible-name-ref", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -18126,10 +18082,10 @@ "kind": "field", "name": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the accessible ARIA name of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.16.0", "_ui5validator": "String" @@ -18140,8 +18096,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component value is shown.", "default": "false", + "description": "Defines whether the component value is shown.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -18151,19 +18107,19 @@ "type": { "text": "number" }, - "description": "Specifies the numerical value in percent for the length of the component.\n\n**Note:**\nIf a value greater than 100 is provided, the percentValue is set to 100. In other cases of invalid value, percentValue is set to its default of 0.", "default": "0", + "description": "Specifies the numerical value in percent for the length of the component.\n\n**Note:**\nIf a value greater than 100 is provided, the percentValue is set to 100. In other cases of invalid value, percentValue is set to its default of 0.", "privacy": "public", - "_ui5validator": "Integer" + "_ui5validator": "Number" }, { "kind": "field", "name": "displayValue", "type": { - "text": "string | null | undefined" + "text": "string | undefined" }, "description": "Specifies the text value to be displayed in the bar.\n\n**Note:**\n\n- If there is no value provided or the value is empty, the default percentage value is shown.\n- If `hideValue` property is `true` both the `displayValue` and `value` property values are not shown.", - "default": "null", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -18180,20 +18136,20 @@ } ] }, - "description": "Defines the value state of the component.", "default": "\"None\"", + "description": "Defines the value state of the component.", "privacy": "public", - "_ui5validator": "ValueState" + "_ui5validator": "String" } ], "attributes": [ { "description": "Defines the accessible ARIA name of the component.", "name": "accessible-name", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -18217,10 +18173,10 @@ { "description": "Specifies the text value to be displayed in the bar.\n\n**Note:**\n\n- If there is no value provided or the value is empty, the default percentage value is shown.\n- If `hideValue` property is `true` both the `displayValue` and `value` property values are not shown.", "name": "display-value", - "default": "null", + "default": "undefined", "fieldName": "displayValue", "type": { - "text": "string | null | undefined" + "text": "string | undefined" } }, { @@ -18288,8 +18244,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is disabled.\n\n**Note:** A disabled component is completely noninteractive.", "default": "false", + "description": "Defines whether the component is disabled.\n\n**Note:** A disabled component is completely noninteractive.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -18299,8 +18255,8 @@ "type": { "text": "boolean" }, - "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.", "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", "_ui5validator": "Boolean" }, @@ -18310,8 +18266,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is required.", "default": "false", + "description": "Defines whether the component is required.", "privacy": "public", "_ui5since": "1.9.0", "_ui5validator": "Boolean" @@ -18322,8 +18278,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is checked or not.\n\n**Note:** The property value can be changed with user interaction,\neither by clicking/tapping on the component,\nor by using the Space or Enter key.", "default": "false", + "description": "Defines whether the component is checked or not.\n\n**Note:** The property value can be changed with user interaction,\neither by clicking/tapping on the component,\nor by using the Space or Enter key.", "privacy": "public", "_ui5since": "1.0.0-rc.15", "_ui5validator": "Boolean", @@ -18334,10 +18290,10 @@ "kind": "field", "name": "text", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -18354,19 +18310,19 @@ } ] }, - "description": "Defines the value state of the component.", "default": "\"None\"", + "description": "Defines the value state of the component.", "privacy": "public", - "_ui5validator": "ValueState" + "_ui5validator": "String" }, { "kind": "field", "name": "name", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Determines the name by which the component will be identified upon submission in an HTML form.\n\nRadio buttons with the same `name` will form a radio button group.\n\n**Note:** By this name the component will be identified upon submission in an HTML form.\n\n**Note:** The selection can be changed with `ARROW_UP/DOWN` and `ARROW_LEFT/RIGHT` keys between radio buttons in same group.\n\n**Note:** Only one radio button can be selected per group.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -18376,8 +18332,8 @@ "type": { "text": "string" }, - "description": "Defines the form value of the component.\nWhen a form with a radio button group is submitted, the group's value\nwill be the value of the currently selected radio button.", "default": "\"\"", + "description": "Defines the form value of the component.\nWhen a form with a radio button group is submitted, the group's value\nwill be the value of the currently selected radio button.", "privacy": "public", "_ui5validator": "String" }, @@ -18394,19 +18350,19 @@ } ] }, - "description": "Defines whether the component text wraps when there is not enough space.\n\n**Note:** for option \"Normal\" the text will wrap and the words will not be broken based on hyphenation.", "default": "\"Normal\"", + "description": "Defines whether the component text wraps when there is not enough space.\n\n**Note:** for option \"Normal\" the text will wrap and the words will not be broken based on hyphenation.", "privacy": "public", - "_ui5validator": "WrappingType" + "_ui5validator": "String" }, { "kind": "field", "name": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the accessible ARIA name of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.6.0", "_ui5validator": "String" @@ -18415,10 +18371,10 @@ "kind": "field", "name": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the IDs of the elements that label the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.1.0", "_ui5validator": "String" @@ -18475,10 +18431,10 @@ { "description": "Defines the text of the component.", "name": "text", - "default": "\"\"", + "default": "undefined", "fieldName": "text", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -18493,10 +18449,10 @@ { "description": "Determines the name by which the component will be identified upon submission in an HTML form.\n\nRadio buttons with the same `name` will form a radio button group.\n\n**Note:** By this name the component will be identified upon submission in an HTML form.\n\n**Note:** The selection can be changed with `ARROW_UP/DOWN` and `ARROW_LEFT/RIGHT` keys between radio buttons in same group.\n\n**Note:** Only one radio button can be selected per group.", "name": "name", - "default": "\"\"", + "default": "undefined", "fieldName": "name", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -18520,19 +18476,19 @@ { "description": "Defines the accessible ARIA name of the component.", "name": "accessible-name", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the IDs of the elements that label the component.", "name": "accessible-name-ref", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" } } ], @@ -18609,10 +18565,10 @@ "type": { "text": "number" }, - "description": "Defines start point of a selection - position of a first handle on the slider.", "default": "0", + "description": "Defines start point of a selection - position of a first handle on the slider.", "privacy": "public", - "_ui5validator": "Float", + "_ui5validator": "Number", "_ui5formProperty": true, "_ui5formEvents": "change,input" }, @@ -18622,10 +18578,10 @@ "type": { "text": "number" }, - "description": "Defines end point of a selection - position of a second handle on the slider.", "default": "100", + "description": "Defines end point of a selection - position of a second handle on the slider.", "privacy": "public", - "_ui5validator": "Float", + "_ui5validator": "Number", "_ui5formProperty": true, "_ui5formEvents": "change,input" }, @@ -18635,10 +18591,10 @@ "type": { "text": "number" }, - "description": "Defines the minimum value of the slider.", "default": "0", + "description": "Defines the minimum value of the slider.", "privacy": "public", - "_ui5validator": "Float", + "_ui5validator": "Number", "inheritedFrom": { "name": "SliderBase", "module": "dist/SliderBase.js" @@ -18650,10 +18606,10 @@ "type": { "text": "number" }, - "description": "Defines the maximum value of the slider.", "default": "100", + "description": "Defines the maximum value of the slider.", "privacy": "public", - "_ui5validator": "Float", + "_ui5validator": "Number", "inheritedFrom": { "name": "SliderBase", "module": "dist/SliderBase.js" @@ -18663,10 +18619,10 @@ "kind": "field", "name": "name", "type": { - "text": "string" + "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": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "2.0.0", "_ui5validator": "String", @@ -18681,10 +18637,10 @@ "type": { "text": "number" }, - "description": "Defines the size of the slider's selection intervals (e.g. min = 0, max = 10, step = 5 would result in possible selection of the values 0, 5, 10).\n\n**Note:** If set to 0 the slider handle movement is disabled. When negative number or value other than a number, the component fallbacks to its default value.", "default": "1", + "description": "Defines the size of the slider's selection intervals (e.g. min = 0, max = 10, step = 5 would result in possible selection of the values 0, 5, 10).\n\n**Note:** If set to 0 the slider handle movement is disabled. When negative number or value other than a number, the component fallbacks to its default value.", "privacy": "public", - "_ui5validator": "Float", + "_ui5validator": "Number", "inheritedFrom": { "name": "SliderBase", "module": "dist/SliderBase.js" @@ -18696,10 +18652,10 @@ "type": { "text": "number" }, - "description": "Displays a label with a value on every N-th step.\n\n**Note:** The step and tickmarks properties must be enabled.\nExample - if the step value is set to 2 and the label interval is also specified to 2 - then every second\ntickmark will be labelled, which means every 4th value number.", "default": "0", + "description": "Displays a label with a value on every N-th step.\n\n**Note:** The step and tickmarks properties must be enabled.\nExample - if the step value is set to 2 and the label interval is also specified to 2 - then every second\ntickmark will be labelled, which means every 4th value number.", "privacy": "public", - "_ui5validator": "Integer", + "_ui5validator": "Number", "inheritedFrom": { "name": "SliderBase", "module": "dist/SliderBase.js" @@ -18711,8 +18667,8 @@ "type": { "text": "boolean" }, - "description": "Enables tickmarks visualization for each step.\n\n**Note:** The step must be a positive number.", "default": "false", + "description": "Enables tickmarks visualization for each step.\n\n**Note:** The step must be a positive number.", "privacy": "public", "_ui5validator": "Boolean", "inheritedFrom": { @@ -18726,8 +18682,8 @@ "type": { "text": "boolean" }, - "description": "Enables handle tooltip displaying the current value.", "default": "false", + "description": "Enables handle tooltip displaying the current value.", "privacy": "public", "_ui5validator": "Boolean", "inheritedFrom": { @@ -18741,8 +18697,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the slider is in disabled state.", "default": "false", + "description": "Defines whether the slider is in disabled state.", "privacy": "public", "_ui5validator": "Boolean", "inheritedFrom": { @@ -18754,10 +18710,10 @@ "kind": "field", "name": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the accessible ARIA name of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.4.0", "_ui5validator": "String", @@ -18815,10 +18771,10 @@ { "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": "\"\"", + "default": "undefined", "fieldName": "name", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "SliderBase", @@ -18893,10 +18849,10 @@ { "description": "Defines the accessible ARIA name of the component.", "name": "accessible-name", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "SliderBase", @@ -18975,10 +18931,10 @@ "type": { "text": "number" }, - "description": "The indicated value of the rating.\n\n**Note:** If you set a number which is not round, it would be shown as follows:\n\n- 1.0 - 1.2 -> 1\n- 1.3 - 1.7 -> 1.5\n- 1.8 - 1.9 -> 2", "default": "0", + "description": "The indicated value of the rating.\n\n**Note:** If you set a number which is not round, it would be shown as follows:\n\n- 1.0 - 1.2 -> 1\n- 1.3 - 1.7 -> 1.5\n- 1.8 - 1.9 -> 2", "privacy": "public", - "_ui5validator": "Float" + "_ui5validator": "Number" }, { "kind": "field", @@ -18986,11 +18942,11 @@ "type": { "text": "number" }, - "description": "The number of displayed rating symbols.", "default": "5", + "description": "The number of displayed rating symbols.", "privacy": "public", "_ui5since": "1.0.0-rc.15", - "_ui5validator": "Integer" + "_ui5validator": "Number" }, { "kind": "field", @@ -18998,8 +18954,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is disabled.\n\n**Note:** A disabled component is completely noninteractive.", "default": "false", + "description": "Defines whether the component is disabled.\n\n**Note:** A disabled component is completely noninteractive.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -19009,8 +18965,8 @@ "type": { "text": "boolean" }, - "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.", "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", "_ui5validator": "Boolean" }, @@ -19018,10 +18974,10 @@ "kind": "field", "name": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the accessible ARIA name of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15", "_ui5validator": "String" @@ -19030,10 +18986,10 @@ "kind": "field", "name": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Receives id(or many ids) of the elements that label the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.15.0", "_ui5validator": "String" @@ -19044,8 +19000,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is required.", "default": "false", + "description": "Defines whether the component is required.", "privacy": "public", "_ui5since": "1.15.0", "_ui5validator": "Boolean" @@ -19054,10 +19010,10 @@ "kind": "field", "name": "tooltip", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the tooltip of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.19.0", "_ui5validator": "String" @@ -19113,19 +19069,19 @@ { "description": "Defines the accessible ARIA name of the component.", "name": "accessible-name", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Receives id(or many ids) of the elements that label the component.", "name": "accessible-name-ref", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -19140,10 +19096,10 @@ { "description": "Defines the tooltip of the component.", "name": "tooltip", - "default": "\"\"", + "default": "undefined", "fieldName": "tooltip", "type": { - "text": "string" + "text": "string | undefined" } } ], @@ -19212,10 +19168,10 @@ { "description": "Defines the header text.\n\n**Note:** If `header` slot is provided, the `headerText` is ignored.", "name": "header-text", - "default": "\"\"", + "default": "undefined", "fieldName": "headerText", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "Popover", @@ -19316,10 +19272,10 @@ { "description": "Defines the ID of the HTML Element, which will get the initial focus.\n\n**Note:** If an element with `autofocus` attribute is added inside the component,\n`initialFocus` won't take effect.", "name": "initial-focus", - "default": "\"\"", + "default": "undefined", "fieldName": "initialFocus", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "Popup", @@ -19355,10 +19311,10 @@ { "description": "Defines the IDs of the elements that label the component.", "name": "accessible-name-ref", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "Popup", @@ -19410,10 +19366,10 @@ "kind": "field", "name": "headerText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the header text.\n\n**Note:** If `header` slot is provided, the `headerText` is ignored.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String", "inheritedFrom": { @@ -19434,10 +19390,10 @@ } ] }, - "description": "Determines on which side the component is placed at.", "default": "\"End\"", + "description": "Determines on which side the component is placed at.", "privacy": "public", - "_ui5validator": "PopoverPlacement", + "_ui5validator": "String", "inheritedFrom": { "name": "Popover", "module": "dist/Popover.js" @@ -19456,10 +19412,10 @@ } ] }, - "description": "Determines the horizontal alignment of the component.", "default": "\"Center\"", + "description": "Determines the horizontal alignment of the component.", "privacy": "public", - "_ui5validator": "PopoverHorizontalAlign", + "_ui5validator": "String", "inheritedFrom": { "name": "Popover", "module": "dist/Popover.js" @@ -19478,10 +19434,10 @@ } ] }, - "description": "Determines the vertical alignment of the component.", "default": "\"Center\"", + "description": "Determines the vertical alignment of the component.", "privacy": "public", - "_ui5validator": "PopoverVerticalAlign", + "_ui5validator": "String", "inheritedFrom": { "name": "Popover", "module": "dist/Popover.js" @@ -19493,8 +19449,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component should close when\nclicking/tapping outside of the popover.\nIf enabled, it blocks any interaction with the background.", "default": "false", + "description": "Defines whether the component should close when\nclicking/tapping outside of the popover.\nIf enabled, it blocks any interaction with the background.", "privacy": "public", "_ui5validator": "Boolean", "inheritedFrom": { @@ -19508,8 +19464,8 @@ "type": { "text": "boolean" }, - "description": "Determines whether the component arrow is hidden.", "default": "false", + "description": "Determines whether the component arrow is hidden.", "privacy": "public", "_ui5since": "1.0.0-rc.15", "_ui5validator": "Boolean", @@ -19524,8 +19480,8 @@ "type": { "text": "boolean" }, - "description": "Determines if there is no enough space, the component can be placed\nover the target.", "default": "false", + "description": "Determines if there is no enough space, the component can be placed\nover the target.", "privacy": "public", "_ui5validator": "Boolean", "inheritedFrom": { @@ -19543,7 +19499,7 @@ "text": "HTMLElement | string | undefined" }, "_ui5since": "1.2.0", - "_ui5validator": "DOMReference", + "_ui5validator": "String", "inheritedFrom": { "name": "Popover", "module": "dist/Popover.js" @@ -19553,10 +19509,10 @@ "kind": "field", "name": "initialFocus", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the ID of the HTML Element, which will get the initial focus.\n\n**Note:** If an element with `autofocus` attribute is added inside the component,\n`initialFocus` won't take effect.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String", "inheritedFrom": { @@ -19570,8 +19526,8 @@ "type": { "text": "boolean" }, - "description": "Defines if the focus should be returned to the previously focused element,\nwhen the popup closes.", "default": "false", + "description": "Defines if the focus should be returned to the previously focused element,\nwhen the popup closes.", "privacy": "public", "_ui5since": "1.0.0-rc.8", "_ui5validator": "Boolean", @@ -19600,10 +19556,10 @@ "kind": "field", "name": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the IDs of the elements that label the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.1.0", "_ui5validator": "String", @@ -19625,11 +19581,11 @@ } ] }, - "description": "Allows setting a custom role.", "default": "\"Dialog\"", + "description": "Allows setting a custom role.", "privacy": "public", "_ui5since": "1.10.0", - "_ui5validator": "PopupAccessibleRole", + "_ui5validator": "String", "inheritedFrom": { "name": "Popup", "module": "dist/Popup.js" @@ -19641,9 +19597,9 @@ "type": { "text": "boolean" }, + "default": "false", "description": "Indicates whether initial focus should be prevented.", "privacy": "public", - "default": "false", "_ui5since": "2.0.0", "_ui5validator": "Boolean", "inheritedFrom": { @@ -19859,11 +19815,11 @@ } ] }, - "description": "Defines the component selection mode.", "default": "\"Single\"", + "description": "Defines the component selection mode.", "privacy": "public", "_ui5since": "1.14.0", - "_ui5validator": "SegmentedButtonSelectionMode" + "_ui5validator": "String" }, { "kind": "field", @@ -20005,8 +19961,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is disabled.\nA disabled component can't be selected or\nfocused, and it is not in the tab chain.", "default": "false", + "description": "Defines whether the component is disabled.\nA disabled component can't be selected or\nfocused, and it is not in the tab chain.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -20016,8 +19972,8 @@ "type": { "text": "boolean" }, - "description": "Determines whether the component is displayed as selected.", "default": "false", + "description": "Determines whether the component is displayed as selected.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -20025,10 +19981,10 @@ "kind": "field", "name": "tooltip", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the tooltip of the component.\n\n**Note:** A tooltip attribute should be provided for icon-only buttons, in order to represent their exact meaning/function.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.2.0", "_ui5validator": "String" @@ -20049,10 +20005,10 @@ "kind": "field", "name": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Receives id(or many ids) of the elements that label the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.1.0", "_ui5validator": "String" @@ -20061,10 +20017,10 @@ "kind": "field", "name": "icon", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the icon, displayed as graphical element within the component.\nThe SAP-icons font provides numerous options.\n\nExample:\nSee all the available icons within the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" } @@ -20091,10 +20047,10 @@ { "description": "Defines the tooltip of the component.\n\n**Note:** A tooltip attribute should be provided for icon-only buttons, in order to represent their exact meaning/function.", "name": "tooltip", - "default": "\"\"", + "default": "undefined", "fieldName": "tooltip", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -20109,19 +20065,19 @@ { "description": "Receives id(or many ids) of the elements that label the component.", "name": "accessible-name-ref", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the icon, displayed as graphical element within the component.\nThe SAP-icons font provides numerous options.\n\nExample:\nSee all the available icons within the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).", "name": "icon", - "default": "\"\"", + "default": "undefined", "fieldName": "icon", "type": { - "text": "string" + "text": "string | undefined" } } ], @@ -20222,8 +20178,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is in disabled state.\n\n**Note:** A disabled component is noninteractive.", "default": "false", + "description": "Defines whether the component is in disabled state.\n\n**Note:** A disabled component is noninteractive.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -20231,10 +20187,10 @@ "kind": "field", "name": "name", "type": { - "text": "string" + "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": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -20251,10 +20207,10 @@ } ] }, - "description": "Defines the value state of the component.", "default": "\"None\"", + "description": "Defines the value state of the component.", "privacy": "public", - "_ui5validator": "ValueState" + "_ui5validator": "String" }, { "kind": "field", @@ -20262,8 +20218,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is required.", "default": "false", + "description": "Defines whether the component is required.", "privacy": "public", "_ui5since": "1.0.0-rc.9", "_ui5validator": "Boolean" @@ -20274,8 +20230,8 @@ "type": { "text": "boolean" }, - "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.", "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": "1.21.0", "_ui5validator": "Boolean" @@ -20284,11 +20240,11 @@ "kind": "field", "name": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the accessible ARIA name of the component.", "privacy": "public", - "default": "\"\"", + "default": "undefined", "_ui5since": "1.0.0-rc.9", "_ui5validator": "String" }, @@ -20296,10 +20252,10 @@ "kind": "field", "name": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Receives id(or many ids) of the elements that label the select.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15", "_ui5validator": "String" @@ -20314,6 +20270,7 @@ "text": "string" }, "_ui5since": "1.20.0", + "_ui5validator": "String", "_ui5formProperty": true, "_ui5formEvents": "change,liveChange" }, @@ -20433,10 +20390,10 @@ { "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": "\"\"", + "default": "undefined", "fieldName": "name", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -20469,19 +20426,19 @@ { "description": "Defines the accessible ARIA name of the component.", "name": "accessible-name", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Receives id(or many ids) of the elements that label the select.", "name": "accessible-name-ref", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -20562,10 +20519,10 @@ "type": { "text": "number" }, - "description": "Current value of the slider", "default": "0", + "description": "Current value of the slider", "privacy": "public", - "_ui5validator": "Float", + "_ui5validator": "Number", "_ui5formProperty": true, "_ui5formEvents": "change,input" }, @@ -20575,10 +20532,10 @@ "type": { "text": "number" }, - "description": "Defines the minimum value of the slider.", "default": "0", + "description": "Defines the minimum value of the slider.", "privacy": "public", - "_ui5validator": "Float", + "_ui5validator": "Number", "inheritedFrom": { "name": "SliderBase", "module": "dist/SliderBase.js" @@ -20590,10 +20547,10 @@ "type": { "text": "number" }, - "description": "Defines the maximum value of the slider.", "default": "100", + "description": "Defines the maximum value of the slider.", "privacy": "public", - "_ui5validator": "Float", + "_ui5validator": "Number", "inheritedFrom": { "name": "SliderBase", "module": "dist/SliderBase.js" @@ -20603,10 +20560,10 @@ "kind": "field", "name": "name", "type": { - "text": "string" + "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": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "2.0.0", "_ui5validator": "String", @@ -20621,10 +20578,10 @@ "type": { "text": "number" }, - "description": "Defines the size of the slider's selection intervals (e.g. min = 0, max = 10, step = 5 would result in possible selection of the values 0, 5, 10).\n\n**Note:** If set to 0 the slider handle movement is disabled. When negative number or value other than a number, the component fallbacks to its default value.", "default": "1", + "description": "Defines the size of the slider's selection intervals (e.g. min = 0, max = 10, step = 5 would result in possible selection of the values 0, 5, 10).\n\n**Note:** If set to 0 the slider handle movement is disabled. When negative number or value other than a number, the component fallbacks to its default value.", "privacy": "public", - "_ui5validator": "Float", + "_ui5validator": "Number", "inheritedFrom": { "name": "SliderBase", "module": "dist/SliderBase.js" @@ -20636,10 +20593,10 @@ "type": { "text": "number" }, - "description": "Displays a label with a value on every N-th step.\n\n**Note:** The step and tickmarks properties must be enabled.\nExample - if the step value is set to 2 and the label interval is also specified to 2 - then every second\ntickmark will be labelled, which means every 4th value number.", "default": "0", + "description": "Displays a label with a value on every N-th step.\n\n**Note:** The step and tickmarks properties must be enabled.\nExample - if the step value is set to 2 and the label interval is also specified to 2 - then every second\ntickmark will be labelled, which means every 4th value number.", "privacy": "public", - "_ui5validator": "Integer", + "_ui5validator": "Number", "inheritedFrom": { "name": "SliderBase", "module": "dist/SliderBase.js" @@ -20651,8 +20608,8 @@ "type": { "text": "boolean" }, - "description": "Enables tickmarks visualization for each step.\n\n**Note:** The step must be a positive number.", "default": "false", + "description": "Enables tickmarks visualization for each step.\n\n**Note:** The step must be a positive number.", "privacy": "public", "_ui5validator": "Boolean", "inheritedFrom": { @@ -20666,8 +20623,8 @@ "type": { "text": "boolean" }, - "description": "Enables handle tooltip displaying the current value.", "default": "false", + "description": "Enables handle tooltip displaying the current value.", "privacy": "public", "_ui5validator": "Boolean", "inheritedFrom": { @@ -20681,8 +20638,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the slider is in disabled state.", "default": "false", + "description": "Defines whether the slider is in disabled state.", "privacy": "public", "_ui5validator": "Boolean", "inheritedFrom": { @@ -20694,10 +20651,10 @@ "kind": "field", "name": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the accessible ARIA name of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.4.0", "_ui5validator": "String", @@ -20746,10 +20703,10 @@ { "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": "\"\"", + "default": "undefined", "fieldName": "name", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "SliderBase", @@ -20824,10 +20781,10 @@ { "description": "Defines the accessible ARIA name of the component.", "name": "accessible-name", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "SliderBase", @@ -20906,10 +20863,10 @@ "type": { "text": "number" }, - "description": "Defines the minimum value of the slider.", "default": "0", + "description": "Defines the minimum value of the slider.", "privacy": "public", - "_ui5validator": "Float" + "_ui5validator": "Number" }, { "kind": "field", @@ -20917,19 +20874,19 @@ "type": { "text": "number" }, - "description": "Defines the maximum value of the slider.", "default": "100", + "description": "Defines the maximum value of the slider.", "privacy": "public", - "_ui5validator": "Float" + "_ui5validator": "Number" }, { "kind": "field", "name": "name", "type": { - "text": "string" + "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": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "2.0.0", "_ui5validator": "String" @@ -20940,10 +20897,10 @@ "type": { "text": "number" }, - "description": "Defines the size of the slider's selection intervals (e.g. min = 0, max = 10, step = 5 would result in possible selection of the values 0, 5, 10).\n\n**Note:** If set to 0 the slider handle movement is disabled. When negative number or value other than a number, the component fallbacks to its default value.", "default": "1", + "description": "Defines the size of the slider's selection intervals (e.g. min = 0, max = 10, step = 5 would result in possible selection of the values 0, 5, 10).\n\n**Note:** If set to 0 the slider handle movement is disabled. When negative number or value other than a number, the component fallbacks to its default value.", "privacy": "public", - "_ui5validator": "Float" + "_ui5validator": "Number" }, { "kind": "field", @@ -20951,10 +20908,10 @@ "type": { "text": "number" }, - "description": "Displays a label with a value on every N-th step.\n\n**Note:** The step and tickmarks properties must be enabled.\nExample - if the step value is set to 2 and the label interval is also specified to 2 - then every second\ntickmark will be labelled, which means every 4th value number.", "default": "0", + "description": "Displays a label with a value on every N-th step.\n\n**Note:** The step and tickmarks properties must be enabled.\nExample - if the step value is set to 2 and the label interval is also specified to 2 - then every second\ntickmark will be labelled, which means every 4th value number.", "privacy": "public", - "_ui5validator": "Integer" + "_ui5validator": "Number" }, { "kind": "field", @@ -20962,8 +20919,8 @@ "type": { "text": "boolean" }, - "description": "Enables tickmarks visualization for each step.\n\n**Note:** The step must be a positive number.", "default": "false", + "description": "Enables tickmarks visualization for each step.\n\n**Note:** The step must be a positive number.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -20973,8 +20930,8 @@ "type": { "text": "boolean" }, - "description": "Enables handle tooltip displaying the current value.", "default": "false", + "description": "Enables handle tooltip displaying the current value.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -20984,8 +20941,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the slider is in disabled state.", "default": "false", + "description": "Defines whether the slider is in disabled state.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -20993,10 +20950,10 @@ "kind": "field", "name": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the accessible ARIA name of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.4.0", "_ui5validator": "String" @@ -21042,10 +20999,10 @@ { "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": "\"\"", + "default": "undefined", "fieldName": "name", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -21096,10 +21053,10 @@ { "description": "Defines the accessible ARIA name of the component.", "name": "accessible-name", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" } } ], @@ -21132,6 +21089,17 @@ "description": "### Overview\n\nThe `ui5-special-date` component defines a special calendar date to be used inside `ui5-calendar`,\nwhich is visually distinguished from the rest of the dates.", "name": "SpecialCalendarDate", "members": [ + { + "kind": "field", + "name": "value", + "type": { + "text": "string" + }, + "default": "\"\"", + "description": "The date formatted according to the `formatPattern` property\nof the `ui5-calendar` that hosts the component.", + "privacy": "public", + "_ui5validator": "String" + }, { "kind": "field", "name": "type", @@ -21145,28 +21113,22 @@ } ] }, - "description": "Defines the type of the special date.", "default": "\"None\"", + "description": "Defines the type of the special date.", "privacy": "public", - "_ui5validator": "CalendarLegendItemType" - }, + "_ui5validator": "String" + } + ], + "attributes": [ { - "kind": "field", + "description": "The date formatted according to the `formatPattern` property\nof the `ui5-calendar` that hosts the component.", "name": "value", + "default": "\"\"", + "fieldName": "value", "type": { "text": "string" - }, - "description": "The date formatted according to the `formatPattern` property\nof the `ui5-calendar` that hosts the component.", - "default": "\"\"", - "privacy": "public", - "_ui5validator": "String", - "inheritedFrom": { - "name": "CalendarDate", - "module": "dist/CalendarDate.js" } - } - ], - "attributes": [ + }, { "description": "Defines the type of the special date.", "name": "type", @@ -21175,25 +21137,12 @@ "type": { "text": "\"Today\" | \"Selected\" | \"None\" | \"Working\" | \"NonWorking\" | \"Type01\" | \"Type02\" | \"Type03\" | \"Type04\" | \"Type05\" | \"Type06\" | \"Type07\" | \"Type08\" | \"Type09\" | \"Type10\" | \"Type11\" | ... 8 more ... | \"Type20\"" } - }, - { - "description": "The date formatted according to the `formatPattern` property\nof the `ui5-calendar` that hosts the component.", - "name": "value", - "default": "\"\"", - "fieldName": "value", - "type": { - "text": "string" - }, - "inheritedFrom": { - "name": "CalendarDate", - "module": "dist/CalendarDate.js" - } } ], "superclass": { - "name": "CalendarDate", - "package": "@ui5/webcomponents", - "module": "dist/CalendarDate.js" + "name": "UI5Element", + "package": "@ui5/webcomponents-base", + "module": "dist/UI5Element.js" }, "tagName": "ui5-special-date", "customElement": true, @@ -21245,10 +21194,10 @@ "kind": "field", "name": "icon", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the icon to be displayed as graphical element within the component.\nThe SAP-icons font provides numerous options.\n\nExample:\n\nSee all the available icons in the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -21258,8 +21207,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the arrow button should have the active state styles or not.", "default": "false", + "description": "Defines whether the arrow button should have the active state styles or not.", "privacy": "public", "_ui5since": "1.21.0", "_ui5validator": "Boolean" @@ -21277,10 +21226,10 @@ } ] }, - "description": "Defines the component design.", "default": "\"Default\"", + "description": "Defines the component design.", "privacy": "public", - "_ui5validator": "ButtonDesign" + "_ui5validator": "String" }, { "kind": "field", @@ -21288,8 +21237,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is disabled.\nA disabled component can't be pressed or\nfocused, and it is not in the tab chain.", "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", "_ui5validator": "Boolean" }, @@ -21327,10 +21276,10 @@ { "description": "Defines the icon to be displayed as graphical element within the component.\nThe SAP-icons font provides numerous options.\n\nExample:\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": "\"\"", + "default": "undefined", "fieldName": "icon", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -21425,10 +21374,10 @@ "type": { "text": "number" }, - "description": "Defines a value of the component.", "default": "0", + "description": "Defines a value of the component.", "privacy": "public", - "_ui5validator": "Float" + "_ui5validator": "Number" }, { "kind": "field", @@ -21439,7 +21388,7 @@ "description": "Defines a minimum value of the component.", "default": "undefined", "privacy": "public", - "_ui5validator": "Float" + "_ui5validator": "Number" }, { "kind": "field", @@ -21450,7 +21399,7 @@ "description": "Defines a maximum value of the component.", "default": "undefined", "privacy": "public", - "_ui5validator": "Float" + "_ui5validator": "Number" }, { "kind": "field", @@ -21458,10 +21407,10 @@ "type": { "text": "number" }, - "description": "Defines a step of increasing/decreasing the value of the component.", "default": "1", + "description": "Defines a step of increasing/decreasing the value of the component.", "privacy": "public", - "_ui5validator": "Float" + "_ui5validator": "Number" }, { "kind": "field", @@ -21476,10 +21425,10 @@ } ] }, - "description": "Defines the value state of the component.", "default": "\"None\"", + "description": "Defines the value state of the component.", "privacy": "public", - "_ui5validator": "ValueState" + "_ui5validator": "String" }, { "kind": "field", @@ -21487,8 +21436,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is required.", "default": "false", + "description": "Defines whether the component is required.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -21498,8 +21447,8 @@ "type": { "text": "boolean" }, - "description": "Determines whether the component is displayed as disabled.", "default": "false", + "description": "Determines whether the component is displayed as disabled.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -21509,8 +21458,8 @@ "type": { "text": "boolean" }, - "description": "Determines whether the component is displayed as read-only.", "default": "false", + "description": "Determines whether the component is displayed as read-only.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -21529,10 +21478,10 @@ "kind": "field", "name": "name", "type": { - "text": "string" + "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": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -21542,19 +21491,19 @@ "type": { "text": "number" }, - "description": "Determines the number of digits after the decimal point of the component.", "default": "0", + "description": "Determines the number of digits after the decimal point of the component.", "privacy": "public", - "_ui5validator": "Integer" + "_ui5validator": "Number" }, { "kind": "field", "name": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the accessible ARIA name of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15", "_ui5validator": "String" @@ -21563,10 +21512,10 @@ "kind": "field", "name": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Receives id(or many ids) of the elements that label the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15", "_ui5validator": "String" @@ -21702,10 +21651,10 @@ { "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": "\"\"", + "default": "undefined", "fieldName": "name", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -21720,19 +21669,19 @@ { "description": "Defines the accessible ARIA name of the component.", "name": "accessible-name", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Receives id(or many ids) of the elements that label the component.", "name": "accessible-name-ref", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" } } ], @@ -21768,49 +21717,69 @@ }, { "kind": "javascript-module", - "path": "dist/SuggestionGroupItem.js", + "path": "dist/SuggestionItem.js", "declarations": [ { "kind": "class", - "description": "The `ui5-suggestion-group-item` is type of suggestion item,\nthat can be used to split the `ui5-input` suggestions into groups.", - "name": "SuggestionGroupItem", + "description": "The `ui5-suggestion-item` represents the suggestion item of the `ui5-input`.", + "name": "SuggestionItem", "members": [ { "kind": "field", "name": "text", "type": { - "text": "string" + "text": "string | undefined" }, - "description": "Defines the text of the `ui5-suggestion-group-item`.", - "default": "\"\"", + "description": "Defines the text of the component.", + "default": "undefined", "privacy": "public", "_ui5validator": "String" + }, + { + "kind": "field", + "name": "additionalText", + "type": { + "text": "string | undefined" + }, + "description": "Defines the `additionalText`, displayed in the end of the item.", + "default": "undefined", + "privacy": "public", + "_ui5since": "1.0.0-rc.15", + "_ui5validator": "String" } ], "attributes": [ { - "description": "Defines the text of the `ui5-suggestion-group-item`.", + "description": "Defines the text of the component.", "name": "text", - "default": "\"\"", + "default": "undefined", "fieldName": "text", "type": { - "text": "string" + "text": "string | undefined" + } + }, + { + "description": "Defines the `additionalText`, displayed in the end of the item.", + "name": "additional-text", + "default": "undefined", + "fieldName": "additionalText", + "type": { + "text": "string | undefined" } } ], "superclass": { - "name": "UI5Element", - "package": "@ui5/webcomponents-base", - "module": "dist/UI5Element.js" + "name": "ListItemBase", + "package": "@ui5/webcomponents", + "module": "dist/ListItemBase.js" }, - "tagName": "ui5-suggestion-group-item", + "tagName": "ui5-suggestion-item", "customElement": true, - "_ui5since": "1.0.0-rc.15", "_ui5privacy": "public", "_ui5abstract": true, "_ui5implements": [ { - "name": "IInputSuggestionItem", + "name": "IInputSuggestionItemSelectable", "package": "@ui5/webcomponents", "module": "dist/Input.js" } @@ -21822,223 +21791,214 @@ "kind": "js", "name": "default", "declaration": { - "name": "SuggestionGroupItem", - "module": "dist/SuggestionGroupItem.js" + "name": "SuggestionItem", + "module": "dist/SuggestionItem.js" } }, { "kind": "custom-element-definition", - "name": "ui5-suggestion-group-item", + "name": "ui5-suggestion-item", "declaration": { - "name": "SuggestionGroupItem", - "module": "dist/SuggestionGroupItem.js" + "name": "SuggestionItem", + "module": "dist/SuggestionItem.js" } } ] }, { "kind": "javascript-module", - "path": "dist/SuggestionItem.js", + "path": "dist/SuggestionItemCustom.js", "declarations": [ { "kind": "class", - "description": "The `ui5-suggestion-item` represents the suggestion item of the `ui5-input`.", - "name": "SuggestionItem", + "description": "The `ui5-suggestion-item-custom` is type of suggestion item,\nthat can be used to place suggestion items with custom content in the input.\nThe text property is considered only for autocomplete.\nIn case the user needs highlighting functionality, check \"@ui5/webcomponents-base/dist/util/generateHighlightedMarkup.js\"", + "name": "SuggestionItemCustom", + "slots": [ + { + "name": "default", + "description": "Defines the content of the component.", + "_ui5propertyName": "content", + "_ui5type": { + "text": "Array" + }, + "_ui5privacy": "public" + } + ], "members": [ { "kind": "field", "name": "text", "type": { - "text": "string" + "text": "string | undefined" }, - "description": "Defines the text of the component.", - "default": "\"\"", + "description": "Defines the text of the `ui5-suggestion-item-custom`.\n**Note:** The text property is considered only for autocomplete.", + "default": "undefined", "privacy": "public", "_ui5validator": "String" - }, + } + ], + "attributes": [ { - "kind": "field", - "name": "type", + "description": "Defines the text of the `ui5-suggestion-item-custom`.\n**Note:** The text property is considered only for autocomplete.", + "name": "text", + "default": "undefined", + "fieldName": "text", "type": { - "text": "ListItemType", + "text": "string | undefined" + } + } + ], + "superclass": { + "name": "ListItemBase", + "package": "@ui5/webcomponents", + "module": "dist/ListItemBase.js" + }, + "tagName": "ui5-suggestion-item-custom", + "customElement": true, + "_ui5since": "2.0.0", + "_ui5privacy": "public", + "_ui5implements": [ + { + "name": "IInputSuggestionItemSelectable", + "package": "@ui5/webcomponents", + "module": "dist/Input.js" + } + ] + } + ], + "exports": [ + { + "kind": "js", + "name": "default", + "declaration": { + "name": "SuggestionItemCustom", + "module": "dist/SuggestionItemCustom.js" + } + }, + { + "kind": "custom-element-definition", + "name": "ui5-suggestion-item-custom", + "declaration": { + "name": "SuggestionItemCustom", + "module": "dist/SuggestionItemCustom.js" + } + } + ] + }, + { + "kind": "javascript-module", + "path": "dist/SuggestionItemGroup.js", + "declarations": [ + { + "kind": "class", + "description": "The `ui5-suggestion-item-group` is type of suggestion item,\nthat can be used to split the `ui5-input` suggestions into groups.", + "name": "SuggestionItemGroup", + "slots": [ + { + "name": "default", + "description": "Defines the items of the ui5-suggestion-item-group.", + "_ui5propertyName": "items", + "_ui5type": { + "text": "Array", "references": [ { - "name": "ListItemType", + "name": "SuggestionListItem", "package": "@ui5/webcomponents", - "module": "dist/types/ListItemType.js" + "module": "dist/SuggestionListItem.js" } ] }, - "description": "Defines the visual indication and behavior of the item.\nAvailable options are `Active` (by default), `Inactive` and `Detail`.\n\n**Note:** When set to `Active`, the item will provide visual response upon press and hover,\nwhile when `Inactive` or `Detail` - will not.", - "default": "\"Active\"", - "privacy": "public", - "_ui5since": "1.0.0-rc.8", - "_ui5validator": "ListItemType" - }, - { - "kind": "field", - "name": "description", - "type": { - "text": "string" - }, - "description": "Defines the description displayed right under the item text, if such is present.", - "default": "\"\"", - "privacy": "public", - "_ui5validator": "String" - }, - { - "kind": "field", - "name": "icon", - "type": { - "text": "string" - }, - "description": "Defines the `icon` source URI.\n\n**Note:**\nSAP-icons font provides numerous built-in icons. To find all the available icons, see the\n[Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).", - "default": "\"\"", - "privacy": "public", - "_ui5validator": "String" - }, - { - "kind": "field", - "name": "iconEnd", - "type": { - "text": "boolean" - }, - "description": "Defines whether the `icon` should be displayed in the beginning of the item or in the end.\n\n**Note:** If `image` is set, the `icon` would be displayed after the `image`.", - "default": "false", - "privacy": "public", - "_ui5validator": "Boolean" - }, - { - "kind": "field", - "name": "image", - "type": { - "text": "string" - }, - "description": "Defines the `image` source URI.\n\n**Note:** The `image` would be displayed in the beginning of the item.", - "default": "\"\"", - "privacy": "public", - "_ui5validator": "String" - }, - { - "kind": "field", - "name": "additionalText", - "type": { - "text": "string" - }, - "description": "Defines the `additionalText`, displayed in the end of the item.", - "default": "\"\"", - "privacy": "public", - "_ui5since": "1.0.0-rc.15", - "_ui5validator": "String" + "_ui5privacy": "public" }, { - "kind": "field", - "name": "additionalTextState", - "type": { - "text": "ValueState", + "name": "header", + "description": "Defines the header of the component.\n\n**Note:** Using this slot, the default header text of group and the value of `headerText` property will be overwritten.", + "_ui5type": { + "text": "Array", "references": [ { - "name": "ValueState", - "package": "@ui5/webcomponents-base", - "module": "dist/types/ValueState.js" + "name": "ListItemBase", + "package": "@ui5/webcomponents", + "module": "dist/ListItemBase.js" } ] }, - "description": "Defines the state of the `additionalText`.", - "default": "\"None\"", - "privacy": "public", - "_ui5since": "1.0.0-rc.15", - "_ui5validator": "ValueState" + "_ui5privacy": "public" } ], + "superclass": { + "name": "ListItemGroup", + "package": "@ui5/webcomponents", + "module": "dist/ListItemGroup.js" + }, + "tagName": "ui5-suggestion-item-group", + "customElement": true, + "_ui5since": "2.0.0", + "_ui5privacy": "public", "attributes": [ { - "description": "Defines the text of the component.", - "name": "text", - "default": "\"\"", - "fieldName": "text", - "type": { - "text": "string" - } - }, - { - "description": "Defines the visual indication and behavior of the item.\nAvailable options are `Active` (by default), `Inactive` and `Detail`.\n\n**Note:** When set to `Active`, the item will provide visual response upon press and hover,\nwhile when `Inactive` or `Detail` - will not.", - "name": "type", - "default": "\"Active\"", - "fieldName": "type", - "type": { - "text": "\"Navigation\" | \"Inactive\" | \"Active\" | \"Detail\"" - } - }, - { - "description": "Defines the description displayed right under the item text, if such is present.", - "name": "description", - "default": "\"\"", - "fieldName": "description", - "type": { - "text": "string" - } - }, - { - "description": "Defines the `icon` source URI.\n\n**Note:**\nSAP-icons font provides numerous built-in icons. To find all the available icons, see the\n[Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).", - "name": "icon", - "default": "\"\"", - "fieldName": "icon", - "type": { - "text": "string" - } - }, - { - "description": "Defines whether the `icon` should be displayed in the beginning of the item or in the end.\n\n**Note:** If `image` is set, the `icon` would be displayed after the `image`.", - "name": "icon-end", - "default": "false", - "fieldName": "iconEnd", + "description": "Defines the header text of the ui5-li-group.", + "name": "header-text", + "default": "undefined", + "fieldName": "headerText", "type": { - "text": "boolean" + "text": "string | undefined" + }, + "inheritedFrom": { + "name": "ListItemGroup", + "module": "dist/ListItemGroup.js" } }, { - "description": "Defines the `image` source URI.\n\n**Note:** The `image` would be displayed in the beginning of the item.", - "name": "image", - "default": "\"\"", - "fieldName": "image", + "description": "Defines the accessible name of the header.", + "name": "header-accessible-name", + "default": "undefined", + "fieldName": "headerAccessibleName", "type": { - "text": "string" + "text": "string | undefined" + }, + "inheritedFrom": { + "name": "ListItemGroup", + "module": "dist/ListItemGroup.js" } - }, + } + ], + "members": [ { - "description": "Defines the `additionalText`, displayed in the end of the item.", - "name": "additional-text", - "default": "\"\"", - "fieldName": "additionalText", + "kind": "field", + "name": "headerText", "type": { - "text": "string" + "text": "string | undefined" + }, + "description": "Defines the header text of the ui5-li-group.", + "privacy": "public", + "default": "undefined", + "_ui5validator": "String", + "inheritedFrom": { + "name": "ListItemGroup", + "module": "dist/ListItemGroup.js" } }, { - "description": "Defines the state of the `additionalText`.", - "name": "additional-text-state", - "default": "\"None\"", - "fieldName": "additionalTextState", + "kind": "field", + "name": "headerAccessibleName", "type": { - "text": "\"Positive\" | \"Negative\" | \"None\" | \"Critical\" | \"Information\"" + "text": "string | undefined" + }, + "description": "Defines the accessible name of the header.", + "privacy": "public", + "default": "undefined", + "_ui5validator": "String", + "inheritedFrom": { + "name": "ListItemGroup", + "module": "dist/ListItemGroup.js" } } ], - "superclass": { - "name": "UI5Element", - "package": "@ui5/webcomponents-base", - "module": "dist/UI5Element.js" - }, - "tagName": "ui5-suggestion-item", - "customElement": true, - "_ui5privacy": "public", - "_ui5abstract": true, - "_ui5implements": [ + "cssParts": [ { - "name": "IInputSuggestionItem", - "package": "@ui5/webcomponents", - "module": "dist/Input.js" + "description": "Used to style the header item of the group", + "name": "header" } ] } @@ -22048,16 +22008,16 @@ "kind": "js", "name": "default", "declaration": { - "name": "SuggestionItem", - "module": "dist/SuggestionItem.js" + "name": "SuggestionItemGroup", + "module": "dist/SuggestionItemGroup.js" } }, { "kind": "custom-element-definition", - "name": "ui5-suggestion-item", + "name": "ui5-suggestion-item-group", "declaration": { - "name": "SuggestionItem", - "module": "dist/SuggestionItem.js" + "name": "SuggestionItemGroup", + "module": "dist/SuggestionItemGroup.js" } } ] @@ -22117,10 +22077,10 @@ } ] }, + "default": "\"Textual\"", "description": "Defines the component design.\n\n**Note:** If `Graphical` type is set,\npositive and negative icons will replace the `textOn` and `textOff`.", "privacy": "public", - "default": "\"Textual\"", - "_ui5validator": "SwitchDesign" + "_ui5validator": "String" }, { "kind": "field", @@ -22128,8 +22088,8 @@ "type": { "text": "boolean" }, - "description": "Defines if the component is checked.\n\n**Note:** The property can be changed with user interaction,\neither by cliking the component, or by pressing the `Enter` or `Space` key.", "default": "false", + "description": "Defines if the component is checked.\n\n**Note:** The property can be changed with user interaction,\neither by cliking the component, or by pressing the `Enter` or `Space` key.", "privacy": "public", "_ui5validator": "Boolean", "_ui5formProperty": true, @@ -22141,8 +22101,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is disabled.\n\n**Note:** A disabled component is noninteractive.", "default": "false", + "description": "Defines whether the component is disabled.\n\n**Note:** A disabled component is noninteractive.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -22150,10 +22110,10 @@ "kind": "field", "name": "textOn", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text, displayed when the component is checked.\n\n**Note:** We recommend using short texts, up to 3 letters (larger texts would be cut off).", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -22161,10 +22121,10 @@ "kind": "field", "name": "textOff", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text, displayed when the component is not checked.\n\n**Note:** We recommend using short texts, up to 3 letters (larger texts would be cut off).", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -22172,10 +22132,10 @@ "kind": "field", "name": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Sets the accessible ARIA name of the component.\n\n**Note**: We recommend that you set an accessibleNameRef pointing to an external label or at least an `accessibleName`.\nProviding an `accessibleNameRef` or an `accessibleName` is mandatory in the cases when `textOn` and `textOff` properties aren't set.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.2.0", "_ui5validator": "String" @@ -22184,10 +22144,10 @@ "kind": "field", "name": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Receives id(or many ids) of the elements that label the component.\n\n**Note**: We recommend that you set an accessibleNameRef pointing to an external label or at least an `accessibleName`.\nProviding an `accessibleNameRef` or an `accessibleName` is mandatory in the cases when `textOn` and `textOff` properties aren't set.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.1.0", "_ui5validator": "String" @@ -22196,10 +22156,10 @@ "kind": "field", "name": "tooltip", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the tooltip of the component.\n\n**Note:** If applicable an external label reference should always be the preferred option to provide context to the `ui5-switch` component over a tooltip.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.9.0", "_ui5validator": "String" @@ -22210,8 +22170,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is required.", "default": "false", + "description": "Defines whether the component is required.", "privacy": "public", "_ui5since": "1.16.0", "_ui5validator": "Boolean" @@ -22220,10 +22180,10 @@ "kind": "field", "name": "name", "type": { - "text": "string" + "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": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.16.0", "_ui5validator": "String" @@ -22271,46 +22231,46 @@ { "description": "Defines the text, displayed when the component is checked.\n\n**Note:** We recommend using short texts, up to 3 letters (larger texts would be cut off).", "name": "text-on", - "default": "\"\"", + "default": "undefined", "fieldName": "textOn", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the text, displayed when the component is not checked.\n\n**Note:** We recommend using short texts, up to 3 letters (larger texts would be cut off).", "name": "text-off", - "default": "\"\"", + "default": "undefined", "fieldName": "textOff", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Sets the accessible ARIA name of the component.\n\n**Note**: We recommend that you set an accessibleNameRef pointing to an external label or at least an `accessibleName`.\nProviding an `accessibleNameRef` or an `accessibleName` is mandatory in the cases when `textOn` and `textOff` properties aren't set.", "name": "accessible-name", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Receives id(or many ids) of the elements that label the component.\n\n**Note**: We recommend that you set an accessibleNameRef pointing to an external label or at least an `accessibleName`.\nProviding an `accessibleNameRef` or an `accessibleName` is mandatory in the cases when `textOn` and `textOff` properties aren't set.", "name": "accessible-name-ref", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the tooltip of the component.\n\n**Note:** If applicable an external label reference should always be the preferred option to provide context to the `ui5-switch` component over a tooltip.", "name": "tooltip", - "default": "\"\"", + "default": "undefined", "fieldName": "tooltip", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -22325,10 +22285,10 @@ { "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": "\"\"", + "default": "undefined", "fieldName": "name", "type": { - "text": "string" + "text": "string | undefined" } } ], @@ -22401,10 +22361,10 @@ "kind": "field", "name": "text", "type": { - "text": "string" + "text": "string | undefined" }, "description": "The text to be displayed for the item.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -22414,8 +22374,8 @@ "type": { "text": "boolean" }, - "description": "Disabled tabs can't be selected.", "default": "false", + "description": "Disabled tabs can't be selected.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -22423,10 +22383,10 @@ "kind": "field", "name": "additionalText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Represents the \"additionalText\" text, which is displayed in the tab. In the cases when in the same time there are tabs with icons and tabs without icons, if a tab has no icon the \"additionalText\" is displayed larger.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -22434,10 +22394,10 @@ "kind": "field", "name": "icon", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the icon source URI to be displayed as graphical element within the component.\nThe SAP-icons font provides numerous built-in icons.\nSee all the available icons in the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -22454,10 +22414,10 @@ } ] }, - "description": "Defines the component's design color.\n\nThe design is applied to:\n\n- the component icon\n- the `text` when the component overflows\n- the tab selection line\n\nAvailable designs are: `\"Default\"`, `\"Neutral\"`, `\"Positive\"`, `\"Critical\"` and `\"Negative\"`.\n\n**Note:** The design depends on the current theme.", "default": "\"Default\"", + "description": "Defines the component's design color.\n\nThe design is applied to:\n\n- the component icon\n- the `text` when the component overflows\n- the tab selection line\n\nAvailable designs are: `\"Default\"`, `\"Neutral\"`, `\"Positive\"`, `\"Critical\"` and `\"Negative\"`.\n\n**Note:** The design depends on the current theme.", "privacy": "public", - "_ui5validator": "SemanticColor" + "_ui5validator": "String" }, { "kind": "field", @@ -22465,8 +22425,8 @@ "type": { "text": "boolean" }, - "description": "Specifies if the component is selected.", "default": "false", + "description": "Specifies if the component is selected.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -22487,10 +22447,10 @@ { "description": "The text to be displayed for the item.", "name": "text", - "default": "\"\"", + "default": "undefined", "fieldName": "text", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -22505,19 +22465,19 @@ { "description": "Represents the \"additionalText\" text, which is displayed in the tab. In the cases when in the same time there are tabs with icons and tabs without icons, if a tab has no icon the \"additionalText\" is displayed larger.", "name": "additional-text", - "default": "\"\"", + "default": "undefined", "fieldName": "additionalText", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the icon source URI to be displayed as graphical element within the component.\nThe SAP-icons font provides numerous built-in icons.\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": "\"\"", + "default": "undefined", "fieldName": "icon", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -22657,8 +22617,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the tab content is collapsed.", "default": "false", + "description": "Defines whether the tab content is collapsed.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -22675,10 +22635,10 @@ } ] }, - "description": "Defines the alignment of the content and the `additionalText` of a tab.\n\n**Note:**\nThe content and the `additionalText` would be displayed vertically by default,\nbut when set to `Inline`, they would be displayed horizontally.", "default": "\"Standard\"", + "description": "Defines the alignment of the content and the `additionalText` of a tab.\n\n**Note:**\nThe content and the `additionalText` would be displayed vertically by default,\nbut when set to `Inline`, they would be displayed horizontally.", "privacy": "public", - "_ui5validator": "TabLayout" + "_ui5validator": "String" }, { "kind": "field", @@ -22693,11 +22653,11 @@ } ] }, - "description": "Defines the overflow mode of the header (the tab strip). If you have a large number of tabs, only the tabs that can fit on screen will be visible.\nAll other tabs that can 't fit on the screen are available in an overflow tab \"More\".\n\n**Note:**\nOnly one overflow at the end would be displayed by default,\nbut when set to `StartAndEnd`, there will be two overflows on both ends, and tab order will not change on tab selection.", "default": "\"End\"", + "description": "Defines the overflow mode of the header (the tab strip). If you have a large number of tabs, only the tabs that can fit on screen will be visible.\nAll other tabs that can 't fit on the screen are available in an overflow tab \"More\".\n\n**Note:**\nOnly one overflow at the end would be displayed by default,\nbut when set to `StartAndEnd`, there will be two overflows on both ends, and tab order will not change on tab selection.", "privacy": "public", "_ui5since": "1.1.0", - "_ui5validator": "OverflowMode" + "_ui5validator": "String" }, { "kind": "field", @@ -22712,11 +22672,11 @@ } ] }, - "description": "Sets the background color of the Tab Container's header as `Solid`, `Transparent`, or `Translucent`.", "default": "\"Solid\"", + "description": "Sets the background color of the Tab Container's header as `Solid`, `Transparent`, or `Translucent`.", "privacy": "public", "_ui5since": "1.10.0", - "_ui5validator": "BackgroundDesign" + "_ui5validator": "String" }, { "kind": "field", @@ -22731,11 +22691,11 @@ } ] }, - "description": "Sets the background color of the Tab Container's content as `Solid`, `Transparent`, or `Translucent`.", "default": "\"Solid\"", + "description": "Sets the background color of the Tab Container's content as `Solid`, `Transparent`, or `Translucent`.", "privacy": "public", "_ui5since": "1.10.0", - "_ui5validator": "BackgroundDesign" + "_ui5validator": "String" }, { "kind": "field", @@ -22791,14 +22751,7 @@ }, { "type": { - "text": "Integer", - "references": [ - { - "name": "Integer", - "package": "@ui5/webcomponents-base", - "module": "dist/types/Integer.js" - } - ] + "text": "Integer" }, "name": "tabIndex", "_ui5privacy": "public", @@ -23027,12 +22980,14 @@ "kind": "interface", "name": "ITableFeature", "description": "Interface for components that can be slotted inside the features slot of the ui5-table.", + "_ui5experimental": true, "_ui5privacy": "public" }, { "kind": "interface", "name": "ITableGrowing", "description": "Interface for components that can be slotted inside the features slot of the ui5-table\nand provide growing/data loading functionality.", + "_ui5experimental": true, "_ui5privacy": "public" }, { @@ -23100,10 +23055,10 @@ "kind": "field", "name": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the accessible ARIA name of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -23111,10 +23066,10 @@ "kind": "field", "name": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Identifies the element (or elements) that labels the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -23122,10 +23077,10 @@ "kind": "field", "name": "noDataText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text to be displayed when there are no rows in the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -23142,10 +23097,10 @@ } ] }, - "description": "Defines the mode of the ui5-table overflow behavior.\n\nAvailable options are:\n\nScroll - Columns are shown as regular columns and horizontal scrolling is enabled.\n\nPopin - Columns are shown as pop-ins instead of regular columns.", "default": "\"Scroll\"", + "description": "Defines the mode of the ui5-table overflow behavior.\n\nAvailable options are:\n\nScroll - Columns are shown as regular columns and horizontal scrolling is enabled.\n\nPopin - Columns are shown as pop-ins instead of regular columns.", "privacy": "public", - "_ui5validator": "TableOverflowMode" + "_ui5validator": "String" }, { "kind": "field", @@ -23153,10 +23108,21 @@ "type": { "text": "boolean" }, - "description": "Defines if the loading indicator should be shown.\n\nNote: When the component is loading, it is non-interactive.", "default": "false", + "description": "Defines if the loading indicator should be shown.\n\nNote: When the component is loading, it is non-interactive.", "privacy": "public", "_ui5validator": "Boolean" + }, + { + "kind": "field", + "name": "loadingDelay", + "type": { + "text": "number" + }, + "default": "1000", + "description": "Defines the delay in milliseconds, after which the loading indicator will show up for this component.", + "privacy": "public", + "_ui5validator": "Number" } ], "events": [ @@ -23197,28 +23163,28 @@ { "description": "Defines the accessible ARIA name of the component.", "name": "accessible-name", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Identifies the element (or elements) that labels the component.", "name": "accessible-name-ref", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the text to be displayed when there are no rows in the component.", "name": "no-data-text", - "default": "\"\"", + "default": "undefined", "fieldName": "noDataText", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -23238,6 +23204,15 @@ "type": { "text": "boolean" } + }, + { + "description": "Defines the delay in milliseconds, after which the loading indicator will show up for this component.", + "name": "loading-delay", + "default": "1000", + "fieldName": "loadingDelay", + "type": { + "text": "number" + } } ], "superclass": { @@ -23247,6 +23222,7 @@ }, "tagName": "ui5-table", "customElement": true, + "_ui5experimental": "This Table web component is available since 2.0 and has been newly implemented to provide better screen reader and keyboard handling support.\nCurrently, it's considered experimental as its API is subject to change.\nThis Table replaces the previous Table web component, that has been part of **@ui5/webcomponents** version 1.x.\nFor compatibility reasons, we moved the previous Tabple implementation to the **@ui5/webcomponents-compat** package\nand will be maintained until the new Table is experimental.", "_ui5since": "2.0", "_ui5privacy": "public" } @@ -23285,6 +23261,7 @@ }, "tagName": "ui5-table-cell", "customElement": true, + "_ui5experimental": "This web component is available since 2.0 with an experimental flag and its API and behavior are subject to change.", "_ui5since": "2.0", "_ui5privacy": "public", "slots": [ @@ -23399,19 +23376,19 @@ } ] }, - "description": "Defines the mode of the ui5-table growing.\n\nAvailable options are:\n\nButton - Shows a More button at the bottom of the table, pressing it will load more rows.\n\nScroll - The rows are loaded automatically by scrolling to the bottom of the table. If the table is not scrollable, this option is the same as the Button.", "default": "\"Button\"", + "description": "Defines the mode of the ui5-table growing.\n\nAvailable options are:\n\nButton - Shows a More button at the bottom of the table, pressing it will load more rows.\n\nScroll - The rows are loaded automatically by scrolling to the bottom of the table. If the table is not scrollable, this option is the same as the Button.", "privacy": "public", - "_ui5validator": "TableGrowingMode" + "_ui5validator": "String" }, { "kind": "field", "name": "growingText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text that will be displayed inside the growing button.\nHas no effect when type is set to `Scroll`.\n\n**Note:** When not provided and the type is set to Button, a default text is displayed, corresponding to the\ncurrent language.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -23419,10 +23396,10 @@ "kind": "field", "name": "growingSubText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text that will be displayed below the `growingText` inside the growing button.\nHas no effect when type is set to Scroll.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" } @@ -23450,19 +23427,19 @@ { "description": "Defines the text that will be displayed inside the growing button.\nHas no effect when type is set to `Scroll`.\n\n**Note:** When not provided and the type is set to Button, a default text is displayed, corresponding to the\ncurrent language.", "name": "growing-text", - "default": "\"\"", + "default": "undefined", "fieldName": "growingText", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the text that will be displayed below the `growingText` inside the growing button.\nHas no effect when type is set to Scroll.", "name": "growing-sub-text", - "default": "\"\"", + "default": "undefined", "fieldName": "growingSubText", "type": { - "text": "string" + "text": "string | undefined" } } ], @@ -23473,6 +23450,7 @@ }, "tagName": "ui5-table-growing", "customElement": true, + "_ui5experimental": "This web component is available since 2.0 with an experimental flag and its API and behavior are subject to change.", "_ui5since": "2.0", "_ui5privacy": "public" } @@ -23511,8 +23489,8 @@ "type": { "text": "string" }, - "description": "Defines the width of column.", "default": "\"auto\"", + "description": "Defines the width of column.", "privacy": "public", "_ui5validator": "String" }, @@ -23522,8 +23500,8 @@ "type": { "text": "string" }, - "description": "Defines the minimum width of the column.\n\nIf the table is in `Popin` mode, the column will move into the popin when\nwhen the minimum width does not fit anymore.", "default": "\"auto\"", + "description": "Defines the minimum width of the column.\n\nIf the table is in `Popin` mode, the column will move into the popin when\nwhen the minimum width does not fit anymore.", "privacy": "public", "_ui5validator": "String" }, @@ -23533,8 +23511,8 @@ "type": { "text": "string" }, - "description": "Defines the maximum width of the column.", "default": "\"auto\"", + "description": "Defines the maximum width of the column.", "privacy": "public", "_ui5validator": "String" }, @@ -23544,10 +23522,10 @@ "type": { "text": "number" }, - "description": "Defines the importance of the column.\n\nThis property affects the popin behaviour.\nColumns with higher importance will move into the popin area later then less important\ncolumns.", "default": "0", + "description": "Defines the importance of the column.\n\nThis property affects the popin behaviour.\nColumns with higher importance will move into the popin area later then less important\ncolumns.", "privacy": "public", - "_ui5validator": "Integer" + "_ui5validator": "Number" } ], "attributes": [ @@ -23595,6 +23573,7 @@ }, "tagName": "ui5-table-header-cell", "customElement": true, + "_ui5experimental": "This web component is available since 2.0 with an experimental flag and its API and behavior are subject to change.", "_ui5since": "2.0", "_ui5privacy": "public", "slots": [ @@ -23662,8 +23641,8 @@ "type": { "text": "boolean" }, - "description": "Sticks the `ui5-table-header-row` to the top of a table.", "default": "false", + "description": "Sticks the `ui5-table-header-row` to the top of a table.", "privacy": "public", "_ui5validator": "Boolean" } @@ -23686,6 +23665,7 @@ }, "tagName": "ui5-table-header-row", "customElement": true, + "_ui5experimental": "This web component is available since 2.0 with an experimental flag and its API and behavior are subject to change.", "_ui5since": "2.0", "_ui5privacy": "public" } @@ -23757,8 +23737,8 @@ "type": { "text": "string" }, - "description": "Unique identifier of the component.", "default": "\"\"", + "description": "Unique identifier of the component.", "privacy": "public", "_ui5validator": "String" }, @@ -23768,8 +23748,19 @@ "type": { "text": "boolean" }, + "default": "false", "description": "Defines the interactive state of the row.", + "privacy": "public", + "_ui5validator": "Boolean" + }, + { + "kind": "field", + "name": "navigated", + "type": { + "text": "boolean" + }, "default": "false", + "description": "Defines the navigated state of the row.", "privacy": "public", "_ui5validator": "Boolean" } @@ -23788,7 +23779,16 @@ "description": "Defines the interactive state of the row.", "name": "interactive", "default": "false", - "fieldName": "interactive", + "fieldName": "interactive", + "type": { + "text": "boolean" + } + }, + { + "description": "Defines the navigated state of the row.", + "name": "navigated", + "default": "false", + "fieldName": "navigated", "type": { "text": "boolean" } @@ -23801,6 +23801,7 @@ }, "tagName": "ui5-table-row", "customElement": true, + "_ui5experimental": "This web component is available since 2.0 with an experimental flag and its API and behavior are subject to change.", "_ui5since": "2.0", "_ui5privacy": "public" } @@ -23877,10 +23878,10 @@ } ] }, - "description": "Defines the selection mode.", "default": "\"Multiple\"", + "description": "Defines the selection mode.", "privacy": "public", - "_ui5validator": "TableSelectionMode" + "_ui5validator": "String" }, { "kind": "field", @@ -23888,8 +23889,8 @@ "type": { "text": "string" }, - "description": "Defines the selected rows separated by a space.", "default": "\"\"", + "description": "Defines the selected rows separated by a space.", "privacy": "public", "_ui5validator": "String" } @@ -23931,6 +23932,7 @@ }, "tagName": "ui5-table-selection", "customElement": true, + "_ui5experimental": "This web component is available since 2.0 with an experimental flag and its API and behavior are subject to change.", "_ui5since": "2.0", "_ui5privacy": "public" } @@ -23954,6 +23956,12 @@ } ] }, + { + "kind": "javascript-module", + "path": "dist/TableUtils.js", + "declarations": [], + "exports": [] + }, { "kind": "javascript-module", "path": "dist/Tag.js", @@ -24002,8 +24010,8 @@ } ] }, - "description": "Defines the design type of the component.", "default": "\"Neutral\"", + "description": "Defines the design type of the component.", "privacy": "public", "_ui5since": "1.22.0", "_ui5validator": "String" @@ -24014,8 +24022,8 @@ "type": { "text": "string" }, - "description": "Defines the color scheme of the component.\nThere are 10 predefined schemes.\nTo use one you can set a number from `\"1\"` to `\"10\"`. The `colorScheme` `\"1\"` will be set by default.", "default": "\"1\"", + "description": "Defines the color scheme of the component.\nThere are 10 predefined schemes.\nTo use one you can set a number from `\"1\"` to `\"10\"`. The `colorScheme` `\"1\"` will be set by default.", "privacy": "public", "_ui5validator": "String" }, @@ -24025,8 +24033,8 @@ "type": { "text": "boolean" }, - "description": "Defines if the default state icon is shown.", "default": "false", + "description": "Defines if the default state icon is shown.", "privacy": "public", "_ui5since": "1.22.0", "_ui5validator": "Boolean" @@ -24037,8 +24045,8 @@ "type": { "text": "boolean" }, - "description": "Defines if the component is interactive (focusable and pressable).", "default": "false", + "description": "Defines if the component is interactive (focusable and pressable).", "privacy": "public", "_ui5since": "1.22.0", "_ui5validator": "Boolean" @@ -24056,11 +24064,11 @@ } ] }, - "description": "Defines how the text of a component will be displayed when there is not enough space.\n\n**Note:** For option \"Normal\" the text will wrap and the\nwords will not be broken based on hyphenation.", "default": "\"Normal\"", + "description": "Defines how the text of a component will be displayed when there is not enough space.\n\n**Note:** For option \"Normal\" the text will wrap and the\nwords will not be broken based on hyphenation.", "privacy": "public", "_ui5since": "1.22.0", - "_ui5validator": "WrappingType" + "_ui5validator": "String" }, { "kind": "field", @@ -24075,11 +24083,11 @@ } ] }, - "description": "Defines predefined size of the component.", "default": "\"S\"", + "description": "Defines predefined size of the component.", "privacy": "public", "_ui5since": "2.0.0", - "_ui5validator": "TagSize" + "_ui5validator": "String" } ], "events": [ @@ -24201,13 +24209,10 @@ { "kind": "field", "name": "maxLines", - "type": { - "text": "number" - }, - "description": "Defines the number of lines the text should wrap before it truncates.", "default": "Infinity", + "description": "Defines the number of lines the text should wrap before it truncates.", "privacy": "public", - "_ui5validator": "Integer" + "_ui5validator": "Number" } ], "attributes": [ @@ -24283,8 +24288,8 @@ "type": { "text": "string" }, - "description": "Defines the value of the component.", "default": "\"\"", + "description": "Defines the value of the component.", "privacy": "public", "_ui5validator": "String", "_ui5formProperty": true, @@ -24296,8 +24301,8 @@ "type": { "text": "boolean" }, - "description": "Indicates whether the user can interact with the component or not.\n\n**Note:** A disabled component is completely noninteractive.", "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", "_ui5validator": "Boolean" }, @@ -24307,8 +24312,8 @@ "type": { "text": "boolean" }, - "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.", "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", "_ui5validator": "Boolean" }, @@ -24318,8 +24323,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is required.", "default": "false", + "description": "Defines whether the component is required.", "privacy": "public", "_ui5since": "1.0.0-rc.3", "_ui5validator": "Boolean" @@ -24328,10 +24333,10 @@ "kind": "field", "name": "placeholder", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines a short hint intended to aid the user with data entry when the component has no value.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -24348,11 +24353,11 @@ } ] }, - "description": "Defines the value state of the component.\n\n**Note:** If `maxlength` property is set,\nthe component turns into \"Warning\" state once the characters exceeds the limit.\nIn this case, only the \"Error\" state is considered and can be applied.", "default": "\"None\"", + "description": "Defines the value state of the component.\n\n**Note:** If `maxlength` property is set,\nthe component turns into \"Warning\" state once the characters exceeds the limit.\nIn this case, only the \"Error\" state is considered and can be applied.", "privacy": "public", "_ui5since": "1.0.0-rc.7", - "_ui5validator": "ValueState" + "_ui5validator": "String" }, { "kind": "field", @@ -24360,10 +24365,10 @@ "type": { "text": "number" }, - "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.", "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", - "_ui5validator": "Integer" + "_ui5validator": "Number" }, { "kind": "field", @@ -24374,7 +24379,7 @@ "description": "Defines the maximum number of characters that the `value` can have.", "default": "undefined", "privacy": "public", - "_ui5validator": "Integer" + "_ui5validator": "Number" }, { "kind": "field", @@ -24382,8 +24387,8 @@ "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.", "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", "_ui5validator": "Boolean" }, @@ -24393,8 +24398,8 @@ "type": { "text": "boolean" }, - "description": "Enables the component to automatically grow and shrink dynamically with its content.", "default": "false", + "description": "Enables the component to automatically grow and shrink dynamically with its content.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -24404,19 +24409,19 @@ "type": { "text": "number" }, - "description": "Defines the maximum number of rows that the component can grow.", "default": "0", + "description": "Defines the maximum number of rows that the component can grow.", "privacy": "public", - "_ui5validator": "Integer" + "_ui5validator": "Number" }, { "kind": "field", "name": "name", "type": { - "text": "string" + "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": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -24424,10 +24429,10 @@ "kind": "field", "name": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the accessible ARIA name of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15", "_ui5validator": "String" @@ -24436,10 +24441,10 @@ "kind": "field", "name": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Receives id(or many ids) of the elements that label the textarea.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15", "_ui5validator": "String" @@ -24522,10 +24527,10 @@ { "description": "Defines a short hint intended to aid the user with data entry when the component has no value.", "name": "placeholder", - "default": "\"\"", + "default": "undefined", "fieldName": "placeholder", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -24585,28 +24590,28 @@ { "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": "\"\"", + "default": "undefined", "fieldName": "name", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the accessible ARIA name of the component.", "name": "accessible-name", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Receives id(or many ids) of the elements that label the textarea.", "name": "accessible-name-ref", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" } } ], @@ -24663,10 +24668,10 @@ "kind": "field", "name": "value", "type": { - "text": "string | undefined" + "text": "string" }, + "default": "\"\"", "description": "Defines a formatted time value.", - "default": "undefined", "privacy": "public", "_ui5validator": "String", "_ui5formProperty": true, @@ -24676,10 +24681,10 @@ "kind": "field", "name": "name", "type": { - "text": "string" + "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": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "2.0.0", "_ui5validator": "String" @@ -24697,10 +24702,10 @@ } ] }, - "description": "Defines the value state of the component.", "default": "\"None\"", + "description": "Defines the value state of the component.", "privacy": "public", - "_ui5validator": "ValueState" + "_ui5validator": "String" }, { "kind": "field", @@ -24708,8 +24713,8 @@ "type": { "text": "boolean" }, - "description": "Defines the disabled state of the comonent.", "default": "false", + "description": "Defines the disabled state of the comonent.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -24719,8 +24724,8 @@ "type": { "text": "boolean" }, - "description": "Defines the readonly state of the comonent.", "default": "false", + "description": "Defines the readonly state of the comonent.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -24739,10 +24744,10 @@ "kind": "field", "name": "formatPattern", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Determines the format, displayed in the input field.\n\nExample:\nHH:mm:ss -> 11:42:35\nhh:mm:ss a -> 2:23:15 PM\nmm:ss -> 12:04 (only minutes and seconds)", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -24752,9 +24757,9 @@ "type": { "text": "boolean" }, + "default": "false", "description": "Defines the open or closed state of the popover.", "privacy": "public", - "default": "false", "_ui5since": "2.0", "_ui5validator": "Boolean" }, @@ -24762,7 +24767,7 @@ "kind": "field", "name": "dateValue", "type": { - "text": "Date | Array | null" + "text": "Date | null" }, "description": "Currently selected time represented as JavaScript Date instance", "privacy": "public", @@ -24903,19 +24908,19 @@ { "description": "Defines a formatted time value.", "name": "value", - "default": "undefined", + "default": "\"\"", "fieldName": "value", "type": { - "text": "string | undefined" + "text": "string" } }, { "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": "\"\"", + "default": "undefined", "fieldName": "name", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -24957,10 +24962,10 @@ { "description": "Determines the format, displayed in the input field.\n\nExample:\nHH:mm:ss -> 11:42:35\nhh:mm:ss a -> 2:23:15 PM\nmm:ss -> 12:04 (only minutes and seconds)", "name": "format-pattern", - "default": "\"\"", + "default": "undefined", "fieldName": "formatPattern", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -25104,10 +25109,10 @@ } ] }, - "description": "Defines how the text of a component will be displayed when there is not enough space.\n\n**Note:** for option \"Normal\" the text will wrap and the words will not be broken based on hyphenation.", "default": "\"Normal\"", + "description": "Defines how the text of a component will be displayed when there is not enough space.\n\n**Note:** for option \"Normal\" the text will wrap and the words will not be broken based on hyphenation.", "privacy": "public", - "_ui5validator": "WrappingType" + "_ui5validator": "String" }, { "kind": "field", @@ -25122,10 +25127,10 @@ } ] }, - "description": "Defines the component level.\nAvailable options are: `\"H6\"` to `\"H1\"`.", "default": "\"H2\"", + "description": "Defines the component level.\nAvailable options are: `\"H6\"` to `\"H1\"`.", "privacy": "public", - "_ui5validator": "TitleLevel" + "_ui5validator": "String" } ], "attributes": [ @@ -25202,10 +25207,10 @@ "type": { "text": "number" }, - "description": "Defines the duration in milliseconds for which component\nremains on the screen before it's automatically closed.\n\n**Note:** The minimum supported value is `500` ms\nand even if a lower value is set, the duration would remain `500` ms.", "default": "3000", + "description": "Defines the duration in milliseconds for which component\nremains on the screen before it's automatically closed.\n\n**Note:** The minimum supported value is `500` ms\nand even if a lower value is set, the duration would remain `500` ms.", "privacy": "public", - "_ui5validator": "Integer" + "_ui5validator": "Number" }, { "kind": "field", @@ -25220,10 +25225,10 @@ } ] }, - "description": "Defines the placement of the component.", "default": "\"BottomCenter\"", + "description": "Defines the placement of the component.", "privacy": "public", - "_ui5validator": "ToastPlacement" + "_ui5validator": "String" }, { "kind": "field", @@ -25231,8 +25236,8 @@ "type": { "text": "boolean" }, - "description": "Indicates whether the component is open (visible).", "default": "false", + "description": "Indicates whether the component is open (visible).", "privacy": "public", "_ui5since": "2.0.0", "_ui5validator": "Boolean" @@ -25323,8 +25328,8 @@ "type": { "text": "boolean" }, - "description": "Determines whether the component is displayed as pressed.", "default": "false", + "description": "Determines whether the component is displayed as pressed.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -25341,10 +25346,10 @@ } ] }, - "description": "Defines the component design.", "default": "\"Default\"", + "description": "Defines the component design.", "privacy": "public", - "_ui5validator": "ButtonDesign", + "_ui5validator": "String", "inheritedFrom": { "name": "Button", "module": "dist/Button.js" @@ -25356,8 +25361,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is disabled.\nA disabled component can't be pressed or\nfocused, and it is not in the tab chain.", "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", "_ui5validator": "Boolean", "inheritedFrom": { @@ -25369,10 +25374,10 @@ "kind": "field", "name": "icon", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the icon, displayed as graphical element within the component.\nThe SAP-icons font provides numerous options.\n\nExample:\nSee all the available icons within the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String", "inheritedFrom": { @@ -25384,10 +25389,10 @@ "kind": "field", "name": "endIcon", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the icon, displayed as graphical element within the component after the button text.\n\n**Note:** It is highly recommended to use `endIcon` property only together with `icon` and/or `text` properties.\nUsage of `endIcon` only should be avoided.\n\nThe SAP-icons font provides numerous options.\n\nExample:\nSee all the available icons within the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String", "inheritedFrom": { @@ -25401,8 +25406,8 @@ "type": { "text": "boolean" }, - "description": "When set to `true`, the component will\nautomatically submit the nearest HTML form element on `press`.\n\n**Note:** This property is only applicable within the context of an HTML Form element.`", "default": "false", + "description": "When set to `true`, the component will\nautomatically submit the nearest HTML form element on `press`.\n\n**Note:** This property is only applicable within the context of an HTML Form element.`", "privacy": "public", "deprecated": "Set the \"type\" property to \"Submit\" to achieve the same result. The \"submits\" property is ignored if \"type\" is set to any value other than \"Button\".", "_ui5validator": "Boolean", @@ -25415,10 +25420,10 @@ "kind": "field", "name": "tooltip", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the tooltip of the component.\n\n**Note:** A tooltip attribute should be provided for icon-only buttons, in order to represent their exact meaning/function.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.2.0", "_ui5validator": "String", @@ -25447,10 +25452,10 @@ "kind": "field", "name": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Receives id(or many ids) of the elements that label the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.1.0", "_ui5validator": "String", @@ -25472,9 +25477,9 @@ } ] }, + "default": "{}", "description": "Defines the additional accessibility attributes that will be applied to the component.\nThe following fields are supported:\n\n- **expanded**: Indicates whether the button, or another grouping element it controls, is currently expanded or collapsed.\nAccepts the following string values: `true` or `false`\n\n- **hasPopup**: Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by the button.\nAccepts the following string values: `dialog`, `grid`, `listbox`, `menu` or `tree`.\n\n- **controls**: Identifies the element (or elements) whose contents or presence are controlled by the button element.\nAccepts a lowercase string value.", "privacy": "public", - "default": "{}", "_ui5since": "1.2.0", "_ui5validator": "Object", "inheritedFrom": { @@ -25495,11 +25500,11 @@ } ] }, - "description": "Defines whether the button has special form-related functionality.\n\n**Note:** This property is only applicable within the context of an HTML Form element.", "default": "\"Button\"", + "description": "Defines whether the button has special form-related functionality.\n\n**Note:** This property is only applicable within the context of an HTML Form element.", "privacy": "public", "_ui5since": "1.15.0", - "_ui5validator": "ButtonType", + "_ui5validator": "String", "inheritedFrom": { "name": "Button", "module": "dist/Button.js" @@ -25518,11 +25523,11 @@ } ] }, - "description": "Describes the accessibility role of the button.\n\n**Note:** Use ButtonAccessibleRole.Link role only with a press handler, which performs a navigation. In all other scenarios the default button semantics are recommended.", "default": "\"Button\"", + "description": "Describes the accessibility role of the button.\n\n**Note:** Use ButtonAccessibleRole.Link role only with a press handler, which performs a navigation. In all other scenarios the default button semantics are recommended.", "privacy": "public", "_ui5since": "1.23", - "_ui5validator": "ButtonAccessibleRole", + "_ui5validator": "String", "inheritedFrom": { "name": "Button", "module": "dist/Button.js" @@ -25568,10 +25573,10 @@ { "description": "Defines the icon, displayed as graphical element within the component.\nThe SAP-icons font provides numerous options.\n\nExample:\nSee all the available icons within the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).", "name": "icon", - "default": "\"\"", + "default": "undefined", "fieldName": "icon", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "Button", @@ -25581,10 +25586,10 @@ { "description": "Defines the icon, displayed as graphical element within the component after the button text.\n\n**Note:** It is highly recommended to use `endIcon` property only together with `icon` and/or `text` properties.\nUsage of `endIcon` only should be avoided.\n\nThe SAP-icons font provides numerous options.\n\nExample:\nSee all the available icons within the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).", "name": "end-icon", - "default": "\"\"", + "default": "undefined", "fieldName": "endIcon", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "Button", @@ -25608,10 +25613,10 @@ { "description": "Defines the tooltip of the component.\n\n**Note:** A tooltip attribute should be provided for icon-only buttons, in order to represent their exact meaning/function.", "name": "tooltip", - "default": "\"\"", + "default": "undefined", "fieldName": "tooltip", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "Button", @@ -25634,10 +25639,10 @@ { "description": "Receives id(or many ids) of the elements that label the component.", "name": "accessible-name-ref", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "Button", @@ -25777,10 +25782,10 @@ "kind": "field", "name": "text", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text of the token.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -25790,8 +25795,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is selected or not.", "default": "false", + "description": "Defines whether the component is selected or not.", "privacy": "public", "_ui5validator": "Boolean" } @@ -25800,10 +25805,10 @@ { "description": "Defines the text of the token.", "name": "text", - "default": "\"\"", + "default": "undefined", "fieldName": "text", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -25868,8 +25873,8 @@ "type": { "text": "boolean" }, - "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.", "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", "_ui5validator": "Boolean" }, @@ -25879,8 +25884,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is disabled.\n\n**Note:** A disabled component is completely noninteractive.", "default": "false", + "description": "Defines whether the component is disabled.\n\n**Note:** A disabled component is completely noninteractive.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -25994,6 +25999,7 @@ }, "tagName": "ui5-tokenizer", "customElement": true, + "_ui5experimental": "This component is availabe since 2.0 under an experimental flag and its API and behaviour are subject to change.", "_ui5since": "2.0.0", "_ui5privacy": "public" } @@ -26057,19 +26063,19 @@ } ] }, + "default": "\"End\"", "description": "Indicated the direction in which the Toolbar items will be aligned.", "privacy": "public", - "default": "\"End\"", - "_ui5validator": "ToolbarAlign" + "_ui5validator": "String" }, { "kind": "field", "name": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the accessible ARIA name of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -26077,10 +26083,10 @@ "kind": "field", "name": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Receives id(or many ids) of the elements that label the input.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -26097,11 +26103,11 @@ } ] }, + "default": "\"Solid\"", "description": "Defines the toolbar design.", "privacy": "public", - "default": "\"Solid\"", "_ui5since": "2.0.0", - "_ui5validator": "ToolbarDesign" + "_ui5validator": "String" }, { "kind": "method", @@ -26128,19 +26134,19 @@ { "description": "Defines the accessible ARIA name of the component.", "name": "accessible-name", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Receives id(or many ids) of the elements that label the input.", "name": "accessible-name-ref", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -26198,8 +26204,8 @@ "type": { "text": "boolean" }, - "description": "Defines if the action is disabled.\n\n**Note:** a disabled action can't be pressed or focused, and it is not in the tab chain.", "default": "false", + "description": "Defines if the action is disabled.\n\n**Note:** a disabled action can't be pressed or focused, and it is not in the tab chain.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -26216,19 +26222,19 @@ } ] }, - "description": "Defines the action design.", "default": "\"Default\"", + "description": "Defines the action design.", "privacy": "public", - "_ui5validator": "ButtonDesign" + "_ui5validator": "String" }, { "kind": "field", "name": "icon", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the `icon` source URI.\n\n**Note:** SAP-icons font provides numerous buil-in icons. To find all the available icons, see the\n[Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -26236,10 +26242,10 @@ "kind": "field", "name": "endIcon", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the icon, displayed as graphical element within the component after the button text.\n\n**Note:** It is highly recommended to use `endIcon` property only together with `icon` and/or `text` properties.\nUsage of `endIcon` only should be avoided.\n\nThe SAP-icons font provides numerous options.\n\nExample:\nSee all the available icons within the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -26247,10 +26253,10 @@ "kind": "field", "name": "tooltip", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the tooltip of the component.\n\n**Note:** A tooltip attribute should be provided for icon-only buttons, in order to represent their exact meaning/function.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -26269,10 +26275,10 @@ "kind": "field", "name": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Receives id(or many ids) of the elements that label the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -26289,8 +26295,8 @@ } ] }, - "description": "Defines the additional accessibility attributes that will be applied to the component.\n\nThe following fields are supported:\n\n- **expanded**: Indicates whether the button, or another grouping element it controls, is currently expanded or collapsed.\nAccepts the following string values: `true` or `false`\n\n- **hasPopup**: Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by the button.\nAccepts the following string values: `dialog`, `grid`, `listbox`, `menu` or `tree`.\n\n- **controls**: Identifies the element (or elements) whose contents or presence are controlled by the button element.\nAccepts a lowercase string value.", "default": "{}", + "description": "Defines the additional accessibility attributes that will be applied to the component.\n\nThe following fields are supported:\n\n- **expanded**: Indicates whether the button, or another grouping element it controls, is currently expanded or collapsed.\nAccepts the following string values: `true` or `false`\n\n- **hasPopup**: Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by the button.\nAccepts the following string values: `dialog`, `grid`, `listbox`, `menu` or `tree`.\n\n- **controls**: Identifies the element (or elements) whose contents or presence are controlled by the button element.\nAccepts a lowercase string value.", "privacy": "public", "_ui5validator": "Object" }, @@ -26298,11 +26304,11 @@ "kind": "field", "name": "text", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Button text", "privacy": "public", - "default": "\"\"", + "default": "undefined", "_ui5validator": "String" }, { @@ -26314,7 +26320,7 @@ "description": "Defines the width of the button.\n\n**Note:** all CSS sizes are supported - 'percentage', 'px', 'rem', 'auto', etc.", "default": "undefined", "privacy": "public", - "_ui5validator": "CSSSize" + "_ui5validator": "String" }, { "kind": "field", @@ -26329,10 +26335,10 @@ } ] }, + "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", - "default": "\"Default\"", - "_ui5validator": "ToolbarItemOverflowBehavior", + "_ui5validator": "String", "inheritedFrom": { "name": "ToolbarItem", "module": "dist/ToolbarItem.js" @@ -26344,8 +26350,8 @@ "type": { "text": "boolean" }, - "description": "Defines if the toolbar overflow popup should close upon intereaction with the item.\nIt will close by default.", "default": "false", + "description": "Defines if the toolbar overflow popup should close upon intereaction with the item.\nIt will close by default.", "privacy": "public", "_ui5validator": "Boolean", "inheritedFrom": { @@ -26386,28 +26392,28 @@ { "description": "Defines the `icon` source URI.\n\n**Note:** SAP-icons font provides numerous buil-in icons. To find all the available icons, see the\n[Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).", "name": "icon", - "default": "\"\"", + "default": "undefined", "fieldName": "icon", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the icon, displayed as graphical element within the component after the button text.\n\n**Note:** It is highly recommended to use `endIcon` property only together with `icon` and/or `text` properties.\nUsage of `endIcon` only should be avoided.\n\nThe SAP-icons font provides numerous options.\n\nExample:\nSee all the available icons within the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).", "name": "end-icon", - "default": "\"\"", + "default": "undefined", "fieldName": "endIcon", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the tooltip of the component.\n\n**Note:** A tooltip attribute should be provided for icon-only buttons, in order to represent their exact meaning/function.", "name": "tooltip", - "default": "\"\"", + "default": "undefined", "fieldName": "tooltip", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -26422,19 +26428,19 @@ { "description": "Receives id(or many ids) of the elements that label the component.", "name": "accessible-name-ref", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Button text", "name": "text", - "default": "\"\"", + "default": "undefined", "fieldName": "text", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -26526,10 +26532,10 @@ } ] }, + "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", - "default": "\"Default\"", - "_ui5validator": "ToolbarItemOverflowBehavior" + "_ui5validator": "String" }, { "kind": "field", @@ -26537,8 +26543,8 @@ "type": { "text": "boolean" }, - "description": "Defines if the toolbar overflow popup should close upon intereaction with the item.\nIt will close by default.", "default": "false", + "description": "Defines if the toolbar overflow popup should close upon intereaction with the item.\nIt will close by default.", "privacy": "public", "_ui5validator": "Boolean" } @@ -26627,7 +26633,7 @@ "description": "Defines the width of the select.\n\n**Note:** all CSS sizes are supported - 'percentage', 'px', 'rem', 'auto', etc.", "default": "undefined", "privacy": "public", - "_ui5validator": "CSSSize" + "_ui5validator": "String" }, { "kind": "field", @@ -26642,10 +26648,10 @@ } ] }, - "description": "Defines the value state of the component.", "default": "\"None\"", + "description": "Defines the value state of the component.", "privacy": "public", - "_ui5validator": "ValueState" + "_ui5validator": "String" }, { "kind": "field", @@ -26653,8 +26659,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the component is in disabled state.\n\n**Note:** A disabled component is noninteractive.", "default": "false", + "description": "Defines whether the component is in disabled state.\n\n**Note:** A disabled component is noninteractive.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -26662,21 +26668,21 @@ "kind": "field", "name": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the accessible ARIA name of the component.", "privacy": "public", - "default": "\"\"", + "default": "undefined", "_ui5validator": "String" }, { "kind": "field", "name": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Receives id(or many ids) of the elements that label the select.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -26693,10 +26699,10 @@ } ] }, + "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", - "default": "\"Default\"", - "_ui5validator": "ToolbarItemOverflowBehavior", + "_ui5validator": "String", "inheritedFrom": { "name": "ToolbarItem", "module": "dist/ToolbarItem.js" @@ -26708,8 +26714,8 @@ "type": { "text": "boolean" }, - "description": "Defines if the toolbar overflow popup should close upon intereaction with the item.\nIt will close by default.", "default": "false", + "description": "Defines if the toolbar overflow popup should close upon intereaction with the item.\nIt will close by default.", "privacy": "public", "_ui5validator": "Boolean", "inheritedFrom": { @@ -26793,19 +26799,19 @@ { "description": "Defines the accessible ARIA name of the component.", "name": "accessible-name", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Receives id(or many ids) of the elements that label the select.", "name": "accessible-name-ref", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -26892,8 +26898,8 @@ "type": { "text": "boolean" }, - "description": "Defines the selected state of the component.", "default": "false", + "description": "Defines the selected state of the component.", "privacy": "public", "_ui5validator": "Boolean" } @@ -27000,10 +27006,10 @@ } ] }, + "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", - "default": "\"Default\"", - "_ui5validator": "ToolbarItemOverflowBehavior", + "_ui5validator": "String", "inheritedFrom": { "name": "ToolbarItem", "module": "dist/ToolbarItem.js" @@ -27015,8 +27021,8 @@ "type": { "text": "boolean" }, - "description": "Defines if the toolbar overflow popup should close upon intereaction with the item.\nIt will close by default.", "default": "false", + "description": "Defines if the toolbar overflow popup should close upon intereaction with the item.\nIt will close by default.", "privacy": "public", "_ui5validator": "Boolean", "inheritedFrom": { @@ -27064,7 +27070,7 @@ "description": "Defines the width of the spacer.\n\n**Note:** all CSS sizes are supported - 'percentage', 'px', 'rem', 'auto', etc.", "privacy": "public", "default": "undefined", - "_ui5validator": "CSSSize" + "_ui5validator": "String" }, { "kind": "field", @@ -27079,10 +27085,10 @@ } ] }, + "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", - "default": "\"Default\"", - "_ui5validator": "ToolbarItemOverflowBehavior", + "_ui5validator": "String", "inheritedFrom": { "name": "ToolbarItem", "module": "dist/ToolbarItem.js" @@ -27094,8 +27100,8 @@ "type": { "text": "boolean" }, - "description": "Defines if the toolbar overflow popup should close upon intereaction with the item.\nIt will close by default.", "default": "false", + "description": "Defines if the toolbar overflow popup should close upon intereaction with the item.\nIt will close by default.", "privacy": "public", "_ui5validator": "Boolean", "inheritedFrom": { @@ -27211,7 +27217,7 @@ "kind": "field", "name": "selectionMode", "type": { - "text": "ListSelectionMode", + "text": "ListSelectionMode | undefined", "references": [ { "name": "ListSelectionMode", @@ -27220,19 +27226,19 @@ } ] }, + "default": "\"None\"", "description": "Defines the selection mode of the component. Since the tree uses a `ui5-list` to display its structure,\nthe tree modes are exactly the same as the list modes, and are all applicable.", "privacy": "public", - "default": "\"None\"", - "_ui5validator": "ListSelectionMode" + "_ui5validator": "String" }, { "kind": "field", "name": "noDataText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text that is displayed when the component contains no items.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -27240,10 +27246,10 @@ "kind": "field", "name": "headerText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the component header text.\n\n**Note:** If the `header` slot is set, this property is ignored.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -27251,10 +27257,10 @@ "kind": "field", "name": "footerText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the component footer text.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5validator": "String" }, @@ -27262,10 +27268,10 @@ "kind": "field", "name": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the accessible name of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.8.0", "_ui5validator": "String" @@ -27274,10 +27280,10 @@ "kind": "field", "name": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the IDs of the elements that label the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.8.0", "_ui5validator": "String" @@ -27490,52 +27496,52 @@ "default": "\"None\"", "fieldName": "selectionMode", "type": { - "text": "\"Single\" | \"Multiple\" | \"None\" | \"SingleStart\" | \"SingleEnd\" | \"SingleAuto\" | \"Delete\"" + "text": "\"Single\" | \"Multiple\" | \"None\" | \"SingleStart\" | \"SingleEnd\" | \"SingleAuto\" | \"Delete\" | undefined" } }, { "description": "Defines the text that is displayed when the component contains no items.", "name": "no-data-text", - "default": "\"\"", + "default": "undefined", "fieldName": "noDataText", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the component header text.\n\n**Note:** If the `header` slot is set, this property is ignored.", "name": "header-text", - "default": "\"\"", + "default": "undefined", "fieldName": "headerText", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the component footer text.", "name": "footer-text", - "default": "\"\"", + "default": "undefined", "fieldName": "footerText", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the accessible name of the component.", "name": "accessible-name", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the IDs of the elements that label the component.", "name": "accessible-name-ref", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleNameRef", "type": { - "text": "string" + "text": "string | undefined" } } ], @@ -27596,21 +27602,21 @@ "kind": "field", "name": "text", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text of the tree item.", "privacy": "public", - "default": "\"\"", + "default": "undefined", "_ui5validator": "String" }, { "kind": "field", "name": "additionalText", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the `additionalText`, displayed in the end of the tree item.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15", "_ui5validator": "String" @@ -27619,11 +27625,11 @@ "kind": "field", "name": "icon", "type": { - "text": "string" + "text": "string | undefined" }, "description": "If set, an icon will be displayed before the text of the tree list item.", "privacy": "public", - "default": "\"\"", + "default": "undefined", "_ui5validator": "String", "inheritedFrom": { "name": "TreeItemBase", @@ -27636,8 +27642,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the tree list item will show a collapse or expand icon inside its toggle button.", "default": "false", + "description": "Defines whether the tree list item will show a collapse or expand icon inside its toggle button.", "privacy": "public", "_ui5validator": "Boolean", "inheritedFrom": { @@ -27683,8 +27689,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the tree node has children, even if currently no other tree nodes are slotted inside.\n\n**Note:** This property is useful for showing big tree structures where not all nodes are initially loaded due to performance reasons.\nSet this to `true` for nodes you intend to load lazily, when the user clicks the expand button.\nIt is not necessary to set this property otherwise. If a tree item has children, the expand button will be displayed anyway.", "default": "false", + "description": "Defines whether the tree node has children, even if currently no other tree nodes are slotted inside.\n\n**Note:** This property is useful for showing big tree structures where not all nodes are initially loaded due to performance reasons.\nSet this to `true` for nodes you intend to load lazily, when the user clicks the expand button.\nIt is not necessary to set this property otherwise. If a tree item has children, the expand button will be displayed anyway.", "privacy": "public", "_ui5validator": "Boolean", "inheritedFrom": { @@ -27705,11 +27711,11 @@ } ] }, - "description": "Defines the state of the `additionalText`.\n\nAvailable options are: `\"None\"` (by default), `\"Positive\"`, `\"Critical\"`, `\"Information\"` and `\"Negative\"`.", "default": "\"None\"", + "description": "Defines the state of the `additionalText`.\n\nAvailable options are: `\"None\"` (by default), `\"Positive\"`, `\"Critical\"`, `\"Information\"` and `\"Negative\"`.", "privacy": "public", "_ui5since": "1.0.0-rc.15", - "_ui5validator": "ValueState", + "_ui5validator": "String", "inheritedFrom": { "name": "TreeItemBase", "module": "dist/TreeItemBase.js" @@ -27719,10 +27725,10 @@ "kind": "field", "name": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the accessible name of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.8.0", "_ui5validator": "String", @@ -27759,10 +27765,10 @@ } ] }, - "description": "Defines the visual indication and behavior of the list items.\nAvailable options are `Active` (by default), `Inactive`, `Detail` and `Navigation`.\n\n**Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and hover,\nwhile with type `Inactive` and `Detail` - will not.", "default": "\"Active\"", + "description": "Defines the visual indication and behavior of the list items.\nAvailable options are `Active` (by default), `Inactive`, `Detail` and `Navigation`.\n\n**Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and hover,\nwhile with type `Inactive` and `Detail` - will not.", "privacy": "public", - "_ui5validator": "ListItemType", + "_ui5validator": "String", "inheritedFrom": { "name": "ListItem", "module": "dist/ListItem.js" @@ -27781,8 +27787,8 @@ } ] }, - "description": "Defines the additional accessibility attributes that will be applied to the component.\nThe following fields are supported:\n\n- **ariaSetsize**: Defines the number of items in the current set when not all items in the set are present in the DOM.\n**Note:** The value is an integer reflecting the number of items in the complete set. If the size of the entire set is unknown, set `-1`.\n\n\t- **ariaPosinset**: Defines an element's number or position in the current set when not all items are present in the DOM.\n\t**Note:** The value is an integer greater than or equal to 1, and less than or equal to the size of the set when that size is known.", "default": "{}", + "description": "Defines the additional accessibility attributes that will be applied to the component.\nThe following fields are supported:\n\n- **ariaSetsize**: Defines the number of items in the current set when not all items in the set are present in the DOM.\n**Note:** The value is an integer reflecting the number of items in the complete set. If the size of the entire set is unknown, set `-1`.\n\n\t- **ariaPosinset**: Defines an element's number or position in the current set when not all items are present in the DOM.\n\t**Note:** The value is an integer greater than or equal to 1, and less than or equal to the size of the set when that size is known.", "privacy": "public", "_ui5since": "1.15.0", "_ui5validator": "Object", @@ -27797,8 +27803,8 @@ "type": { "text": "boolean" }, - "description": "The navigated state of the list item.\nIf set to `true`, a navigation indicator is displayed at the end of the list item.", "default": "false", + "description": "The navigated state of the list item.\nIf set to `true`, a navigation indicator is displayed at the end of the list item.", "privacy": "public", "_ui5since": "1.10.0", "_ui5validator": "Boolean", @@ -27811,10 +27817,10 @@ "kind": "field", "name": "tooltip", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text of the tooltip that would be displayed for the list item.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.23.0", "_ui5validator": "String", @@ -27836,11 +27842,11 @@ } ] }, - "description": "Defines the highlight state of the list items.\nAvailable options are: `\"None\"` (by default), `\"Positive\"`, `\"Critical\"`, `\"Information\"` and `\"Negative\"`.", "default": "\"None\"", + "description": "Defines the highlight state of the list items.\nAvailable options are: `\"None\"` (by default), `\"Positive\"`, `\"Critical\"`, `\"Information\"` and `\"Negative\"`.", "privacy": "public", "_ui5since": "1.24", - "_ui5validator": "Highlight", + "_ui5validator": "String", "inheritedFrom": { "name": "ListItem", "module": "dist/ListItem.js" @@ -27857,8 +27863,8 @@ "privacy": "public", "_ui5validator": "Boolean", "inheritedFrom": { - "name": "ListItemBase", - "module": "dist/ListItemBase.js" + "name": "ListItem", + "module": "dist/ListItem.js" } } ], @@ -27866,28 +27872,28 @@ { "description": "Defines the text of the tree item.", "name": "text", - "default": "\"\"", + "default": "undefined", "fieldName": "text", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "Defines the `additionalText`, displayed in the end of the tree item.", "name": "additional-text", - "default": "\"\"", + "default": "undefined", "fieldName": "additionalText", "type": { - "text": "string" + "text": "string | undefined" } }, { "description": "If set, an icon will be displayed before the text of the tree list item.", "name": "icon", - "default": "\"\"", + "default": "undefined", "fieldName": "icon", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "TreeItemBase", @@ -27962,10 +27968,10 @@ { "description": "Defines the accessible name of the component.", "name": "accessible-name", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "TreeItemBase", @@ -28001,10 +28007,10 @@ { "description": "Defines the text of the tooltip that would be displayed for the list item.", "name": "tooltip", - "default": "\"\"", + "default": "undefined", "fieldName": "tooltip", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "ListItem", @@ -28033,8 +28039,8 @@ "text": "boolean" }, "inheritedFrom": { - "name": "ListItemBase", - "module": "dist/ListItemBase.js" + "name": "ListItem", + "module": "dist/ListItem.js" } } ], @@ -28163,11 +28169,11 @@ "kind": "field", "name": "icon", "type": { - "text": "string" + "text": "string | undefined" }, "description": "If set, an icon will be displayed before the text of the tree list item.", "privacy": "public", - "default": "\"\"", + "default": "undefined", "_ui5validator": "String" }, { @@ -28176,8 +28182,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the tree list item will show a collapse or expand icon inside its toggle button.", "default": "false", + "description": "Defines whether the tree list item will show a collapse or expand icon inside its toggle button.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -28211,8 +28217,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the tree node has children, even if currently no other tree nodes are slotted inside.\n\n**Note:** This property is useful for showing big tree structures where not all nodes are initially loaded due to performance reasons.\nSet this to `true` for nodes you intend to load lazily, when the user clicks the expand button.\nIt is not necessary to set this property otherwise. If a tree item has children, the expand button will be displayed anyway.", "default": "false", + "description": "Defines whether the tree node has children, even if currently no other tree nodes are slotted inside.\n\n**Note:** This property is useful for showing big tree structures where not all nodes are initially loaded due to performance reasons.\nSet this to `true` for nodes you intend to load lazily, when the user clicks the expand button.\nIt is not necessary to set this property otherwise. If a tree item has children, the expand button will be displayed anyway.", "privacy": "public", "_ui5validator": "Boolean" }, @@ -28229,20 +28235,20 @@ } ] }, - "description": "Defines the state of the `additionalText`.\n\nAvailable options are: `\"None\"` (by default), `\"Positive\"`, `\"Critical\"`, `\"Information\"` and `\"Negative\"`.", "default": "\"None\"", + "description": "Defines the state of the `additionalText`.\n\nAvailable options are: `\"None\"` (by default), `\"Positive\"`, `\"Critical\"`, `\"Information\"` and `\"Negative\"`.", "privacy": "public", "_ui5since": "1.0.0-rc.15", - "_ui5validator": "ValueState" + "_ui5validator": "String" }, { "kind": "field", "name": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the accessible name of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.8.0", "_ui5validator": "String" @@ -28271,10 +28277,10 @@ } ] }, - "description": "Defines the visual indication and behavior of the list items.\nAvailable options are `Active` (by default), `Inactive`, `Detail` and `Navigation`.\n\n**Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and hover,\nwhile with type `Inactive` and `Detail` - will not.", "default": "\"Active\"", + "description": "Defines the visual indication and behavior of the list items.\nAvailable options are `Active` (by default), `Inactive`, `Detail` and `Navigation`.\n\n**Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and hover,\nwhile with type `Inactive` and `Detail` - will not.", "privacy": "public", - "_ui5validator": "ListItemType", + "_ui5validator": "String", "inheritedFrom": { "name": "ListItem", "module": "dist/ListItem.js" @@ -28293,8 +28299,8 @@ } ] }, - "description": "Defines the additional accessibility attributes that will be applied to the component.\nThe following fields are supported:\n\n- **ariaSetsize**: Defines the number of items in the current set when not all items in the set are present in the DOM.\n**Note:** The value is an integer reflecting the number of items in the complete set. If the size of the entire set is unknown, set `-1`.\n\n\t- **ariaPosinset**: Defines an element's number or position in the current set when not all items are present in the DOM.\n\t**Note:** The value is an integer greater than or equal to 1, and less than or equal to the size of the set when that size is known.", "default": "{}", + "description": "Defines the additional accessibility attributes that will be applied to the component.\nThe following fields are supported:\n\n- **ariaSetsize**: Defines the number of items in the current set when not all items in the set are present in the DOM.\n**Note:** The value is an integer reflecting the number of items in the complete set. If the size of the entire set is unknown, set `-1`.\n\n\t- **ariaPosinset**: Defines an element's number or position in the current set when not all items are present in the DOM.\n\t**Note:** The value is an integer greater than or equal to 1, and less than or equal to the size of the set when that size is known.", "privacy": "public", "_ui5since": "1.15.0", "_ui5validator": "Object", @@ -28309,8 +28315,8 @@ "type": { "text": "boolean" }, - "description": "The navigated state of the list item.\nIf set to `true`, a navigation indicator is displayed at the end of the list item.", "default": "false", + "description": "The navigated state of the list item.\nIf set to `true`, a navigation indicator is displayed at the end of the list item.", "privacy": "public", "_ui5since": "1.10.0", "_ui5validator": "Boolean", @@ -28323,10 +28329,10 @@ "kind": "field", "name": "tooltip", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text of the tooltip that would be displayed for the list item.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.23.0", "_ui5validator": "String", @@ -28348,11 +28354,11 @@ } ] }, - "description": "Defines the highlight state of the list items.\nAvailable options are: `\"None\"` (by default), `\"Positive\"`, `\"Critical\"`, `\"Information\"` and `\"Negative\"`.", "default": "\"None\"", + "description": "Defines the highlight state of the list items.\nAvailable options are: `\"None\"` (by default), `\"Positive\"`, `\"Critical\"`, `\"Information\"` and `\"Negative\"`.", "privacy": "public", "_ui5since": "1.24", - "_ui5validator": "Highlight", + "_ui5validator": "String", "inheritedFrom": { "name": "ListItem", "module": "dist/ListItem.js" @@ -28369,8 +28375,8 @@ "privacy": "public", "_ui5validator": "Boolean", "inheritedFrom": { - "name": "ListItemBase", - "module": "dist/ListItemBase.js" + "name": "ListItem", + "module": "dist/ListItem.js" } } ], @@ -28378,10 +28384,10 @@ { "description": "If set, an icon will be displayed before the text of the tree list item.", "name": "icon", - "default": "\"\"", + "default": "undefined", "fieldName": "icon", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -28432,10 +28438,10 @@ { "description": "Defines the accessible name of the component.", "name": "accessible-name", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" } }, { @@ -28467,10 +28473,10 @@ { "description": "Defines the text of the tooltip that would be displayed for the list item.", "name": "tooltip", - "default": "\"\"", + "default": "undefined", "fieldName": "tooltip", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "ListItem", @@ -28499,8 +28505,8 @@ "text": "boolean" }, "inheritedFrom": { - "name": "ListItemBase", - "module": "dist/ListItemBase.js" + "name": "ListItem", + "module": "dist/ListItem.js" } } ], @@ -28610,20 +28616,20 @@ "type": { "text": "boolean" }, + "default": "false", "description": "Defines whether the tree list item should display the selection element.", "privacy": "public", - "default": "false", "_ui5validator": "Boolean" }, { "kind": "field", "name": "icon", "type": { - "text": "string" + "text": "string | undefined" }, "description": "If set, an icon will be displayed before the text of the tree list item.", "privacy": "public", - "default": "\"\"", + "default": "undefined", "_ui5validator": "String", "inheritedFrom": { "name": "TreeItemBase", @@ -28636,8 +28642,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the tree list item will show a collapse or expand icon inside its toggle button.", "default": "false", + "description": "Defines whether the tree list item will show a collapse or expand icon inside its toggle button.", "privacy": "public", "_ui5validator": "Boolean", "inheritedFrom": { @@ -28683,8 +28689,8 @@ "type": { "text": "boolean" }, - "description": "Defines whether the tree node has children, even if currently no other tree nodes are slotted inside.\n\n**Note:** This property is useful for showing big tree structures where not all nodes are initially loaded due to performance reasons.\nSet this to `true` for nodes you intend to load lazily, when the user clicks the expand button.\nIt is not necessary to set this property otherwise. If a tree item has children, the expand button will be displayed anyway.", "default": "false", + "description": "Defines whether the tree node has children, even if currently no other tree nodes are slotted inside.\n\n**Note:** This property is useful for showing big tree structures where not all nodes are initially loaded due to performance reasons.\nSet this to `true` for nodes you intend to load lazily, when the user clicks the expand button.\nIt is not necessary to set this property otherwise. If a tree item has children, the expand button will be displayed anyway.", "privacy": "public", "_ui5validator": "Boolean", "inheritedFrom": { @@ -28705,11 +28711,11 @@ } ] }, - "description": "Defines the state of the `additionalText`.\n\nAvailable options are: `\"None\"` (by default), `\"Positive\"`, `\"Critical\"`, `\"Information\"` and `\"Negative\"`.", "default": "\"None\"", + "description": "Defines the state of the `additionalText`.\n\nAvailable options are: `\"None\"` (by default), `\"Positive\"`, `\"Critical\"`, `\"Information\"` and `\"Negative\"`.", "privacy": "public", "_ui5since": "1.0.0-rc.15", - "_ui5validator": "ValueState", + "_ui5validator": "String", "inheritedFrom": { "name": "TreeItemBase", "module": "dist/TreeItemBase.js" @@ -28719,10 +28725,10 @@ "kind": "field", "name": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the accessible name of the component.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.8.0", "_ui5validator": "String", @@ -28759,10 +28765,10 @@ } ] }, - "description": "Defines the visual indication and behavior of the list items.\nAvailable options are `Active` (by default), `Inactive`, `Detail` and `Navigation`.\n\n**Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and hover,\nwhile with type `Inactive` and `Detail` - will not.", "default": "\"Active\"", + "description": "Defines the visual indication and behavior of the list items.\nAvailable options are `Active` (by default), `Inactive`, `Detail` and `Navigation`.\n\n**Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and hover,\nwhile with type `Inactive` and `Detail` - will not.", "privacy": "public", - "_ui5validator": "ListItemType", + "_ui5validator": "String", "inheritedFrom": { "name": "ListItem", "module": "dist/ListItem.js" @@ -28781,8 +28787,8 @@ } ] }, - "description": "Defines the additional accessibility attributes that will be applied to the component.\nThe following fields are supported:\n\n- **ariaSetsize**: Defines the number of items in the current set when not all items in the set are present in the DOM.\n**Note:** The value is an integer reflecting the number of items in the complete set. If the size of the entire set is unknown, set `-1`.\n\n\t- **ariaPosinset**: Defines an element's number or position in the current set when not all items are present in the DOM.\n\t**Note:** The value is an integer greater than or equal to 1, and less than or equal to the size of the set when that size is known.", "default": "{}", + "description": "Defines the additional accessibility attributes that will be applied to the component.\nThe following fields are supported:\n\n- **ariaSetsize**: Defines the number of items in the current set when not all items in the set are present in the DOM.\n**Note:** The value is an integer reflecting the number of items in the complete set. If the size of the entire set is unknown, set `-1`.\n\n\t- **ariaPosinset**: Defines an element's number or position in the current set when not all items are present in the DOM.\n\t**Note:** The value is an integer greater than or equal to 1, and less than or equal to the size of the set when that size is known.", "privacy": "public", "_ui5since": "1.15.0", "_ui5validator": "Object", @@ -28797,8 +28803,8 @@ "type": { "text": "boolean" }, - "description": "The navigated state of the list item.\nIf set to `true`, a navigation indicator is displayed at the end of the list item.", "default": "false", + "description": "The navigated state of the list item.\nIf set to `true`, a navigation indicator is displayed at the end of the list item.", "privacy": "public", "_ui5since": "1.10.0", "_ui5validator": "Boolean", @@ -28811,10 +28817,10 @@ "kind": "field", "name": "tooltip", "type": { - "text": "string" + "text": "string | undefined" }, "description": "Defines the text of the tooltip that would be displayed for the list item.", - "default": "\"\"", + "default": "undefined", "privacy": "public", "_ui5since": "1.23.0", "_ui5validator": "String", @@ -28836,11 +28842,11 @@ } ] }, - "description": "Defines the highlight state of the list items.\nAvailable options are: `\"None\"` (by default), `\"Positive\"`, `\"Critical\"`, `\"Information\"` and `\"Negative\"`.", "default": "\"None\"", + "description": "Defines the highlight state of the list items.\nAvailable options are: `\"None\"` (by default), `\"Positive\"`, `\"Critical\"`, `\"Information\"` and `\"Negative\"`.", "privacy": "public", "_ui5since": "1.24", - "_ui5validator": "Highlight", + "_ui5validator": "String", "inheritedFrom": { "name": "ListItem", "module": "dist/ListItem.js" @@ -28857,8 +28863,8 @@ "privacy": "public", "_ui5validator": "Boolean", "inheritedFrom": { - "name": "ListItemBase", - "module": "dist/ListItemBase.js" + "name": "ListItem", + "module": "dist/ListItem.js" } } ], @@ -28875,10 +28881,10 @@ { "description": "If set, an icon will be displayed before the text of the tree list item.", "name": "icon", - "default": "\"\"", + "default": "undefined", "fieldName": "icon", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "TreeItemBase", @@ -28953,10 +28959,10 @@ { "description": "Defines the accessible name of the component.", "name": "accessible-name", - "default": "\"\"", + "default": "undefined", "fieldName": "accessibleName", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "TreeItemBase", @@ -28992,10 +28998,10 @@ { "description": "Defines the text of the tooltip that would be displayed for the list item.", "name": "tooltip", - "default": "\"\"", + "default": "undefined", "fieldName": "tooltip", "type": { - "text": "string" + "text": "string | undefined" }, "inheritedFrom": { "name": "ListItem", @@ -29024,8 +29030,8 @@ "text": "boolean" }, "inheritedFrom": { - "name": "ListItemBase", - "module": "dist/ListItemBase.js" + "name": "ListItem", + "module": "dist/ListItem.js" } } ], diff --git a/packages/cli/src/scripts/codemod/transforms/v2/codemodConfig.json b/packages/cli/src/scripts/codemod/transforms/v2/codemodConfig.json index ba330927254..76141b9ba14 100644 --- a/packages/cli/src/scripts/codemod/transforms/v2/codemodConfig.json +++ b/packages/cli/src/scripts/codemod/transforms/v2/codemodConfig.json @@ -78,7 +78,10 @@ } }, "ComboBoxGroupItem": { - "newComponent": "ComboBoxItemGroup" + "newComponent": "ComboBoxItemGroup", + "changedProps": { + "text": "headerText" + } }, "CustomListItem": { "newComponent": "ListItemCustom", @@ -118,6 +121,11 @@ }, "FilterItem": {}, "FilterItemOption": {}, + "FlexibleColumnLayout": { + "changedProps": { + "hideArrows": "disableResizing" + } + }, "Form": { "comment": "merge labelSpan and columns props", "changedProps": { @@ -211,7 +219,8 @@ "changedProps": { "busy": "loading", "busyDelay": "loadingDelay" - } + }, + "removedProps": ["startsSection"] }, "MessageItem": { "renamedEnums": { @@ -239,13 +248,15 @@ "MultiComboBoxGroupItem": { "newComponent": "MultiComboBoxItemGroup", "changedProps": { - "onOpenChange": "onOpen" + "onOpenChange": "onOpen", + "text": "headerText" } }, "MultiComboBoxItem": {}, "MultiComboBoxItemGroup": { "changedProps": { - "onOpenChange": "onOpen" + "onOpenChange": "onOpen", + "text": "headerText" } }, "MultiInput": { @@ -263,7 +274,7 @@ "busy": "loading", "busyDelay": "loadingDelay" }, - "removedProps": ["actions", "priority", "showClose", "showCounter"] + "removedProps": ["actions", "priority", "showClose", "showCounter", "selected"] }, "NotificationListItem": { "changedProps": { @@ -271,7 +282,8 @@ "busyDelay": "loadingDelay", "actions": "menu", "priority": "importance" - } + }, + "removedProps": ["selected"] }, "ObjectStatus": { "renamedEnums": { @@ -549,14 +561,14 @@ "FCLLayout": "@ui5/webcomponents-fiori/dist/types/FCLLayout.js", "HighlightTypes": "@ui5/webcomponents/dist/types/Highlight.js", "IconDesign": "@ui5/webcomponents/dist/types/IconDesign.js", - "IllustrationMessageSize": "@ui5/webcomponents-fiori/dist/types/IllustrationMessageSize.js", + "IllustrationMessageSize": "@ui5/webcomponents-fiori/dist/types/IllustrationMessageDesign.js", "IllustrationMessageType": "@ui5/webcomponents-fiori/dist/types/IllustrationMessageType.js", "InputType": "@ui5/webcomponents/dist/types/InputType.js", "LinkDesign": "@ui5/webcomponents/dist/types/LinkDesign.js", "ListItemType": "@ui5/webcomponents/dist/types/ListItemType.js", "ListMode": "@ui5/webcomponents/dist/types/ListSelectionMode.js", "ListGrowingMode": "@ui5/webcomponents/dist/types/ListGrowingMode.js", - "ListSeparators": "@ui5/webcomponents/dist/types/ListSeparators.js", + "ListSeparators": "@ui5/webcomponents/dist/types/ListSeparator.js", "MediaGalleryItemLayout": "@ui5/webcomponents-fiori/dist/types/MediaGalleryItemLayout.js", "MediaGalleryLayout": "@ui5/webcomponents-fiori/dist/types/MediaGalleryLayout.js", "MediaGalleryMenuHorizontalAlign": "@ui5/webcomponents-fiori/dist/types/MediaGalleryMenuHorizontalAlign.js", diff --git a/packages/compat/src/components/Table/index.tsx b/packages/compat/src/components/Table/index.tsx index f15c49f881c..bf6c99909df 100644 --- a/packages/compat/src/components/Table/index.tsx +++ b/packages/compat/src/components/Table/index.tsx @@ -25,8 +25,9 @@ interface TableAttributes { * Receives id(or many ids) of the elements that label the component. * * **Note:** Available since [v2.0.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v2.0.0) of **@ui5/webcomponents-compat**. + * @default undefined */ - accessibleNameRef?: string; + accessibleNameRef?: string | undefined; /** * Defines if the table is in busy state. @@ -71,8 +72,9 @@ interface TableAttributes { * **Note:** This property takes effect if `growing` is set to `Button`. * * **Note:** Available since [v2.0.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v2.0.0) of **@ui5/webcomponents-compat**. + * @default undefined */ - growingButtonSubtext?: string; + growingButtonSubtext?: string | undefined; /** * Defines the text that will be displayed inside the growing button at the bottom of the table, @@ -83,8 +85,9 @@ interface TableAttributes { * **Note:** This property takes effect if `growing` is set to `Button`. * * **Note:** Available since [v2.0.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v2.0.0) of **@ui5/webcomponents-compat**. + * @default undefined */ - growingButtonText?: string; + growingButtonText?: string | undefined; /** * Defines if the value of `noDataText` will be diplayed when there is no rows present in the table. @@ -104,8 +107,9 @@ interface TableAttributes { /** * Defines the text that will be displayed when there is no data and `hideNoData` is not present. + * @default undefined */ - noDataText?: string; + noDataText?: string | undefined; /** * Determines whether the column headers remain fixed at the top of the page during diff --git a/packages/compat/src/components/TableColumn/index.tsx b/packages/compat/src/components/TableColumn/index.tsx index 8dcd09d0c9d..99d08846650 100644 --- a/packages/compat/src/components/TableColumn/index.tsx +++ b/packages/compat/src/components/TableColumn/index.tsx @@ -40,8 +40,9 @@ interface TableColumnAttributes { /** * The text for the column when it pops in. + * @default undefined */ - popinText?: string; + popinText?: string | undefined; } interface TableColumnDomRef extends Required, Ui5DomRef {} diff --git a/packages/main/src/webComponents/Avatar/index.tsx b/packages/main/src/webComponents/Avatar/index.tsx index 68b69e27aaa..1f6353f6182 100644 --- a/packages/main/src/webComponents/Avatar/index.tsx +++ b/packages/main/src/webComponents/Avatar/index.tsx @@ -25,8 +25,9 @@ interface AvatarAttributes { /** * Defines the text alternative of the component. * If not provided a default text alternative will be set, if present. + * @default undefined */ - accessibleName?: string; + accessibleName?: string | undefined; /** * Defines the background color of the desired image. @@ -58,6 +59,7 @@ interface AvatarAttributes { * `` * * See all the available icons in the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html). + * @default "employee" */ fallbackIcon?: string; @@ -75,15 +77,17 @@ interface AvatarAttributes { * **Note:** If no icon or an empty one is provided, by default the "employee" icon should be displayed. * * See all the available icons in the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html). + * @default undefined */ - icon?: string; + icon?: string | undefined; /** * Defines the displayed initials. * * Up to three Latin letters can be displayed as initials. + * @default undefined */ - initials?: string; + initials?: string | undefined; /** * Defines if the avatar is interactive (focusable and pressable). diff --git a/packages/main/src/webComponents/BreadcrumbsItem/index.tsx b/packages/main/src/webComponents/BreadcrumbsItem/index.tsx index 4d4b997f697..943e1f81a96 100644 --- a/packages/main/src/webComponents/BreadcrumbsItem/index.tsx +++ b/packages/main/src/webComponents/BreadcrumbsItem/index.tsx @@ -10,14 +10,15 @@ interface BreadcrumbsItemAttributes { * Defines the accessible ARIA name of the item. * @default undefined */ - accessibleName?: string; + accessibleName?: string | undefined; /** * Defines the link href. * * **Note:** Standard hyperlink behavior is supported. + * @default undefined */ - href?: string; + href?: string | undefined; /** * Defines the link target. diff --git a/packages/main/src/webComponents/BusyIndicator/index.tsx b/packages/main/src/webComponents/BusyIndicator/index.tsx index 3a0d1a822ee..f7dc9bf42ad 100644 --- a/packages/main/src/webComponents/BusyIndicator/index.tsx +++ b/packages/main/src/webComponents/BusyIndicator/index.tsx @@ -28,8 +28,9 @@ interface BusyIndicatorAttributes { /** * Defines text to be displayed below the component. It can be used to inform the user of the current operation. + * @default undefined */ - text?: string; + text?: string | undefined; /** * Defines the placement of the text. diff --git a/packages/main/src/webComponents/Button/index.tsx b/packages/main/src/webComponents/Button/index.tsx index 4f892792d8f..dcaf29a1b4b 100644 --- a/packages/main/src/webComponents/Button/index.tsx +++ b/packages/main/src/webComponents/Button/index.tsx @@ -38,8 +38,9 @@ interface ButtonAttributes { * Receives id(or many ids) of the elements that label the component. * * **Note:** Available since [v1.1.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.1.0) of **@ui5/webcomponents**. + * @default undefined */ - accessibleNameRef?: string; + accessibleNameRef?: string | undefined; /** * Describes the accessibility role of the button. @@ -75,8 +76,9 @@ interface ButtonAttributes { * * Example: * See all the available icons within the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html). + * @default undefined */ - endIcon?: string; + endIcon?: string | undefined; /** * Defines the icon, displayed as graphical element within the component. @@ -84,8 +86,9 @@ interface ButtonAttributes { * * Example: * See all the available icons within the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html). + * @default undefined */ - icon?: string; + icon?: string | undefined; /** * When set to `true`, the component will @@ -103,8 +106,9 @@ interface ButtonAttributes { * **Note:** A tooltip attribute should be provided for icon-only buttons, in order to represent their exact meaning/function. * * **Note:** Available since [v1.2.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.2.0) of **@ui5/webcomponents**. + * @default undefined */ - tooltip?: string; + tooltip?: string | undefined; /** * Defines whether the button has special form-related functionality. diff --git a/packages/main/src/webComponents/Calendar/index.tsx b/packages/main/src/webComponents/Calendar/index.tsx index 0fc06bbfb8e..f707f13253e 100644 --- a/packages/main/src/webComponents/Calendar/index.tsx +++ b/packages/main/src/webComponents/Calendar/index.tsx @@ -11,8 +11,9 @@ import type { CommonProps, Ui5CustomEvent, Ui5DomRef, UI5WCSlotsNode } from '../ interface CalendarAttributes { /** * Determines the format, displayed in the input field. + * @default undefined */ - formatPattern?: string; + formatPattern?: string | undefined; /** * Defines the visibility of the week numbers column. @@ -83,7 +84,8 @@ interface CalendarPropTypes /** * Defines the selected date or dates (depending on the `selectionMode` property) - * for this calendar as instances of `CalendarDate`. + * for this calendar as instances of `CalendarDate` or `CalendarDateRange`. + * Use `CalendarDate` for single or multiple selection, and `CalendarDateRange` for range selection. */ children?: ReactNode | ReactNode[]; diff --git a/packages/main/src/webComponents/CalendarLegendItem/index.tsx b/packages/main/src/webComponents/CalendarLegendItem/index.tsx index b912e4a1b19..df3a5aeee91 100644 --- a/packages/main/src/webComponents/CalendarLegendItem/index.tsx +++ b/packages/main/src/webComponents/CalendarLegendItem/index.tsx @@ -8,8 +8,9 @@ import type { CommonProps, Ui5DomRef } from '../../types/index.js'; interface CalendarLegendItemAttributes { /** * Defines the text content of the Calendar Legend Item. + * @default undefined */ - text?: string; + text?: string | undefined; /** * Defines the type of the Calendar Legend Item. diff --git a/packages/main/src/webComponents/Card/index.tsx b/packages/main/src/webComponents/Card/index.tsx index ea86b108fda..43f6317ff69 100644 --- a/packages/main/src/webComponents/Card/index.tsx +++ b/packages/main/src/webComponents/Card/index.tsx @@ -10,13 +10,15 @@ interface CardAttributes { * Defines the accessible name of the component, which is used as the name of the card region and should be unique per card. * * **Note:** `accessibleName` should be always set, unless `accessibleNameRef` is set. + * @default undefined */ - accessibleName?: string; + accessibleName?: string | undefined; /** * Defines the IDs of the elements that label the component. + * @default undefined */ - accessibleNameRef?: string; + accessibleNameRef?: string | undefined; } interface CardDomRef extends Required, Ui5DomRef {} diff --git a/packages/main/src/webComponents/CardHeader/index.tsx b/packages/main/src/webComponents/CardHeader/index.tsx index f1b79265272..b78b83e8c4b 100644 --- a/packages/main/src/webComponents/CardHeader/index.tsx +++ b/packages/main/src/webComponents/CardHeader/index.tsx @@ -7,8 +7,9 @@ import type { CommonProps, Ui5CustomEvent, Ui5DomRef, UI5WCSlotsNode } from '../ interface CardHeaderAttributes { /** * Defines the additional text. + * @default undefined */ - additionalText?: string; + additionalText?: string | undefined; /** * Defines if the component would be interactive, @@ -19,13 +20,15 @@ interface CardHeaderAttributes { /** * Defines the subtitle text. + * @default undefined */ - subtitleText?: string; + subtitleText?: string | undefined; /** * Defines the title text. + * @default undefined */ - titleText?: string; + titleText?: string | undefined; } interface CardHeaderDomRef extends Required, Ui5DomRef {} diff --git a/packages/main/src/webComponents/Carousel/index.tsx b/packages/main/src/webComponents/Carousel/index.tsx index 96df9b2c785..476462c8aa5 100644 --- a/packages/main/src/webComponents/Carousel/index.tsx +++ b/packages/main/src/webComponents/Carousel/index.tsx @@ -15,15 +15,17 @@ interface CarouselAttributes { * Defines the accessible name of the component. * * **Note:** Available since [v1.24](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.24) of **@ui5/webcomponents**. + * @default undefined */ - accessibleName?: string; + accessibleName?: string | undefined; /** * Defines the IDs of the elements that label the input. * * **Note:** Available since [v1.24](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.24) of **@ui5/webcomponents**. + * @default undefined */ - accessibleNameRef?: string; + accessibleNameRef?: string | undefined; /** * Defines the position of arrows. diff --git a/packages/main/src/webComponents/CheckBox/index.tsx b/packages/main/src/webComponents/CheckBox/index.tsx index ab2466b4999..66fda0dd13f 100644 --- a/packages/main/src/webComponents/CheckBox/index.tsx +++ b/packages/main/src/webComponents/CheckBox/index.tsx @@ -11,15 +11,17 @@ interface CheckBoxAttributes { * Defines the accessible ARIA name of the component. * * **Note:** Available since [v1.1.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.1.0) of **@ui5/webcomponents**. + * @default undefined */ - accessibleName?: string; + accessibleName?: string | undefined; /** * Receives id(or many ids) of the elements that label the component * * **Note:** Available since [v1.1.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.1.0) of **@ui5/webcomponents**. + * @default undefined */ - accessibleNameRef?: string; + accessibleNameRef?: string | undefined; /** * Defines if the component is checked. @@ -70,8 +72,9 @@ interface CheckBoxAttributes { * Determines the name by which the component will be identified upon submission in an HTML form. * * **Note:** This property is only applicable within the context of an HTML Form element. + * @default undefined */ - name?: string; + name?: string | undefined; /** * Defines whether the component is read-only. @@ -92,8 +95,9 @@ interface CheckBoxAttributes { /** * Defines the text of the component. + * @default undefined */ - text?: string; + text?: string | undefined; /** * Defines the value state of the component. diff --git a/packages/main/src/webComponents/ColorPaletteItem/index.tsx b/packages/main/src/webComponents/ColorPaletteItem/index.tsx index 43e6143371a..faa3e6b434b 100644 --- a/packages/main/src/webComponents/ColorPaletteItem/index.tsx +++ b/packages/main/src/webComponents/ColorPaletteItem/index.tsx @@ -1,7 +1,6 @@ 'use client'; import '@ui5/webcomponents/dist/ColorPaletteItem.js'; -import type { CSSProperties } from 'react'; import { withWebComponent } from '../../internal/withWebComponent.js'; import type { CommonProps, Ui5DomRef } from '../../types/index.js'; @@ -21,9 +20,8 @@ interface ColorPaletteItemAttributes { * Defines the colour of the component. * * **Note:** The value should be a valid CSS color. - * @default undefined */ - value?: CSSProperties['color']; + value?: string; } interface ColorPaletteItemDomRef extends Required, Ui5DomRef {} diff --git a/packages/main/src/webComponents/ColorPalettePopover/index.tsx b/packages/main/src/webComponents/ColorPalettePopover/index.tsx index 1687819ff42..7d25d09ff62 100644 --- a/packages/main/src/webComponents/ColorPalettePopover/index.tsx +++ b/packages/main/src/webComponents/ColorPalettePopover/index.tsx @@ -2,7 +2,7 @@ import '@ui5/webcomponents/dist/ColorPalettePopover.js'; import type { ColorPalettePopoverItemClickEventDetail } from '@ui5/webcomponents/dist/ColorPalettePopover.js'; -import type { CSSProperties, ReactNode } from 'react'; +import type { ReactNode } from 'react'; import { withWebComponent } from '../../internal/withWebComponent.js'; import type { CommonProps, Ui5CustomEvent, Ui5DomRef } from '../../types/index.js'; @@ -13,7 +13,7 @@ interface ColorPalettePopoverAttributes { * **Note:** The default color should be a part of the ColorPalette colors` * @default undefined */ - defaultColor?: CSSProperties['color']; + defaultColor?: string | undefined; /** * Defines the open | closed state of the popover. diff --git a/packages/main/src/webComponents/ColorPicker/index.tsx b/packages/main/src/webComponents/ColorPicker/index.tsx index 6d2bcbbc1e9..fd24af638d0 100644 --- a/packages/main/src/webComponents/ColorPicker/index.tsx +++ b/packages/main/src/webComponents/ColorPicker/index.tsx @@ -1,7 +1,6 @@ 'use client'; import '@ui5/webcomponents/dist/ColorPicker.js'; -import type { CSSProperties } from 'react'; import { withWebComponent } from '../../internal/withWebComponent.js'; import type { CommonProps, Ui5CustomEvent, Ui5DomRef } from '../../types/index.js'; @@ -12,16 +11,17 @@ interface ColorPickerAttributes { * **Note:** This property is only applicable within the context of an HTML Form element. * * **Note:** Available since [v2.0.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v2.0.0) of **@ui5/webcomponents**. + * @default undefined */ - name?: string; + name?: string | undefined; /** * Defines the currently selected color of the component. * * **Note**: use HEX, RGB, RGBA, HSV formats or a CSS color name when modifying this property. - * @default "rgba(255, 255, 255, 1)" + * @default "rgba(255,255,255,1)" */ - value?: CSSProperties['color']; + value?: string; } interface ColorPickerDomRef extends Required, Ui5DomRef {} diff --git a/packages/main/src/webComponents/ComboBox/index.tsx b/packages/main/src/webComponents/ComboBox/index.tsx index 13a42c8cf78..0e58f551b76 100644 --- a/packages/main/src/webComponents/ComboBox/index.tsx +++ b/packages/main/src/webComponents/ComboBox/index.tsx @@ -11,13 +11,15 @@ import type { CommonProps, Ui5CustomEvent, Ui5DomRef, UI5WCSlotsNode } from '../ interface ComboBoxAttributes { /** * Defines the accessible ARIA name of the component. + * @default undefined */ - accessibleName?: string; + accessibleName?: string | undefined; /** * Receives id(or many ids) of the elements that label the component + * @default undefined */ - accessibleNameRef?: string; + accessibleNameRef?: string | undefined; /** * Defines whether the component is in disabled state. @@ -45,8 +47,9 @@ interface ComboBoxAttributes { * **Note:** This property is only applicable within the context of an HTML Form element. * * **Note:** Available since [v2.0.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v2.0.0) of **@ui5/webcomponents**. + * @default undefined */ - name?: string; + name?: string | undefined; /** * Defines whether the value will be autocompleted to match an item @@ -59,8 +62,9 @@ interface ComboBoxAttributes { /** * Defines a short hint intended to aid the user with data entry when the * component has no value. + * @default undefined */ - placeholder?: string; + placeholder?: string | undefined; /** * Defines whether the component is read-only. diff --git a/packages/main/src/webComponents/ComboBoxItem/index.tsx b/packages/main/src/webComponents/ComboBoxItem/index.tsx index 3d58d85227f..54c7879e917 100644 --- a/packages/main/src/webComponents/ComboBoxItem/index.tsx +++ b/packages/main/src/webComponents/ComboBoxItem/index.tsx @@ -7,13 +7,15 @@ import type { CommonProps, Ui5DomRef } from '../../types/index.js'; interface ComboBoxItemAttributes { /** * Defines the additional text of the component. + * @default undefined */ - additionalText?: string; + additionalText?: string | undefined; /** * Defines the text of the component. + * @default undefined */ - text?: string; + text?: string | undefined; } interface ComboBoxItemDomRef extends Required, Ui5DomRef {} diff --git a/packages/main/src/webComponents/ComboBoxItemGroup/index.tsx b/packages/main/src/webComponents/ComboBoxItemGroup/index.tsx index 7263ccdfe35..6b20e0e446c 100644 --- a/packages/main/src/webComponents/ComboBoxItemGroup/index.tsx +++ b/packages/main/src/webComponents/ComboBoxItemGroup/index.tsx @@ -8,8 +8,9 @@ import type { CommonProps, Ui5DomRef } from '../../types/index.js'; interface ComboBoxItemGroupAttributes { /** * Defines the text of the component. + * @default undefined */ - text?: string; + headerText?: string | undefined; } interface ComboBoxItemGroupDomRef extends Required, Ui5DomRef {} @@ -32,7 +33,7 @@ interface ComboBoxItemGroupPropTypes */ const ComboBoxItemGroup = withWebComponent( 'ui5-cb-item-group', - ['text'], + ['headerText'], [], [], [], diff --git a/packages/main/src/webComponents/DatePicker/index.tsx b/packages/main/src/webComponents/DatePicker/index.tsx index 074bb7971cc..2b061a0c57c 100644 --- a/packages/main/src/webComponents/DatePicker/index.tsx +++ b/packages/main/src/webComponents/DatePicker/index.tsx @@ -14,13 +14,15 @@ import type { CommonProps, Ui5CustomEvent, Ui5DomRef, UI5WCSlotsNode } from '../ interface DatePickerAttributes { /** * Defines the aria-label attribute for the component. + * @default undefined */ - accessibleName?: string; + accessibleName?: string | undefined; /** * Receives id(or many ids) of the elements that label the component. + * @default undefined */ - accessibleNameRef?: string; + accessibleNameRef?: string | undefined; /** * Determines whether the component is displayed as disabled. @@ -30,8 +32,9 @@ interface DatePickerAttributes { /** * Determines the format, displayed in the input field. + * @default undefined */ - formatPattern?: string; + formatPattern?: string | undefined; /** * Defines the visibility of the week numbers column. @@ -60,8 +63,9 @@ interface DatePickerAttributes { * Determines the name by which the component will be identified upon submission in an HTML form. * * **Note:** This property is only applicable within the context of an HTML Form element. + * @default undefined */ - name?: string; + name?: string | undefined; /** * Defines the open or closed state of the popover. diff --git a/packages/main/src/webComponents/DateRangePicker/index.tsx b/packages/main/src/webComponents/DateRangePicker/index.tsx index aa6eb9e9609..d7da364f4ea 100644 --- a/packages/main/src/webComponents/DateRangePicker/index.tsx +++ b/packages/main/src/webComponents/DateRangePicker/index.tsx @@ -14,20 +14,22 @@ import type { CommonProps, Ui5CustomEvent, Ui5DomRef, UI5WCSlotsNode } from '../ interface DateRangePickerAttributes { /** * Defines the aria-label attribute for the component. + * @default undefined */ - accessibleName?: string; + accessibleName?: string | undefined; /** * Receives id(or many ids) of the elements that label the component. + * @default undefined */ - accessibleNameRef?: string; + accessibleNameRef?: string | undefined; /** * Determines the symbol which separates the dates. * If not supplied, the default time interval delimiter for the current locale will be used. * @default "-" */ - delimiter?: string; + delimiter?: unknown; /** * Determines whether the component is displayed as disabled. @@ -37,8 +39,9 @@ interface DateRangePickerAttributes { /** * Determines the format, displayed in the input field. + * @default undefined */ - formatPattern?: string; + formatPattern?: string | undefined; /** * Defines the visibility of the week numbers column. @@ -67,8 +70,9 @@ interface DateRangePickerAttributes { * Determines the name by which the component will be identified upon submission in an HTML form. * * **Note:** This property is only applicable within the context of an HTML Form element. + * @default undefined */ - name?: string; + name?: string | undefined; /** * Defines the open or closed state of the popover. diff --git a/packages/main/src/webComponents/DateTimePicker/index.tsx b/packages/main/src/webComponents/DateTimePicker/index.tsx index 5344dab5ba3..b0f0d1fa7b2 100644 --- a/packages/main/src/webComponents/DateTimePicker/index.tsx +++ b/packages/main/src/webComponents/DateTimePicker/index.tsx @@ -14,13 +14,15 @@ import type { CommonProps, Ui5CustomEvent, Ui5DomRef, UI5WCSlotsNode } from '../ interface DateTimePickerAttributes { /** * Defines the aria-label attribute for the component. + * @default undefined */ - accessibleName?: string; + accessibleName?: string | undefined; /** * Receives id(or many ids) of the elements that label the component. + * @default undefined */ - accessibleNameRef?: string; + accessibleNameRef?: string | undefined; /** * Determines whether the component is displayed as disabled. @@ -30,8 +32,9 @@ interface DateTimePickerAttributes { /** * Determines the format, displayed in the input field. + * @default undefined */ - formatPattern?: string; + formatPattern?: string | undefined; /** * Defines the visibility of the week numbers column. @@ -60,8 +63,9 @@ interface DateTimePickerAttributes { * Determines the name by which the component will be identified upon submission in an HTML form. * * **Note:** This property is only applicable within the context of an HTML Form element. + * @default undefined */ - name?: string; + name?: string | undefined; /** * Defines the open or closed state of the popover. diff --git a/packages/main/src/webComponents/Dialog/index.tsx b/packages/main/src/webComponents/Dialog/index.tsx index cd095319303..b6c640bfdfe 100644 --- a/packages/main/src/webComponents/Dialog/index.tsx +++ b/packages/main/src/webComponents/Dialog/index.tsx @@ -19,8 +19,9 @@ interface DialogAttributes { * Defines the IDs of the elements that label the component. * * **Note:** Available since [v1.1.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.1.0) of **@ui5/webcomponents**. + * @default undefined */ - accessibleNameRef?: string; + accessibleNameRef?: string | undefined; /** * Allows setting a custom role. @@ -47,16 +48,18 @@ interface DialogAttributes { * Defines the header text. * * **Note:** If `header` slot is provided, the `headerText` is ignored. + * @default undefined */ - headerText?: string; + headerText?: string | undefined; /** * Defines the ID of the HTML Element, which will get the initial focus. * * **Note:** If an element with `autofocus` attribute is added inside the component, * `initialFocus` won't take effect. + * @default undefined */ - initialFocus?: string; + initialFocus?: string | undefined; /** * Indicates if the element is open diff --git a/packages/main/src/webComponents/FileUploader/index.tsx b/packages/main/src/webComponents/FileUploader/index.tsx index ee4d359c133..8cd996ee6b8 100644 --- a/packages/main/src/webComponents/FileUploader/index.tsx +++ b/packages/main/src/webComponents/FileUploader/index.tsx @@ -13,7 +13,7 @@ interface FileUploaderAttributes { * * **Note:** Please make sure you are adding the `.` in front on the file type, e.g. `.png` in case you want to accept png's only. */ - accept?: string; + accept?: string | undefined; /** * Defines whether the component is in disabled state. @@ -39,13 +39,15 @@ interface FileUploaderAttributes { * Determines the name by which the component will be identified upon submission in an HTML form. * * **Note:** This property is only applicable within the context of an HTML Form element. + * @default undefined */ - name?: string; + name?: string | undefined; /** * Defines a short hint intended to aid the user with data entry when the component has no value. + * @default undefined */ - placeholder?: string; + placeholder?: string | undefined; /** * Defines the name/names of the file/files to upload. diff --git a/packages/main/src/webComponents/FilterItem/index.tsx b/packages/main/src/webComponents/FilterItem/index.tsx index 46e073369bb..79ea6d28356 100644 --- a/packages/main/src/webComponents/FilterItem/index.tsx +++ b/packages/main/src/webComponents/FilterItem/index.tsx @@ -7,13 +7,15 @@ import type { CommonProps, Ui5DomRef, UI5WCSlotsNode } from '../../types/index.j interface FilterItemAttributes { /** * Defines the additional text of the component. + * @default undefined */ - additionalText?: string; + additionalText?: string | undefined; /** * Defines the text of the component. + * @default undefined */ - text?: string; + text?: string | undefined; } interface FilterItemDomRef extends Required, Ui5DomRef {} diff --git a/packages/main/src/webComponents/FilterItemOption/index.tsx b/packages/main/src/webComponents/FilterItemOption/index.tsx index 6df01ecbd35..eed69dc27e2 100644 --- a/packages/main/src/webComponents/FilterItemOption/index.tsx +++ b/packages/main/src/webComponents/FilterItemOption/index.tsx @@ -13,8 +13,9 @@ interface FilterItemOptionAttributes { /** * Defines the text of the component. + * @default undefined */ - text?: string; + text?: string | undefined; } interface FilterItemOptionDomRef extends Required, Ui5DomRef {} diff --git a/packages/main/src/webComponents/FlexibleColumnLayout/index.tsx b/packages/main/src/webComponents/FlexibleColumnLayout/index.tsx index cb3224170fc..9eed287d4c1 100644 --- a/packages/main/src/webComponents/FlexibleColumnLayout/index.tsx +++ b/packages/main/src/webComponents/FlexibleColumnLayout/index.tsx @@ -20,12 +20,8 @@ interface FlexibleColumnLayoutAttributes { * - **startColumn**: `startColumn.role` and `startColumn.name`. * - **midColumn**: `midColumn.role` and `midColumn.name`. * - **endColumn**: `endColumn.role` and `endColumn.name`. - * - **startArrowContainer**: `startArrowContainer.role` and `startArrowContainer.name`. - * - **endArrowContainer**: `endArrowContainerrole.role` and `endArrowContainer.name`. - * - **startArrowLeft**: `startArrowLeft.name`. - * - **startArrowRight**: `startArrowRight.name`. - * - **endArrowLeft**: `endArrowLeft.name`. - * - **endArrowRight**: `endArrowRight.name`. + * - **startSeparator**: `startSeparator.role` and `startSeparator.name`. + * - **endSeparator**: `endSeparator.role` and `endSeparator.name`. * * The accessibility attributes support the following values: * @@ -41,11 +37,12 @@ interface FlexibleColumnLayoutAttributes { accessibilityAttributes?: FCLAccessibilityAttributes; /** - * Defines the visibility of the arrows, - * used for expanding and shrinking the columns. + * Specifies if the user is allowed to change the columns layout by dragging the separator between the columns. + * + * **Note:** Available since [v2.0.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v2.0.0) of **@ui5/webcomponents-fiori**. * @default false */ - hideArrows?: boolean; + disableResizing?: boolean; /** * Defines the columns layout and their proportion. @@ -129,7 +126,7 @@ interface FlexibleColumnLayoutPropTypes */ startColumn?: UI5WCSlotsNode; /** - * Fired when the layout changes via user interaction by clicking the arrows + * Fired when the layout changes via user interaction by dragging the separators * or by changing the component size due to resizing. */ onLayoutChange?: ( @@ -139,7 +136,7 @@ interface FlexibleColumnLayoutPropTypes /** * The `FlexibleColumnLayout` implements the list-detail-detail paradigm by displaying up to three pages in separate columns. - * There are several possible layouts that can be changed either with the component API, or by pressing the arrows, displayed between the columns. + * There are several possible layouts that can be changed either with the component API, or by dragging the column separators. * * ### Usage * @@ -152,11 +149,19 @@ interface FlexibleColumnLayoutPropTypes * The component would display 1 column for window size smaller than 599px, up to two columns between 599px and 1023px, * and 3 columns for sizes bigger than 1023px. * + * **Note:** When the component displays more than one column, the minimal width of each column is 312px. Consequently, when the user drags a column separator to resize the columns, the minimal allowed width of any resized column is 312px. + * * ### Keyboard Handling * * #### Basic Navigation * - * - [Space] / [Enter] or [Return] - If focus is on the layout toggle button (arrow button), once activated, it triggers the associated action (such as expand/collapse the column). + * When a column separator is focused, the following keyboard + * shortcuts allow the user to resize the columns and change the layout: + * + * - [Shift] + [Left] or [Shift] + [Right] - Moves the separator to the left or right, which resizes the columns accordingly. + * - [Left] or [Right] - Moves the separator to the left or right with a bigger step, which resizes the columns accordingly. + * - [Home] - Moves the separator to the start position. + * - [End] - Moves the separator to the end position. * - This 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]. * In order to use this functionality, you need to import the following module: * `import "@ui5/webcomponents-base/dist/features/F6Navigation.js"` @@ -173,7 +178,7 @@ interface FlexibleColumnLayoutPropTypes const FlexibleColumnLayout = withWebComponent( 'ui5-flexible-column-layout', ['accessibilityAttributes', 'layout'], - ['hideArrows'], + ['disableResizing'], ['endColumn', 'midColumn', 'startColumn'], ['layout-change'], () => import('@ui5/webcomponents-fiori/dist/FlexibleColumnLayout.js') diff --git a/packages/main/src/webComponents/Form/index.tsx b/packages/main/src/webComponents/Form/index.tsx index 4752976dec5..746c263ee8f 100644 --- a/packages/main/src/webComponents/Form/index.tsx +++ b/packages/main/src/webComponents/Form/index.tsx @@ -11,8 +11,9 @@ interface FormAttributes { * Defines the header text of the component. * * **Note:** The property gets overridden by the `header` slot. + * @default undefined */ - headerText?: string; + headerText?: string | undefined; /** * Defines the vertical spacing between form items. diff --git a/packages/main/src/webComponents/FormGroup/index.tsx b/packages/main/src/webComponents/FormGroup/index.tsx index b49b00ddaeb..40e4eb63ac0 100644 --- a/packages/main/src/webComponents/FormGroup/index.tsx +++ b/packages/main/src/webComponents/FormGroup/index.tsx @@ -15,8 +15,9 @@ interface FormGroupAttributes { /** * Defines header text of the component. + * @default undefined */ - headerText?: string; + headerText?: string | undefined; } interface FormGroupDomRef extends Required, Ui5DomRef {} diff --git a/packages/main/src/webComponents/Icon/index.tsx b/packages/main/src/webComponents/Icon/index.tsx index e0be33419ca..7f3fc907209 100644 --- a/packages/main/src/webComponents/Icon/index.tsx +++ b/packages/main/src/webComponents/Icon/index.tsx @@ -13,8 +13,9 @@ interface IconAttributes { * * **Note:** Every icon should have a text alternative in order to * calculate its accessible name. + * @default undefined */ - accessibleName?: string; + accessibleName?: string | undefined; /** * Defines the component semantic design. @@ -54,8 +55,9 @@ interface IconAttributes { * * Example: * `name='business-suite/3d'`, `name='business-suite/1x2-grid-layout'`, `name='business-suite/4x4-grid-layout'`. + * @default undefined */ - name?: string; + name?: string | undefined; /** * Defines whether the component should have a tooltip. diff --git a/packages/main/src/webComponents/IllustratedMessage/index.tsx b/packages/main/src/webComponents/IllustratedMessage/index.tsx index b9952cb2eee..545ff29e731 100644 --- a/packages/main/src/webComponents/IllustratedMessage/index.tsx +++ b/packages/main/src/webComponents/IllustratedMessage/index.tsx @@ -1,7 +1,7 @@ 'use client'; import '@ui5/webcomponents-fiori/dist/IllustratedMessage.js'; -import type IllustrationMessageSize from '@ui5/webcomponents-fiori/dist/types/IllustrationMessageSize.js'; +import type IllustrationMessageDesign from '@ui5/webcomponents-fiori/dist/types/IllustrationMessageDesign.js'; import type { ReactNode } from 'react'; import { withWebComponent } from '../../internal/withWebComponent.js'; import type { CommonProps, Ui5DomRef, UI5WCSlotsNode } from '../../types/index.js'; @@ -11,8 +11,9 @@ interface IllustratedMessageAttributes { * Receives id(or many ids) of the elements that label the component. * * **Note:** Available since [v1.7.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.7.0) of **@ui5/webcomponents-fiori**. + * @default undefined */ - accessibleNameRef?: string; + accessibleNameRef?: string | undefined; /** * Determines which illustration breakpoint variant is used. @@ -20,10 +21,10 @@ interface IllustratedMessageAttributes { * As `IllustratedMessage` adapts itself around the `Illustration`, the other * elements of the component are displayed differently on the different breakpoints/illustration designs. * - * **Note:** Available since [v1.5.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.5.0) of **@ui5/webcomponents-fiori**. + * **Note:** Available since [v2.0.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v2.0.0) of **@ui5/webcomponents-fiori**. * @default "Auto" */ - design?: IllustrationMessageSize | keyof typeof IllustrationMessageSize; + design?: IllustrationMessageDesign | keyof typeof IllustrationMessageDesign; /** * Defines the illustration name that will be displayed in the component. @@ -57,15 +58,17 @@ interface IllustratedMessageAttributes { * **Note:** Using this property, the default subtitle text of illustration will be overwritten. * * **Note:** Using `subtitle` slot, the default of this property will be overwritten. + * @default undefined */ - subtitleText?: string; + subtitleText?: string | undefined; /** * Defines the title of the component. * * **Note:** Using this property, the default title text of illustration will be overwritten. + * @default undefined */ - titleText?: string; + titleText?: string | undefined; } interface IllustratedMessageDomRef extends Required, Ui5DomRef {} diff --git a/packages/main/src/webComponents/Input/index.tsx b/packages/main/src/webComponents/Input/index.tsx index 79a4605c29e..a13b4bbd32f 100644 --- a/packages/main/src/webComponents/Input/index.tsx +++ b/packages/main/src/webComponents/Input/index.tsx @@ -11,13 +11,15 @@ import type { CommonProps, Ui5CustomEvent, Ui5DomRef, UI5WCSlotsNode } from '../ interface InputAttributes { /** * Defines the accessible ARIA name of the component. + * @default undefined */ - accessibleName?: string; + accessibleName?: string | undefined; /** * Receives id(or many ids) of the elements that label the input. + * @default undefined */ - accessibleNameRef?: string; + accessibleNameRef?: string | undefined; /** * Defines whether the component is in disabled state. @@ -39,8 +41,9 @@ interface InputAttributes { * Determines the name by which the component will be identified upon submission in an HTML form. * * **Note:** This property is only applicable within the context of an HTML Form element. + * @default undefined */ - name?: string; + name?: string | undefined; /** * Defines whether the value will be autcompleted to match an item @@ -63,8 +66,9 @@ interface InputAttributes { /** * Defines a short hint intended to aid the user with data entry when the * component has no value. + * @default undefined */ - placeholder?: string; + placeholder?: string | undefined; /** * Defines whether the component is read-only. @@ -147,13 +151,13 @@ interface InputPropTypes * **Note:** The suggestions would be displayed only if the `showSuggestions` * property is set to `true`. * - * **Note:** The `` and `` are recommended to be used as suggestion items. + * **Note:** The ``, `` and `SuggestionItemCustom` are recommended to be used as suggestion items. * * **Note:** Importing the Input Suggestions Support feature: * * `import "@ui5/webcomponents/dist/features/InputSuggestions.js";` * - * automatically imports the `` and `` for your convenience. + * automatically imports the `` and `` for your convenience. */ children?: ReactNode | ReactNode[]; diff --git a/packages/main/src/webComponents/Label/index.tsx b/packages/main/src/webComponents/Label/index.tsx index e88647cefdd..43b9f9844d6 100644 --- a/packages/main/src/webComponents/Label/index.tsx +++ b/packages/main/src/webComponents/Label/index.tsx @@ -11,8 +11,9 @@ interface LabelAttributes { * Defines the labeled input by providing its ID. * * **Note:** Can be used with both `Input` and native input. + * @default undefined */ - for?: string; + for?: string | undefined; /** * Defines whether an asterisk character is added to the component text. diff --git a/packages/main/src/webComponents/Link/index.tsx b/packages/main/src/webComponents/Link/index.tsx index f5967ae14cb..855601e82c4 100644 --- a/packages/main/src/webComponents/Link/index.tsx +++ b/packages/main/src/webComponents/Link/index.tsx @@ -29,13 +29,15 @@ interface LinkAttributes { * Defines the accessible ARIA name of the component. * * **Note:** Available since [v1.2.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.2.0) of **@ui5/webcomponents**. + * @default undefined */ - accessibleName?: string; + accessibleName?: string | undefined; /** * Receives id(or many ids) of the elements that label the input + * @default undefined */ - accessibleNameRef?: string; + accessibleNameRef?: string | undefined; /** * Defines the ARIA role of the component. @@ -43,7 +45,7 @@ interface LinkAttributes { * **Note:** Use the LinkAccessibleRole.Button role in cases when navigation is not expected to occur and the href property is not defined. * * **Note:** Available since [v1.9.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.9.0) of **@ui5/webcomponents**. - * @default "link" + * @default "Link" */ accessibleRole?: LinkAccessibleRole | keyof typeof LinkAccessibleRole; @@ -74,15 +76,17 @@ interface LinkAttributes { * See all the available icons within the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html). * * **Note:** Available since [v2.0.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v2.0.0) of **@ui5/webcomponents**. + * @default undefined */ - endIcon?: string; + endIcon?: string | undefined; /** * Defines the component href. * * **Note:** Standard hyperlink behavior is supported. + * @default undefined */ - href?: string; + href?: string | undefined; /** * Defines the icon, displayed as graphical element within the component before the link's text. @@ -95,8 +99,9 @@ interface LinkAttributes { * See all the available icons within the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html). * * **Note:** Available since [v2.0.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v2.0.0) of **@ui5/webcomponents**. + * @default undefined */ - icon?: string; + icon?: string | undefined; /** * Defines the component target. @@ -110,15 +115,17 @@ interface LinkAttributes { * - `_search` * * **This property must only be used when the `href` property is set.** + * @default undefined */ - target?: string; + target?: string | undefined; /** * Defines the tooltip of the component. * * **Note:** Available since [v2.0.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v2.0.0) of **@ui5/webcomponents**. + * @default undefined */ - tooltip?: string; + tooltip?: string | undefined; /** * Defines how the text of a component will be displayed when there is not enough space. diff --git a/packages/main/src/webComponents/List/index.tsx b/packages/main/src/webComponents/List/index.tsx index 289038d9823..a8cf14abb51 100644 --- a/packages/main/src/webComponents/List/index.tsx +++ b/packages/main/src/webComponents/List/index.tsx @@ -13,7 +13,7 @@ import type ListItemBase from '@ui5/webcomponents/dist/ListItemBase.js'; import type ListAccessibleRole from '@ui5/webcomponents/dist/types/ListAccessibleRole.js'; import type ListGrowingMode from '@ui5/webcomponents/dist/types/ListGrowingMode.js'; import type ListSelectionMode from '@ui5/webcomponents/dist/types/ListSelectionMode.js'; -import type ListSeparators from '@ui5/webcomponents/dist/types/ListSeparators.js'; +import type ListSeparator from '@ui5/webcomponents/dist/types/ListSeparator.js'; import type { ReactNode } from 'react'; import { withWebComponent } from '../../internal/withWebComponent.js'; import type { CommonProps, Ui5CustomEvent, Ui5DomRef, UI5WCSlotsNode } from '../../types/index.js'; @@ -21,13 +21,15 @@ import type { CommonProps, Ui5CustomEvent, Ui5DomRef, UI5WCSlotsNode } from '../ interface ListAttributes { /** * Defines the accessible name of the component. + * @default undefined */ - accessibleName?: string; + accessibleName?: string | undefined; /** * Defines the IDs of the elements that label the input. + * @default undefined */ - accessibleNameRef?: string; + accessibleNameRef?: string | undefined; /** * Defines the accessible role of the component. @@ -37,8 +39,9 @@ interface ListAttributes { /** * Defines the footer text. + * @default undefined */ - footerText?: string; + footerText?: string | undefined; /** * Defines whether the component will have growing capability either by pressing a `More` button, @@ -58,15 +61,17 @@ interface ListAttributes { * **Note:** This property takes effect if the `growing` property is set to the `Button`. * * **Note:** Available since [v1.24](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.24) of **@ui5/webcomponents**. + * @default undefined */ - growingButtonText?: string; + growingButtonText?: string | undefined; /** * Defines the component header text. * * **Note:** If `header` is set this property is ignored. + * @default undefined */ - headerText?: string; + headerText?: string | undefined; /** * Determines whether the component is indented. @@ -88,8 +93,9 @@ interface ListAttributes { /** * Defines the text that is displayed when the component contains no items. + * @default undefined */ - noDataText?: string; + noDataText?: string | undefined; /** * Defines the selection mode of the component. @@ -101,7 +107,7 @@ interface ListAttributes { * Defines the item separator style that is used. * @default "All" */ - separators?: ListSeparators | keyof typeof ListSeparators; + separators?: ListSeparator | keyof typeof ListSeparator; } interface ListDomRef extends Required, Ui5DomRef { diff --git a/packages/main/src/webComponents/ListItemCustom/index.tsx b/packages/main/src/webComponents/ListItemCustom/index.tsx index c836ef30bf5..3a13a0915dc 100644 --- a/packages/main/src/webComponents/ListItemCustom/index.tsx +++ b/packages/main/src/webComponents/ListItemCustom/index.tsx @@ -28,8 +28,9 @@ interface ListItemCustomAttributes { * Defines the text alternative of the component. * * **Note**: If not provided a default text alternative will be set, if present. + * @default undefined */ - accessibleName?: string; + accessibleName?: string | undefined; /** * Defines the highlight state of the list items. @@ -67,8 +68,9 @@ interface ListItemCustomAttributes { * Defines the text of the tooltip that would be displayed for the list item. * * **Note:** Available since [v1.23.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.23.0) of **@ui5/webcomponents**. + * @default undefined */ - tooltip?: string; + tooltip?: string | undefined; /** * Defines the visual indication and behavior of the list items. diff --git a/packages/main/src/webComponents/ListItemGroup/index.tsx b/packages/main/src/webComponents/ListItemGroup/index.tsx index 9f20d4e6e44..f37f81de168 100644 --- a/packages/main/src/webComponents/ListItemGroup/index.tsx +++ b/packages/main/src/webComponents/ListItemGroup/index.tsx @@ -8,13 +8,15 @@ import type { CommonProps, Ui5DomRef, UI5WCSlotsNode } from '../../types/index.j interface ListItemGroupAttributes { /** * Defines the accessible name of the header. + * @default undefined */ - headerAccessibleName?: string; + headerAccessibleName?: string | undefined; /** * Defines the header text of the ui5-li-group. + * @default undefined */ - headerText?: string; + headerText?: string | undefined; } interface ListItemGroupDomRef extends Required, Ui5DomRef {} diff --git a/packages/main/src/webComponents/ListItemStandard/index.tsx b/packages/main/src/webComponents/ListItemStandard/index.tsx index 7957b052b2a..e43451a987e 100644 --- a/packages/main/src/webComponents/ListItemStandard/index.tsx +++ b/packages/main/src/webComponents/ListItemStandard/index.tsx @@ -28,13 +28,15 @@ interface ListItemStandardAttributes { /** * Defines the text alternative of the component. * Note: If not provided a default text alternative will be set, if present. + * @default undefined */ - accessibleName?: string; + accessibleName?: string | undefined; /** * Defines the `additionalText`, displayed in the end of the list item. + * @default undefined */ - additionalText?: string; + additionalText?: string | undefined; /** * Defines the state of the `additionalText`. @@ -46,8 +48,9 @@ interface ListItemStandardAttributes { /** * Defines the description displayed right under the item text, if such is present. + * @default undefined */ - description?: string; + description?: string | undefined; /** * Defines the highlight state of the list items. @@ -64,24 +67,16 @@ interface ListItemStandardAttributes { * **Note:** * SAP-icons font provides numerous built-in icons. To find all the available icons, see the * [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html). + * @default undefined */ - icon?: string; + icon?: string | undefined; /** * Defines whether the `icon` should be displayed in the beginning of the list item or in the end. - * - * **Note:** If `image` is set, the `icon` would be displayed after the `image`. * @default false */ iconEnd?: boolean; - /** - * Defines the `image` source URI. - * - * **Note:** The `image` would be displayed in the beginning of the list item. - */ - image?: string; - /** * Defines whether the item is movable. * @@ -109,8 +104,9 @@ interface ListItemStandardAttributes { * Defines the text of the tooltip that would be displayed for the list item. * * **Note:** Available since [v1.23.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.23.0) of **@ui5/webcomponents**. + * @default undefined */ - tooltip?: string; + tooltip?: string | undefined; /** * Defines the visual indication and behavior of the list items. @@ -127,10 +123,7 @@ interface ListItemStandardDomRef extends Required, U interface ListItemStandardPropTypes extends ListItemStandardAttributes, - Omit< - CommonProps, - keyof ListItemStandardAttributes | 'children' | 'deleteButton' | 'imageContent' | 'onDetailClick' - > { + Omit { /** * Defines the text of the component. * @@ -161,15 +154,15 @@ interface ListItemStandardPropTypes * **Note:** If bigger `Avatar` needs to be used, then the size of the * `ListItemStandard` should be customized in order to fit. * - * __Note:__ The content of the prop will be rendered into a [<slot>](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/slot) by assigning the respective [slot](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/slot) attribute (`slot="imageContent"`). + * __Note:__ The content of the prop will be rendered into a [<slot>](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/slot) by assigning the respective [slot](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/slot) attribute (`slot="image"`). * Since you can't change the DOM order of slots when declaring them within a prop, it might prove beneficial to manually mount them as part of the component's children, especially when facing problems with the reading order of screen readers. * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://sap.github.io/ui5-webcomponents-react/?path=/docs/knowledge-base-handling-slots--docs). * - * **Note:** Available since [v1.10.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.10.0) of **@ui5/webcomponents**. + * **Note:** Available since [v2.0.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v2.0.0) of **@ui5/webcomponents**. */ - imageContent?: UI5WCSlotsNode; + image?: UI5WCSlotsNode; /** * Fired when the user clicks on the detail button when type is `Detail`. */ @@ -195,12 +188,11 @@ const ListItemStandard = withWebComponent import('@ui5/webcomponents/dist/ListItemStandard.js') ); diff --git a/packages/main/src/webComponents/Menu/index.tsx b/packages/main/src/webComponents/Menu/index.tsx index d280c4b47bc..4f039b67ed8 100644 --- a/packages/main/src/webComponents/Menu/index.tsx +++ b/packages/main/src/webComponents/Menu/index.tsx @@ -13,8 +13,9 @@ import type { CommonProps, Ui5CustomEvent, Ui5DomRef } from '../../types/index.j interface MenuAttributes { /** * Defines the header text of the menu (displayed on mobile). + * @default undefined */ - headerText?: string; + headerText?: string | undefined; /** * Defines if a loading indicator would be displayed inside the corresponding ui5-menu popover. @@ -46,8 +47,9 @@ interface MenuAttributes { * You can only set the `opener` attribute to a DOM Reference when using JavaScript. * * **Note:** Available since [v1.10.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.10.0) of **@ui5/webcomponents**. + * @default undefined */ - opener?: HTMLElement | string; + opener?: HTMLElement | string | undefined; } interface MenuDomRef extends Required, Ui5DomRef {} @@ -61,7 +63,7 @@ interface MenuPropTypes /** * Defines the items of this component. * - * **Note:** Use `MenuItem` for the intended design. + * **Note:** Use `MenuItem` and `MenuSeparator` for their intended design. */ children?: ReactNode | ReactNode[]; /** @@ -111,9 +113,13 @@ interface MenuPropTypes /** * `Menu` component represents a hierarchical menu structure. * - * ### Usage + * ### Structure + * + * The `Menu` can hold two types of entities: + * + * - `MenuItem` components + * - `MenuSeparator` - used to separate menu items with a line * - * `Menu` contains `MenuItem` components. * An arbitrary hierarchy structure can be represented by recursively nesting menu items. * * ### Keyboard Handling diff --git a/packages/main/src/webComponents/MenuItem/index.tsx b/packages/main/src/webComponents/MenuItem/index.tsx index b7052d2c7f3..31f82b848b4 100644 --- a/packages/main/src/webComponents/MenuItem/index.tsx +++ b/packages/main/src/webComponents/MenuItem/index.tsx @@ -28,8 +28,9 @@ interface MenuItemAttributes { * Defines the accessible ARIA name of the component. * * **Note:** Available since [v1.7.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.7.0) of **@ui5/webcomponents**. + * @default undefined */ - accessibleName?: string; + accessibleName?: string | undefined; /** * Defines the `additionalText`, displayed in the end of the menu item. @@ -41,8 +42,9 @@ interface MenuItemAttributes { * sub-menu arrow (if there are items added in `items` slot) -> components added in `endContent` -> text set to `additionalText`. * * **Note:** Available since [v1.8.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.8.0) of **@ui5/webcomponents**. + * @default undefined */ - additionalText?: string; + additionalText?: string | undefined; /** * Defines whether `MenuItem` is in disabled state. @@ -68,8 +70,9 @@ interface MenuItemAttributes { * **Example:** * * See all the available icons in the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html). + * @default undefined */ - icon?: string; + icon?: string | undefined; /** * Defines the delay in milliseconds, after which the loading indicator will be displayed inside the corresponding ui5-menu popover. @@ -104,23 +107,19 @@ interface MenuItemAttributes { */ selected?: boolean; - /** - * Defines whether a visual separator should be rendered before the item. - * @default false - */ - startsSection?: boolean; - /** * Defines the text of the tree item. + * @default undefined */ - text?: string; + text?: string | undefined; /** * Defines the text of the tooltip for the menu item. * * **Note:** Available since [v1.23.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.23.0) of **@ui5/webcomponents**. + * @default undefined */ - tooltip?: string; + tooltip?: string | undefined; /** * Defines the visual indication and behavior of the list items. @@ -141,7 +140,9 @@ interface MenuItemPropTypes /** * Defines the items of this component. * - * **Note:** If there are items added to this slot, an arrow will be displayed at the end + * **Note:** The slot can hold `MenuItem` and `MenuSeparator` items. + * + * If there are items added to this slot, an arrow will be displayed at the end * of the item in order to indicate that there are items added. In that case components added * to `endContent` slot or `additionalText` content will not be displayed. * @@ -221,7 +222,7 @@ const MenuItem = withWebComponent( 'tooltip', 'type' ], - ['disabled', 'loading', 'navigated', 'selected', 'startsSection'], + ['disabled', 'loading', 'navigated', 'selected'], ['deleteButton', 'endContent'], ['detail-click'], () => import('@ui5/webcomponents/dist/MenuItem.js') diff --git a/packages/main/src/webComponents/MenuSeparator/index.tsx b/packages/main/src/webComponents/MenuSeparator/index.tsx new file mode 100644 index 00000000000..2ce78f6d8ed --- /dev/null +++ b/packages/main/src/webComponents/MenuSeparator/index.tsx @@ -0,0 +1,32 @@ +'use client'; + +import '@ui5/webcomponents/dist/MenuSeparator.js'; +import { withWebComponent } from '../../internal/withWebComponent.js'; +import type { CommonProps, Ui5DomRef } from '../../types/index.js'; + +interface MenuSeparatorAttributes {} + +interface MenuSeparatorDomRef extends Required, Ui5DomRef {} + +interface MenuSeparatorPropTypes extends MenuSeparatorAttributes, CommonProps {} + +/** + * The `MenuSeparator` represents a horizontal line to separate menu items inside a `Menu`. + * + * __Note__: This is a UI5 Web Component! [Repository](https://github.com/SAP/ui5-webcomponents) | [Documentation](https://sap.github.io/ui5-webcomponents/) + * + * @since [2.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v2.0) of __@ui5/webcomponents__. + */ +const MenuSeparator = withWebComponent( + 'ui5-menu-separator', + [], + [], + [], + [], + () => import('@ui5/webcomponents/dist/MenuSeparator.js') +); + +MenuSeparator.displayName = 'MenuSeparator'; + +export { MenuSeparator }; +export type { MenuSeparatorDomRef, MenuSeparatorPropTypes }; diff --git a/packages/main/src/webComponents/MultiComboBox/index.tsx b/packages/main/src/webComponents/MultiComboBox/index.tsx index 28c3abd1aef..03f18e35b9f 100644 --- a/packages/main/src/webComponents/MultiComboBox/index.tsx +++ b/packages/main/src/webComponents/MultiComboBox/index.tsx @@ -13,15 +13,17 @@ interface MultiComboBoxAttributes { * Defines the accessible ARIA name of the component. * * **Note:** Available since [v1.4.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.4.0) of **@ui5/webcomponents**. + * @default undefined */ - accessibleName?: string; + accessibleName?: string | undefined; /** * Receives id(or many ids) of the elements that label the component. * * **Note:** Available since [v1.4.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.4.0) of **@ui5/webcomponents**. + * @default undefined */ - accessibleNameRef?: string; + accessibleNameRef?: string | undefined; /** * Defines whether the component is in disabled state. @@ -45,8 +47,9 @@ interface MultiComboBoxAttributes { * the value is sent as the first element in the form data, even if it's empty. * * **Note:** Available since [v2.0.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v2.0.0) of **@ui5/webcomponents**. + * @default undefined */ - name?: string; + name?: string | undefined; /** * Defines whether the value will be autcompleted to match an item @@ -65,8 +68,9 @@ interface MultiComboBoxAttributes { /** * Defines a short hint intended to aid the user with data entry when the * component has no value. + * @default undefined */ - placeholder?: string; + placeholder?: string | undefined; /** * Defines whether the component is read-only. diff --git a/packages/main/src/webComponents/MultiComboBoxItem/index.tsx b/packages/main/src/webComponents/MultiComboBoxItem/index.tsx index 994a2022885..dd8fc3137a5 100644 --- a/packages/main/src/webComponents/MultiComboBoxItem/index.tsx +++ b/packages/main/src/webComponents/MultiComboBoxItem/index.tsx @@ -7,8 +7,9 @@ import type { CommonProps, Ui5DomRef } from '../../types/index.js'; interface MultiComboBoxItemAttributes { /** * Defines the additional text of the component. + * @default undefined */ - additionalText?: string; + additionalText?: string | undefined; /** * Defines the selected state of the component. @@ -18,8 +19,9 @@ interface MultiComboBoxItemAttributes { /** * Defines the text of the component. + * @default undefined */ - text?: string; + text?: string | undefined; } interface MultiComboBoxItemDomRef extends Required, Ui5DomRef {} diff --git a/packages/main/src/webComponents/MultiComboBoxItemGroup/index.tsx b/packages/main/src/webComponents/MultiComboBoxItemGroup/index.tsx index c95523414d9..8118a2c57ef 100644 --- a/packages/main/src/webComponents/MultiComboBoxItemGroup/index.tsx +++ b/packages/main/src/webComponents/MultiComboBoxItemGroup/index.tsx @@ -8,8 +8,9 @@ import type { CommonProps, Ui5DomRef } from '../../types/index.js'; interface MultiComboBoxItemGroupAttributes { /** * Defines the text of the component. + * @default undefined */ - text?: string; + headerText?: string | undefined; } interface MultiComboBoxItemGroupDomRef extends Required, Ui5DomRef {} @@ -34,7 +35,7 @@ interface MultiComboBoxItemGroupPropTypes */ const MultiComboBoxItemGroup = withWebComponent( 'ui5-mcb-item-group', - ['text'], + ['headerText'], [], [], [], diff --git a/packages/main/src/webComponents/MultiInput/index.tsx b/packages/main/src/webComponents/MultiInput/index.tsx index 6dd2e685ce8..ee776bc652a 100644 --- a/packages/main/src/webComponents/MultiInput/index.tsx +++ b/packages/main/src/webComponents/MultiInput/index.tsx @@ -12,13 +12,15 @@ import type { CommonProps, Ui5CustomEvent, Ui5DomRef, UI5WCSlotsNode } from '../ interface MultiInputAttributes { /** * Defines the accessible ARIA name of the component. + * @default undefined */ - accessibleName?: string; + accessibleName?: string | undefined; /** * Receives id(or many ids) of the elements that label the input. + * @default undefined */ - accessibleNameRef?: string; + accessibleNameRef?: string | undefined; /** * Defines whether the component is in disabled state. @@ -42,8 +44,9 @@ interface MultiInputAttributes { * **Note:** This property is only applicable within the context of an HTML Form element. * **Note:** When the component is used inside a form element, * the value is sent as the first element in the form data, even if it's empty. + * @default undefined */ - name?: string; + name?: string | undefined; /** * Defines whether the value will be autcompleted to match an item @@ -66,8 +69,9 @@ interface MultiInputAttributes { /** * Defines a short hint intended to aid the user with data entry when the * component has no value. + * @default undefined */ - placeholder?: string; + placeholder?: string | undefined; /** * Defines whether the component is read-only. @@ -160,13 +164,13 @@ interface MultiInputPropTypes * **Note:** The suggestions would be displayed only if the `showSuggestions` * property is set to `true`. * - * **Note:** The `` and `` are recommended to be used as suggestion items. + * **Note:** The ``, `` and `SuggestionItemCustom` are recommended to be used as suggestion items. * * **Note:** Importing the Input Suggestions Support feature: * * `import "@ui5/webcomponents/dist/features/InputSuggestions.js";` * - * automatically imports the `` and `` for your convenience. + * automatically imports the `` and `` for your convenience. */ children?: ReactNode | ReactNode[]; diff --git a/packages/main/src/webComponents/NotificationList/index.tsx b/packages/main/src/webComponents/NotificationList/index.tsx index 55c00ac4974..184cad594b0 100644 --- a/packages/main/src/webComponents/NotificationList/index.tsx +++ b/packages/main/src/webComponents/NotificationList/index.tsx @@ -13,8 +13,9 @@ import type { CommonProps, Ui5CustomEvent, Ui5DomRef } from '../../types/index.j interface NotificationListAttributes { /** * Defines the text that is displayed when the component contains no items. + * @default undefined */ - noDataText?: string; + noDataText?: string | undefined; } interface NotificationListDomRef extends Required, Ui5DomRef {} @@ -69,7 +70,7 @@ interface NotificationListPropTypes * * __Note__: This is a UI5 Web Component! [Repository](https://github.com/SAP/ui5-webcomponents) | [Documentation](https://sap.github.io/ui5-webcomponents/) * - * @since [2.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v2.0) of __@ui5/webcomponents-fiori__. + * @since [2.0.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v2.0.0) of __@ui5/webcomponents-fiori__. */ const NotificationList = withWebComponent( 'ui5-notification-list', diff --git a/packages/main/src/webComponents/NotificationListGroupItem/index.tsx b/packages/main/src/webComponents/NotificationListGroupItem/index.tsx index 8e52cea2994..1c40f9c572f 100644 --- a/packages/main/src/webComponents/NotificationListGroupItem/index.tsx +++ b/packages/main/src/webComponents/NotificationListGroupItem/index.tsx @@ -33,16 +33,11 @@ interface NotificationListGroupItemAttributes { */ read?: boolean; - /** - * Defines the selected state of the component. - * @default false - */ - selected?: boolean; - /** * Defines the `titleText` of the item. + * @default undefined */ - titleText?: string; + titleText?: string | undefined; } interface NotificationListGroupItemDomRef extends Required, Ui5DomRef {} @@ -91,7 +86,7 @@ interface NotificationListGroupItemPropTypes const NotificationListGroupItem = withWebComponent( 'ui5-li-notification-group', ['loadingDelay', 'titleText'], - ['collapsed', 'loading', 'read', 'selected'], + ['collapsed', 'loading', 'read'], [], ['toggle'], () => import('@ui5/webcomponents-fiori/dist/NotificationListGroupItem.js') diff --git a/packages/main/src/webComponents/NotificationListItem/index.tsx b/packages/main/src/webComponents/NotificationListItem/index.tsx index 455a8645ca6..36708ef6928 100644 --- a/packages/main/src/webComponents/NotificationListItem/index.tsx +++ b/packages/main/src/webComponents/NotificationListItem/index.tsx @@ -37,12 +37,6 @@ interface NotificationListItemAttributes { */ read?: boolean; - /** - * Defines the selected state of the component. - * @default false - */ - selected?: boolean; - /** * Defines if the `Close` button would be displayed. * @default false @@ -57,8 +51,9 @@ interface NotificationListItemAttributes { /** * Defines the `titleText` of the item. + * @default undefined */ - titleText?: string; + titleText?: string | undefined; /** * Defines if the `titleText` and `description` should wrap, @@ -171,7 +166,7 @@ interface NotificationListItemPropTypes const NotificationListItem = withWebComponent( 'ui5-li-notification', ['importance', 'loadingDelay', 'state', 'titleText', 'wrappingType'], - ['loading', 'read', 'selected', 'showClose'], + ['loading', 'read', 'showClose'], ['avatar', 'footnotes', 'menu'], ['close'], () => import('@ui5/webcomponents-fiori/dist/NotificationListItem.js') diff --git a/packages/main/src/webComponents/Option/index.tsx b/packages/main/src/webComponents/Option/index.tsx index c1eecb36e0f..e60bd486eaf 100644 --- a/packages/main/src/webComponents/Option/index.tsx +++ b/packages/main/src/webComponents/Option/index.tsx @@ -8,8 +8,9 @@ import type { CommonProps, Ui5DomRef } from '../../types/index.js'; interface OptionAttributes { /** * Defines the `additionalText`, displayed in the end of the list item. + * @default undefined */ - additionalText?: string; + additionalText?: string | undefined; /** * Defines the `icon` source URI. @@ -17,8 +18,9 @@ interface OptionAttributes { * **Note:** * SAP-icons font provides numerous built-in icons. To find all the available icons, see the * [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html). + * @default undefined */ - icon?: string; + icon?: string | undefined; /** * Defines the selected state of the component. @@ -30,14 +32,16 @@ interface OptionAttributes { * Defines the text of the tooltip that would be displayed for the list item. * * **Note:** Available since [v1.23.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.23.0) of **@ui5/webcomponents**. + * @default undefined */ - tooltip?: string; + tooltip?: string | undefined; /** * Defines the value of the `Select` inside an HTML Form element when this component is selected. * For more information on HTML Form support, see the `name` property of `Select`. + * @default undefined */ - value?: string; + value?: string | undefined; } interface OptionDomRef extends Required, Ui5DomRef {} diff --git a/packages/main/src/webComponents/OptionCustom/index.tsx b/packages/main/src/webComponents/OptionCustom/index.tsx index 8d9400fe6f0..fb24e256712 100644 --- a/packages/main/src/webComponents/OptionCustom/index.tsx +++ b/packages/main/src/webComponents/OptionCustom/index.tsx @@ -9,8 +9,9 @@ interface OptionCustomAttributes { /** * Defines the text, displayed inside the `Select` input filed * when the option gets selected. + * @default undefined */ - displayText?: string; + displayText?: string | undefined; /** * Defines the selected state of the component. @@ -20,14 +21,16 @@ interface OptionCustomAttributes { /** * Defines the text of the tooltip that would be displayed for the list item. + * @default undefined */ - tooltip?: string; + tooltip?: string | undefined; /** * Defines the value of the `Select` inside an HTML Form element when this component is selected. * For more information on HTML Form support, see the `name` property of `Select`. + * @default undefined */ - value?: string; + value?: string | undefined; } interface OptionCustomDomRef extends Required, Ui5DomRef {} diff --git a/packages/main/src/webComponents/Panel/index.tsx b/packages/main/src/webComponents/Panel/index.tsx index 0009415d856..b8baa4db080 100644 --- a/packages/main/src/webComponents/Panel/index.tsx +++ b/packages/main/src/webComponents/Panel/index.tsx @@ -10,8 +10,9 @@ import type { CommonProps, Ui5CustomEvent, Ui5DomRef, UI5WCSlotsNode } from '../ interface PanelAttributes { /** * Defines the accessible ARIA name of the component. + * @default undefined */ - accessibleName?: string; + accessibleName?: string | undefined; /** * Sets the accessible ARIA role of the component. @@ -46,8 +47,9 @@ interface PanelAttributes { * The text is visible in both expanded and collapsed states. * * **Note:** This property is overridden by the `header` slot. + * @default undefined */ - headerText?: string; + headerText?: string | undefined; /** * Indicates whether the transition between the expanded and the collapsed state of the component is animated. By default the animation is enabled. diff --git a/packages/main/src/webComponents/Popover/index.tsx b/packages/main/src/webComponents/Popover/index.tsx index 52739e446b6..14e971e5790 100644 --- a/packages/main/src/webComponents/Popover/index.tsx +++ b/packages/main/src/webComponents/Popover/index.tsx @@ -21,8 +21,9 @@ interface PopoverAttributes { * Defines the IDs of the elements that label the component. * * **Note:** Available since [v1.1.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.1.0) of **@ui5/webcomponents**. + * @default undefined */ - accessibleNameRef?: string; + accessibleNameRef?: string | undefined; /** * Allows setting a custom role. @@ -43,8 +44,9 @@ interface PopoverAttributes { * Defines the header text. * * **Note:** If `header` slot is provided, the `headerText` is ignored. + * @default undefined */ - headerText?: string; + headerText?: string | undefined; /** * Determines whether the component arrow is hidden. @@ -63,8 +65,9 @@ interface PopoverAttributes { * * **Note:** If an element with `autofocus` attribute is added inside the component, * `initialFocus` won't take effect. + * @default undefined */ - initialFocus?: string; + initialFocus?: string | undefined; /** * Defines whether the component should close when diff --git a/packages/main/src/webComponents/ProductSwitchItem/index.tsx b/packages/main/src/webComponents/ProductSwitchItem/index.tsx index aedb3207070..7bc53a3b16b 100644 --- a/packages/main/src/webComponents/ProductSwitchItem/index.tsx +++ b/packages/main/src/webComponents/ProductSwitchItem/index.tsx @@ -13,13 +13,15 @@ interface ProductSwitchItemAttributes { * `` * * See all the available icons in the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html). + * @default undefined */ - icon?: string; + icon?: string | undefined; /** * Defines the subtitle of the component. + * @default undefined */ - subtitleText?: string; + subtitleText?: string | undefined; /** * Defines a target where the `targetSrc` content must be open. @@ -31,19 +33,23 @@ interface ProductSwitchItemAttributes { * - `_blank` * - `_parent` * - `_search` - * @default "_self" + * + * **Note:** By default target will be open in the same frame as it was clicked. + * @default undefined */ - target?: string; + target?: string | undefined; /** * Defines the component target URI. Supports standard hyperlink behavior. + * @default undefined */ - targetSrc?: string; + targetSrc?: string | undefined; /** * Defines the title of the component. + * @default undefined */ - titleText?: string; + titleText?: string | undefined; } interface ProductSwitchItemDomRef extends Required, Ui5DomRef {} diff --git a/packages/main/src/webComponents/ProgressIndicator/index.tsx b/packages/main/src/webComponents/ProgressIndicator/index.tsx index 68a6e38e07c..f256f6c8cd3 100644 --- a/packages/main/src/webComponents/ProgressIndicator/index.tsx +++ b/packages/main/src/webComponents/ProgressIndicator/index.tsx @@ -10,8 +10,9 @@ interface ProgressIndicatorAttributes { * Defines the accessible ARIA name of the component. * * **Note:** Available since [v1.16.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.16.0) of **@ui5/webcomponents**. + * @default undefined */ - accessibleName?: string; + accessibleName?: string | undefined; /** * Specifies the text value to be displayed in the bar. @@ -20,9 +21,9 @@ interface ProgressIndicatorAttributes { * * - If there is no value provided or the value is empty, the default percentage value is shown. * - If `hideValue` property is `true` both the `displayValue` and `value` property values are not shown. - * @default null + * @default undefined */ - displayValue?: string | null | undefined; + displayValue?: string | undefined; /** * Defines whether the component value is shown. diff --git a/packages/main/src/webComponents/RadioButton/index.tsx b/packages/main/src/webComponents/RadioButton/index.tsx index 6aa9f4ce55d..be33ee412e4 100644 --- a/packages/main/src/webComponents/RadioButton/index.tsx +++ b/packages/main/src/webComponents/RadioButton/index.tsx @@ -11,15 +11,17 @@ interface RadioButtonAttributes { * Defines the accessible ARIA name of the component. * * **Note:** Available since [v1.6.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.6.0) of **@ui5/webcomponents**. + * @default undefined */ - accessibleName?: string; + accessibleName?: string | undefined; /** * Defines the IDs of the elements that label the component. * * **Note:** Available since [v1.1.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.1.0) of **@ui5/webcomponents**. + * @default undefined */ - accessibleNameRef?: string; + accessibleNameRef?: string | undefined; /** * Defines whether the component is checked or not. @@ -49,8 +51,9 @@ interface RadioButtonAttributes { * **Note:** The selection can be changed with `ARROW_UP/DOWN` and `ARROW_LEFT/RIGHT` keys between radio buttons in same group. * * **Note:** Only one radio button can be selected per group. + * @default undefined */ - name?: string; + name?: string | undefined; /** * Defines whether the component is read-only. @@ -71,8 +74,9 @@ interface RadioButtonAttributes { /** * Defines the text of the component. + * @default undefined */ - text?: string; + text?: string | undefined; /** * Defines the form value of the component. diff --git a/packages/main/src/webComponents/RangeSlider/index.tsx b/packages/main/src/webComponents/RangeSlider/index.tsx index 8b2dfc78fa7..decf230bc25 100644 --- a/packages/main/src/webComponents/RangeSlider/index.tsx +++ b/packages/main/src/webComponents/RangeSlider/index.tsx @@ -9,8 +9,9 @@ interface RangeSliderAttributes { * Defines the accessible ARIA name of the component. * * **Note:** Available since [v1.4.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.4.0) of **@ui5/webcomponents**. + * @default undefined */ - accessibleName?: string; + accessibleName?: string | undefined; /** * Defines whether the slider is in disabled state. @@ -52,8 +53,9 @@ interface RangeSliderAttributes { * **Note:** This property is only applicable within the context of an HTML Form element. * * **Note:** Available since [v2.0.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v2.0.0) of **@ui5/webcomponents**. + * @default undefined */ - name?: string; + name?: string | undefined; /** * Enables tickmarks visualization for each step. diff --git a/packages/main/src/webComponents/RatingIndicator/index.tsx b/packages/main/src/webComponents/RatingIndicator/index.tsx index d72b686610a..d977e08d478 100644 --- a/packages/main/src/webComponents/RatingIndicator/index.tsx +++ b/packages/main/src/webComponents/RatingIndicator/index.tsx @@ -7,15 +7,17 @@ import type { CommonProps, Ui5CustomEvent, Ui5DomRef } from '../../types/index.j interface RatingIndicatorAttributes { /** * Defines the accessible ARIA name of the component. + * @default undefined */ - accessibleName?: string; + accessibleName?: string | undefined; /** * Receives id(or many ids) of the elements that label the component. * * **Note:** Available since [v1.15.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.15.0) of **@ui5/webcomponents**. + * @default undefined */ - accessibleNameRef?: string; + accessibleNameRef?: string | undefined; /** * Defines whether the component is disabled. @@ -52,8 +54,9 @@ interface RatingIndicatorAttributes { * Defines the tooltip of the component. * * **Note:** Available since [v1.19.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.19.0) of **@ui5/webcomponents**. + * @default undefined */ - tooltip?: string; + tooltip?: string | undefined; /** * The indicated value of the rating. diff --git a/packages/main/src/webComponents/ResponsivePopover/index.tsx b/packages/main/src/webComponents/ResponsivePopover/index.tsx index ba78dc339a8..b4c86d77a9c 100644 --- a/packages/main/src/webComponents/ResponsivePopover/index.tsx +++ b/packages/main/src/webComponents/ResponsivePopover/index.tsx @@ -21,8 +21,9 @@ interface ResponsivePopoverAttributes { * Defines the IDs of the elements that label the component. * * **Note:** Available since [v1.1.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.1.0) of **@ui5/webcomponents**. + * @default undefined */ - accessibleNameRef?: string; + accessibleNameRef?: string | undefined; /** * Allows setting a custom role. @@ -43,8 +44,9 @@ interface ResponsivePopoverAttributes { * Defines the header text. * * **Note:** If `header` slot is provided, the `headerText` is ignored. + * @default undefined */ - headerText?: string; + headerText?: string | undefined; /** * Determines whether the component arrow is hidden. @@ -63,8 +65,9 @@ interface ResponsivePopoverAttributes { * * **Note:** If an element with `autofocus` attribute is added inside the component, * `initialFocus` won't take effect. + * @default undefined */ - initialFocus?: string; + initialFocus?: string | undefined; /** * Defines whether the component should close when diff --git a/packages/main/src/webComponents/SegmentedButtonItem/index.tsx b/packages/main/src/webComponents/SegmentedButtonItem/index.tsx index 7935f282608..7e8678d1257 100644 --- a/packages/main/src/webComponents/SegmentedButtonItem/index.tsx +++ b/packages/main/src/webComponents/SegmentedButtonItem/index.tsx @@ -16,8 +16,9 @@ interface SegmentedButtonItemAttributes { * Receives id(or many ids) of the elements that label the component. * * **Note:** Available since [v1.1.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.1.0) of **@ui5/webcomponents**. + * @default undefined */ - accessibleNameRef?: string; + accessibleNameRef?: string | undefined; /** * Defines whether the component is disabled. @@ -33,8 +34,9 @@ interface SegmentedButtonItemAttributes { * * Example: * See all the available icons within the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html). + * @default undefined */ - icon?: string; + icon?: string | undefined; /** * Determines whether the component is displayed as selected. @@ -48,8 +50,9 @@ interface SegmentedButtonItemAttributes { * **Note:** A tooltip attribute should be provided for icon-only buttons, in order to represent their exact meaning/function. * * **Note:** Available since [v1.2.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.2.0) of **@ui5/webcomponents**. + * @default undefined */ - tooltip?: string; + tooltip?: string | undefined; } interface SegmentedButtonItemDomRef extends Required, Ui5DomRef {} diff --git a/packages/main/src/webComponents/Select/index.tsx b/packages/main/src/webComponents/Select/index.tsx index c9b7f41489a..46c96cfbc48 100644 --- a/packages/main/src/webComponents/Select/index.tsx +++ b/packages/main/src/webComponents/Select/index.tsx @@ -10,13 +10,15 @@ import type { CommonProps, Ui5CustomEvent, Ui5DomRef, UI5WCSlotsNode } from '../ interface SelectAttributes { /** * Defines the accessible ARIA name of the component. + * @default undefined */ - accessibleName?: string; + accessibleName?: string | undefined; /** * Receives id(or many ids) of the elements that label the select. + * @default undefined */ - accessibleNameRef?: string; + accessibleNameRef?: string | undefined; /** * Defines whether the component is in disabled state. @@ -30,8 +32,9 @@ interface SelectAttributes { * Determines the name by which the component will be identified upon submission in an HTML form. * * **Note:** This property is only applicable within the context of an HTML Form element. + * @default undefined */ - name?: string; + name?: string | undefined; /** * Defines whether the component is read-only. diff --git a/packages/main/src/webComponents/ShellBar/index.tsx b/packages/main/src/webComponents/ShellBar/index.tsx index c822d42f58e..e5ea5148f05 100644 --- a/packages/main/src/webComponents/ShellBar/index.tsx +++ b/packages/main/src/webComponents/ShellBar/index.tsx @@ -52,22 +52,25 @@ interface ShellBarAttributes { /** * Defines the `notificationsCount`, * displayed in the notification icon top-right corner. + * @default undefined */ - notificationsCount?: string; + notificationsCount?: string | undefined; /** * Defines the `primaryTitle`. * * **Note:** The `primaryTitle` would be hidden on S screen size (less than approx. 700px). + * @default undefined */ - primaryTitle?: string; + primaryTitle?: string | undefined; /** * Defines the `secondaryTitle`. * * **Note:** The `secondaryTitle` would be hidden on S and M screen sizes (less than approx. 1300px). + * @default undefined */ - secondaryTitle?: string; + secondaryTitle?: string | undefined; /** * Defines, if the notification icon would be displayed. diff --git a/packages/main/src/webComponents/ShellBarItem/index.tsx b/packages/main/src/webComponents/ShellBarItem/index.tsx index 91841b0f009..8b2a243a380 100644 --- a/packages/main/src/webComponents/ShellBarItem/index.tsx +++ b/packages/main/src/webComponents/ShellBarItem/index.tsx @@ -8,20 +8,23 @@ import type { CommonProps, Ui5CustomEvent, Ui5DomRef } from '../../types/index.j interface ShellBarItemAttributes { /** * Defines the count displayed in the top-right corner. + * @default undefined */ - count?: string; + count?: string | undefined; /** * Defines the name of the item's icon. + * @default undefined */ - icon?: string; + icon?: string | undefined; /** * Defines the item text. * * **Note:** The text is only displayed inside the overflow popover list view. + * @default undefined */ - text?: string; + text?: string | undefined; } interface ShellBarItemDomRef extends Required, Ui5DomRef {} diff --git a/packages/main/src/webComponents/SideNavigationGroup/index.tsx b/packages/main/src/webComponents/SideNavigationGroup/index.tsx index c6318a9e85a..b50e3b80e1b 100644 --- a/packages/main/src/webComponents/SideNavigationGroup/index.tsx +++ b/packages/main/src/webComponents/SideNavigationGroup/index.tsx @@ -24,8 +24,9 @@ interface SideNavigationGroupAttributes { /** * Defines the text of the item. + * @default undefined */ - text?: string; + text?: string | undefined; /** * Defines the tooltip of the component. @@ -33,8 +34,9 @@ interface SideNavigationGroupAttributes { * A tooltip attribute should be provided, in order to represent meaning/function, when the component is collapsed(icon only is visualized). * * **Note:** Available since [v2.0.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v2.0.0) of **@ui5/webcomponents-fiori**. + * @default undefined */ - tooltip?: string; + tooltip?: string | undefined; } interface SideNavigationGroupDomRef extends Required, Ui5DomRef {} diff --git a/packages/main/src/webComponents/SideNavigationItem/index.tsx b/packages/main/src/webComponents/SideNavigationItem/index.tsx index 66d386d9384..78921a856db 100644 --- a/packages/main/src/webComponents/SideNavigationItem/index.tsx +++ b/packages/main/src/webComponents/SideNavigationItem/index.tsx @@ -29,8 +29,9 @@ interface SideNavigationItemAttributes { * for the `click` event should be registered. * * **Note:** Available since [v1.19.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.19.0) of **@ui5/webcomponents-fiori**. + * @default undefined */ - href?: string; + href?: string | undefined; /** * Defines the icon of the item. @@ -38,8 +39,9 @@ interface SideNavigationItemAttributes { * The SAP-icons font provides numerous options. * * See all the available icons in the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html). + * @default undefined */ - icon?: string; + icon?: string | undefined; /** * Defines whether the item is selected @@ -61,13 +63,15 @@ interface SideNavigationItemAttributes { * **This property must only be used when the `href` property is set.** * * **Note:** Available since [v1.19.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.19.0) of **@ui5/webcomponents-fiori**. + * @default undefined */ - target?: string; + target?: string | undefined; /** * Defines the text of the item. + * @default undefined */ - text?: string; + text?: string | undefined; /** * Defines the tooltip of the component. @@ -75,8 +79,9 @@ interface SideNavigationItemAttributes { * A tooltip attribute should be provided, in order to represent meaning/function, when the component is collapsed(icon only is visualized). * * **Note:** Available since [v2.0.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v2.0.0) of **@ui5/webcomponents-fiori**. + * @default undefined */ - tooltip?: string; + tooltip?: string | undefined; } interface SideNavigationItemDomRef extends Required, Ui5DomRef {} diff --git a/packages/main/src/webComponents/SideNavigationSubItem/index.tsx b/packages/main/src/webComponents/SideNavigationSubItem/index.tsx index 4ea5a25758c..a31e7577c94 100644 --- a/packages/main/src/webComponents/SideNavigationSubItem/index.tsx +++ b/packages/main/src/webComponents/SideNavigationSubItem/index.tsx @@ -22,8 +22,9 @@ interface SideNavigationSubItemAttributes { * for the `click` event should be registered. * * **Note:** Available since [v1.19.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.19.0) of **@ui5/webcomponents-fiori**. + * @default undefined */ - href?: string; + href?: string | undefined; /** * Defines the icon of the item. @@ -31,8 +32,9 @@ interface SideNavigationSubItemAttributes { * The SAP-icons font provides numerous options. * * See all the available icons in the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html). + * @default undefined */ - icon?: string; + icon?: string | undefined; /** * Defines whether the item is selected @@ -54,13 +56,15 @@ interface SideNavigationSubItemAttributes { * **This property must only be used when the `href` property is set.** * * **Note:** Available since [v1.19.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.19.0) of **@ui5/webcomponents-fiori**. + * @default undefined */ - target?: string; + target?: string | undefined; /** * Defines the text of the item. + * @default undefined */ - text?: string; + text?: string | undefined; /** * Defines the tooltip of the component. @@ -68,8 +72,9 @@ interface SideNavigationSubItemAttributes { * A tooltip attribute should be provided, in order to represent meaning/function, when the component is collapsed(icon only is visualized). * * **Note:** Available since [v2.0.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v2.0.0) of **@ui5/webcomponents-fiori**. + * @default undefined */ - tooltip?: string; + tooltip?: string | undefined; } interface SideNavigationSubItemDomRef extends Required, Ui5DomRef {} diff --git a/packages/main/src/webComponents/Slider/index.tsx b/packages/main/src/webComponents/Slider/index.tsx index 29067f91920..189177ceacb 100644 --- a/packages/main/src/webComponents/Slider/index.tsx +++ b/packages/main/src/webComponents/Slider/index.tsx @@ -9,8 +9,9 @@ interface SliderAttributes { * Defines the accessible ARIA name of the component. * * **Note:** Available since [v1.4.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.4.0) of **@ui5/webcomponents**. + * @default undefined */ - accessibleName?: string; + accessibleName?: string | undefined; /** * Defines whether the slider is in disabled state. @@ -46,8 +47,9 @@ interface SliderAttributes { * **Note:** This property is only applicable within the context of an HTML Form element. * * **Note:** Available since [v2.0.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v2.0.0) of **@ui5/webcomponents**. + * @default undefined */ - name?: string; + name?: string | undefined; /** * Enables tickmarks visualization for each step. diff --git a/packages/main/src/webComponents/SortItem/index.tsx b/packages/main/src/webComponents/SortItem/index.tsx index 5d7f45b8564..44e982eadf6 100644 --- a/packages/main/src/webComponents/SortItem/index.tsx +++ b/packages/main/src/webComponents/SortItem/index.tsx @@ -13,8 +13,9 @@ interface SortItemAttributes { /** * Defines the text of the component. + * @default undefined */ - text?: string; + text?: string | undefined; } interface SortItemDomRef extends Required, Ui5DomRef {} diff --git a/packages/main/src/webComponents/SplitButton/index.tsx b/packages/main/src/webComponents/SplitButton/index.tsx index 4ebfd15bc81..55f7ae7355d 100644 --- a/packages/main/src/webComponents/SplitButton/index.tsx +++ b/packages/main/src/webComponents/SplitButton/index.tsx @@ -42,8 +42,9 @@ interface SplitButtonAttributes { * Example: * * See all the available icons in the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html). + * @default undefined */ - icon?: string; + icon?: string | undefined; } interface SplitButtonDomRef extends Required, Ui5DomRef {} diff --git a/packages/main/src/webComponents/StepInput/index.tsx b/packages/main/src/webComponents/StepInput/index.tsx index dc3594b12b5..fdd1dcde964 100644 --- a/packages/main/src/webComponents/StepInput/index.tsx +++ b/packages/main/src/webComponents/StepInput/index.tsx @@ -9,13 +9,15 @@ import type { CommonProps, Ui5CustomEvent, Ui5DomRef, UI5WCSlotsNode } from '../ interface StepInputAttributes { /** * Defines the accessible ARIA name of the component. + * @default undefined */ - accessibleName?: string; + accessibleName?: string | undefined; /** * Receives id(or many ids) of the elements that label the component. + * @default undefined */ - accessibleNameRef?: string; + accessibleNameRef?: string | undefined; /** * Determines whether the component is displayed as disabled. @@ -39,8 +41,9 @@ interface StepInputAttributes { * Determines the name by which the component will be identified upon submission in an HTML form. * * **Note:** This property is only applicable within the context of an HTML Form element. + * @default undefined */ - name?: string; + name?: string | undefined; /** * Defines a short hint, intended to aid the user with data entry when the diff --git a/packages/main/src/webComponents/Switch/index.tsx b/packages/main/src/webComponents/Switch/index.tsx index 500ba7a6446..0baaa251e90 100644 --- a/packages/main/src/webComponents/Switch/index.tsx +++ b/packages/main/src/webComponents/Switch/index.tsx @@ -13,8 +13,9 @@ interface SwitchAttributes { * Providing an `accessibleNameRef` or an `accessibleName` is mandatory in the cases when `textOn` and `textOff` properties aren't set. * * **Note:** Available since [v1.2.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.2.0) of **@ui5/webcomponents**. + * @default undefined */ - accessibleName?: string; + accessibleName?: string | undefined; /** * Receives id(or many ids) of the elements that label the component. @@ -23,8 +24,9 @@ interface SwitchAttributes { * Providing an `accessibleNameRef` or an `accessibleName` is mandatory in the cases when `textOn` and `textOff` properties aren't set. * * **Note:** Available since [v1.1.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.1.0) of **@ui5/webcomponents**. + * @default undefined */ - accessibleNameRef?: string; + accessibleNameRef?: string | undefined; /** * Defines if the component is checked. @@ -58,8 +60,9 @@ interface SwitchAttributes { * **Note:** This property is only applicable within the context of an HTML Form element. * * **Note:** Available since [v1.16.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.16.0) of **@ui5/webcomponents**. + * @default undefined */ - name?: string; + name?: string | undefined; /** * Defines whether the component is required. @@ -73,15 +76,17 @@ interface SwitchAttributes { * Defines the text, displayed when the component is not checked. * * **Note:** We recommend using short texts, up to 3 letters (larger texts would be cut off). + * @default undefined */ - textOff?: string; + textOff?: string | undefined; /** * Defines the text, displayed when the component is checked. * * **Note:** We recommend using short texts, up to 3 letters (larger texts would be cut off). + * @default undefined */ - textOn?: string; + textOn?: string | undefined; /** * Defines the tooltip of the component. @@ -89,8 +94,9 @@ interface SwitchAttributes { * **Note:** If applicable an external label reference should always be the preferred option to provide context to the `Switch` component over a tooltip. * * **Note:** Available since [v1.9.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.9.0) of **@ui5/webcomponents**. + * @default undefined */ - tooltip?: string; + tooltip?: string | undefined; } interface SwitchDomRef extends Required, Ui5DomRef {} diff --git a/packages/main/src/webComponents/Tab/index.tsx b/packages/main/src/webComponents/Tab/index.tsx index 299594471aa..b5ac3fe0fb9 100644 --- a/packages/main/src/webComponents/Tab/index.tsx +++ b/packages/main/src/webComponents/Tab/index.tsx @@ -9,8 +9,9 @@ import type { CommonProps, Ui5DomRef, UI5WCSlotsNode } from '../../types/index.j interface TabAttributes { /** * Represents the "additionalText" text, which is displayed in the tab. In the cases when in the same time there are tabs with icons and tabs without icons, if a tab has no icon the "additionalText" is displayed larger. + * @default undefined */ - additionalText?: string; + additionalText?: string | undefined; /** * Defines the component's design color. @@ -38,8 +39,9 @@ interface TabAttributes { * Defines the icon source URI to be displayed as graphical element within the component. * The SAP-icons font provides numerous built-in icons. * See all the available icons in the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html). + * @default undefined */ - icon?: string; + icon?: string | undefined; /** * Specifies if the component is selected. @@ -49,8 +51,9 @@ interface TabAttributes { /** * The text to be displayed for the item. + * @default undefined */ - text?: string; + text?: string | undefined; } interface TabDomRef extends Required, Ui5DomRef { diff --git a/packages/main/src/webComponents/TextArea/index.tsx b/packages/main/src/webComponents/TextArea/index.tsx index 83b62cb8d18..d5548013199 100644 --- a/packages/main/src/webComponents/TextArea/index.tsx +++ b/packages/main/src/webComponents/TextArea/index.tsx @@ -8,13 +8,15 @@ import type { CommonProps, Ui5CustomEvent, Ui5DomRef, UI5WCSlotsNode } from '../ interface TextAreaAttributes { /** * Defines the accessible ARIA name of the component. + * @default undefined */ - accessibleName?: string; + accessibleName?: string | undefined; /** * Receives id(or many ids) of the elements that label the textarea. + * @default undefined */ - accessibleNameRef?: string; + accessibleNameRef?: string | undefined; /** * Indicates whether the user can interact with the component or not. @@ -46,13 +48,15 @@ interface TextAreaAttributes { * Determines the name by which the component will be identified upon submission in an HTML form. * * **Note:** This property is only applicable within the context of an HTML Form element. + * @default undefined */ - name?: string; + name?: string | undefined; /** * Defines a short hint intended to aid the user with data entry when the component has no value. + * @default undefined */ - placeholder?: string; + placeholder?: string | undefined; /** * Defines whether the component is read-only. diff --git a/packages/main/src/webComponents/TimePicker/index.tsx b/packages/main/src/webComponents/TimePicker/index.tsx index c06b2824785..06e4b8451ef 100644 --- a/packages/main/src/webComponents/TimePicker/index.tsx +++ b/packages/main/src/webComponents/TimePicker/index.tsx @@ -20,8 +20,9 @@ interface TimePickerAttributes { * HH:mm:ss -> 11:42:35 * hh:mm:ss a -> 2:23:15 PM * mm:ss -> 12:04 (only minutes and seconds) + * @default undefined */ - formatPattern?: string; + formatPattern?: string | undefined; /** * Determines the name by which the component will be identified upon submission in an HTML form. @@ -29,8 +30,9 @@ interface TimePickerAttributes { * **Note:** This property is only applicable within the context of an HTML Form element. * * **Note:** Available since [v2.0.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v2.0.0) of **@ui5/webcomponents**. + * @default undefined */ - name?: string; + name?: string | undefined; /** * Defines the open or closed state of the popover. @@ -58,9 +60,8 @@ interface TimePickerAttributes { /** * Defines a formatted time value. - * @default undefined */ - value?: string | undefined; + value?: string; /** * Defines the value state of the component. @@ -73,7 +74,7 @@ interface TimePickerDomRef extends Required, Ui5DomRef { /** * Currently selected time represented as JavaScript Date instance */ - readonly dateValue: Date | Array | null; + readonly dateValue: Date | null; /** * Formats a Java Script date object into a string representing a locale date and time diff --git a/packages/main/src/webComponents/Timeline/index.tsx b/packages/main/src/webComponents/Timeline/index.tsx index d2d37cbab38..58e808016c1 100644 --- a/packages/main/src/webComponents/Timeline/index.tsx +++ b/packages/main/src/webComponents/Timeline/index.tsx @@ -11,8 +11,9 @@ interface TimelineAttributes { * Defines the accessible ARIA name of the component. * * **Note:** Available since [v1.2.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.2.0) of **@ui5/webcomponents-fiori**. + * @default undefined */ - accessibleName?: string; + accessibleName?: string | undefined; /** * Defines the items orientation. diff --git a/packages/main/src/webComponents/TimelineItem/index.tsx b/packages/main/src/webComponents/TimelineItem/index.tsx index 6919486e1c9..80d8219a1e7 100644 --- a/packages/main/src/webComponents/TimelineItem/index.tsx +++ b/packages/main/src/webComponents/TimelineItem/index.tsx @@ -11,13 +11,15 @@ interface TimelineItemAttributes { * SAP-icons font provides numerous options. * * See all the available icons in the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html). + * @default undefined */ - icon?: string; + icon?: string | undefined; /** * Defines the name of the item, displayed before the `title-text`. + * @default undefined */ - name?: string; + name?: string | undefined; /** * Defines if the `name` is clickable. @@ -27,13 +29,15 @@ interface TimelineItemAttributes { /** * Defines the subtitle text of the component. + * @default undefined */ - subtitleText?: string; + subtitleText?: string | undefined; /** * Defines the title text of the component. + * @default undefined */ - titleText?: string; + titleText?: string | undefined; } interface TimelineItemDomRef extends Required, Ui5DomRef {} diff --git a/packages/main/src/webComponents/ToggleButton/index.tsx b/packages/main/src/webComponents/ToggleButton/index.tsx index c106d737996..164d6932c37 100644 --- a/packages/main/src/webComponents/ToggleButton/index.tsx +++ b/packages/main/src/webComponents/ToggleButton/index.tsx @@ -38,8 +38,9 @@ interface ToggleButtonAttributes { * Receives id(or many ids) of the elements that label the component. * * **Note:** Available since [v1.1.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.1.0) of **@ui5/webcomponents**. + * @default undefined */ - accessibleNameRef?: string; + accessibleNameRef?: string | undefined; /** * Describes the accessibility role of the button. @@ -75,8 +76,9 @@ interface ToggleButtonAttributes { * * Example: * See all the available icons within the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html). + * @default undefined */ - endIcon?: string; + endIcon?: string | undefined; /** * Defines the icon, displayed as graphical element within the component. @@ -84,8 +86,9 @@ interface ToggleButtonAttributes { * * Example: * See all the available icons within the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html). + * @default undefined */ - icon?: string; + icon?: string | undefined; /** * Determines whether the component is displayed as pressed. @@ -109,8 +112,9 @@ interface ToggleButtonAttributes { * **Note:** A tooltip attribute should be provided for icon-only buttons, in order to represent their exact meaning/function. * * **Note:** Available since [v1.2.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.2.0) of **@ui5/webcomponents**. + * @default undefined */ - tooltip?: string; + tooltip?: string | undefined; /** * Defines whether the button has special form-related functionality. diff --git a/packages/main/src/webComponents/Token/index.tsx b/packages/main/src/webComponents/Token/index.tsx index c8ec6e58c1c..7ba78ad5f2b 100644 --- a/packages/main/src/webComponents/Token/index.tsx +++ b/packages/main/src/webComponents/Token/index.tsx @@ -13,8 +13,9 @@ interface TokenAttributes { /** * Defines the text of the token. + * @default undefined */ - text?: string; + text?: string | undefined; } interface TokenDomRef extends Required, Ui5DomRef {} diff --git a/packages/main/src/webComponents/Toolbar/index.tsx b/packages/main/src/webComponents/Toolbar/index.tsx index 84d860d8ad5..772b656df71 100644 --- a/packages/main/src/webComponents/Toolbar/index.tsx +++ b/packages/main/src/webComponents/Toolbar/index.tsx @@ -10,13 +10,15 @@ import type { CommonProps, Ui5DomRef } from '../../types/index.js'; interface ToolbarAttributes { /** * Defines the accessible ARIA name of the component. + * @default undefined */ - accessibleName?: string; + accessibleName?: string | undefined; /** * Receives id(or many ids) of the elements that label the input. + * @default undefined */ - accessibleNameRef?: string; + accessibleNameRef?: string | undefined; /** * Indicated the direction in which the Toolbar items will be aligned. diff --git a/packages/main/src/webComponents/ToolbarButton/index.tsx b/packages/main/src/webComponents/ToolbarButton/index.tsx index c6aa4ef3f0b..e501bddb93c 100644 --- a/packages/main/src/webComponents/ToolbarButton/index.tsx +++ b/packages/main/src/webComponents/ToolbarButton/index.tsx @@ -4,7 +4,6 @@ import '@ui5/webcomponents/dist/ToolbarButton.js'; import type { ToolbarButtonAccessibilityAttributes } from '@ui5/webcomponents/dist/ToolbarButton.js'; import type ButtonDesign from '@ui5/webcomponents/dist/types/ButtonDesign.js'; import type ToolbarItemOverflowBehavior from '@ui5/webcomponents/dist/types/ToolbarItemOverflowBehavior.js'; -import type { CSSProperties } from 'react'; import { withWebComponent } from '../../internal/withWebComponent.js'; import type { CommonProps, Ui5CustomEvent, Ui5DomRef } from '../../types/index.js'; @@ -34,8 +33,9 @@ interface ToolbarButtonAttributes { /** * Receives id(or many ids) of the elements that label the component. + * @default undefined */ - accessibleNameRef?: string; + accessibleNameRef?: string | undefined; /** * Defines the action design. @@ -61,16 +61,18 @@ interface ToolbarButtonAttributes { * * Example: * See all the available icons within the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html). + * @default undefined */ - endIcon?: string; + endIcon?: string | undefined; /** * Defines the `icon` source URI. * * **Note:** SAP-icons font provides numerous buil-in icons. To find all the available icons, see the * [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html). + * @default undefined */ - icon?: string; + icon?: string | undefined; /** * Property used to define the access of the item to the overflow Popover. If "NeverOverflow" option is set, @@ -88,15 +90,17 @@ interface ToolbarButtonAttributes { /** * Button text + * @default undefined */ - text?: string; + text?: string | undefined; /** * Defines the tooltip of the component. * * **Note:** A tooltip attribute should be provided for icon-only buttons, in order to represent their exact meaning/function. + * @default undefined */ - tooltip?: string; + tooltip?: string | undefined; /** * Defines the width of the button. @@ -104,7 +108,7 @@ interface ToolbarButtonAttributes { * **Note:** all CSS sizes are supported - 'percentage', 'px', 'rem', 'auto', etc. * @default undefined */ - width?: CSSProperties['width'] | CSSProperties['height']; + width?: string | undefined; } interface ToolbarButtonDomRef extends Required, Ui5DomRef {} diff --git a/packages/main/src/webComponents/ToolbarSelect/index.tsx b/packages/main/src/webComponents/ToolbarSelect/index.tsx index 86b496bd8c3..c6d3f6da963 100644 --- a/packages/main/src/webComponents/ToolbarSelect/index.tsx +++ b/packages/main/src/webComponents/ToolbarSelect/index.tsx @@ -4,20 +4,22 @@ import '@ui5/webcomponents/dist/ToolbarSelect.js'; import type { ToolbarSelectChangeEventDetail } from '@ui5/webcomponents/dist/ToolbarSelect.js'; import type ToolbarItemOverflowBehavior from '@ui5/webcomponents/dist/types/ToolbarItemOverflowBehavior.js'; import type ValueState from '@ui5/webcomponents-base/dist/types/ValueState.js'; -import type { CSSProperties, ReactNode } from 'react'; +import type { ReactNode } from 'react'; import { withWebComponent } from '../../internal/withWebComponent.js'; import type { CommonProps, Ui5CustomEvent, Ui5DomRef } from '../../types/index.js'; interface ToolbarSelectAttributes { /** * Defines the accessible ARIA name of the component. + * @default undefined */ - accessibleName?: string; + accessibleName?: string | undefined; /** * Receives id(or many ids) of the elements that label the select. + * @default undefined */ - accessibleNameRef?: string; + accessibleNameRef?: string | undefined; /** * Defines whether the component is in disabled state. @@ -53,7 +55,7 @@ interface ToolbarSelectAttributes { * **Note:** all CSS sizes are supported - 'percentage', 'px', 'rem', 'auto', etc. * @default undefined */ - width?: CSSProperties['width'] | CSSProperties['height']; + width?: string | undefined; } interface ToolbarSelectDomRef extends Required, Ui5DomRef {} diff --git a/packages/main/src/webComponents/ToolbarSpacer/index.tsx b/packages/main/src/webComponents/ToolbarSpacer/index.tsx index 40551d567ba..61239f7dc06 100644 --- a/packages/main/src/webComponents/ToolbarSpacer/index.tsx +++ b/packages/main/src/webComponents/ToolbarSpacer/index.tsx @@ -2,7 +2,6 @@ import '@ui5/webcomponents/dist/ToolbarSpacer.js'; import type ToolbarItemOverflowBehavior from '@ui5/webcomponents/dist/types/ToolbarItemOverflowBehavior.js'; -import type { CSSProperties } from 'react'; import { withWebComponent } from '../../internal/withWebComponent.js'; import type { CommonProps, Ui5DomRef } from '../../types/index.js'; @@ -27,7 +26,7 @@ interface ToolbarSpacerAttributes { * **Note:** all CSS sizes are supported - 'percentage', 'px', 'rem', 'auto', etc. * @default undefined */ - width?: CSSProperties['width'] | CSSProperties['height']; + width?: string | undefined; } interface ToolbarSpacerDomRef extends Required, Ui5DomRef {} diff --git a/packages/main/src/webComponents/Tree/index.tsx b/packages/main/src/webComponents/Tree/index.tsx index 8af6745f121..1b45ffc9b84 100644 --- a/packages/main/src/webComponents/Tree/index.tsx +++ b/packages/main/src/webComponents/Tree/index.tsx @@ -20,39 +20,44 @@ interface TreeAttributes { * Defines the accessible name of the component. * * **Note:** Available since [v1.8.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.8.0) of **@ui5/webcomponents**. + * @default undefined */ - accessibleName?: string; + accessibleName?: string | undefined; /** * Defines the IDs of the elements that label the component. * * **Note:** Available since [v1.8.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.8.0) of **@ui5/webcomponents**. + * @default undefined */ - accessibleNameRef?: string; + accessibleNameRef?: string | undefined; /** * Defines the component footer text. + * @default undefined */ - footerText?: string; + footerText?: string | undefined; /** * Defines the component header text. * * **Note:** If the `header` slot is set, this property is ignored. + * @default undefined */ - headerText?: string; + headerText?: string | undefined; /** * Defines the text that is displayed when the component contains no items. + * @default undefined */ - noDataText?: string; + noDataText?: string | undefined; /** * Defines the selection mode of the component. Since the tree uses a `List` to display its structure, * the tree modes are exactly the same as the list modes, and are all applicable. * @default "None" */ - selectionMode?: ListSelectionMode | keyof typeof ListSelectionMode; + selectionMode?: ListSelectionMode | undefined | keyof typeof ListSelectionMode; } interface TreeDomRef extends Required, Ui5DomRef { diff --git a/packages/main/src/webComponents/TreeItem/index.tsx b/packages/main/src/webComponents/TreeItem/index.tsx index ae66bc28941..389de2c264e 100644 --- a/packages/main/src/webComponents/TreeItem/index.tsx +++ b/packages/main/src/webComponents/TreeItem/index.tsx @@ -29,13 +29,15 @@ interface TreeItemAttributes { * Defines the accessible name of the component. * * **Note:** Available since [v1.8.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.8.0) of **@ui5/webcomponents**. + * @default undefined */ - accessibleName?: string; + accessibleName?: string | undefined; /** * Defines the `additionalText`, displayed in the end of the tree item. + * @default undefined */ - additionalText?: string; + additionalText?: string | undefined; /** * Defines the state of the `additionalText`. @@ -72,8 +74,9 @@ interface TreeItemAttributes { /** * If set, an icon will be displayed before the text of the tree list item. + * @default undefined */ - icon?: string; + icon?: string | undefined; /** * Defines whether the selection of a tree node is displayed as partially selected. @@ -118,15 +121,17 @@ interface TreeItemAttributes { /** * Defines the text of the tree item. + * @default undefined */ - text?: string; + text?: string | undefined; /** * Defines the text of the tooltip that would be displayed for the list item. * * **Note:** Available since [v1.23.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.23.0) of **@ui5/webcomponents**. + * @default undefined */ - tooltip?: string; + tooltip?: string | undefined; /** * Defines the visual indication and behavior of the list items. diff --git a/packages/main/src/webComponents/TreeItemCustom/index.tsx b/packages/main/src/webComponents/TreeItemCustom/index.tsx index c4cb7ddec2c..0b5d6d217e9 100644 --- a/packages/main/src/webComponents/TreeItemCustom/index.tsx +++ b/packages/main/src/webComponents/TreeItemCustom/index.tsx @@ -29,8 +29,9 @@ interface TreeItemCustomAttributes { * Defines the accessible name of the component. * * **Note:** Available since [v1.8.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.8.0) of **@ui5/webcomponents**. + * @default undefined */ - accessibleName?: string; + accessibleName?: string | undefined; /** * Defines the state of the `additionalText`. @@ -73,8 +74,9 @@ interface TreeItemCustomAttributes { /** * If set, an icon will be displayed before the text of the tree list item. + * @default undefined */ - icon?: string; + icon?: string | undefined; /** * Defines whether the selection of a tree node is displayed as partially selected. @@ -121,8 +123,9 @@ interface TreeItemCustomAttributes { * Defines the text of the tooltip that would be displayed for the list item. * * **Note:** Available since [v1.23.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.23.0) of **@ui5/webcomponents**. + * @default undefined */ - tooltip?: string; + tooltip?: string | undefined; /** * Defines the visual indication and behavior of the list items. diff --git a/packages/main/src/webComponents/UploadCollection/index.tsx b/packages/main/src/webComponents/UploadCollection/index.tsx index 5261bb7e9dc..0ba5d360761 100644 --- a/packages/main/src/webComponents/UploadCollection/index.tsx +++ b/packages/main/src/webComponents/UploadCollection/index.tsx @@ -13,8 +13,9 @@ import type { CommonProps, Ui5CustomEvent, Ui5DomRef, UI5WCSlotsNode } from '../ interface UploadCollectionAttributes { /** * Defines the accessible ARIA name of the component. + * @default undefined */ - accessibleName?: string; + accessibleName?: string | undefined; /** * By default there will be drag and drop overlay shown over the `UploadCollection` when files @@ -28,13 +29,15 @@ interface UploadCollectionAttributes { /** * Allows you to set your own text for the 'No data' description. + * @default undefined */ - noDataDescription?: string; + noDataDescription?: string | undefined; /** * Allows you to set your own text for the 'No data' text. + * @default undefined */ - noDataText?: string; + noDataText?: string | undefined; /** * Defines the selection mode of the `UploadCollection`. diff --git a/packages/main/src/webComponents/ViewSettingsDialog/index.tsx b/packages/main/src/webComponents/ViewSettingsDialog/index.tsx index 29781016af1..163260ffe03 100644 --- a/packages/main/src/webComponents/ViewSettingsDialog/index.tsx +++ b/packages/main/src/webComponents/ViewSettingsDialog/index.tsx @@ -10,6 +10,14 @@ import { withWebComponent } from '../../internal/withWebComponent.js'; import type { CommonProps, Ui5CustomEvent, Ui5DomRef, UI5WCSlotsNode } from '../../types/index.js'; interface ViewSettingsDialogAttributes { + /** + * Indicates if the dialog is open. + * + * **Note:** Available since [v2.0.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v2.0.0) of **@ui5/webcomponents-fiori**. + * @default false + */ + open?: boolean; + /** * Defines the initial sort order. * @default false @@ -29,19 +37,20 @@ interface ViewSettingsDialogDomRef extends Required void; - - /** - * Shows the dialog. - * @returns {void} - */ - show: () => void; } interface ViewSettingsDialogPropTypes extends ViewSettingsDialogAttributes, Omit< CommonProps, - keyof ViewSettingsDialogAttributes | 'filterItems' | 'sortItems' | 'onBeforeOpen' | 'onCancel' | 'onConfirm' + | keyof ViewSettingsDialogAttributes + | 'filterItems' + | 'sortItems' + | 'onBeforeOpen' + | 'onCancel' + | 'onClose' + | 'onConfirm' + | 'onOpen' > { /** * Defines the `filterItems` list. @@ -78,10 +87,24 @@ interface ViewSettingsDialogPropTypes */ onCancel?: (event: Ui5CustomEvent) => void; + /** + * Fired after the dialog is closed. + * + * **Note:** Available since [v2.0.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v2.0.0) of **@ui5/webcomponents-fiori**. + */ + onClose?: (event: Ui5CustomEvent) => void; + /** * Fired when confirmation button is activated. */ onConfirm?: (event: Ui5CustomEvent) => void; + + /** + * Fired after the dialog is opened. + * + * **Note:** Available since [v2.0.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v2.0.0) of **@ui5/webcomponents-fiori**. + */ + onOpen?: (event: Ui5CustomEvent) => void; } /** @@ -108,9 +131,9 @@ interface ViewSettingsDialogPropTypes const ViewSettingsDialog = withWebComponent( 'ui5-view-settings-dialog', [], - ['sortDescending'], + ['open', 'sortDescending'], ['filterItems', 'sortItems'], - ['before-open', 'cancel', 'confirm'], + ['before-open', 'cancel', 'close', 'confirm', 'open'], () => import('@ui5/webcomponents-fiori/dist/ViewSettingsDialog.js') ); diff --git a/packages/main/src/webComponents/WizardStep/index.tsx b/packages/main/src/webComponents/WizardStep/index.tsx index 83b2518efba..92d11bda3c3 100644 --- a/packages/main/src/webComponents/WizardStep/index.tsx +++ b/packages/main/src/webComponents/WizardStep/index.tsx @@ -33,8 +33,9 @@ interface WizardStepAttributes { * * The SAP-icons font provides numerous options. * See all the available icons in the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html). + * @default undefined */ - icon?: string; + icon?: string | undefined; /** * Defines the step's `selected` state - the step that is currently active. @@ -49,15 +50,17 @@ interface WizardStepAttributes { * Defines the `subtitleText` of the step. * * **Note:** the text is displayed in the `Wizard` navigation header. + * @default undefined */ - subtitleText?: string; + subtitleText?: string | undefined; /** * Defines the `titleText` of the step. * * **Note:** The text is displayed in the `Wizard` navigation header. + * @default undefined */ - titleText?: string; + titleText?: string | undefined; } interface WizardStepDomRef extends Required, Ui5DomRef {} diff --git a/packages/main/src/webComponents/index.ts b/packages/main/src/webComponents/index.ts index 857069651c0..87f3c83b65c 100644 --- a/packages/main/src/webComponents/index.ts +++ b/packages/main/src/webComponents/index.ts @@ -48,6 +48,7 @@ export * from './MediaGallery/index.js'; export * from './MediaGalleryItem/index.js'; export * from './Menu/index.js'; export * from './MenuItem/index.js'; +export * from './MenuSeparator/index.js'; export * from './MessageStrip/index.js'; export * from './MultiComboBox/index.js'; export * from './MultiComboBoxItem/index.js'; From fd43454782bcf9b774364e9e84f1348874e34c3d Mon Sep 17 00:00:00 2001 From: Marcus Notheis Date: Wed, 3 Jul 2024 17:11:48 +0200 Subject: [PATCH 3/9] Tabe --- .../codemod/transforms/v2/codemodConfig.json | 2 +- packages/main/src/webComponents/Table/index.tsx | 17 +++++++++++++---- 2 files changed, 14 insertions(+), 5 deletions(-) diff --git a/packages/cli/src/scripts/codemod/transforms/v2/codemodConfig.json b/packages/cli/src/scripts/codemod/transforms/v2/codemodConfig.json index 76141b9ba14..642213a034b 100644 --- a/packages/cli/src/scripts/codemod/transforms/v2/codemodConfig.json +++ b/packages/cli/src/scripts/codemod/transforms/v2/codemodConfig.json @@ -434,10 +434,10 @@ "comment": "noDataText is now noData slot", "changedProps": { "busy": "loading", + "busyDelay": "loadingDelay", "columns": "headerRow" }, "removedProps": [ - "busyDelay", "growing", "growingButtonSubtext", "growingButtonText", diff --git a/packages/main/src/webComponents/Table/index.tsx b/packages/main/src/webComponents/Table/index.tsx index a09561fd0e2..031ade0c66c 100644 --- a/packages/main/src/webComponents/Table/index.tsx +++ b/packages/main/src/webComponents/Table/index.tsx @@ -10,13 +10,15 @@ import type { CommonProps, Ui5CustomEvent, Ui5DomRef, UI5WCSlotsNode } from '../ interface TableAttributes { /** * Defines the accessible ARIA name of the component. + * @default undefined */ - accessibleName?: string; + accessibleName?: string | undefined; /** * Identifies the element (or elements) that labels the component. + * @default undefined */ - accessibleNameRef?: string; + accessibleNameRef?: string | undefined; /** * Defines if the loading indicator should be shown. @@ -26,10 +28,17 @@ interface TableAttributes { */ loading?: boolean; + /** + * Defines the delay in milliseconds, after which the loading indicator will show up for this component. + * @default 1000 + */ + loadingDelay?: number; + /** * Defines the text to be displayed when there are no rows in the component. + * @default undefined */ - noDataText?: string; + noDataText?: string | undefined; /** * Defines the mode of the ui5-table overflow behavior. @@ -165,7 +174,7 @@ interface TablePropTypes */ const Table = withWebComponent( 'ui5-table', - ['accessibleName', 'accessibleNameRef', 'noDataText', 'overflowMode'], + ['accessibleName', 'accessibleNameRef', 'loadingDelay', 'noDataText', 'overflowMode'], ['loading'], ['features', 'headerRow', 'nodata'], ['row-click'], From 05464fc97c342b2dd55f86705a0232b98a8df9b5 Mon Sep 17 00:00:00 2001 From: Marcus Notheis Date: Wed, 3 Jul 2024 17:12:29 +0200 Subject: [PATCH 4/9] other Table components --- packages/main/src/webComponents/TableCell/index.tsx | 10 ++++++++-- .../main/src/webComponents/TableGrowing/index.tsx | 6 ++++-- packages/main/src/webComponents/TableRow/index.tsx | 11 +++++++++-- 3 files changed, 21 insertions(+), 6 deletions(-) diff --git a/packages/main/src/webComponents/TableCell/index.tsx b/packages/main/src/webComponents/TableCell/index.tsx index e8d52a4a685..bd1d1ef704f 100644 --- a/packages/main/src/webComponents/TableCell/index.tsx +++ b/packages/main/src/webComponents/TableCell/index.tsx @@ -1,5 +1,6 @@ 'use client'; +import '@ui5/webcomponents/dist/TableCell.js'; import type { ReactNode } from 'react'; import { withWebComponent } from '../../internal/withWebComponent.js'; import type { CommonProps, Ui5DomRef } from '../../types/index.js'; @@ -25,8 +26,13 @@ interface TableCellPropTypes extends TableCellAttributes, Omit('ui5-table-cell', [], [], [], [], () => - Promise.resolve() +const TableCell = withWebComponent( + 'ui5-table-cell', + [], + [], + [], + [], + () => import('@ui5/webcomponents/dist/TableCell.js') ); TableCell.displayName = 'TableCell'; diff --git a/packages/main/src/webComponents/TableGrowing/index.tsx b/packages/main/src/webComponents/TableGrowing/index.tsx index 67004a6c621..6185ea9cb96 100644 --- a/packages/main/src/webComponents/TableGrowing/index.tsx +++ b/packages/main/src/webComponents/TableGrowing/index.tsx @@ -9,8 +9,9 @@ interface TableGrowingAttributes { /** * Defines the text that will be displayed below the `growingText` inside the growing button. * Has no effect when type is set to Scroll. + * @default undefined */ - growingSubText?: string; + growingSubText?: string | undefined; /** * Defines the text that will be displayed inside the growing button. @@ -18,8 +19,9 @@ interface TableGrowingAttributes { * * **Note:** When not provided and the type is set to Button, a default text is displayed, corresponding to the * current language. + * @default undefined */ - growingText?: string; + growingText?: string | undefined; /** * Defines the mode of the ui5-table growing. diff --git a/packages/main/src/webComponents/TableRow/index.tsx b/packages/main/src/webComponents/TableRow/index.tsx index da3126efcb4..29713b2a0b0 100644 --- a/packages/main/src/webComponents/TableRow/index.tsx +++ b/packages/main/src/webComponents/TableRow/index.tsx @@ -1,5 +1,6 @@ 'use client'; +import '@ui5/webcomponents/dist/TableRow.js'; import type { ReactNode } from 'react'; import { withWebComponent } from '../../internal/withWebComponent.js'; import type { CommonProps, Ui5DomRef } from '../../types/index.js'; @@ -15,6 +16,12 @@ interface TableRowAttributes { * Unique identifier of the component. */ key?: string; + + /** + * Defines the navigated state of the row. + * @default false + */ + navigated?: boolean; } interface TableRowDomRef extends Required, Ui5DomRef {} @@ -40,10 +47,10 @@ interface TableRowPropTypes extends TableRowAttributes, Omit( 'ui5-table-row', ['key'], - ['interactive'], + ['interactive', 'navigated'], [], [], - () => Promise.resolve() + () => import('@ui5/webcomponents/dist/TableRow.js') ); TableRow.displayName = 'TableRow'; From d8f9bf4f9999bc32a84e462de9e7ebd83f47199e Mon Sep 17 00:00:00 2001 From: Marcus Notheis Date: Fri, 5 Jul 2024 07:44:28 +0200 Subject: [PATCH 5/9] SuggestionItemGroup BREAKING CHANGE: the `SuggestionGroupItem` component has been replaced by the `SuggestionItemGroup` component --- .storybook/utils.ts | 2 +- .../codemod/transforms/v2/codemodConfig.json | 11 ++-- packages/cli/src/util/formatters.ts | 1 + .../main/src/webComponents/Input/Input.mdx | 8 +-- .../src/webComponents/Input/Input.stories.tsx | 21 +++--- .../webComponents/MultiInput/MultiInput.mdx | 8 +-- .../SuggestionGroupItem/index.tsx | 39 ----------- .../SuggestionItemCustom/index.tsx | 50 ++++++++++++++ .../SuggestionItemGroup/index.tsx | 66 +++++++++++++++++++ packages/main/src/webComponents/index.ts | 3 +- 10 files changed, 146 insertions(+), 63 deletions(-) delete mode 100644 packages/main/src/webComponents/SuggestionGroupItem/index.tsx create mode 100644 packages/main/src/webComponents/SuggestionItemCustom/index.tsx create mode 100644 packages/main/src/webComponents/SuggestionItemGroup/index.tsx diff --git a/.storybook/utils.ts b/.storybook/utils.ts index ec1f7b77652..3a4cfcada53 100644 --- a/.storybook/utils.ts +++ b/.storybook/utils.ts @@ -55,7 +55,7 @@ export function useGetCem() { const replaceSubComps = { ListItemBase: ['ListItemStandard', 'ListItemCustom', 'ListItemGroup'], - InputSuggestionItem: ['SuggestionItem', 'SuggestionGroupItem'], + InputSuggestionItem: ['SuggestionItem', 'SuggestionItemGroup'], NotificationListItemBase: ['NotificationListItem'], ToolbarItem: ['ToolbarSeparatorV2', 'ToolbarSpacerV2', 'ToolbarButton', 'ToolbarSelect', 'ToolbarSelectOption'], TreeItemBase: ['TreeItem', 'TreeItemCustom'], diff --git a/packages/cli/src/scripts/codemod/transforms/v2/codemodConfig.json b/packages/cli/src/scripts/codemod/transforms/v2/codemodConfig.json index 642213a034b..b42a79ccc91 100644 --- a/packages/cli/src/scripts/codemod/transforms/v2/codemodConfig.json +++ b/packages/cli/src/scripts/codemod/transforms/v2/codemodConfig.json @@ -411,12 +411,15 @@ "valueState": "ValueState" } }, - "SuggestionGroupItem": {}, - "SuggestionItem": { - "renamedEnums": { - "additionalTextState": "ValueState" + "SuggestionGroupItem": { + "newComponent": "SuggestionItemGroup", + "changedProps": { + "text": "headerText" } }, + "SuggestionItem": { + "removedProps": ["additionalTextState", "description", "icon", "iconEnd", "image", "type"] + }, "Switch": {}, "Tab": { "changedProps": { diff --git a/packages/cli/src/util/formatters.ts b/packages/cli/src/util/formatters.ts index eb4a25fee48..724ae0a55b4 100644 --- a/packages/cli/src/util/formatters.ts +++ b/packages/cli/src/util/formatters.ts @@ -45,6 +45,7 @@ export function mapWebComponentTypeToPrimitive(type: string): string | null { switch (type) { case 'sap.ui.webc.base.types.Integer': case 'sap.ui.webc.base.types.Float': + case 'number': return 'number'; case 'string': return 'string'; diff --git a/packages/main/src/webComponents/Input/Input.mdx b/packages/main/src/webComponents/Input/Input.mdx index 4dad1dcff87..e9aa4e0d4a1 100644 --- a/packages/main/src/webComponents/Input/Input.mdx +++ b/packages/main/src/webComponents/Input/Input.mdx @@ -1,7 +1,7 @@ import { ArgTypesWithNote, ControlsWithNote, DocsHeader, Footer } from '@sb/components'; import SubcomponentsSection from '@sb/docs/SubcomponentsSection.md?raw'; import { Canvas, Description, Markdown, Meta } from '@storybook/blocks'; -import { SuggestionGroupItem } from '../SuggestionGroupItem'; +import { SuggestionItemGroup } from '../SuggestionItemGroup'; import { SuggestionItem } from '../SuggestionItem'; import * as ComponentStories from './Input.stories'; import { excludePropsForAbstract } from '@sb/utils'; @@ -42,9 +42,9 @@ and the `showSuggestions` prop is set to `true`. -## SuggestionGroupItem +## SuggestionItemGroup - - + +