{ "schemaVersion": "1.0.0", "readme": "", "modules": [ { "kind": "javascript-module", "path": "dist/Assets-fetch.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "dist/Assets-node.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "dist/Assets.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "dist/BarcodeScannerDialog.js", "declarations": [ { "kind": "class", "description": "### Overview\n\nThe `BarcodeScannerDialog` component provides barcode scanning functionality for all devices that support the `MediaDevices.getUserMedia()` native API.\nOpening the dialog launches the device camera and scans for known barcode formats.\n\nA `scanSuccess` event fires whenever a barcode is identified\nand a `scanError` event fires when the scan failed (for example, due to missing permisions).\n\nInternally, the component uses the zxing-js/library third party OSS.\n\nFor a list of supported barcode formats, see the [zxing-js/library](https://github.com/zxing-js/library) documentation.", "name": "BarcodeScannerDialog", "slots": [ { "name": "footer", "description": "Defines the footer HTML Element.\n\n**Note:** When you provide custom content for the `footer` slot, the default close button is not rendered.\nThis means you need to include your own mechanism within the custom `footer` to close the dialog,\nsuch as a button with an event listener that closes the dialog.\n\n**Note:** If the `footer` slot is not provided, a default footer with a close button is rendered automatically,\nallowing users to close the dialog without any additional implementation.", "_ui5since": "2.4.0", "_ui5type": { "text": "Array" }, "_ui5privacy": "public" }, { "name": "header", "description": "Defines the header HTML Element.\n\n**Note:** If `header` slot is provided, the labelling of the dialog is a responsibility of the application developer.\n`accessibleName` should be used.", "_ui5since": "2.4.0", "_ui5type": { "text": "Array" }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the dialog is open.", "privacy": "public", "_ui5since": "1.24.0" } ], "events": [ { "name": "close", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the user closes the component.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5since": "2.0.0" }, { "name": "scan-error", "_ui5privacy": "public", "type": { "text": "CustomEvent", "references": [ { "name": "BarcodeScannerDialogScanErrorEventDetail", "package": "@ui5/webcomponents-fiori", "module": "dist/BarcodeScannerDialog.js" } ] }, "description": "Fires when the scan fails with error.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5parameters": [ { "type": { "text": "string" }, "name": "message", "_ui5privacy": "public", "description": "the error message" } ] }, { "name": "scan-success", "_ui5privacy": "public", "type": { "text": "CustomEvent", "references": [ { "name": "BarcodeScannerDialogScanSuccessEventDetail", "package": "@ui5/webcomponents-fiori", "module": "dist/BarcodeScannerDialog.js" } ] }, "description": "Fires when the scan is completed successfuuly.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5parameters": [ { "type": { "text": "Object" }, "name": "rawBytes", "_ui5privacy": "public", "description": "the scan result as a Uint8Array" }, { "type": { "text": "string" }, "name": "text", "_ui5privacy": "public", "description": "the scan result as string" } ] } ], "attributes": [ { "description": "Indicates whether the dialog is open.", "name": "open", "default": "false", "fieldName": "open", "type": { "text": "boolean" } } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-barcode-scanner-dialog", "customElement": true, "_ui5since": "1.0.0-rc.15", "_ui5privacy": "public" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "BarcodeScannerDialog", "module": "dist/BarcodeScannerDialog.js" } }, { "kind": "custom-element-definition", "name": "ui5-barcode-scanner-dialog", "declaration": { "name": "BarcodeScannerDialog", "module": "dist/BarcodeScannerDialog.js" } } ] }, { "kind": "javascript-module", "path": "dist/DynamicPage.js", "declarations": [ { "kind": "class", "description": "### Overview\n\nA layout component, representing a web page, consisting of a title, header with dynamic behavior, a content area, and an optional floating footer.\n\nThe component consist of several components:\n\n- `DynamicPageTitle` - a component, holding the title of the page, the navigation actions and the content. The displayed content changes based on the current mode of the `DynamicPageHeader`.\n- `DynamicPageHeader` - a generic container, which can contain a single layout component and any other HTML elements. The header works in two modes - expanded and snapped and its behavior can be adjusted with the help of different properties.\n- `Content area` - a generic container, which can have a single UI5 layout.\n- `Footer` - positioned at the bottom with a small offset and used for additional actions, the footer floats above the content.\n\n### Usage\n\nUse the `DynamicPage` if you need to have a title, that is always visible\nand a header, that has configurable Expanding/Snapping functionality.\nIf you don't need the Expanding/Snapping functionality it is better to use the\n`ui5-page` as a lighter component.\n\nThe app can add to the `default` slot of the ui5-dynamic-page either content that is designed to fit its container (e.g. has 100% height),\nor content with own height that may overflow its container. In the second case the `DynamicPage` will show a scrollbar that allows the user\nscroll through the content.\n\n## Notes:\n\n- Snapping of the `DynamicPageTitle` is not supported in the following case:\n - When the `DynamicPage` has a scroll bar, the component usually scrolls to the snapping point - the point, where the `DynamicPageHeader` is scrolled out completely. However, when there is a scroll bar, but not enough content to reach the snapping point, the snapping is not possible using scrolling.\n\n### Responsive Behavior\n\nDynamic page web component implements the responsive paddings design.\n\n### Keyboard Handling\n\n\n### Basic Navigation\n\n- [SPACE, ENTER, RETURN] - If focus is on a button inside DynamicPageTitle its action is being triggered, once activated.\nIf focus is on the snap header button (arrow button), or on the header itself, once activated, it triggers the associated action (such as snap/expand the header).\nIf focus is on pin button (the button with pin icon on the bottom of the header), once activated, it triggers the associated action (pinning of the header).\n\n### Fast Navigation\n- This component provides a build in fast navigation group which can be used via `F6 / Shift + F6` or ` Ctrl + Alt(Option) + Down / Ctrl + Alt(Option) + Up`.\nIn order to use this functionality, you need to import the following module:\n\n- `import \"@ui5/webcomponents-base/dist/features/F6Navigation.js\"`\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-fiori/dist/DynamicPage.js\";`", "name": "DynamicPage", "cssParts": [ { "description": "Used to style the content of the component", "name": "content" }, { "description": "Used to style the fit content container of the component.", "name": "fit-content" }, { "description": "Used to style the footer of the component", "name": "footer" } ], "slots": [ { "name": "default", "description": "Defines the content of the Dynamic Page.", "_ui5propertyName": "content", "_ui5type": { "text": "Array" }, "_ui5privacy": "public" }, { "name": "footerArea", "description": "Defines the footer HTML Element.", "_ui5type": { "text": "Array" }, "_ui5privacy": "public" }, { "name": "headerArea", "description": "Defines the header HTML Element.", "_ui5type": { "text": "Array", "references": [ { "name": "DynamicPageHeader", "package": "@ui5/webcomponents-fiori", "module": "dist/DynamicPageHeader.js" } ] }, "_ui5privacy": "public" }, { "name": "titleArea", "description": "Defines the title HTML Element.", "_ui5type": { "text": "Array", "references": [ { "name": "DynamicPageTitle", "package": "@ui5/webcomponents-fiori", "module": "dist/DynamicPageTitle.js" } ] }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "headerPinned", "type": { "text": "boolean" }, "default": "false", "description": "Defines if the header is pinned.", "privacy": "public" }, { "kind": "field", "name": "headerSnapped", "type": { "text": "boolean" }, "description": "Defines if the header is snapped.", "default": "false", "privacy": "public" }, { "kind": "field", "name": "hidePinButton", "type": { "text": "boolean" }, "default": "false", "description": "Defines if the pin button is hidden.", "privacy": "public" }, { "kind": "field", "name": "showFooter", "type": { "text": "boolean" }, "default": "false", "description": "Defines if the footer is shown.", "privacy": "public" } ], "events": [ { "name": "pin-button-toggle", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the pin header button is toggled.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true }, { "name": "title-toggle", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the expand/collapse area of the title is toggled.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true } ], "attributes": [ { "description": "Defines if the header is pinned.", "name": "header-pinned", "default": "false", "fieldName": "headerPinned", "type": { "text": "boolean" } }, { "description": "Defines if the header is snapped.", "name": "header-snapped", "default": "false", "fieldName": "headerSnapped", "type": { "text": "any" } }, { "description": "Defines if the pin button is hidden.", "name": "hide-pin-button", "default": "false", "fieldName": "hidePinButton", "type": { "text": "boolean" } }, { "description": "Defines if the footer is shown.", "name": "show-footer", "default": "false", "fieldName": "showFooter", "type": { "text": "boolean" } } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-dynamic-page", "customElement": true, "_ui5since": "2.0.0", "_ui5privacy": "public" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "DynamicPage", "module": "dist/DynamicPage.js" } }, { "kind": "custom-element-definition", "name": "ui5-dynamic-page", "declaration": { "name": "DynamicPage", "module": "dist/DynamicPage.js" } } ] }, { "kind": "javascript-module", "path": "dist/DynamicPageHeader.js", "declarations": [ { "kind": "class", "description": "Header of the DynamicPage.\n\n### Overview\n\nThe DynamicPageHeader `ui5-dynamic-page-header` is part of the DynamicPage family\nand is used to serve as header of the `DynamicPage`.\n\n### Usage\n\nThe `DynamicPageHeader` can hold any layout control and has two states - expanded\nand collapsed (snapped). The switching between these states happens when:\n- the user scrolls below its bottom margin\n- the user clicks on the `DynamicPageTitle`\n- through the `DynamicPage` property `headerSnapped`\n\n### Responsive Behavior\n\nThe responsive behavior of the `DynamicPageHeader` depends on the behavior of the\ncontent that is displayed.\n\n### Accessibility\n\nThe `DynamicPageHeader` provides an accessible label for the header region.", "name": "DynamicPageHeader", "slots": [ { "name": "default", "description": "Defines the content of the Dynamic Page Header.", "_ui5propertyName": "content", "_ui5type": { "text": "Array" }, "_ui5privacy": "public" } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-dynamic-page-header", "customElement": true, "_ui5since": "2.0.0", "_ui5privacy": "public" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "DynamicPageHeader", "module": "dist/DynamicPageHeader.js" } }, { "kind": "custom-element-definition", "name": "ui5-dynamic-page-header", "declaration": { "name": "DynamicPageHeader", "module": "dist/DynamicPageHeader.js" } } ] }, { "kind": "javascript-module", "path": "dist/DynamicPageHeaderActions.js", "declarations": [ { "kind": "class", "description": "### Overview\n\nThe `DynamicPageHeaderActions` component is part of the `DynamicPage`\nfamily and is holding the action buttons behind the `DynamicPageTitle` and the `DynamicPageHeader`.\n\nThe \"pin\" action is used to attach the header to a certain state (expanded/collapsed).\nThe expand/collapse action is used to switch between the two states of `DynamicPageHeader`.", "name": "DynamicPageHeaderActions", "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-dynamic-page-header-actions", "customElement": true, "_ui5privacy": "private" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "DynamicPageHeaderActions", "module": "dist/DynamicPageHeaderActions.js" } }, { "kind": "custom-element-definition", "name": "ui5-dynamic-page-header-actions", "declaration": { "name": "DynamicPageHeaderActions", "module": "dist/DynamicPageHeaderActions.js" } } ] }, { "kind": "javascript-module", "path": "dist/DynamicPageTitle.js", "declarations": [ { "kind": "class", "description": "### Overview\n\nTitle of the `DynamicPage`.\n\nThe `DynamicPageTitle` component is part of the `DynamicPage`\nfamily and is used to serve as title of the `DynamicPage`.\n\n### Usage\n\nThe `DynamicPageTitle` can hold any component and displays the most important\ninformation regarding the object that will always remain visible while scrolling.\n\n**Note:** The `actions` slot accepts any UI5 web component, but it's\nrecommended to use `ui5-toolbar`.\n\nThe user can switch between the expanded/collapsed states of the\n`DynamicPage` by clicking on the `DynamicPageTitle`\nor by using the expand/collapse visual indicators, positioned at the bottom of the\n`DynamicPageTitle` and the `DynamicPageHeader` inside `ui5-dynamic-page-header-actions`.\n\n### Responsive Behavior\n\nThe responsive behavior of the `DynamicPageTitle` depends on the behavior of the\ncontent that is displayed.", "name": "DynamicPageTitle", "slots": [ { "name": "actionsBar", "description": "Defines the bar with actions in the Dynamic page title.", "_ui5type": { "text": "Array" }, "_ui5privacy": "public" }, { "name": "breadcrumbs", "description": "Defines the content of the breadcrumbs inside Dynamic Page Title.", "_ui5type": { "text": "Array" }, "_ui5privacy": "public" }, { "name": "default", "description": "Defines the content of the Dynamic page title.", "_ui5propertyName": "content", "_ui5type": { "text": "Array" }, "_ui5privacy": "public" }, { "name": "heading", "description": "Defines the content of the Heading of the Dynamic Page.\n\nThe font size of the title within the `heading` slot can be adjusted to the recommended values using the following CSS variables:\n\n**Expanded:** `var(--sapObjectHeader_Title_FontSize)`\n\n**Collapsed:** `var(--sapObjectHeader_Title_SnappedFontSize)`", "_ui5type": { "text": "Array" }, "_ui5privacy": "public" }, { "name": "navigationBar", "description": "Defines the bar with navigation actions in the Dynamic page title.", "_ui5type": { "text": "Array", "references": [ { "name": "Toolbar", "package": "@ui5/webcomponents", "module": "dist/Toolbar.js" } ] }, "_ui5privacy": "public" }, { "name": "snappedHeading", "description": "Defines the heading that is shown only when the header is snapped.", "_ui5type": { "text": "Array" }, "_ui5privacy": "public" }, { "name": "snappedSubheading", "description": "Defines the content of the title that is shown only when the header is snapped.", "_ui5type": { "text": "Array" }, "_ui5privacy": "public" }, { "name": "snappedTitleOnMobile", "description": "Defines the content of the snapped title on mobile devices.\n\nThis slot is displayed only when the `DynamicPageTitle` is in the snapped state on mobile devices.\nIt should be used to provide a simplified, single-line title that takes up less space on smaller screens.\n\n**Note:**\n- The content set in this slot **overrides** all other content set in the `DynamicPageTitle` slots when displayed.\n- The slot is intended for a single `ui5-title` component.", "_ui5since": "2.3.0", "_ui5type": { "text": "Array", "references": [ { "name": "Title", "package": "@ui5/webcomponents", "module": "dist/Title.js" } ] }, "_ui5privacy": "public" }, { "name": "subheading", "description": "Defines the content of the title that is shown only when the header is not snapped.", "_ui5type": { "text": "Array<HTMLElement>" }, "_ui5privacy": "public" } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-dynamic-page-title", "customElement": true, "_ui5since": "2.0.0", "_ui5privacy": "public" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "DynamicPageTitle", "module": "dist/DynamicPageTitle.js" } }, { "kind": "custom-element-definition", "name": "ui5-dynamic-page-title", "declaration": { "name": "DynamicPageTitle", "module": "dist/DynamicPageTitle.js" } } ] }, { "kind": "javascript-module", "path": "dist/DynamicSideContent.js", "declarations": [ { "kind": "class", "description": "### Overview\n\nThe DynamicSideContent (`ui5-dynamic-side-content`) is a layout component that allows additional content\nto be displayed in a way that flexibly adapts to different screen sizes. The side\ncontent appears in a container next to or directly below the main content\n(it doesn't overlay). When the side content is triggered, the main content becomes\nnarrower (if appearing side-by-side). The side content contains a separate scrollbar\nwhen appearing next to the main content.\n\n### Usage\n\n*When to use?*\n\nUse this component if you want to display relevant information that is not critical\nfor users to complete a task. Users should have access to all the key functions and\ncritical information in the app even if they do not see the side content. This is\nimportant because on smaller screen sizes it may be difficult to display the side\ncontent in a way that is easily accessible for the user.\n\n*When not to use?*\n\nDon't use it if you want to display navigation or critical information that prevents\nusers from completing a task when they have no access to the side content.\n\n### Responsive Behavior\n\nScreen width \\> 1440px\n\n- Main vs. side content ratio is 75 vs. 25 percent (with a minimum of 320px\neach).\n- If the application defines a trigger, the side content can be hidden.\n\nScreen width \\<\\= 1440px and \\> 1024px\n\n- Main vs. side content ratio is 66.666 vs. 33.333 percent (with a minimum of\n320px each). If the side content width falls below 320 px, it automatically slides\nunder the main content, unless the app development team specifies that it should\ndisappear.\n\nScreen width \\<\\= 1024px and \\> 720px\n\n- The side content ratio is fixed to 340px, and the main content takes the rest\nof the width. Only if the `sideContentFallDown` is set to `OnMinimumWidth`\nand screen width is \\<\\= 960px and \\> 720px the side content falls below the main content.\n\nScreen width \\<\\= 720px (for example on a mobile device)\n\n- In this case, the side content automatically disappears from the screen (unless\nspecified to stay under the content by setting of `sideContentVisibility`\nproperty to `AlwaysShow`) and can be triggered from a pre-set trigger\n(specified within the app). When the side content is triggered, it replaces the main\ncontent. We recommend that you always place the trigger for the side content in the\nsame location, such as in the app footer.\n\nA special case allows switching the comparison mode between the main and side content.\nIn this case, the screen is split into 50:50 percent for main vs. side content. The\nresponsive behavior of the equal split is the same as in the standard view - the\nside content disappears on screen widths of less than 720 px and can only be\nviewed by triggering it.\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-fiori/dist/DynamicSideContent.js\";`", "name": "DynamicSideContent", "slots": [ { "description": "Defines the main content.", "name": "default", "_ui5privacy": "public", "_ui5type": { "text": "Array<HTMLElement>" } }, { "name": "sideContent", "description": "Defines the side content.", "_ui5type": { "text": "Array<HTMLElement>" }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "accessibilityAttributes", "type": { "text": "DynamicSideContentAccessibilityAttributes", "references": [ { "name": "DynamicSideContentAccessibilityAttributes", "package": "@ui5/webcomponents-fiori", "module": "dist/DynamicSideContent.js" } ] }, "default": "{}", "description": "Defines additional accessibility attributes on different areas of the component.\n\nThe accessibilityAttributes object has the following fields:\n\n - **mainContent**: `mainContent.ariaLabel` defines the aria-label of the main content area. Accepts any string.\n - **sideContent**: `sideContent.ariaLabel` defines the aria-label of the side content area. Accepts any string.", "privacy": "public", "_ui5since": "2.6.0" }, { "kind": "field", "name": "equalSplit", "type": { "text": "boolean" }, "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" }, { "kind": "field", "name": "hideMainContent", "type": { "text": "boolean" }, "default": "false", "description": "Defines the visibility of the main content.", "privacy": "public" }, { "kind": "field", "name": "hideSideContent", "type": { "text": "boolean" }, "default": "false", "description": "Defines the visibility of the side content.", "privacy": "public" }, { "kind": "field", "name": "sideContentFallDown", "type": { "text": "SideContentFallDown", "references": [ { "name": "SideContentFallDown", "package": "@ui5/webcomponents-fiori", "module": "dist/types/SideContentFallDown.js" } ] }, "default": "\"OnMinimumWidth\"", "description": "Defines on which breakpoints the side content falls down below the main content.", "privacy": "public" }, { "kind": "field", "name": "sideContentPosition", "type": { "text": "SideContentPosition", "references": [ { "name": "SideContentPosition", "package": "@ui5/webcomponents-fiori", "module": "dist/types/SideContentPosition.js" } ] }, "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" }, { "kind": "field", "name": "sideContentVisibility", "type": { "text": "SideContentVisibility", "references": [ { "name": "SideContentVisibility", "package": "@ui5/webcomponents-fiori", "module": "dist/types/SideContentVisibility.js" } ] }, "default": "\"ShowAboveS\"", "description": "Defines on which breakpoints the side content is visible.", "privacy": "public" }, { "kind": "method", "name": "toggleContents", "return": { "type": { "text": "void" } }, "description": "Toggles visibility of main and side contents on S screen size (mobile device).", "privacy": "public" } ], "events": [ { "name": "layout-change", "_ui5privacy": "public", "type": { "text": "CustomEvent<DynamicSideContentLayoutChangeEventDetail>", "references": [ { "name": "DynamicSideContentLayoutChangeEventDetail", "package": "@ui5/webcomponents-fiori", "module": "dist/DynamicSideContent.js" } ] }, "description": "Fires when the current breakpoint has been changed.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5parameters": [ { "type": { "text": "string" }, "name": "currentBreakpoint", "_ui5privacy": "public", "description": "the current breakpoint." }, { "type": { "text": "boolean" }, "name": "mainContentVisible", "_ui5privacy": "public", "description": "visibility of the main content." }, { "type": { "text": "string | undefined" }, "name": "previousBreakpoint", "_ui5privacy": "public", "description": "the breakpoint that was active before change to current breakpoint." }, { "type": { "text": "boolean" }, "name": "sideContentVisible", "_ui5privacy": "public", "description": "visibility of the side content." } ] } ], "attributes": [ { "description": "Defines additional accessibility attributes on different areas of the component.\n\nThe accessibilityAttributes object has the following fields:\n\n - **mainContent**: `mainContent.ariaLabel` defines the aria-label of the main content area. Accepts any string.\n - **sideContent**: `sideContent.ariaLabel` defines the aria-label of the side content area. Accepts any string.", "name": "accessibility-attributes", "default": "{}", "fieldName": "accessibilityAttributes", "type": { "text": "DynamicSideContentAccessibilityAttributes" } }, { "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.", "name": "equal-split", "default": "false", "fieldName": "equalSplit", "type": { "text": "boolean" } }, { "description": "Defines the visibility of the main content.", "name": "hide-main-content", "default": "false", "fieldName": "hideMainContent", "type": { "text": "boolean" } }, { "description": "Defines the visibility of the side content.", "name": "hide-side-content", "default": "false", "fieldName": "hideSideContent", "type": { "text": "boolean" } }, { "description": "Defines on which breakpoints the side content falls down below the main content.", "name": "side-content-fall-down", "default": "\"OnMinimumWidth\"", "fieldName": "sideContentFallDown", "type": { "text": "\"BelowXL\" | \"BelowL\" | \"BelowM\" | \"OnMinimumWidth\"" } }, { "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).", "name": "side-content-position", "default": "\"End\"", "fieldName": "sideContentPosition", "type": { "text": "\"End\" | \"Start\"" } }, { "description": "Defines on which breakpoints the side content is visible.", "name": "side-content-visibility", "default": "\"ShowAboveS\"", "fieldName": "sideContentVisibility", "type": { "text": "\"AlwaysShow\" | \"ShowAboveL\" | \"ShowAboveM\" | \"ShowAboveS\" | \"NeverShow\"" } } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-dynamic-side-content", "customElement": true, "_ui5since": "1.1.0", "_ui5privacy": "public" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "DynamicSideContent", "module": "dist/DynamicSideContent.js" } }, { "kind": "custom-element-definition", "name": "ui5-dynamic-side-content", "declaration": { "name": "DynamicSideContent", "module": "dist/DynamicSideContent.js" } } ] }, { "kind": "javascript-module", "path": "dist/FilterItem.js", "declarations": [ { "kind": "class", "description": "### Overview\n\nThe `ui5-filter-item` component defines the filtering criteria for data in `ui5-view-settings-dialog`.\nIt represents a single filter category that contains multiple filter options that users can select.\n\n### Usage\n\nThe `ui5-filter-item` is used within the `ui5-view-settings-dialog` to provide filtering options.\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-fiori/dist/FilterItem.js\";`", "name": "FilterItem", "slots": [ { "name": "values", "description": "Defines the filter options available for this filter category.", "_ui5type": { "text": "Array<FilterItemOption>", "references": [ { "name": "FilterItemOption", "package": "@ui5/webcomponents-fiori", "module": "dist/FilterItemOption.js" } ] }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "additionalText", "type": { "text": "string | undefined" }, "description": "Defines the additional text of the filter item.\nThis text is typically used to show the number of selected filter options within this category.", "default": "undefined", "privacy": "public" }, { "kind": "field", "name": "text", "type": { "text": "string | undefined" }, "description": "Defines the text of the filter item.", "default": "undefined", "privacy": "public" } ], "attributes": [ { "description": "Defines the additional text of the filter item.\nThis text is typically used to show the number of selected filter options within this category.", "name": "additional-text", "default": "undefined", "fieldName": "additionalText", "type": { "text": "string | undefined" } }, { "description": "Defines the text of the filter item.", "name": "text", "default": "undefined", "fieldName": "text", "type": { "text": "string | undefined" } } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-filter-item", "customElement": true, "_ui5since": "1.0.0-rc.16", "_ui5privacy": "public", "_ui5abstract": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "FilterItem", "module": "dist/FilterItem.js" } }, { "kind": "custom-element-definition", "name": "ui5-filter-item", "declaration": { "name": "FilterItem", "module": "dist/FilterItem.js" } } ] }, { "kind": "javascript-module", "path": "dist/FilterItemOption.js", "declarations": [ { "kind": "class", "description": "### Overview\n\nThe `ui5-filter-item-option` component defines individual filter values within a `ui5-filter-item`.\nIt represents a single selectable option that users can choose to filter data.\n\n### Usage\n\nThe `ui5-filter-item-option` is used as a child component within `ui5-filter-item` in the context\nof `ui5-view-settings-dialog`. Each option represents a specific value that can be used for filtering\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-fiori/dist/FilterItemOption.js\";`", "name": "FilterItemOption", "members": [ { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Defines if the filter option is selected.", "privacy": "public" }, { "kind": "field", "name": "text", "type": { "text": "string | undefined" }, "description": "Defines the text of the filter option.", "default": "undefined", "privacy": "public" } ], "attributes": [ { "description": "Defines if the filter option is selected.", "name": "selected", "default": "false", "fieldName": "selected", "type": { "text": "boolean" } }, { "description": "Defines the text of the filter option.", "name": "text", "default": "undefined", "fieldName": "text", "type": { "text": "string | undefined" } } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-filter-item-option", "customElement": true, "_ui5since": "1.0.0-rc.16", "_ui5privacy": "public", "_ui5abstract": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "FilterItemOption", "module": "dist/FilterItemOption.js" } }, { "kind": "custom-element-definition", "name": "ui5-filter-item-option", "declaration": { "name": "FilterItemOption", "module": "dist/FilterItemOption.js" } } ] }, { "kind": "javascript-module", "path": "dist/FlexibleColumnLayout.js", "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 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 248px. Consequently, when the user drags a column separator to resize the columns, the minimal allowed width of any resized column is 248px.\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": [ { "name": "endColumn", "description": "Defines the content in the end column.", "_ui5type": { "text": "Array<HTMLElement>" }, "_ui5privacy": "public" }, { "name": "midColumn", "description": "Defines the content in the middle column.", "_ui5type": { "text": "Array<HTMLElement>" }, "_ui5privacy": "public" }, { "name": "startColumn", "description": "Defines the content in the start column.", "_ui5type": { "text": "Array<HTMLElement>" }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "accessibilityAttributes", "type": { "text": "FCLAccessibilityAttributes", "references": [ { "name": "FCLAccessibilityAttributes", "package": "@ui5/webcomponents-fiori", "module": "dist/FlexibleColumnLayout.js" } ] }, "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" }, { "kind": "field", "name": "columnLayout", "type": { "text": "FlexibleColumnLayoutColumnLayout | undefined", "references": [ { "name": "FlexibleColumnLayoutColumnLayout", "package": "@ui5/webcomponents-fiori", "module": "dist/FlexibleColumnLayout.js" } ] }, "description": "Returns the current column layout, based on both the `layout` property and the screen size.\n\n**For example:** [\"67%\", \"33%\", 0], [\"100%\", 0, 0], [\"25%\", \"50%\", \"25%\"], etc,\nwhere the numbers represents the width of the start, middle and end columns.", "default": "undefined", "privacy": "public", "readonly": true }, { "kind": "field", "name": "disableResizing", "type": { "text": "boolean" }, "default": "false", "description": "Specifies if the user is allowed to change the columns layout by dragging the separator between the columns.", "privacy": "public", "_ui5since": "2.0.0" }, { "kind": "field", "name": "endColumnVisible", "type": { "text": "boolean" }, "description": "Returns if the `end` column is visible.", "default": "false", "privacy": "public", "readonly": true }, { "kind": "field", "name": "layout", "type": { "text": "FCLLayout", "references": [ { "name": "FCLLayout", "package": "@ui5/webcomponents-fiori", "module": "dist/types/FCLLayout.js" } ] }, "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" }, { "kind": "field", "name": "layoutsConfiguration", "type": { "text": "LayoutConfiguration", "references": [ { "name": "LayoutConfiguration", "package": "@ui5/webcomponents-fiori", "module": "dist/FlexibleColumnLayout.js" } ] }, "default": "{}", "description": "Allows to customize the column proportions per screen size and layout.\nIf no custom proportion provided for a specific layout, the default will be used.\n\n**Notes:**\n\n- The proportions should be given in percentages. For example [\"30%\", \"40%\", \"30%\"], [\"70%\", \"30%\", 0], etc.\n- The proportions should add up to 100%.\n- Hidden columns are marked as \"0px\", e.g. [\"0px\", \"70%\", \"30%\"]. Specifying 0 or \"0%\" for hidden columns is also valid.\n- If the proportions do not match the layout (e.g. if provided proportions [\"70%\", \"30%\", \"0px\"] for \"OneColumn\" layout), then the default proportions will be used instead.\n- Whenever the user drags the columns separator to resize the columns, the `layoutsConfiguration` object will be updated with the user-specified proportions for the given layout (and the `layout-configuration-change` event will be fired).\n- No custom configuration available for the phone screen size, as the default of 100% column width is always used there.", "privacy": "public", "_ui5since": "2.16.0" }, { "kind": "field", "name": "midColumnVisible", "type": { "text": "boolean" }, "description": "Returns if the `middle` column is visible.", "default": "false", "privacy": "public", "readonly": true }, { "kind": "field", "name": "startColumnVisible", "type": { "text": "boolean" }, "description": "Returns if the `start` column is visible.", "default": "true", "privacy": "public", "readonly": true }, { "kind": "field", "name": "visibleColumns", "type": { "text": "number" }, "description": "Returns the number of currently visible columns.", "default": "1", "privacy": "public", "readonly": true } ], "events": [ { "name": "layout-change", "_ui5privacy": "public", "type": { "text": "CustomEvent<FlexibleColumnLayoutLayoutChangeEventDetail>", "references": [ { "name": "FlexibleColumnLayoutLayoutChangeEventDetail", "package": "@ui5/webcomponents-fiori", "module": "dist/FlexibleColumnLayout.js" } ] }, "description": "Fired when the layout changes via user interaction by dragging the separators\nor by changing the component size due to resizing.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5parameters": [ { "type": { "text": "array" }, "name": "columnLayout", "_ui5privacy": "public", "description": "The effective column layout, f.e [67%, 33%, 0]" }, { "type": { "text": "boolean" }, "name": "endColumnVisible", "_ui5privacy": "public", "description": "Indicates if the end column is currently visible" }, { "type": { "text": "FCLLayout", "references": [ { "name": "FCLLayout", "package": "@ui5/webcomponents-fiori", "module": "dist/types/FCLLayout.js" } ] }, "name": "layout", "_ui5privacy": "public", "description": "The current layout" }, { "type": { "text": "boolean" }, "name": "midColumnVisible", "_ui5privacy": "public", "description": "Indicates if the middle column is currently visible" }, { "type": { "text": "boolean" }, "name": "resized", "_ui5privacy": "public", "description": "Indicates if the layout was changed by resizing the entire component" }, { "type": { "text": "boolean" }, "name": "separatorsUsed", "_ui5privacy": "public", "description": "Indicates if the layout was changed by dragging the column separators" }, { "type": { "text": "boolean" }, "name": "startColumnVisible", "_ui5privacy": "public", "description": "Indicates if the start column is currently visible" } ] }, { "name": "layout-configuration-change", "_ui5privacy": "public", "type": { "text": "CustomEvent<FlexibleColumnLayoutLayoutConfigurationChangeEventDetail>", "references": [ { "name": "FlexibleColumnLayoutLayoutConfigurationChangeEventDetail", "package": "@ui5/webcomponents-fiori", "module": "dist/FlexibleColumnLayout.js" } ] }, "description": "Fired when the `layoutsConfiguration` changes via user interaction by dragging the separators.\n\n**Note:** The `layout-configuration-change` event is in an experimental state and is a subject to change.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5since": "2.16.0", "_ui5parameters": [ { "type": { "text": "array" }, "name": "columnLayout", "_ui5privacy": "public", "description": "The effective column layout, f.e [\"67%\", \"33%\", \"0px\"]" }, { "type": { "text": "FCLLayout", "references": [ { "name": "FCLLayout", "package": "@ui5/webcomponents-fiori", "module": "dist/types/FCLLayout.js" } ] }, "name": "layout", "_ui5privacy": "public", "description": "The current layout" }, { "type": { "text": "MEDIA", "references": [ { "name": "MEDIA", "package": "@ui5/webcomponents-fiori", "module": "dist/FlexibleColumnLayout.js" } ] }, "name": "media", "_ui5privacy": "public", "description": "The current media type" } ] } ], "attributes": [ { "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.", "name": "accessibility-attributes", "default": "{}", "fieldName": "accessibilityAttributes", "type": { "text": "FCLAccessibilityAttributes" } }, { "description": "Returns the current column layout, based on both the `layout` property and the screen size.\n\n**For example:** [\"67%\", \"33%\", 0], [\"100%\", 0, 0], [\"25%\", \"50%\", \"25%\"], etc,\nwhere the numbers represents the width of the start, middle and end columns.", "name": "column-layout", "default": "undefined", "fieldName": "columnLayout", "type": { "text": "any" } }, { "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": "disableResizing", "type": { "text": "boolean" } }, { "description": "Returns if the `end` column is visible.", "name": "end-column-visible", "default": "false", "fieldName": "endColumnVisible", "type": { "text": "any" } }, { "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.", "name": "layout", "default": "\"OneColumn\"", "fieldName": "layout", "type": { "text": "\"OneColumn\" | \"TwoColumnsStartExpanded\" | \"TwoColumnsMidExpanded\" | \"ThreeColumnsMidExpanded\" | \"ThreeColumnsEndExpanded\" | \"ThreeColumnsStartExpandedEndHidden\" | \"ThreeColumnsMidExpandedEndHidden\" | \"ThreeColumnsStartHiddenMidExpanded\" | \"ThreeColumnsStartHiddenEndExpanded\" | \"MidColumnFullScreen\" | \"EndColumnFullS..." } }, { "description": "Allows to customize the column proportions per screen size and layout.\nIf no custom proportion provided for a specific layout, the default will be used.\n\n**Notes:**\n\n- The proportions should be given in percentages. For example [\"30%\", \"40%\", \"30%\"], [\"70%\", \"30%\", 0], etc.\n- The proportions should add up to 100%.\n- Hidden columns are marked as \"0px\", e.g. [\"0px\", \"70%\", \"30%\"]. Specifying 0 or \"0%\" for hidden columns is also valid.\n- If the proportions do not match the layout (e.g. if provided proportions [\"70%\", \"30%\", \"0px\"] for \"OneColumn\" layout), then the default proportions will be used instead.\n- Whenever the user drags the columns separator to resize the columns, the `layoutsConfiguration` object will be updated with the user-specified proportions for the given layout (and the `layout-configuration-change` event will be fired).\n- No custom configuration available for the phone screen size, as the default of 100% column width is always used there.", "name": "layouts-configuration", "default": "{}", "fieldName": "layoutsConfiguration", "type": { "text": "LayoutConfiguration" } }, { "description": "Returns if the `middle` column is visible.", "name": "mid-column-visible", "default": "false", "fieldName": "midColumnVisible", "type": { "text": "any" } }, { "description": "Returns if the `start` column is visible.", "name": "start-column-visible", "default": "true", "fieldName": "startColumnVisible", "type": { "text": "any" } }, { "description": "Returns the number of currently visible columns.", "name": "visible-columns", "default": "1", "fieldName": "visibleColumns", "type": { "text": "any" } } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-flexible-column-layout", "customElement": true, "_ui5since": "1.0.0-rc.8", "_ui5privacy": "public" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "FlexibleColumnLayout", "module": "dist/FlexibleColumnLayout.js" } }, { "kind": "custom-element-definition", "name": "ui5-flexible-column-layout", "declaration": { "name": "FlexibleColumnLayout", "module": "dist/FlexibleColumnLayout.js" } } ] }, { "kind": "javascript-module", "path": "dist/GroupItem.js", "declarations": [ { "kind": "class", "description": "### Overview\n\nThe `ui5-group-item` component defines the grouping criteria for data in `ui5-view-settings-dialog`.\nIt represents a single group option that users can select to organize data into logical groups.\n\n### Usage\n\nThe `ui5-group-item` is used within the `ui5-view-settings-dialog` to provide grouping options.\nEach group item represents a column or field by which data can be grouped.\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-fiori/dist/GroupItem.js\";`", "name": "GroupItem", "members": [ { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Defines if the group item is selected.", "privacy": "public" }, { "kind": "field", "name": "text", "type": { "text": "string | undefined" }, "description": "Defines the text of the group item.", "default": "undefined", "privacy": "public" } ], "attributes": [ { "description": "Defines if the group item is selected.", "name": "selected", "default": "false", "fieldName": "selected", "type": { "text": "boolean" } }, { "description": "Defines the text of the group item.", "name": "text", "default": "undefined", "fieldName": "text", "type": { "text": "string | undefined" } } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-group-item", "customElement": true, "_ui5since": "2.15.0", "_ui5privacy": "public", "_ui5abstract": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "GroupItem", "module": "dist/GroupItem.js" } }, { "kind": "custom-element-definition", "name": "ui5-group-item", "declaration": { "name": "GroupItem", "module": "dist/GroupItem.js" } } ] }, { "kind": "javascript-module", "path": "dist/IllustratedMessage.js", "declarations": [ { "kind": "class", "description": "### Overview\nAn IllustratedMessage is a recommended combination of a solution-oriented message, an engaging\nillustration, and conversational tone to better communicate an empty or a success state than just show\na message alone.\n\nEach illustration has default internationalised title and subtitle texts. Also they can be managed with\n`titleText` and `subtitleText` properties.\n\nTo display the desired illustration, use the `name` property, where you can find the list of all available illustrations.\n\n**Note:** By default the “BeforeSearch” illustration is loaded. To use other illustrations, make sure you import them in addition, for example:\n\n`import \"@ui5/webcomponents-fiori/dist/illustrations/NoData.js\"`\n\n**Note:** Illustrations starting with the “Tnt” prefix are part of another illustration set. For example to use the “TntSuccess” illustration, add the following import::\n\n`import \"@ui5/webcomponents-fiori/dist/illustrations/tnt/Success.js\"`\n\n### Structure\nThe IllustratedMessage consists of the following elements, which are displayed below each other in the following order:\n\n- Illustration\n- Title\n- Subtitle\n- Actions\n\n### Usage\n`ui5-illustrated-message` is meant to be used inside container component, for example a `ui5-card`,\na `ui5-dialog` or a `ui5-page`\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-fiori/dist/IllustratedMessage.js\";`", "name": "IllustratedMessage", "cssParts": [ { "description": "Used to style the subtitle wrapper of the `ui5-illustrated-message`", "name": "subtitle" } ], "slots": [ { "name": "default", "description": "Defines the component actions.\n\n**Note:** Not displayed when the `design` property is set to `Base`.", "_ui5propertyName": "actions", "_ui5type": { "text": "Array<IButton>", "references": [ { "name": "IButton", "package": "@ui5/webcomponents", "module": "dist/Button.js" } ] }, "_ui5privacy": "public" }, { "name": "subtitle", "description": "Defines the subtitle of the component.\n\n**Note:** Using this slot, the default subtitle text of illustration and the value of `subtitleText` property will be overwritten.", "_ui5since": "1.0.0-rc.16", "_ui5type": { "text": "Array<HTMLElement>" }, "_ui5privacy": "public" }, { "name": "title", "description": "Defines the title of the component.\n\n**Note:** Using this slot, the default title text of illustration and the value of `title` property will be overwritten.", "_ui5since": "1.7.0", "_ui5type": { "text": "Array<HTMLElement> & string" }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "accessibleNameRef", "type": { "text": "string | undefined" }, "description": "Receives id(or many ids) of the elements that label the component.", "default": "undefined", "privacy": "public", "_ui5since": "1.7.0" }, { "kind": "field", "name": "decorative", "type": { "text": "boolean" }, "default": "false", "description": "Defines whether the illustration is decorative.\n\nWhen set to `true`, the attributes `role=\"presentation\"` and `aria-hidden=\"true\"` are applied to the SVG element.", "privacy": "public", "_ui5since": "2.10.0" }, { "kind": "field", "name": "design", "type": { "text": "IllustrationMessageDesign", "references": [ { "name": "IllustrationMessageDesign", "package": "@ui5/webcomponents-fiori", "module": "dist/types/IllustrationMessageDesign.js" } ] }, "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": "2.0.0" }, { "kind": "field", "name": "name", "type": { "text": "string" }, "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" }, { "kind": "field", "name": "subtitleText", "type": { "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": "undefined", "privacy": "public" }, { "kind": "field", "name": "titleText", "type": { "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": "undefined", "privacy": "public" } ], "attributes": [ { "description": "Receives id(or many ids) of the elements that label the component.", "name": "accessible-name-ref", "default": "undefined", "fieldName": "accessibleNameRef", "type": { "text": "string | undefined" } }, { "description": "Defines whether the illustration is decorative.\n\nWhen set to `true`, the attributes `role=\"presentation\"` and `aria-hidden=\"true\"` are applied to the SVG element.", "name": "decorative", "default": "false", "fieldName": "decorative", "type": { "text": "boolean" } }, { "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.", "name": "design", "default": "\"Auto\"", "fieldName": "design", "type": { "text": "\"Auto\" | \"Base\" | \"Dot\" | \"Spot\" | \"Dialog\" | \"Scene\" | \"ExtraSmall\" | \"Small\" | \"Medium\" | \"Large\"" } }, { "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\";`", "name": "name", "default": "\"BeforeSearch\"", "fieldName": "name", "type": { "text": "string" } }, { "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": "undefined", "fieldName": "subtitleText", "type": { "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": "undefined", "fieldName": "titleText", "type": { "text": "string | undefined" } } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-illustrated-message", "customElement": true, "_ui5since": "1.0.0-rc.15", "_ui5privacy": "public" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IllustratedMessage", "module": "dist/IllustratedMessage.js" } }, { "kind": "custom-element-definition", "name": "ui5-illustrated-message", "declaration": { "name": "IllustratedMessage", "module": "dist/IllustratedMessage.js" } } ] }, { "kind": "javascript-module", "path": "dist/MediaGallery.js", "declarations": [ { "kind": "interface", "name": "IMediaGalleryItem", "description": "Interface for components that can be slotted inside `ui5-media-gallery` as items.", "_ui5privacy": "public" }, { "kind": "class", "description": "### Overview\n\nThe `ui5-media-gallery` component allows the user to browse through multimedia items. Currently,\nthe supported items are images and videos. The items should be defined using the `ui5-media-gallery-item`\ncomponent.\n\nThe items are initially displayed as thumbnails. When the user selects a thumbnail, the corresponding item\nis displayed in larger size.\n\nThe component is responsive by default and adjusts the position of the menu with respect to viewport size,\nbut the application is able to further customize the layout via the provided API.\n\n### Keyboard Handling\nThe `ui5-media-gallery` provides advanced keyboard handling.\n\nWhen the thumbnails menu is focused the following keyboard\nshortcuts allow the user to navigate through the thumbnail items:\n\n- [Up] or [Down] - Navigates up and down the items\n- [Home] - Navigates to first item\n- [End] - Navigates to the last item\n- [Space], [Enter] - Selects an item\n\n### ES6 Module Import\n`import \"@ui5/webcomponents-fiori/dist/MediaGallery.js\";`\n\n`import \"@ui5/webcomponents-fiori/dist/MediaGalleryItem.js\";`", "name": "MediaGallery", "slots": [ { "name": "default", "description": "Defines the component items.\n\n**Note:** Only one selected item is allowed.\n\n**Note:** Use the `ui5-media-gallery-item` component to define the desired items.", "_ui5propertyName": "items", "_ui5type": { "text": "Array<IMediaGalleryItem>", "references": [ { "name": "IMediaGalleryItem", "package": "@ui5/webcomponents-fiori", "module": "dist/MediaGallery.js" } ] }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "interactiveDisplayArea", "type": { "text": "boolean" }, "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" }, { "kind": "field", "name": "layout", "type": { "text": "MediaGalleryLayout", "references": [ { "name": "MediaGalleryLayout", "package": "@ui5/webcomponents-fiori", "module": "dist/types/MediaGalleryLayout.js" } ] }, "default": "\"Auto\"", "description": "Determines the layout of the component.", "privacy": "public" }, { "kind": "field", "name": "menuHorizontalAlign", "type": { "text": "MediaGalleryMenuHorizontalAlign", "references": [ { "name": "MediaGalleryMenuHorizontalAlign", "package": "@ui5/webcomponents-fiori", "module": "dist/types/MediaGalleryMenuHorizontalAlign.js" } ] }, "default": "\"Left\"", "description": "Determines the horizontal alignment of the thumbnails menu\nvs. the central display area.", "privacy": "public" }, { "kind": "field", "name": "menuVerticalAlign", "type": { "text": "MediaGalleryMenuVerticalAlign", "references": [ { "name": "MediaGalleryMenuVerticalAlign", "package": "@ui5/webcomponents-fiori", "module": "dist/types/MediaGalleryMenuVerticalAlign.js" } ] }, "default": "\"Bottom\"", "description": "Determines the vertical alignment of the thumbnails menu\nvs. the central display area.", "privacy": "public" }, { "kind": "field", "name": "showAllThumbnails", "type": { "text": "boolean" }, "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" } ], "events": [ { "name": "display-area-click", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the display area is clicked.\nThe display area is the central area that contains\nthe enlarged content of the currently selected item.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true }, { "name": "overflow-click", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the thumbnails overflow button is clicked.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true }, { "name": "selection-change", "_ui5privacy": "public", "type": { "text": "CustomEvent<MediaGallerySelectionChangeEventDetail>", "references": [ { "name": "MediaGallerySelectionChangeEventDetail", "package": "@ui5/webcomponents-fiori", "module": "dist/MediaGallery.js" } ] }, "description": "Fired when selection is changed by user interaction.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5parameters": [ { "type": { "text": "HTMLElement" }, "name": "item", "_ui5privacy": "public", "description": "the selected item." } ] } ], "attributes": [ { "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.", "name": "interactive-display-area", "default": "false", "fieldName": "interactiveDisplayArea", "type": { "text": "boolean" } }, { "description": "Determines the layout of the component.", "name": "layout", "default": "\"Auto\"", "fieldName": "layout", "type": { "text": "\"Auto\" | \"Vertical\" | \"Horizontal\"" } }, { "description": "Determines the horizontal alignment of the thumbnails menu\nvs. the central display area.", "name": "menu-horizontal-align", "default": "\"Left\"", "fieldName": "menuHorizontalAlign", "type": { "text": "\"Left\" | \"Right\"" } }, { "description": "Determines the vertical alignment of the thumbnails menu\nvs. the central display area.", "name": "menu-vertical-align", "default": "\"Bottom\"", "fieldName": "menuVerticalAlign", "type": { "text": "\"Top\" | \"Bottom\"" } }, { "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.", "name": "show-all-thumbnails", "default": "false", "fieldName": "showAllThumbnails", "type": { "text": "boolean" } } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-media-gallery", "customElement": true, "_ui5since": "1.1.0", "_ui5privacy": "public" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "MediaGallery", "module": "dist/MediaGallery.js" } }, { "kind": "custom-element-definition", "name": "ui5-media-gallery", "declaration": { "name": "MediaGallery", "module": "dist/MediaGallery.js" } } ] }, { "kind": "javascript-module", "path": "dist/MediaGalleryItem.js", "declarations": [ { "kind": "class", "description": "### Overview\nThe `ui5-media-gallery-item` web component represents the items displayed in the\n`ui5-media-gallery` web component.\n\n**Note:** `ui5-media-gallery-item` is not supported when used outside of `ui5-media-gallery`.\n\n### Keyboard Handling\nThe `ui5-media-gallery` provides advanced keyboard handling.\nWhen focused, the user can use the following keyboard\nshortcuts in order to perform a navigation:\n\n- [Space] / [Enter] or [Return] - Trigger `ui5-click` event\n\n### ES6 Module Import\n`import \"@ui5/webcomponents-fiori/dist/MediaGalleryItem.js\";` (comes with `ui5-media-gallery`)", "name": "MediaGalleryItem", "slots": [ { "name": "default", "description": "Defines the content of the component.", "_ui5propertyName": "content", "_ui5type": { "text": "Array<HTMLElement>" }, "_ui5privacy": "public" }, { "name": "thumbnail", "description": "Defines the content of the thumbnail.", "_ui5type": { "text": "Array<HTMLElement>" }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Defines whether the component is in disabled state.", "privacy": "public" }, { "kind": "field", "name": "layout", "type": { "text": "MediaGalleryItemLayout", "references": [ { "name": "MediaGalleryItemLayout", "package": "@ui5/webcomponents-fiori", "module": "dist/types/MediaGalleryItemLayout.js" } ] }, "default": "\"Square\"", "description": "Determines the layout of the item container.", "privacy": "public" }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Defines the selected state of the component.", "privacy": "public" } ], "attributes": [ { "description": "Defines whether the component is in disabled state.", "name": "disabled", "default": "false", "fieldName": "disabled", "type": { "text": "boolean" } }, { "description": "Determines the layout of the item container.", "name": "layout", "default": "\"Square\"", "fieldName": "layout", "type": { "text": "\"Square\" | \"Wide\"" } }, { "description": "Defines the selected state of the component.", "name": "selected", "default": "false", "fieldName": "selected", "type": { "text": "boolean" } } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-media-gallery-item", "customElement": true, "_ui5since": "1.1.0", "_ui5privacy": "public", "_ui5implements": [ { "name": "IMediaGalleryItem", "package": "@ui5/webcomponents-fiori", "module": "dist/MediaGallery.js" } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "MediaGalleryItem", "module": "dist/MediaGalleryItem.js" } }, { "kind": "custom-element-definition", "name": "ui5-media-gallery-item", "declaration": { "name": "MediaGalleryItem", "module": "dist/MediaGalleryItem.js" } } ] }, { "kind": "javascript-module", "path": "dist/NavigationLayout.js", "declarations": [ { "kind": "class", "description": "### Overview\n\nThe `ui5-navigation-layout` is a container component that can be used to\ncreate a layout with a header, a side navigation and a content area.\n\n### Usage\n\nUse the `ui5-navigation-layout` to create whole screen of an application with vertical navigation.\n\n### Responsive Behavior\n\nOn larger screens with a width of 600px or more, excluding mobile phone devices, the side navigation is visible\nby default and can be expanded or collapsed using the `mode` property.\nOn mobile phone devices and screens with a width of 599px or less, the side navigation is hidden by\ndefault and can be displayed using the `mode` property.\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-fiori/dist/NavigationLayout.js\";`", "name": "NavigationLayout", "slots": [ { "name": "default", "description": "Defines the content.", "_ui5propertyName": "content", "_ui5type": { "text": "Array<HTMLElement>" }, "_ui5privacy": "public" }, { "name": "header", "description": "Defines the header.", "_ui5type": { "text": "Array<HTMLElement>" }, "_ui5privacy": "public" }, { "name": "sideContent", "description": "Defines the side content.", "_ui5type": { "text": "Array<SideNavigation>", "references": [ { "name": "SideNavigation", "package": "@ui5/webcomponents-fiori", "module": "dist/SideNavigation.js" } ] }, "_ui5privacy": "public" } ], "members": [ { "kind": "method", "name": "isSideCollapsed", "return": { "type": { "text": "boolean" } }, "description": "Gets whether the side navigation is collapsed.", "privacy": "public" }, { "kind": "field", "name": "mode", "type": { "text": "NavigationLayoutMode", "references": [ { "name": "NavigationLayoutMode", "package": "@ui5/webcomponents-fiori", "module": "dist/types/NavigationLayoutMode.js" } ] }, "default": "\"Auto\"", "description": "Specifies the navigation layout mode.", "privacy": "public" } ], "attributes": [ { "description": "Specifies the navigation layout mode.", "name": "mode", "default": "\"Auto\"", "fieldName": "mode", "type": { "text": "\"Auto\" | \"Collapsed\" | \"Expanded\"" } } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-navigation-layout", "customElement": true, "_ui5since": "2.4.0", "_ui5privacy": "public" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "NavigationLayout", "module": "dist/NavigationLayout.js" } }, { "kind": "custom-element-definition", "name": "ui5-navigation-layout", "declaration": { "name": "NavigationLayout", "module": "dist/NavigationLayout.js" } } ] }, { "kind": "javascript-module", "path": "dist/NavigationMenu.js", "declarations": [ { "kind": "class", "description": "### Overview\n\n`ui5-navigation-menu` component represents a hierarchical menu structure, inherits all the functionality of `ui5-menu`.\n\n### Usage\n\n`ui5-navigation-menu` contains `ui5-navigation-menu-item` components.\nAn arbitrary hierarchy structure can be represented by recursively nesting navigation menu items.\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-fiori/dist/NavigationMenu.js\";`", "name": "NavigationMenu", "slots": [ { "name": "default", "description": "Defines the items of this component.\n\n**Note:** Use `ui5-navigation-menu-item` for the intended design.", "_ui5propertyName": "items", "_ui5type": { "text": "Array<NavigationMenuItem>", "references": [ { "name": "NavigationMenuItem", "package": "@ui5/webcomponents-fiori", "module": "dist/NavigationMenuItem.js" } ] }, "_ui5privacy": "public" } ], "superclass": { "name": "Menu", "package": "@ui5/webcomponents", "module": "dist/Menu.js" }, "tagName": "ui5-navigation-menu", "customElement": true, "_ui5since": "1.22.0", "_ui5privacy": "private", "members": [ { "kind": "field", "name": "headerText", "type": { "text": "string | undefined" }, "description": "Defines the header text of the menu (displayed on mobile).", "default": "undefined", "privacy": "public" }, { "kind": "field", "name": "horizontalAlign", "type": { "text": "PopoverHorizontalAlign", "references": [ { "name": "PopoverHorizontalAlign", "package": "@ui5/webcomponents", "module": "dist/types/PopoverHorizontalAlign.js" } ] }, "default": "\"Start\"", "description": "Determines the horizontal alignment of the menu relative to its opener control.", "privacy": "public" }, { "kind": "field", "name": "loading", "type": { "text": "boolean" }, "default": "false", "description": "Defines if a loading indicator would be displayed inside the corresponding ui5-menu popover.", "privacy": "public", "_ui5since": "1.13.0" }, { "kind": "field", "name": "loadingDelay", "type": { "text": "number" }, "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" }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Indicates if the menu is open.", "privacy": "public", "_ui5since": "1.10.0" }, { "kind": "field", "name": "opener", "type": { "text": "HTMLElement | string | null | 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": "undefined", "_ui5since": "1.10.0" }, { "kind": "field", "name": "placement", "type": { "text": "PopoverPlacement", "references": [ { "name": "PopoverPlacement", "package": "@ui5/webcomponents", "module": "dist/types/PopoverPlacement.js" } ] }, "default": "\"Bottom\"", "description": "Determines on which side the component is placed at.", "privacy": "public", "_ui5since": "2.16.0" } ], "events": [ { "name": "before-close", "_ui5privacy": "public", "type": { "text": "CustomEvent<MenuBeforeCloseEventDetail>", "references": [ { "name": "MenuBeforeCloseEventDetail", "package": "@ui5/webcomponents", "module": "dist/Menu.js" } ] }, "description": "Fired before the menu is closed. This event can be cancelled, which will prevent the menu from closing.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": true, "_ui5since": "1.10.0", "_ui5parameters": [ { "type": { "text": "boolean" }, "name": "escPressed", "_ui5privacy": "public", "description": "Indicates that `ESC` key has triggered the event." } ] }, { "name": "before-open", "_ui5privacy": "public", "type": { "text": "CustomEvent<MenuBeforeOpenEventDetail>", "references": [ { "name": "MenuBeforeOpenEventDetail", "package": "@ui5/webcomponents", "module": "dist/Menu.js" } ] }, "description": "Fired before the menu is opened. This event can be cancelled, which will prevent the menu from opening.\n\n**Note:** Since 1.14.0 the event is also fired before a sub-menu opens.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": true, "_ui5since": "1.10.0", "_ui5parameters": [ { "type": { "text": "HTMLElement" }, "name": "item", "_ui5privacy": "public", "description": "The `ui5-menu-item` that triggers opening of the sub-menu or undefined when fired upon root menu opening." } ] }, { "name": "close", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired after the menu is closed.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": false, "_ui5since": "1.10.0" }, { "name": "item-click", "_ui5privacy": "public", "type": { "text": "CustomEvent<MenuItemClickEventDetail>", "references": [ { "name": "MenuItemClickEventDetail", "package": "@ui5/webcomponents", "module": "dist/Menu.js" } ] }, "description": "Fired when an item is being clicked.\n\n**Note:** Since 1.17.0 the event is preventable, allowing the menu to remain open after an item is pressed.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": false, "_ui5parameters": [ { "type": { "text": "HTMLElement" }, "name": "item", "_ui5privacy": "public", "description": "The currently clicked menu item." }, { "type": { "text": "string" }, "name": "text", "_ui5privacy": "public", "description": "The text of the currently clicked menu item." } ] }, { "name": "open", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired after the menu is opened.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5since": "1.10.0" } ], "attributes": [ { "description": "Defines the header text of the menu (displayed on mobile).", "name": "header-text", "default": "undefined", "fieldName": "headerText", "type": { "text": "string | undefined" } }, { "description": "Determines the horizontal alignment of the menu relative to its opener control.", "name": "horizontal-align", "default": "\"Start\"", "fieldName": "horizontalAlign", "type": { "text": "\"Start\" | \"End\" | \"Center\" | \"Stretch\"" } }, { "description": "Defines if a loading indicator would be displayed inside the corresponding ui5-menu popover.", "name": "loading", "default": "false", "fieldName": "loading", "type": { "text": "boolean" } }, { "description": "Defines the delay in milliseconds, after which the loading indicator will be displayed inside the corresponding ui5-menu popover.", "name": "loading-delay", "default": "1000", "fieldName": "loadingDelay", "type": { "text": "number" } }, { "description": "Indicates if the menu is open.", "name": "open", "default": "false", "fieldName": "open", "type": { "text": "boolean" } }, { "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": "undefined", "fieldName": "opener", "type": { "text": "string | HTMLElement | null | undefined" } }, { "description": "Determines on which side the component is placed at.", "name": "placement", "default": "\"Bottom\"", "fieldName": "placement", "type": { "text": "\"Top\" | \"Bottom\" | \"Start\" | \"End\"" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "NavigationMenu", "module": "dist/NavigationMenu.js" } }, { "kind": "custom-element-definition", "name": "ui5-navigation-menu", "declaration": { "name": "NavigationMenu", "module": "dist/NavigationMenu.js" } } ] }, { "kind": "javascript-module", "path": "dist/NavigationMenuItem.js", "declarations": [ { "kind": "class", "description": "### Overview\n\n`ui5-navigation-menu-item` is the item to use inside a `ui5-navigation-menu`.\nAn arbitrary hierarchy structure can be represented by recursively nesting navigation menu items.\n\n### Usage\n\n`ui5-navigation-menu-item` represents a node in a `ui5-navigation-menu`. The navigation menu itself is rendered as a list,\nand each `ui5-navigation-menu-item` is represented by a list item in that list. Therefore, you should only use\n`ui5-navigation-menu-item` directly in your apps. The `ui5-li` list item is internal for the list, and not intended for public use.\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-fiori/dist/NavigationMenuItem.js\";`", "name": "NavigationMenuItem", "members": [ { "kind": "field", "name": "href", "type": { "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": "undefined", "_ui5since": "1.22.0" }, { "kind": "field", "name": "target", "type": { "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": "undefined", "_ui5since": "1.22.0" }, { "kind": "field", "name": "accessibilityAttributes", "type": { "text": "MenuItemAccessibilityAttributes", "references": [ { "name": "MenuItemAccessibilityAttributes", "package": "@ui5/webcomponents", "module": "dist/MenuItem.js" } ] }, "default": "{}", "description": "Defines the additional accessibility attributes that will be applied to the component.\nThe following fields are supported:\n\n- **ariaKeyShortcuts**: Indicated the availability of a keyboard shortcuts defined for the menu item.\n\n- **role**: Defines the role of the menu item. If not set, menu item will have default role=\"menuitem\".", "privacy": "public", "_ui5since": "2.1.0" }, { "kind": "field", "name": "accessibleName", "type": { "text": "string | undefined" }, "description": "Defines the accessible ARIA name of the component.", "default": "undefined", "privacy": "public", "_ui5since": "1.7.0" }, { "kind": "field", "name": "additionalText", "type": { "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": "undefined", "privacy": "public", "_ui5since": "1.8.0" }, { "kind": "field", "name": "checked", "type": { "text": "boolean" }, "default": "false", "description": "Defines whether menu item is in checked state.\n\n**Note:** checked state is only taken into account when menu item is added to menu item group\nwith `checkMode` other than `None`.\n\n**Note:** A checked menu item has a checkmark displayed at its end.", "privacy": "public", "_ui5since": "2.12.0" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Defines whether menu item is in disabled state.\n\n**Note:** A disabled menu item is noninteractive.", "privacy": "public" }, { "kind": "field", "name": "highlight", "type": { "text": "Highlight", "references": [ { "name": "Highlight", "package": "@ui5/webcomponents", "module": "dist/types/Highlight.js" } ] }, "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" }, { "kind": "field", "name": "icon", "type": { "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": "undefined", "privacy": "public" }, { "kind": "field", "name": "loading", "type": { "text": "boolean" }, "default": "false", "description": "Defines the delay in milliseconds, after which the loading indicator will be displayed inside the corresponding menu popover.\n\n**Note:** If set to `true` a busy indicator component will be displayed into the related one to the current menu item sub-menu popover.", "privacy": "public", "_ui5since": "1.13.0" }, { "kind": "field", "name": "loadingDelay", "type": { "text": "number" }, "default": "1000", "description": "Defines the delay in milliseconds, after which the loading indicator will be displayed inside the corresponding menu popover.", "privacy": "public", "_ui5since": "1.13.0" }, { "kind": "field", "name": "navigated", "type": { "text": "boolean" }, "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" }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Defines the selected state of the component.", "privacy": "public" }, { "kind": "field", "name": "text", "type": { "text": "string | undefined" }, "description": "Defines the text of the tree item.", "default": "undefined", "privacy": "public" }, { "kind": "field", "name": "tooltip", "type": { "text": "string | undefined" }, "description": "Defines the text of the tooltip for the menu item.", "default": "undefined", "privacy": "public", "_ui5since": "1.23.0" }, { "kind": "field", "name": "type", "type": { "text": "ListItemType", "references": [ { "name": "ListItemType", "package": "@ui5/webcomponents", "module": "dist/types/ListItemType.js" } ] }, "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" } ], "attributes": [ { "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": "undefined", "fieldName": "href", "type": { "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": "undefined", "fieldName": "target", "type": { "text": "string | undefined" } }, { "description": "Defines the additional accessibility attributes that will be applied to the component.\nThe following fields are supported:\n\n- **ariaKeyShortcuts**: Indicated the availability of a keyboard shortcuts defined for the menu item.\n\n- **role**: Defines the role of the menu item. If not set, menu item will have default role=\"menuitem\".", "name": "accessibility-attributes", "default": "{}", "fieldName": "accessibilityAttributes", "type": { "text": "MenuItemAccessibilityAttributes" } }, { "description": "Defines the accessible ARIA name of the component.", "name": "accessible-name", "default": "undefined", "fieldName": "accessibleName", "type": { "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": "undefined", "fieldName": "additionalText", "type": { "text": "string | undefined" } }, { "description": "Defines whether menu item is in checked state.\n\n**Note:** checked state is only taken into account when menu item is added to menu item group\nwith `checkMode` other than `None`.\n\n**Note:** A checked menu item has a checkmark displayed at its end.", "name": "checked", "default": "false", "fieldName": "checked", "type": { "text": "boolean" } }, { "description": "Defines whether menu item is in disabled state.\n\n**Note:** A disabled menu item is noninteractive.", "name": "disabled", "default": "false", "fieldName": "disabled", "type": { "text": "boolean" } }, { "description": "Defines the highlight state of the list items.\nAvailable options are: `\"None\"` (by default), `\"Positive\"`, `\"Critical\"`, `\"Information\"` and `\"Negative\"`.", "name": "highlight", "default": "\"None\"", "fieldName": "highlight", "type": { "text": "\"None\" | \"Positive\" | \"Critical\" | \"Negative\" | \"Information\"" } }, { "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": "undefined", "fieldName": "icon", "type": { "text": "string | undefined" } }, { "description": "Defines the delay in milliseconds, after which the loading indicator will be displayed inside the corresponding menu popover.\n\n**Note:** If set to `true` a busy indicator component will be displayed into the related one to the current menu item sub-menu popover.", "name": "loading", "default": "false", "fieldName": "loading", "type": { "text": "boolean" } }, { "description": "Defines the delay in milliseconds, after which the loading indicator will be displayed inside the corresponding menu popover.", "name": "loading-delay", "default": "1000", "fieldName": "loadingDelay", "type": { "text": "number" } }, { "description": "The navigated state of the list item.\nIf set to `true`, a navigation indicator is displayed at the end of the list item.", "name": "navigated", "default": "false", "fieldName": "navigated", "type": { "text": "boolean" } }, { "description": "Defines the selected state of the component.", "name": "selected", "default": "false", "fieldName": "selected", "type": { "text": "boolean" } }, { "description": "Defines the text of the tree item.", "name": "text", "default": "undefined", "fieldName": "text", "type": { "text": "string | undefined" } }, { "description": "Defines the text of the tooltip for the menu item.", "name": "tooltip", "default": "undefined", "fieldName": "tooltip", "type": { "text": "string | undefined" } }, { "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.", "name": "type", "default": "\"Active\"", "fieldName": "type", "type": { "text": "\"Navigation\" | \"Inactive\" | \"Active\" | \"Detail\"" } } ], "superclass": { "name": "MenuItem", "package": "@ui5/webcomponents", "module": "dist/MenuItem.js" }, "tagName": "ui5-navigation-menu-item", "customElement": true, "_ui5since": "1.22.0", "_ui5privacy": "private", "slots": [ { "name": "default", "description": "Defines the items of this component.\n\n**Note:** The slot can hold menu item and 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<IMenuItem>", "references": [ { "name": "IMenuItem", "package": "@ui5/webcomponents", "module": "dist/Menu.js" } ] }, "_ui5privacy": "public" }, { "name": "deleteButton", "description": "Defines the delete button, displayed in \"Delete\" mode.\n**Note:** While the slot allows custom buttons, to match\ndesign guidelines, please use the `ui5-button` component.\n**Note:** When the slot is not present, a built-in delete button will be displayed.", "_ui5since": "1.9.0", "_ui5type": { "text": "Array<IButton>", "references": [ { "name": "IButton", "package": "@ui5/webcomponents", "module": "dist/Button.js" } ] }, "_ui5privacy": "public" }, { "name": "endContent", "description": "Defines the components that should be displayed at the end of the menu item.\n\n**Note:** It is highly recommended to slot only components of type `ui5-button`,`ui5-link`\nor `ui5-icon` in order to preserve the intended design. If there are components added to this slot,\nand there is text set in `additionalText`, it will not be displayed. If there are items added to `items` slot,\nnether `additionalText` nor components added to this slot would 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`.\n\nApplication developers are responsible for ensuring that interactive elements placed in the `endContent` slot\nhave the correct accessibility behaviour, including their enabled or disabled states.\nThe menu does not manage these aspects when the menu item state changes.", "_ui5since": "2.0.0", "_ui5type": { "text": "Array<HTMLElement>" }, "_ui5privacy": "public" } ], "events": [ { "name": "before-close", "_ui5privacy": "public", "type": { "text": "CustomEvent<MenuBeforeCloseEventDetail>", "references": [ { "name": "MenuBeforeCloseEventDetail", "package": "@ui5/webcomponents", "module": "dist/MenuItem.js" } ] }, "description": "Fired before the menu is closed. This event can be cancelled, which will prevent the menu from closing.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": false, "_ui5since": "1.10.0", "_ui5parameters": [ { "type": { "text": "boolean" }, "name": "escPressed", "_ui5privacy": "public", "description": "Indicates that `ESC` key has triggered the event." } ] }, { "name": "before-open", "_ui5privacy": "public", "type": { "text": "CustomEvent<MenuBeforeOpenEventDetail>", "references": [ { "name": "MenuBeforeOpenEventDetail", "package": "@ui5/webcomponents", "module": "dist/MenuItem.js" } ] }, "description": "Fired before the menu is opened. This event can be cancelled, which will prevent the menu from opening.\n\n**Note:** Since 1.14.0 the event is also fired before a sub-menu opens.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": false, "_ui5since": "1.10.0", "_ui5parameters": [ { "type": { "text": "HTMLElement" }, "name": "item", "_ui5privacy": "public", "description": "The menu item that triggers opening of the sub-menu or undefined when fired upon root menu opening." } ] }, { "name": "check", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when an item is checked or unchecked.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5since": "2.12.0" }, { "name": "close", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired after the menu is closed.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": false, "_ui5since": "1.10.0" }, { "name": "detail-click", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the user clicks on the detail button when type is `Detail`.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true }, { "name": "open", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired after the menu is opened.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": false } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "NavigationMenuItem", "module": "dist/NavigationMenuItem.js" } }, { "kind": "custom-element-definition", "name": "ui5-navigation-menu-item", "declaration": { "name": "NavigationMenuItem", "module": "dist/NavigationMenuItem.js" } } ] }, { "kind": "javascript-module", "path": "dist/NotificationList.js", "declarations": [ { "kind": "class", "description": "### Overview\nThe `ui5-notification-list` web component represents\na container for `ui5-li-notification-group` and `ui5-li-notification`.\n\n### Keyboard Handling\n\n#### Basic Navigation\nThe `ui5-notification-list` provides advanced keyboard handling.\nWhen a list is focused the user can use the following keyboard\nshortcuts in order to perform a navigation:\n\n- [Up] or [Left] - Navigates up the items\n- [Down] or [Right] - Navigates down the items\n- [Home] - Navigates to first item\n- [End] - Navigates to the last item\n\n#### Fast Navigation\nThis component provides a build in fast navigation group which can be used via [F6] / [Shift] + [F6] / [Ctrl] + [Alt/Option] / [Down] or [Ctrl] + [Alt/Option] + [Up].\nIn order to use this functionality, you need to import the following module:\n`import \"@ui5/webcomponents-base/dist/features/F6Navigation.js\"`\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-fiori/dist/NotificationList.js\";``", "name": "NotificationList", "slots": [ { "name": "default", "description": "Defines the items of the component.", "_ui5propertyName": "items", "_ui5type": { "text": "Array<NotificationListItemBase>", "references": [ { "name": "NotificationListItemBase", "package": "@ui5/webcomponents-fiori", "module": "dist/NotificationListItemBase.js" } ] }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "noDataText", "type": { "text": "string | undefined" }, "description": "Defines the text that is displayed when the component contains no items.", "default": "undefined", "privacy": "public" } ], "events": [ { "name": "item-click", "_ui5privacy": "public", "type": { "text": "CustomEvent<NotificationItemClickEventDetail>", "references": [ { "name": "NotificationItemClickEventDetail", "package": "@ui5/webcomponents-fiori", "module": "dist/NotificationList.js" } ] }, "description": "Fired when an item is clicked.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": true, "_ui5parameters": [ { "type": { "text": "HTMLElement" }, "name": "item", "_ui5privacy": "public", "description": "The clicked item." } ] }, { "name": "item-close", "_ui5privacy": "public", "type": { "text": "CustomEvent<NotificationItemCloseEventDetail>", "references": [ { "name": "NotificationItemCloseEventDetail", "package": "@ui5/webcomponents-fiori", "module": "dist/NotificationList.js" } ] }, "description": "Fired when the `Close` button of any item is clicked.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": true, "_ui5parameters": [ { "type": { "text": "HTMLElement" }, "name": "item", "_ui5privacy": "public", "description": "the item about to be closed." } ] }, { "name": "item-toggle", "_ui5privacy": "public", "type": { "text": "CustomEvent<NotificationItemToggleEventDetail>", "references": [ { "name": "NotificationItemToggleEventDetail", "package": "@ui5/webcomponents-fiori", "module": "dist/NotificationList.js" } ] }, "description": "Fired when an item is toggled.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": true, "_ui5parameters": [ { "type": { "text": "HTMLElement" }, "name": "item", "_ui5privacy": "public", "description": "the toggled item." } ] } ], "attributes": [ { "description": "Defines the text that is displayed when the component contains no items.", "name": "no-data-text", "default": "undefined", "fieldName": "noDataText", "type": { "text": "string | undefined" } } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-notification-list", "customElement": true, "_ui5since": "2.0.0", "_ui5privacy": "public" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "NotificationList", "module": "dist/NotificationList.js" } }, { "kind": "custom-element-definition", "name": "ui5-notification-list", "declaration": { "name": "NotificationList", "module": "dist/NotificationList.js" } } ] }, { "kind": "javascript-module", "path": "dist/NotificationListGroupItem.js", "declarations": [ { "kind": "class", "description": "### Overview\nThe `ui5-li-notification-group` is a special type of list item,\nthat unlike others can group items within self, usually `ui5-li-notification` items.\n\nThe component consists of:\n\n- `Toggle` button to expand and collapse the group\n- `TitleText` to entitle the group\n- Items of the group\n\n### Usage\nThe component should be used inside a `ui5-notification-list`.\n\n### Keyboard Handling\nThe `ui5-li-notification-group` provides advanced keyboard handling.\nThis component provides fast navigation when the header is focused using the following keyboard shortcuts:\n\n- [Space] - toggles expand / collapse of the group\n- [Plus] - expands the group\n- [Minus] - collapses the group\n- [Right] - expands the group\n- [Left] - collapses the group\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-fiori/dist/NotificationListGroupItem.js\";`", "name": "NotificationListGroupItem", "slots": [ { "name": "default", "description": "Defines the items of the `ui5-li-notification-group`,\nusually `ui5-li-notification` items.", "_ui5propertyName": "items", "_ui5type": { "text": "Array<NotificationListItem>", "references": [ { "name": "NotificationListItem", "package": "@ui5/webcomponents-fiori", "module": "dist/NotificationListItem.js" } ] }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "collapsed", "type": { "text": "boolean" }, "default": "false", "description": "Defines if the group is collapsed or expanded.", "privacy": "public" }, { "kind": "field", "name": "growing", "type": { "text": "NotificationListGrowingMode", "references": [ { "name": "NotificationListGrowingMode", "package": "@ui5/webcomponents", "module": "dist/types/NotificationListGrowingMode.js" } ] }, "default": "\"None\"", "description": "Defines whether the component will have growing capability by pressing a `More` button.\nWhen button is pressed `load-more` event will be fired.", "privacy": "public", "_ui5since": "2.2.0" }, { "kind": "field", "name": "loading", "type": { "text": "boolean" }, "default": "false", "description": "Defines if a busy indicator would be displayed over the item.", "privacy": "public", "_ui5since": "1.0.0-rc.8" }, { "kind": "field", "name": "loadingDelay", "type": { "text": "number" }, "default": "1000", "description": "Defines the delay in milliseconds, after which the busy indicator will show up for this component.", "privacy": "public" }, { "kind": "field", "name": "read", "type": { "text": "boolean" }, "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" }, { "kind": "field", "name": "titleText", "type": { "text": "string | undefined" }, "description": "Defines the `titleText` of the item.", "default": "undefined", "privacy": "public" } ], "events": [ { "name": "load-more", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when additional items are requested.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5since": "2.2.0" }, { "name": "toggle", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the `ui5-li-notification-group` is expanded/collapsed by user interaction.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true } ], "attributes": [ { "description": "Defines if the group is collapsed or expanded.", "name": "collapsed", "default": "false", "fieldName": "collapsed", "type": { "text": "boolean" } }, { "description": "Defines whether the component will have growing capability by pressing a `More` button.\nWhen button is pressed `load-more` event will be fired.", "name": "growing", "default": "\"None\"", "fieldName": "growing", "type": { "text": "\"Button\" | \"None\"" } } ], "superclass": { "name": "NotificationListItemBase", "package": "@ui5/webcomponents-fiori", "module": "dist/NotificationListItemBase.js" }, "tagName": "ui5-li-notification-group", "customElement": true, "_ui5since": "1.0.0-rc.8", "_ui5privacy": "public" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "NotificationListGroupItem", "module": "dist/NotificationListGroupItem.js" } }, { "kind": "custom-element-definition", "name": "ui5-li-notification-group", "declaration": { "name": "NotificationListGroupItem", "module": "dist/NotificationListGroupItem.js" } } ] }, { "kind": "javascript-module", "path": "dist/NotificationListGroupList.js", "declarations": [ { "kind": "class", "description": "Internal `ui5-li-notification-group-list` component,\nthat is used to support keyboard navigation of the notification group internal list.", "name": "NotificationListGroupList", "superclass": { "name": "List", "package": "@ui5/webcomponents", "module": "dist/List.js" }, "tagName": "ui5-notification-group-list", "customElement": true, "_ui5privacy": "private", "cssParts": [ { "description": "Used to style the button, that is used for growing of the component", "name": "growing-button" }, { "description": "Used to style the button inner element", "name": "growing-button-inner" } ], "slots": [ { "name": "default", "description": "Defines the items of the component.\n\n**Note:** Use `ui5-li`, `ui5-li-custom`, and `ui5-li-group` for the intended design.", "_ui5propertyName": "items", "_ui5type": { "text": "Array<ListItemBase | ListItemGroup>" }, "_ui5privacy": "public" }, { "name": "header", "description": "Defines the component header.\n\n**Note:** When `header` is set, the\n`headerText` property is ignored.", "_ui5type": { "text": "Array<HTMLElement>" }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "accessibilityAttributes", "type": { "text": "ListAccessibilityAttributes", "references": [ { "name": "ListAccessibilityAttributes", "package": "@ui5/webcomponents", "module": "dist/List.js" } ] }, "default": "{}", "description": "Defines additional accessibility attributes on different areas of the component.\n\nThe accessibilityAttributes object has the following field:\n\n - **growingButton**: `growingButton.name`, `growingButton.description`.\n\n The accessibility attributes support the following values:\n\n- **name**: Defines the accessible ARIA name of the growing button.\nAccepts any string.\n\n- **description**: Defines the accessible ARIA description of the growing button.\nAccepts any string.\n\n **Note:** The `accessibilityAttributes` property is in an experimental state and is a subject to change.", "privacy": "public", "_ui5since": "2.13.0" }, { "kind": "field", "name": "accessibleDescription", "type": { "text": "string | undefined" }, "description": "Defines the accessible description of the component.", "default": "undefined", "privacy": "public", "_ui5since": "2.5.0" }, { "kind": "field", "name": "accessibleDescriptionRef", "type": { "text": "string | undefined" }, "description": "Defines the IDs of the elements that describe the component.", "default": "undefined", "privacy": "public", "_ui5since": "2.5.0" }, { "kind": "field", "name": "accessibleName", "type": { "text": "string | undefined" }, "description": "Defines the accessible name of the component.", "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15" }, { "kind": "field", "name": "accessibleNameRef", "type": { "text": "string | undefined" }, "description": "Defines the IDs of the elements that label the component.", "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15" }, { "kind": "field", "name": "accessibleRole", "type": { "text": "ListAccessibleRole", "references": [ { "name": "ListAccessibleRole", "package": "@ui5/webcomponents", "module": "dist/types/ListAccessibleRole.js" } ] }, "default": "\"List\"", "description": "Defines the accessible role of the component.", "privacy": "public", "_ui5since": "1.0.0-rc.15" }, { "kind": "field", "name": "footerText", "type": { "text": "string | undefined" }, "description": "Defines the footer text.", "default": "undefined", "privacy": "public" }, { "kind": "field", "name": "growing", "type": { "text": "ListGrowingMode", "references": [ { "name": "ListGrowingMode", "package": "@ui5/webcomponents", "module": "dist/types/ListGrowingMode.js" } ] }, "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" }, { "kind": "field", "name": "growingButtonText", "type": { "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": "undefined", "privacy": "public", "_ui5since": "1.24" }, { "kind": "field", "name": "headerText", "type": { "text": "string | undefined" }, "description": "Defines the component header text.\n\n**Note:** If `header` is set this property is ignored.", "default": "undefined", "privacy": "public" }, { "kind": "field", "name": "indent", "type": { "text": "boolean" }, "default": "false", "description": "Determines whether the component is indented.", "privacy": "public" }, { "kind": "field", "name": "listItems", "type": { "text": "Array<ListItemBase>", "references": [ { "name": "ListItemBase", "package": "@ui5/webcomponents", "module": "dist/ListItemBase.js" } ] }, "description": "Returns an array containing the list item instances without the groups in a flat structure.", "default": "[]", "privacy": "public", "readonly": true, "_ui5since": "2.0.0" }, { "kind": "field", "name": "loading", "type": { "text": "boolean" }, "default": "false", "description": "Defines if the component would display a loading indicator over the list.", "privacy": "public", "_ui5since": "1.0.0-rc.6" }, { "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" }, { "kind": "field", "name": "noDataText", "type": { "text": "string | undefined" }, "description": "Defines the text that is displayed when the component contains no items.", "default": "undefined", "privacy": "public" }, { "kind": "field", "name": "selectionMode", "type": { "text": "ListSelectionMode", "references": [ { "name": "ListSelectionMode", "package": "@ui5/webcomponents", "module": "dist/types/ListSelectionMode.js" } ] }, "default": "\"None\"", "description": "Defines the selection mode of the component.", "privacy": "public" }, { "kind": "field", "name": "separators", "type": { "text": "ListSeparator", "references": [ { "name": "ListSeparator", "package": "@ui5/webcomponents", "module": "dist/types/ListSeparator.js" } ] }, "default": "\"All\"", "description": "Defines the item separator style that is used.", "privacy": "public" }, { "kind": "field", "name": "stickyHeader", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the List header is sticky or not.\nIf stickyHeader is set to true, then whenever you scroll the content or\nthe application, the header of the list will be always visible.", "privacy": "public", "_ui5since": "2.19.0" } ], "events": [ { "name": "item-click", "_ui5privacy": "public", "type": { "text": "CustomEvent<ListItemClickEventDetail>", "references": [ { "name": "ListItemClickEventDetail", "package": "@ui5/webcomponents", "module": "dist/List.js" } ] }, "description": "Fired when an item is activated, unless the item's `type` property\nis set to `Inactive`.\n\n**Note**: This event is not triggered by interactions with selection components such as the checkboxes and radio buttons,\nassociated with non-default `selectionMode` values, or if any other **interactive** component\n(such as a button or input) within the list item is directly clicked.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": true, "_ui5parameters": [ { "type": { "text": "HTMLElement" }, "name": "item", "_ui5privacy": "public", "description": "The clicked item." } ] }, { "name": "item-close", "_ui5privacy": "public", "type": { "text": "CustomEvent<ListItemCloseEventDetail>", "references": [ { "name": "ListItemCloseEventDetail", "package": "@ui5/webcomponents", "module": "dist/List.js" } ] }, "description": "Fired when the `Close` button of any item is clicked\n\n**Note:** This event is only applicable to list items that can be closed (such as notification list items),\nnot to be confused with `item-delete`.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5since": "1.0.0-rc.8", "_ui5parameters": [ { "type": { "text": "HTMLElement" }, "name": "item", "_ui5privacy": "public", "description": "the item about to be closed." } ] }, { "name": "item-delete", "_ui5privacy": "public", "type": { "text": "CustomEvent<ListItemDeleteEventDetail>", "references": [ { "name": "ListItemDeleteEventDetail", "package": "@ui5/webcomponents", "module": "dist/List.js" } ] }, "description": "Fired when the Delete button of any item is pressed.\n\n**Note:** A Delete button is displayed on each item,\nwhen the component `selectionMode` property is set to `Delete`.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5parameters": [ { "type": { "text": "HTMLElement" }, "name": "item", "_ui5privacy": "public", "description": "the deleted item." } ] }, { "name": "item-toggle", "_ui5privacy": "public", "type": { "text": "CustomEvent<ListItemToggleEventDetail>", "references": [ { "name": "ListItemToggleEventDetail", "package": "@ui5/webcomponents", "module": "dist/List.js" } ] }, "description": "Fired when the `Toggle` button of any item is clicked.\n\n**Note:** This event is only applicable to list items that can be toggled (such as notification group list items).", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5since": "1.0.0-rc.8", "_ui5parameters": [ { "type": { "text": "HTMLElement" }, "name": "item", "_ui5privacy": "public", "description": "the toggled item." } ] }, { "name": "load-more", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the user scrolls to the bottom of the list.\n\n**Note:** The event is fired when the `growing='Scroll'` property is enabled.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5since": "1.0.0-rc.6" }, { "name": "move", "_ui5privacy": "public", "type": { "text": "CustomEvent<ListMoveEventDetail>", "references": [ { "name": "ListMoveEventDetail", "package": "@ui5/webcomponents", "module": "dist/List.js" } ] }, "description": "Fired when a movable list item is dropped onto a drop target.\n\n**Note:** `move` event is fired only if there was a preceding `move-over` with prevented default action.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5parameters": [ { "type": { "text": "object" }, "name": "destination", "_ui5privacy": "public", "description": "Contains information about the destination of the moved element. Has `element` and `placement` properties." }, { "type": { "text": "object" }, "name": "source", "_ui5privacy": "public", "description": "Contains information about the moved element under `element` property." } ] }, { "name": "move-over", "_ui5privacy": "public", "type": { "text": "CustomEvent<ListMoveEventDetail>", "references": [ { "name": "ListMoveEventDetail", "package": "@ui5/webcomponents", "module": "dist/List.js" } ] }, "description": "Fired when a movable list item is moved over a potential drop target during a dragging operation.\n\nIf the new position is valid, prevent the default action of the event using `preventDefault()`.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": true, "_ui5since": "2.0.0", "_ui5parameters": [ { "type": { "text": "object" }, "name": "destination", "_ui5privacy": "public", "description": "Contains information about the destination of the moved element. Has `element` and `placement` properties." }, { "type": { "text": "object" }, "name": "source", "_ui5privacy": "public", "description": "Contains information about the moved element under `element` property." } ] }, { "name": "selection-change", "_ui5privacy": "public", "type": { "text": "CustomEvent<ListSelectionChangeEventDetail>", "references": [ { "name": "ListSelectionChangeEventDetail", "package": "@ui5/webcomponents", "module": "dist/List.js" } ] }, "description": "Fired when selection is changed by user interaction\nin `Single`, `SingleStart`, `SingleEnd` and `Multiple` selection modes.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": true, "_ui5parameters": [ { "type": { "text": "Array<ListItemBase>", "references": [ { "name": "ListItemBase", "package": "@ui5/webcomponents", "module": "dist/ListItemBase.js" } ] }, "name": "previouslySelectedItems", "_ui5privacy": "public", "description": "An array of the previously selected items." }, { "type": { "text": "Array<ListItemBase>", "references": [ { "name": "ListItemBase", "package": "@ui5/webcomponents", "module": "dist/ListItemBase.js" } ] }, "name": "selectedItems", "_ui5privacy": "public", "description": "An array of the selected items." } ] } ], "attributes": [ { "description": "Defines additional accessibility attributes on different areas of the component.\n\nThe accessibilityAttributes object has the following field:\n\n - **growingButton**: `growingButton.name`, `growingButton.description`.\n\n The accessibility attributes support the following values:\n\n- **name**: Defines the accessible ARIA name of the growing button.\nAccepts any string.\n\n- **description**: Defines the accessible ARIA description of the growing button.\nAccepts any string.\n\n **Note:** The `accessibilityAttributes` property is in an experimental state and is a subject to change.", "name": "accessibility-attributes", "default": "{}", "fieldName": "accessibilityAttributes", "type": { "text": "ListAccessibilityAttributes" } }, { "description": "Defines the accessible description of the component.", "name": "accessible-description", "default": "undefined", "fieldName": "accessibleDescription", "type": { "text": "string | undefined" } }, { "description": "Defines the IDs of the elements that describe the component.", "name": "accessible-description-ref", "default": "undefined", "fieldName": "accessibleDescriptionRef", "type": { "text": "string | undefined" } }, { "description": "Defines the accessible name of the component.", "name": "accessible-name", "default": "undefined", "fieldName": "accessibleName", "type": { "text": "string | undefined" } }, { "description": "Defines the IDs of the elements that label the component.", "name": "accessible-name-ref", "default": "undefined", "fieldName": "accessibleNameRef", "type": { "text": "string | undefined" } }, { "description": "Defines the accessible role of the component.", "name": "accessible-role", "default": "\"List\"", "fieldName": "accessibleRole", "type": { "text": "\"List\" | \"Menu\" | \"Tree\" | \"ListBox\"" } }, { "description": "Defines the footer text.", "name": "footer-text", "default": "undefined", "fieldName": "footerText", "type": { "text": "string | undefined" } }, { "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\"`.", "name": "growing", "default": "\"None\"", "fieldName": "growing", "type": { "text": "\"None\" | \"Button\" | \"Scroll\"" } }, { "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": "undefined", "fieldName": "growingButtonText", "type": { "text": "string | undefined" } }, { "description": "Defines the component header text.\n\n**Note:** If `header` is set this property is ignored.", "name": "header-text", "default": "undefined", "fieldName": "headerText", "type": { "text": "string | undefined" } }, { "description": "Determines whether the component is indented.", "name": "indent", "default": "false", "fieldName": "indent", "type": { "text": "boolean" } }, { "description": "Returns an array containing the list item instances without the groups in a flat structure.", "name": "list-items", "default": "[]", "fieldName": "listItems", "type": { "text": "any" } }, { "description": "Defines if the component would display a loading indicator over the list.", "name": "loading", "default": "false", "fieldName": "loading", "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" } }, { "description": "Defines the text that is displayed when the component contains no items.", "name": "no-data-text", "default": "undefined", "fieldName": "noDataText", "type": { "text": "string | undefined" } }, { "description": "Defines the selection mode of the component.", "name": "selection-mode", "default": "\"None\"", "fieldName": "selectionMode", "type": { "text": "\"None\" | \"Single\" | \"Multiple\" | \"SingleStart\" | \"SingleEnd\" | \"SingleAuto\" | \"Delete\"" } }, { "description": "Defines the item separator style that is used.", "name": "separators", "default": "\"All\"", "fieldName": "separators", "type": { "text": "\"None\" | \"All\" | \"Inner\"" } }, { "description": "Indicates whether the List header is sticky or not.\nIf stickyHeader is set to true, then whenever you scroll the content or\nthe application, the header of the list will be always visible.", "name": "sticky-header", "default": "false", "fieldName": "stickyHeader", "type": { "text": "boolean" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "NotificationListGroupList", "module": "dist/NotificationListGroupList.js" } }, { "kind": "custom-element-definition", "name": "ui5-notification-group-list", "declaration": { "name": "NotificationListGroupList", "module": "dist/NotificationListGroupList.js" } } ] }, { "kind": "javascript-module", "path": "dist/NotificationListInternal.js", "declarations": [ { "kind": "class", "description": "Internal `ui5-li-notification-list-list` component,\nthat is used to support keyboard navigation of the notification list internal list.", "name": "NotificationListInternal", "superclass": { "name": "List", "package": "@ui5/webcomponents", "module": "dist/List.js" }, "tagName": "ui5-notification-list-internal", "customElement": true, "_ui5privacy": "private", "cssParts": [ { "description": "Used to style the button, that is used for growing of the component", "name": "growing-button" }, { "description": "Used to style the button inner element", "name": "growing-button-inner" } ], "slots": [ { "name": "default", "description": "Defines the items of the component.\n\n**Note:** Use `ui5-li`, `ui5-li-custom`, and `ui5-li-group` for the intended design.", "_ui5propertyName": "items", "_ui5type": { "text": "Array<ListItemBase | ListItemGroup>" }, "_ui5privacy": "public" }, { "name": "header", "description": "Defines the component header.\n\n**Note:** When `header` is set, the\n`headerText` property is ignored.", "_ui5type": { "text": "Array<HTMLElement>" }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "accessibilityAttributes", "type": { "text": "ListAccessibilityAttributes", "references": [ { "name": "ListAccessibilityAttributes", "package": "@ui5/webcomponents", "module": "dist/List.js" } ] }, "default": "{}", "description": "Defines additional accessibility attributes on different areas of the component.\n\nThe accessibilityAttributes object has the following field:\n\n - **growingButton**: `growingButton.name`, `growingButton.description`.\n\n The accessibility attributes support the following values:\n\n- **name**: Defines the accessible ARIA name of the growing button.\nAccepts any string.\n\n- **description**: Defines the accessible ARIA description of the growing button.\nAccepts any string.\n\n **Note:** The `accessibilityAttributes` property is in an experimental state and is a subject to change.", "privacy": "public", "_ui5since": "2.13.0" }, { "kind": "field", "name": "accessibleDescription", "type": { "text": "string | undefined" }, "description": "Defines the accessible description of the component.", "default": "undefined", "privacy": "public", "_ui5since": "2.5.0" }, { "kind": "field", "name": "accessibleDescriptionRef", "type": { "text": "string | undefined" }, "description": "Defines the IDs of the elements that describe the component.", "default": "undefined", "privacy": "public", "_ui5since": "2.5.0" }, { "kind": "field", "name": "accessibleName", "type": { "text": "string | undefined" }, "description": "Defines the accessible name of the component.", "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15" }, { "kind": "field", "name": "accessibleNameRef", "type": { "text": "string | undefined" }, "description": "Defines the IDs of the elements that label the component.", "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15" }, { "kind": "field", "name": "accessibleRole", "type": { "text": "ListAccessibleRole", "references": [ { "name": "ListAccessibleRole", "package": "@ui5/webcomponents", "module": "dist/types/ListAccessibleRole.js" } ] }, "default": "\"List\"", "description": "Defines the accessible role of the component.", "privacy": "public", "_ui5since": "1.0.0-rc.15" }, { "kind": "field", "name": "footerText", "type": { "text": "string | undefined" }, "description": "Defines the footer text.", "default": "undefined", "privacy": "public" }, { "kind": "field", "name": "growing", "type": { "text": "ListGrowingMode", "references": [ { "name": "ListGrowingMode", "package": "@ui5/webcomponents", "module": "dist/types/ListGrowingMode.js" } ] }, "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" }, { "kind": "field", "name": "growingButtonText", "type": { "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": "undefined", "privacy": "public", "_ui5since": "1.24" }, { "kind": "field", "name": "headerText", "type": { "text": "string | undefined" }, "description": "Defines the component header text.\n\n**Note:** If `header` is set this property is ignored.", "default": "undefined", "privacy": "public" }, { "kind": "field", "name": "indent", "type": { "text": "boolean" }, "default": "false", "description": "Determines whether the component is indented.", "privacy": "public" }, { "kind": "field", "name": "listItems", "type": { "text": "Array<ListItemBase>", "references": [ { "name": "ListItemBase", "package": "@ui5/webcomponents", "module": "dist/ListItemBase.js" } ] }, "description": "Returns an array containing the list item instances without the groups in a flat structure.", "default": "[]", "privacy": "public", "readonly": true, "_ui5since": "2.0.0" }, { "kind": "field", "name": "loading", "type": { "text": "boolean" }, "default": "false", "description": "Defines if the component would display a loading indicator over the list.", "privacy": "public", "_ui5since": "1.0.0-rc.6" }, { "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" }, { "kind": "field", "name": "noDataText", "type": { "text": "string | undefined" }, "description": "Defines the text that is displayed when the component contains no items.", "default": "undefined", "privacy": "public" }, { "kind": "field", "name": "selectionMode", "type": { "text": "ListSelectionMode", "references": [ { "name": "ListSelectionMode", "package": "@ui5/webcomponents", "module": "dist/types/ListSelectionMode.js" } ] }, "default": "\"None\"", "description": "Defines the selection mode of the component.", "privacy": "public" }, { "kind": "field", "name": "separators", "type": { "text": "ListSeparator", "references": [ { "name": "ListSeparator", "package": "@ui5/webcomponents", "module": "dist/types/ListSeparator.js" } ] }, "default": "\"All\"", "description": "Defines the item separator style that is used.", "privacy": "public" }, { "kind": "field", "name": "stickyHeader", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the List header is sticky or not.\nIf stickyHeader is set to true, then whenever you scroll the content or\nthe application, the header of the list will be always visible.", "privacy": "public", "_ui5since": "2.19.0" } ], "events": [ { "name": "item-click", "_ui5privacy": "public", "type": { "text": "CustomEvent<ListItemClickEventDetail>", "references": [ { "name": "ListItemClickEventDetail", "package": "@ui5/webcomponents", "module": "dist/List.js" } ] }, "description": "Fired when an item is activated, unless the item's `type` property\nis set to `Inactive`.\n\n**Note**: This event is not triggered by interactions with selection components such as the checkboxes and radio buttons,\nassociated with non-default `selectionMode` values, or if any other **interactive** component\n(such as a button or input) within the list item is directly clicked.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": true, "_ui5parameters": [ { "type": { "text": "HTMLElement" }, "name": "item", "_ui5privacy": "public", "description": "The clicked item." } ] }, { "name": "item-close", "_ui5privacy": "public", "type": { "text": "CustomEvent<ListItemCloseEventDetail>", "references": [ { "name": "ListItemCloseEventDetail", "package": "@ui5/webcomponents", "module": "dist/List.js" } ] }, "description": "Fired when the `Close` button of any item is clicked\n\n**Note:** This event is only applicable to list items that can be closed (such as notification list items),\nnot to be confused with `item-delete`.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5since": "1.0.0-rc.8", "_ui5parameters": [ { "type": { "text": "HTMLElement" }, "name": "item", "_ui5privacy": "public", "description": "the item about to be closed." } ] }, { "name": "item-delete", "_ui5privacy": "public", "type": { "text": "CustomEvent<ListItemDeleteEventDetail>", "references": [ { "name": "ListItemDeleteEventDetail", "package": "@ui5/webcomponents", "module": "dist/List.js" } ] }, "description": "Fired when the Delete button of any item is pressed.\n\n**Note:** A Delete button is displayed on each item,\nwhen the component `selectionMode` property is set to `Delete`.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5parameters": [ { "type": { "text": "HTMLElement" }, "name": "item", "_ui5privacy": "public", "description": "the deleted item." } ] }, { "name": "item-toggle", "_ui5privacy": "public", "type": { "text": "CustomEvent<ListItemToggleEventDetail>", "references": [ { "name": "ListItemToggleEventDetail", "package": "@ui5/webcomponents", "module": "dist/List.js" } ] }, "description": "Fired when the `Toggle` button of any item is clicked.\n\n**Note:** This event is only applicable to list items that can be toggled (such as notification group list items).", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5since": "1.0.0-rc.8", "_ui5parameters": [ { "type": { "text": "HTMLElement" }, "name": "item", "_ui5privacy": "public", "description": "the toggled item." } ] }, { "name": "load-more", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the user scrolls to the bottom of the list.\n\n**Note:** The event is fired when the `growing='Scroll'` property is enabled.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5since": "1.0.0-rc.6" }, { "name": "move", "_ui5privacy": "public", "type": { "text": "CustomEvent<ListMoveEventDetail>", "references": [ { "name": "ListMoveEventDetail", "package": "@ui5/webcomponents", "module": "dist/List.js" } ] }, "description": "Fired when a movable list item is dropped onto a drop target.\n\n**Note:** `move` event is fired only if there was a preceding `move-over` with prevented default action.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5parameters": [ { "type": { "text": "object" }, "name": "destination", "_ui5privacy": "public", "description": "Contains information about the destination of the moved element. Has `element` and `placement` properties." }, { "type": { "text": "object" }, "name": "source", "_ui5privacy": "public", "description": "Contains information about the moved element under `element` property." } ] }, { "name": "move-over", "_ui5privacy": "public", "type": { "text": "CustomEvent<ListMoveEventDetail>", "references": [ { "name": "ListMoveEventDetail", "package": "@ui5/webcomponents", "module": "dist/List.js" } ] }, "description": "Fired when a movable list item is moved over a potential drop target during a dragging operation.\n\nIf the new position is valid, prevent the default action of the event using `preventDefault()`.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": true, "_ui5since": "2.0.0", "_ui5parameters": [ { "type": { "text": "object" }, "name": "destination", "_ui5privacy": "public", "description": "Contains information about the destination of the moved element. Has `element` and `placement` properties." }, { "type": { "text": "object" }, "name": "source", "_ui5privacy": "public", "description": "Contains information about the moved element under `element` property." } ] }, { "name": "selection-change", "_ui5privacy": "public", "type": { "text": "CustomEvent<ListSelectionChangeEventDetail>", "references": [ { "name": "ListSelectionChangeEventDetail", "package": "@ui5/webcomponents", "module": "dist/List.js" } ] }, "description": "Fired when selection is changed by user interaction\nin `Single`, `SingleStart`, `SingleEnd` and `Multiple` selection modes.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": true, "_ui5parameters": [ { "type": { "text": "Array<ListItemBase>", "references": [ { "name": "ListItemBase", "package": "@ui5/webcomponents", "module": "dist/ListItemBase.js" } ] }, "name": "previouslySelectedItems", "_ui5privacy": "public", "description": "An array of the previously selected items." }, { "type": { "text": "Array<ListItemBase>", "references": [ { "name": "ListItemBase", "package": "@ui5/webcomponents", "module": "dist/ListItemBase.js" } ] }, "name": "selectedItems", "_ui5privacy": "public", "description": "An array of the selected items." } ] } ], "attributes": [ { "description": "Defines additional accessibility attributes on different areas of the component.\n\nThe accessibilityAttributes object has the following field:\n\n - **growingButton**: `growingButton.name`, `growingButton.description`.\n\n The accessibility attributes support the following values:\n\n- **name**: Defines the accessible ARIA name of the growing button.\nAccepts any string.\n\n- **description**: Defines the accessible ARIA description of the growing button.\nAccepts any string.\n\n **Note:** The `accessibilityAttributes` property is in an experimental state and is a subject to change.", "name": "accessibility-attributes", "default": "{}", "fieldName": "accessibilityAttributes", "type": { "text": "ListAccessibilityAttributes" } }, { "description": "Defines the accessible description of the component.", "name": "accessible-description", "default": "undefined", "fieldName": "accessibleDescription", "type": { "text": "string | undefined" } }, { "description": "Defines the IDs of the elements that describe the component.", "name": "accessible-description-ref", "default": "undefined", "fieldName": "accessibleDescriptionRef", "type": { "text": "string | undefined" } }, { "description": "Defines the accessible name of the component.", "name": "accessible-name", "default": "undefined", "fieldName": "accessibleName", "type": { "text": "string | undefined" } }, { "description": "Defines the IDs of the elements that label the component.", "name": "accessible-name-ref", "default": "undefined", "fieldName": "accessibleNameRef", "type": { "text": "string | undefined" } }, { "description": "Defines the accessible role of the component.", "name": "accessible-role", "default": "\"List\"", "fieldName": "accessibleRole", "type": { "text": "\"List\" | \"Menu\" | \"Tree\" | \"ListBox\"" } }, { "description": "Defines the footer text.", "name": "footer-text", "default": "undefined", "fieldName": "footerText", "type": { "text": "string | undefined" } }, { "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\"`.", "name": "growing", "default": "\"None\"", "fieldName": "growing", "type": { "text": "\"None\" | \"Button\" | \"Scroll\"" } }, { "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": "undefined", "fieldName": "growingButtonText", "type": { "text": "string | undefined" } }, { "description": "Defines the component header text.\n\n**Note:** If `header` is set this property is ignored.", "name": "header-text", "default": "undefined", "fieldName": "headerText", "type": { "text": "string | undefined" } }, { "description": "Determines whether the component is indented.", "name": "indent", "default": "false", "fieldName": "indent", "type": { "text": "boolean" } }, { "description": "Returns an array containing the list item instances without the groups in a flat structure.", "name": "list-items", "default": "[]", "fieldName": "listItems", "type": { "text": "any" } }, { "description": "Defines if the component would display a loading indicator over the list.", "name": "loading", "default": "false", "fieldName": "loading", "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" } }, { "description": "Defines the text that is displayed when the component contains no items.", "name": "no-data-text", "default": "undefined", "fieldName": "noDataText", "type": { "text": "string | undefined" } }, { "description": "Defines the selection mode of the component.", "name": "selection-mode", "default": "\"None\"", "fieldName": "selectionMode", "type": { "text": "\"None\" | \"Single\" | \"Multiple\" | \"SingleStart\" | \"SingleEnd\" | \"SingleAuto\" | \"Delete\"" } }, { "description": "Defines the item separator style that is used.", "name": "separators", "default": "\"All\"", "fieldName": "separators", "type": { "text": "\"None\" | \"All\" | \"Inner\"" } }, { "description": "Indicates whether the List header is sticky or not.\nIf stickyHeader is set to true, then whenever you scroll the content or\nthe application, the header of the list will be always visible.", "name": "sticky-header", "default": "false", "fieldName": "stickyHeader", "type": { "text": "boolean" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "NotificationListInternal", "module": "dist/NotificationListInternal.js" } }, { "kind": "custom-element-definition", "name": "ui5-notification-list-internal", "declaration": { "name": "NotificationListInternal", "module": "dist/NotificationListInternal.js" } } ] }, { "kind": "javascript-module", "path": "dist/NotificationListItem.js", "declarations": [ { "kind": "class", "description": "### Overview\nThe `ui5-li-notification` is a type of list item, meant to display notifications.\n\nThe component has a rich set of various properties that allows the user to set `avatar`, `menu`, `titleText`, descriptive `content`\nand `footnotes` to fully describe a notification.\n\nThe user can:\n\n- display a `Close` button\n- can control whether the `titleText` and `description` should wrap or truncate\nand display a `ShowMore` button to switch between less and more information\n- add actions by using the `ui5-menu` component\n\n**Note:** Adding custom actions by using the `ui5-notification-action` component is deprecated as of version 2.0!\n\n### Usage\nThe component should be used inside a `ui5-notification-list`.\n\n### Keyboard Handling\n\n#### Basic Navigation\nThe user can use the following keyboard shortcuts to perform actions (such as select, delete):\n\n- [Enter] - select an item (trigger \"item-click\" event)\n- [Delete] - close an item (trigger \"item-close\" event)\n\n#### Fast Navigation\nThis component provides a fast navigation using the following keyboard shortcuts:\n\n- [Shift] + [Enter] - 'More'/'Less' link will be triggered\n- [Shift] + [F10] - 'Menu' (Actions) button will be triggered (clicked)\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-fiori/dist/NotificationListItem.js\";`", "name": "NotificationListItem", "cssParts": [ { "description": "Used to style the titleText of the notification list item", "name": "title-text" } ], "slots": [ { "name": "avatar", "description": "Defines the avatar, displayed in the `ui5-li-notification`.\n\n**Note:** Consider using the `ui5-avatar` to display icons, initials or images.\n\n**Note:** In order to be complaint with the UX guidlines and for best experience,\nwe recommend using avatars with 2rem X 2rem in size (32px X 32px). In case you are using the `ui5-avatar`\nyou can set its `size` property to `XS` to get the required size - `<ui5-avatar size=\"XS\"></ui5-avatar>`.", "_ui5type": { "text": "Array<HTMLElement>" }, "_ui5privacy": "public" }, { "name": "default", "description": "Defines the content of the `ui5-li-notification`,\nusually a description of the notification.\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.", "_ui5propertyName": "description", "_ui5type": { "text": "Array<Node>" }, "_ui5privacy": "public" }, { "name": "footnotes", "description": "Defines the elements, displayed in the footer of the of the component.", "_ui5type": { "text": "Array<HTMLElement>" }, "_ui5privacy": "public" }, { "name": "menu", "description": "Defines the menu, displayed in the `ui5-li-notification`.\n\n**Note:** Use this for implementing actions.\n\n**Note:** Should be used instead `u5-notification-action`, which is deprecated as of version 2.0.", "_ui5type": { "text": "Array<HTMLElement>" }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "importance", "type": { "text": "NotificationListItemImportance", "references": [ { "name": "NotificationListItemImportance", "package": "@ui5/webcomponents-fiori", "module": "dist/types/NotificationListItemImportance.js" } ] }, "default": "\"Standard\"", "description": "Defines the `Important` label of the item.", "privacy": "public" }, { "kind": "field", "name": "loading", "type": { "text": "boolean" }, "default": "false", "description": "Defines if a busy indicator would be displayed over the item.", "privacy": "public", "_ui5since": "1.0.0-rc.8" }, { "kind": "field", "name": "loadingDelay", "type": { "text": "number" }, "default": "1000", "description": "Defines the delay in milliseconds, after which the busy indicator will show up for this component.", "privacy": "public" }, { "kind": "field", "name": "read", "type": { "text": "boolean" }, "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" }, { "kind": "field", "name": "showClose", "type": { "text": "boolean" }, "default": "false", "description": "Defines if the `Close` button would be displayed.", "privacy": "public" }, { "kind": "field", "name": "state", "type": { "text": "ValueState", "references": [ { "name": "ValueState", "package": "@ui5/webcomponents-base", "module": "dist/types/ValueState.js" } ] }, "default": "\"None\"", "description": "Defines the status indicator of the item.", "privacy": "public" }, { "kind": "field", "name": "titleText", "type": { "text": "string | undefined" }, "description": "Defines the `titleText` of the item.", "default": "undefined", "privacy": "public" }, { "kind": "field", "name": "wrappingType", "type": { "text": "WrappingType", "references": [ { "name": "WrappingType", "package": "@ui5/webcomponents", "module": "dist/types/WrappingType.js" } ] }, "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" } ], "events": [ { "name": "close", "_ui5privacy": "public", "type": { "text": "CustomEvent<NotificationListItemCloseEventDetail>", "references": [ { "name": "NotificationListItemCloseEventDetail", "package": "@ui5/webcomponents-fiori", "module": "dist/NotificationListItem.js" } ] }, "description": "Fired when the `Close` button is pressed.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": false, "_ui5parameters": [ { "type": { "text": "HTMLElement" }, "name": "item", "_ui5privacy": "public", "description": "the closed item." } ] } ], "attributes": [ { "description": "Defines the `Important` label of the item.", "name": "importance", "default": "\"Standard\"", "fieldName": "importance", "type": { "text": "\"Standard\" | \"Important\"" } }, { "description": "Defines if the `Close` button would be displayed.", "name": "show-close", "default": "false", "fieldName": "showClose", "type": { "text": "boolean" } }, { "description": "Defines the status indicator of the item.", "name": "state", "default": "\"None\"", "fieldName": "state", "type": { "text": "\"None\" | \"Positive\" | \"Critical\" | \"Negative\" | \"Information\"" } }, { "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.", "name": "wrapping-type", "default": "\"None\"", "fieldName": "wrappingType", "type": { "text": "\"None\" | \"Normal\"" } } ], "superclass": { "name": "NotificationListItemBase", "package": "@ui5/webcomponents-fiori", "module": "dist/NotificationListItemBase.js" }, "tagName": "ui5-li-notification", "customElement": true, "_ui5since": "1.0.0-rc.8", "_ui5privacy": "public" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "NotificationListItem", "module": "dist/NotificationListItem.js" } }, { "kind": "custom-element-definition", "name": "ui5-li-notification", "declaration": { "name": "NotificationListItem", "module": "dist/NotificationListItem.js" } } ] }, { "kind": "javascript-module", "path": "dist/NotificationListItemBase.js", "declarations": [ { "kind": "class", "description": "The base class of the `NotificationListItem` and `NotificationListGroupItem`.", "name": "NotificationListItemBase", "members": [ { "kind": "field", "name": "loading", "type": { "text": "boolean" }, "default": "false", "description": "Defines if a busy indicator would be displayed over the item.", "privacy": "public", "_ui5since": "1.0.0-rc.8" }, { "kind": "field", "name": "loadingDelay", "type": { "text": "number" }, "default": "1000", "description": "Defines the delay in milliseconds, after which the busy indicator will show up for this component.", "privacy": "public" }, { "kind": "field", "name": "read", "type": { "text": "boolean" }, "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" }, { "kind": "field", "name": "titleText", "type": { "text": "string | undefined" }, "description": "Defines the `titleText` of the item.", "default": "undefined", "privacy": "public" } ], "superclass": { "name": "ListItemBase", "package": "@ui5/webcomponents", "module": "dist/ListItemBase.js" }, "_ui5since": "1.0.0-rc.8", "_ui5privacy": "public" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "NotificationListItemBase", "module": "dist/NotificationListItemBase.js" } } ] }, { "kind": "javascript-module", "path": "dist/Page.js", "declarations": [ { "kind": "class", "description": "### Overview\n\nThe `ui5-page` is a container component that holds one whole screen of an application.\nThe page has three distinct areas that can hold content - a header, content area and a footer.\n### Structure\n#### Header\nThe top most area of the page is occupied by the header. The standard header includes a navigation button and a title.\n#### Content\nThe content occupies the main part of the page. Only the content area is scrollable by default.\nThis can be prevented by setting `noScrolling` to `true`.\n#### Footer\nThe footer is optional and occupies the part above the bottom part of the content. Alternatively, the footer can be fixed at the bottom of the page by enabling the `fixedFooter` property.\n\n**Note:** `ui5-page` occipues the whole available space of its parent. In order to achieve the intended design you have to make sure\nthat there is enough space for the `ui5-page` to be rendered.\n**Note:** In order for the `ui5-page` to be displayed, the parent element should have fixed height.\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-fiori/dist/Page.js\";`", "name": "Page", "cssParts": [ { "description": "Used to style the content section of the component", "name": "content" } ], "slots": [ { "name": "default", "description": "Defines the content HTML Element.", "_ui5propertyName": "content", "_ui5type": { "text": "Array<Node>" }, "_ui5privacy": "public" }, { "name": "footer", "description": "Defines the footer HTML Element.", "_ui5type": { "text": "Array<HTMLElement>" }, "_ui5privacy": "public" }, { "name": "header", "description": "Defines the header HTML Element.", "_ui5type": { "text": "Array<HTMLElement>" }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "backgroundDesign", "type": { "text": "PageBackgroundDesign", "references": [ { "name": "PageBackgroundDesign", "package": "@ui5/webcomponents-fiori", "module": "dist/types/PageBackgroundDesign.js" } ] }, "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" }, { "kind": "field", "name": "fixedFooter", "type": { "text": "boolean" }, "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" }, { "kind": "field", "name": "hideFooter", "type": { "text": "boolean" }, "default": "false", "description": "Defines the footer visibility.", "privacy": "public" }, { "kind": "field", "name": "noScrolling", "type": { "text": "boolean" }, "default": "false", "description": "Disables vertical scrolling of page content.\nIf set to true, there will be no vertical scrolling at all.", "privacy": "public" } ], "attributes": [ { "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.", "name": "background-design", "default": "\"Solid\"", "fieldName": "backgroundDesign", "type": { "text": "\"List\" | \"Solid\" | \"Transparent\"" } }, { "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.", "name": "fixed-footer", "default": "false", "fieldName": "fixedFooter", "type": { "text": "boolean" } }, { "description": "Defines the footer visibility.", "name": "hide-footer", "default": "false", "fieldName": "hideFooter", "type": { "text": "boolean" } }, { "description": "Disables vertical scrolling of page content.\nIf set to true, there will be no vertical scrolling at all.", "name": "no-scrolling", "default": "false", "fieldName": "noScrolling", "type": { "text": "boolean" } } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-page", "customElement": true, "_ui5since": "1.0.0-rc.12", "_ui5privacy": "public" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "Page", "module": "dist/Page.js" } }, { "kind": "custom-element-definition", "name": "ui5-page", "declaration": { "name": "Page", "module": "dist/Page.js" } } ] }, { "kind": "javascript-module", "path": "dist/ProductSwitch.js", "declarations": [ { "kind": "interface", "name": "IProductSwitchItem", "description": "Interface for components that may be slotted inside `ui5-product-switch` as items", "_ui5privacy": "public" }, { "kind": "class", "description": "### Overview\n\nThe `ui5-product-switch` is an SAP Fiori specific web component that is used in `ui5-shellbar`\nand allows the user to easily switch between products.\n\n### Keyboard Handling\nThe `ui5-product-switch` provides advanced keyboard handling.\nWhen focused, the user can use the following keyboard\nshortcuts in order to perform a navigation:\n\n- [Tab] - Move focus to the next interactive element after the `ui5-product-switch`\n- [Up] or [Down] - Navigates up and down the items\n- [Left] or [Right] - Navigates left and right the items\n\n### ES6 Module Import\n`import \"@ui5/webcomponents-fiori/dist/ProductSwitch.js\";`\n\n`import \"@ui5/webcomponents-fiori/dist/ProductSwitchItem.js\";` (for `ui5-product-switch-item`)", "name": "ProductSwitch", "slots": [ { "name": "default", "description": "Defines the items of the `ui5-product-switch`.", "_ui5propertyName": "items", "_ui5type": { "text": "Array<IProductSwitchItem>", "references": [ { "name": "IProductSwitchItem", "package": "@ui5/webcomponents-fiori", "module": "dist/ProductSwitch.js" } ] }, "_ui5privacy": "public" } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-product-switch", "customElement": true, "_ui5since": "1.0.0-rc.5", "_ui5privacy": "public" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "ProductSwitch", "module": "dist/ProductSwitch.js" } }, { "kind": "custom-element-definition", "name": "ui5-product-switch", "declaration": { "name": "ProductSwitch", "module": "dist/ProductSwitch.js" } } ] }, { "kind": "javascript-module", "path": "dist/ProductSwitchItem.js", "declarations": [ { "kind": "class", "description": "### Overview\nThe `ui5-product-switch-item` web component represents the items displayed in the\n`ui5-product-switch` web component.\n\n**Note:** `ui5-product-switch-item` is not supported when used outside of `ui5-product-switch`.\n\n### Keyboard Handling\nThe `ui5-product-switch` provides advanced keyboard handling.\nWhen focused, the user can use the following keyboard\nshortcuts in order to perform a navigation:\n\n- [Space] / [Enter] or [Return] - Trigger `ui5-click` event\n\n### ES6 Module Import\n`import \"@ui5/webcomponents-fiori/dist/ProductSwitchItem.js\";`", "name": "ProductSwitchItem", "slots": [ { "name": "image", "description": "Defines an image to be displayed instead of the standard icon.\n\n**Note:** The image slot takes precedence over the icon property.\n**Note:** We recommend using non-interactive ui5-avatar with size S, Square shape and Transparent colorScheme for best alignment.", "_ui5since": "2.14.0", "_ui5type": { "text": "Array<HTMLElement>" }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "icon", "type": { "text": "string | undefined" }, "description": "Defines the icon to be displayed as a graphical element within the component.\n\nExample:\n\n`<ui5-product-switch-item icon=\"palette\">`\n\nSee all the available icons in the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).", "default": "undefined", "privacy": "public" }, { "kind": "field", "name": "subtitleText", "type": { "text": "string | undefined" }, "description": "Defines the subtitle of the component.", "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15" }, { "kind": "field", "name": "target", "type": { "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`\n\n**Note:** By default target will be open in the same frame as it was clicked.", "default": "undefined", "privacy": "public" }, { "kind": "field", "name": "targetSrc", "type": { "text": "string | undefined" }, "description": "Defines the component target URI. Supports standard hyperlink behavior.", "default": "undefined", "privacy": "public" }, { "kind": "field", "name": "titleText", "type": { "text": "string | undefined" }, "description": "Defines the title of the component.", "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15" } ], "events": [ { "name": "click", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the `ui5-product-switch-item` is activated either with a\nclick/tap or by using the Enter or Space key.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true } ], "attributes": [ { "description": "Defines the icon to be displayed as a graphical element within the component.\n\nExample:\n\n`<ui5-product-switch-item icon=\"palette\">`\n\nSee all the available icons in the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).", "name": "icon", "default": "undefined", "fieldName": "icon", "type": { "text": "string | undefined" } }, { "description": "Defines the subtitle of the component.", "name": "subtitle-text", "default": "undefined", "fieldName": "subtitleText", "type": { "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`\n\n**Note:** By default target will be open in the same frame as it was clicked.", "name": "target", "default": "undefined", "fieldName": "target", "type": { "text": "string | undefined" } }, { "description": "Defines the component target URI. Supports standard hyperlink behavior.", "name": "target-src", "default": "undefined", "fieldName": "targetSrc", "type": { "text": "string | undefined" } }, { "description": "Defines the title of the component.", "name": "title-text", "default": "undefined", "fieldName": "titleText", "type": { "text": "string | undefined" } } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-product-switch-item", "customElement": true, "_ui5since": "1.0.0-rc.5", "_ui5privacy": "public", "_ui5implements": [ { "name": "IProductSwitchItem", "package": "@ui5/webcomponents-fiori", "module": "dist/ProductSwitch.js" } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "ProductSwitchItem", "module": "dist/ProductSwitchItem.js" } }, { "kind": "custom-element-definition", "name": "ui5-product-switch-item", "declaration": { "name": "ProductSwitchItem", "module": "dist/ProductSwitchItem.js" } } ] }, { "kind": "javascript-module", "path": "dist/Search.js", "declarations": [ { "kind": "class", "description": "### Overview\n\nA `ui5-search` is an input with suggestions, used for user search.\n\nThe `ui5-search` consists of several elements parts:\n- Scope - displays a select in the beggining of the component, used for filtering results by their scope.\n- Input field - for user input value\n- Clear button - gives the possibility for deleting the entered value\n- Search button - a primary button for performing search, when the user has entered a search term\n- Suggestions - a list with available search suggestions\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-fiori/dist/Search.js\";`", "name": "Search", "slots": [ { "name": "action", "description": "Defines the popup footer action button.", "_ui5type": { "text": "Array<Button>", "references": [ { "name": "Button", "package": "@ui5/webcomponents", "module": "dist/Button.js" } ] }, "_ui5privacy": "public" }, { "name": "default", "description": "Defines the Search suggestion items.", "_ui5propertyName": "items", "_ui5type": { "text": "Array<SearchItem | SearchItemGroup>" }, "_ui5privacy": "public" }, { "name": "filterButton", "description": "Defines the filter button slot, used to display an additional filtering button.\nThis slot is intended for passing a `ui5-button` with a filter icon to provide extended filtering options.\n\n**Note:** Scope button and Filter button are mutually exclusive.", "_ui5since": "2.11.0", "_ui5type": { "text": "Array<Button>", "references": [ { "name": "Button", "package": "@ui5/webcomponents", "module": "dist/Button.js" } ] }, "_ui5privacy": "public" }, { "name": "illustration", "description": "Defines the illustrated message to be shown in the popup.", "_ui5type": { "text": "Array<IllustratedMessage>", "references": [ { "name": "IllustratedMessage", "package": "@ui5/webcomponents-fiori", "module": "dist/IllustratedMessage.js" } ] }, "_ui5privacy": "public" }, { "name": "messageArea", "description": "Defines the illustrated message to be shown in the popup.", "_ui5type": { "text": "Array<SearchMessageArea>", "references": [ { "name": "SearchMessageArea", "package": "@ui5/webcomponents-fiori", "module": "dist/SearchMessageArea.js" } ] }, "_ui5privacy": "public" }, { "name": "scopes", "description": "Defines the component scope options.", "_ui5type": { "text": "Array<ISearchScope>", "references": [ { "name": "ISearchScope", "package": "@ui5/webcomponents-fiori", "module": "dist/SearchField.js" } ] }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "accessibleDescription", "type": { "text": "string | undefined" }, "description": "Defines the accessible ARIA description of the field.", "privacy": "public", "default": "undefined" }, { "kind": "field", "name": "accessibleName", "type": { "text": "string | undefined" }, "description": "Defines the accessible ARIA name of the component.", "privacy": "public", "default": "undefined" }, { "kind": "field", "name": "fieldLoading", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether a loading indicator should be shown in the input field.", "privacy": "public", "_ui5since": "2.19.0" }, { "kind": "field", "name": "loading", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether a loading indicator should be shown in the popup.", "privacy": "public" }, { "kind": "field", "name": "noTypeahead", "type": { "text": "boolean" }, "default": "false", "description": "Defines whether the value will be autcompleted to match an item.", "privacy": "public" }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the items picker is open.", "privacy": "public" }, { "kind": "field", "name": "placeholder", "type": { "text": "string | undefined" }, "description": "Defines a short hint intended to aid the user with data entry when the\ncomponent has no value.", "default": "undefined", "privacy": "public" }, { "kind": "field", "name": "scopeValue", "type": { "text": "string | undefined" }, "description": "Defines the value of the component:\n\nApplications are responsible for setting the correct scope value.\n\n**Note:** If the given value does not match any existing scopes,\nno scope will be selected and the SearchField scope component will be displayed as empty.", "privacy": "public", "default": "\"\"", "_ui5since": "2.18.0" }, { "kind": "field", "name": "showClearIcon", "type": { "text": "boolean" }, "default": "false", "description": "Defines whether the clear icon of the search will be shown.", "privacy": "public" }, { "kind": "field", "name": "value", "type": { "text": "string" }, "default": "\"\"", "description": "Defines the value of the component.\n\n**Note:** The property is updated upon typing.", "privacy": "public" } ], "events": [ { "name": "close", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the popup is closed.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": false }, { "name": "input", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when typing in input or clear icon is pressed.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true }, { "name": "open", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the popup is opened.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": false }, { "name": "scope-change", "_ui5privacy": "public", "type": { "text": "CustomEvent<SearchFieldScopeSelectionChangeDetails>", "references": [ { "name": "SearchFieldScopeSelectionChangeDetails", "package": "@ui5/webcomponents-fiori", "module": "dist/SearchField.js" } ] }, "description": "Fired when the scope has changed.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5parameters": [ { "type": { "text": "HTMLElement" }, "name": "scope", "_ui5privacy": "public", "description": "The newly selected scope" } ] }, { "name": "search", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the user has triggered search with Enter key or Search Button press.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": true } ], "attributes": [ { "description": "Defines the accessible ARIA description of the field.", "name": "accessible-description", "default": "undefined", "fieldName": "accessibleDescription", "type": { "text": "string | undefined" } }, { "description": "Defines the accessible ARIA name of the component.", "name": "accessible-name", "default": "undefined", "fieldName": "accessibleName", "type": { "text": "string | undefined" } }, { "description": "Indicates whether a loading indicator should be shown in the input field.", "name": "field-loading", "default": "false", "fieldName": "fieldLoading", "type": { "text": "boolean" } }, { "description": "Indicates whether a loading indicator should be shown in the popup.", "name": "loading", "default": "false", "fieldName": "loading", "type": { "text": "boolean" } }, { "description": "Defines whether the value will be autcompleted to match an item.", "name": "no-typeahead", "default": "false", "fieldName": "noTypeahead", "type": { "text": "boolean" } }, { "description": "Indicates whether the items picker is open.", "name": "open", "default": "false", "fieldName": "open", "type": { "text": "boolean" } }, { "description": "Defines a short hint intended to aid the user with data entry when the\ncomponent has no value.", "name": "placeholder", "default": "undefined", "fieldName": "placeholder", "type": { "text": "string | undefined" } }, { "description": "Defines the value of the component:\n\nApplications are responsible for setting the correct scope value.\n\n**Note:** If the given value does not match any existing scopes,\nno scope will be selected and the SearchField scope component will be displayed as empty.", "name": "scope-value", "default": "\"\"", "fieldName": "scopeValue", "type": { "text": "string | undefined" } }, { "description": "Defines whether the clear icon of the search will be shown.", "name": "show-clear-icon", "default": "false", "fieldName": "showClearIcon", "type": { "text": "boolean" } }, { "description": "Defines the value of the component.\n\n**Note:** The property is updated upon typing.", "name": "value", "default": "\"\"", "fieldName": "value", "type": { "text": "string" } } ], "superclass": { "name": "SearchField", "package": "@ui5/webcomponents-fiori", "module": "dist/SearchField.js" }, "tagName": "ui5-search", "customElement": true, "_ui5experimental": true, "_ui5since": "2.9.0", "_ui5privacy": "public" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "Search", "module": "dist/Search.js" } }, { "kind": "custom-element-definition", "name": "ui5-search", "declaration": { "name": "Search", "module": "dist/Search.js" } } ] }, { "kind": "javascript-module", "path": "dist/SearchField.js", "declarations": [ { "kind": "interface", "name": "ISearchScope", "description": "Interface for components that may be slotted inside a `ui5-search`", "_ui5privacy": "public" }, { "kind": "class", "description": "### Overview\n\nA `ui5-search-field` is an input field, used for user search.\n\nThe `ui5-search-field` consists of several elements parts:\n- Scope - displays a select in the beggining of the component, used for filtering results by their scope.\n- Input field - for user input value\n- Clear button - gives the possibility for deleting the entered value\n- Search button - a primary button for performing search, when the user has entered a search term\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-fiori/dist/SearchField.js\";`", "name": "SearchField", "slots": [ { "name": "filterButton", "description": "Defines the filter button slot, used to display an additional filtering button.\nThis slot is intended for passing a `ui5-button` with a filter icon to provide extended filtering options.\n\n**Note:** Scope button and Filter button are mutually exclusive.", "_ui5since": "2.11.0", "_ui5type": { "text": "Array<Button>", "references": [ { "name": "Button", "package": "@ui5/webcomponents", "module": "dist/Button.js" } ] }, "_ui5privacy": "public" }, { "name": "scopes", "description": "Defines the component scope options.", "_ui5type": { "text": "Array<ISearchScope>", "references": [ { "name": "ISearchScope", "package": "@ui5/webcomponents-fiori", "module": "dist/SearchField.js" } ] }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "accessibleDescription", "type": { "text": "string | undefined" }, "description": "Defines the accessible ARIA description of the field.", "privacy": "public", "default": "undefined" }, { "kind": "field", "name": "accessibleName", "type": { "text": "string | undefined" }, "description": "Defines the accessible ARIA name of the component.", "privacy": "public", "default": "undefined" }, { "kind": "field", "name": "fieldLoading", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether a loading indicator should be shown in the input field.", "privacy": "public", "_ui5since": "2.19.0" }, { "kind": "field", "name": "placeholder", "type": { "text": "string | undefined" }, "description": "Defines a short hint intended to aid the user with data entry when the\ncomponent has no value.", "default": "undefined", "privacy": "public" }, { "kind": "field", "name": "scopeValue", "type": { "text": "string | undefined" }, "description": "Defines the value of the component:\n\nApplications are responsible for setting the correct scope value.\n\n**Note:** If the given value does not match any existing scopes,\nno scope will be selected and the SearchField scope component will be displayed as empty.", "privacy": "public", "default": "\"\"", "_ui5since": "2.18.0" }, { "kind": "field", "name": "showClearIcon", "type": { "text": "boolean" }, "default": "false", "description": "Defines whether the clear icon of the search will be shown.", "privacy": "public" }, { "kind": "field", "name": "value", "type": { "text": "string" }, "default": "\"\"", "description": "Defines the value of the component.\n\n**Note:** The property is updated upon typing.", "privacy": "public" } ], "events": [ { "name": "input", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when typing in input or clear icon is pressed.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true }, { "name": "scope-change", "_ui5privacy": "public", "type": { "text": "CustomEvent<SearchFieldScopeSelectionChangeDetails>", "references": [ { "name": "SearchFieldScopeSelectionChangeDetails", "package": "@ui5/webcomponents-fiori", "module": "dist/SearchField.js" } ] }, "description": "Fired when the scope has changed.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5parameters": [ { "type": { "text": "HTMLElement" }, "name": "scope", "_ui5privacy": "public", "description": "The newly selected scope" } ] }, { "name": "search", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the user has triggered search with Enter key or Search Button press.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": true } ], "attributes": [ { "description": "Defines the accessible ARIA description of the field.", "name": "accessible-description", "default": "undefined", "fieldName": "accessibleDescription", "type": { "text": "string | undefined" } }, { "description": "Defines the accessible ARIA name of the component.", "name": "accessible-name", "default": "undefined", "fieldName": "accessibleName", "type": { "text": "string | undefined" } }, { "description": "Indicates whether a loading indicator should be shown in the input field.", "name": "field-loading", "default": "false", "fieldName": "fieldLoading", "type": { "text": "boolean" } }, { "description": "Defines a short hint intended to aid the user with data entry when the\ncomponent has no value.", "name": "placeholder", "default": "undefined", "fieldName": "placeholder", "type": { "text": "string | undefined" } }, { "description": "Defines the value of the component:\n\nApplications are responsible for setting the correct scope value.\n\n**Note:** If the given value does not match any existing scopes,\nno scope will be selected and the SearchField scope component will be displayed as empty.", "name": "scope-value", "default": "\"\"", "fieldName": "scopeValue", "type": { "text": "string | undefined" } }, { "description": "Defines whether the clear icon of the search will be shown.", "name": "show-clear-icon", "default": "false", "fieldName": "showClearIcon", "type": { "text": "boolean" } }, { "description": "Defines the value of the component.\n\n**Note:** The property is updated upon typing.", "name": "value", "default": "\"\"", "fieldName": "value", "type": { "text": "string" } } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-search-field", "customElement": true, "_ui5privacy": "private" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "SearchField", "module": "dist/SearchField.js" } }, { "kind": "custom-element-definition", "name": "ui5-search-field", "declaration": { "name": "SearchField", "module": "dist/SearchField.js" } } ] }, { "kind": "javascript-module", "path": "dist/SearchItem.js", "declarations": [ { "kind": "class", "description": "### Overview\n\nA `ui5-search-item` is a list item, used for displaying search suggestions\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-fiori/dist/SearchItem.js\";`", "name": "SearchItem", "slots": [ { "name": "actions", "description": "Defines the actionable elements.\nThis slot allows placing additional interactive elements (such as buttons, icons, or tags)\nnext to the delete button, providing flexible customization for various user actions.\n\n**Note:** While the slot is flexible, for consistency with design guidelines,\nit's recommended to use `ui5-button` with `Transparent` design or `ui5-icon` elements.", "_ui5since": "2.16.0", "_ui5type": { "text": "Array<HTMLElement>" }, "_ui5privacy": "public" }, { "name": "image", "description": "**Note:** While the slot allows the option of setting a custom avatar, to comply with the\ndesign guidelines, use the `ui5-avatar` with size - XS.", "_ui5since": "2.12.0", "_ui5type": { "text": "Array<HTMLElement>" }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "deletable", "type": { "text": "boolean" }, "default": "false", "description": "Defines whether the search item is deletable.", "privacy": "public" }, { "kind": "field", "name": "description", "type": { "text": "string | undefined" }, "description": "Defines the description that appears right under the item text, if available.", "default": "undefined", "privacy": "public", "_ui5since": "2.12.0" }, { "kind": "field", "name": "icon", "type": { "text": "string | undefined" }, "description": "Defines the icon name of the search item.\n**Note:** If provided, the image slot will be ignored.", "default": "undefined", "privacy": "public" }, { "kind": "field", "name": "scopeName", "type": { "text": "string | undefined" }, "description": "Defines the scope of the search item", "default": "undefined", "privacy": "public" }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Defines whether the search item is selected.", "privacy": "public" }, { "kind": "field", "name": "text", "type": { "text": "string | undefined" }, "description": "Defines the heading text of the search item.", "default": "undefined", "privacy": "public" } ], "events": [ { "name": "delete", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when delete button is pressed.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": false } ], "attributes": [ { "description": "Defines whether the search item is deletable.", "name": "deletable", "default": "false", "fieldName": "deletable", "type": { "text": "boolean" } }, { "description": "Defines the description that appears right under the item text, if available.", "name": "description", "default": "undefined", "fieldName": "description", "type": { "text": "string | undefined" } }, { "description": "Defines the icon name of the search item.\n**Note:** If provided, the image slot will be ignored.", "name": "icon", "default": "undefined", "fieldName": "icon", "type": { "text": "string | undefined" } }, { "description": "Defines the scope of the search item", "name": "scope-name", "default": "undefined", "fieldName": "scopeName", "type": { "text": "string | undefined" } }, { "description": "Defines whether the search item is selected.", "name": "selected", "default": "false", "fieldName": "selected", "type": { "text": "boolean" } }, { "description": "Defines the heading text of the search item.", "name": "text", "default": "undefined", "fieldName": "text", "type": { "text": "string | undefined" } } ], "superclass": { "name": "ListItemBase", "package": "@ui5/webcomponents", "module": "dist/ListItemBase.js" }, "tagName": "ui5-search-item", "customElement": true, "_ui5experimental": true, "_ui5since": "2.9.0", "_ui5privacy": "public" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "SearchItem", "module": "dist/SearchItem.js" } }, { "kind": "custom-element-definition", "name": "ui5-search-item", "declaration": { "name": "SearchItem", "module": "dist/SearchItem.js" } } ] }, { "kind": "javascript-module", "path": "dist/SearchItemGroup.js", "declarations": [ { "kind": "class", "description": "The `ui5-search-item-group` is type of suggestion item,\nthat can be used to split the `ui5-search-item` suggestions into groups.", "name": "SearchItemGroup", "superclass": { "name": "ListItemGroup", "package": "@ui5/webcomponents", "module": "dist/ListItemGroup.js" }, "tagName": "ui5-search-item-group", "customElement": true, "_ui5experimental": true, "_ui5since": "2.9.0", "_ui5privacy": "public", "cssParts": [ { "description": "Used to style the header item of the group", "name": "header" }, { "description": "Used to style the title of the group header", "name": "title" } ], "slots": [ { "name": "default", "description": "Defines the items of the <code>ui5-li-group</code>.", "_ui5propertyName": "items", "_ui5type": { "text": "Array<ListItemBase>", "references": [ { "name": "ListItemBase", "package": "@ui5/webcomponents", "module": "dist/ListItemBase.js" } ] }, "_ui5privacy": "public" }, { "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<ListItemBase>", "references": [ { "name": "ListItemBase", "package": "@ui5/webcomponents", "module": "dist/ListItemBase.js" } ] }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "headerAccessibleName", "type": { "text": "string | undefined" }, "description": "Defines the accessible name of the header.", "privacy": "public", "default": "undefined" }, { "kind": "field", "name": "headerText", "type": { "text": "string | undefined" }, "description": "Defines the header text of the <code>ui5-li-group</code>.", "privacy": "public", "default": "undefined" }, { "kind": "field", "name": "wrappingType", "type": { "text": "WrappingType", "references": [ { "name": "WrappingType", "package": "@ui5/webcomponents", "module": "dist/types/WrappingType.js" } ] }, "default": "\"None\"", "description": "Defines if the text of the component should wrap when it's too long.\nWhen set to \"Normal\", the content (title, description) will be wrapped\nusing the `ui5-expandable-text` component.<br/>\n\nThe text can wrap up to 100 characters on small screens (size S) and\nup to 300 characters on larger screens (size M and above). When text exceeds\nthese limits, it truncates with an ellipsis followed by a text expansion trigger.\n\nAvailable options are:\n- `None` (default) - The text will truncate with an ellipsis.\n- `Normal` - The text will wrap (without truncation).", "privacy": "public", "_ui5since": "2.15.0" } ], "events": [ { "name": "move", "_ui5privacy": "public", "type": { "text": "CustomEvent<ListItemGroupMoveEventDetail>", "references": [ { "name": "ListItemGroupMoveEventDetail", "package": "@ui5/webcomponents", "module": "dist/ListItemGroup.js" } ] }, "description": "Fired when a movable list item is dropped onto a drop target.\n\n**Note:** `move` event is fired only if there was a preceding `move-over` with prevented default action.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5since": "2.1.0", "_ui5parameters": [ { "type": { "text": "object" }, "name": "destination", "_ui5privacy": "public", "description": "Contains information about the destination of the moved element. Has `element` and `placement` properties." }, { "type": { "text": "object" }, "name": "source", "_ui5privacy": "public", "description": "Contains information about the moved element under `element` property." } ] }, { "name": "move-over", "_ui5privacy": "public", "type": { "text": "CustomEvent<ListItemGroupMoveEventDetail>", "references": [ { "name": "ListItemGroupMoveEventDetail", "package": "@ui5/webcomponents", "module": "dist/ListItemGroup.js" } ] }, "description": "Fired when a movable list item is moved over a potential drop target during a dragging operation.\n\nIf the new position is valid, prevent the default action of the event using `preventDefault()`.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": true, "_ui5since": "2.1.0", "_ui5parameters": [ { "type": { "text": "object" }, "name": "destination", "_ui5privacy": "public", "description": "Contains information about the destination of the moved element. Has `element` and `placement` properties." }, { "type": { "text": "object" }, "name": "source", "_ui5privacy": "public", "description": "Contains information about the moved element under `element` property." } ] } ], "attributes": [ { "description": "Defines the accessible name of the header.", "name": "header-accessible-name", "default": "undefined", "fieldName": "headerAccessibleName", "type": { "text": "string | undefined" } }, { "description": "Defines the header text of the <code>ui5-li-group</code>.", "name": "header-text", "default": "undefined", "fieldName": "headerText", "type": { "text": "string | undefined" } }, { "description": "Defines if the text of the component should wrap when it's too long.\nWhen set to \"Normal\", the content (title, description) will be wrapped\nusing the `ui5-expandable-text` component.<br/>\n\nThe text can wrap up to 100 characters on small screens (size S) and\nup to 300 characters on larger screens (size M and above). When text exceeds\nthese limits, it truncates with an ellipsis followed by a text expansion trigger.\n\nAvailable options are:\n- `None` (default) - The text will truncate with an ellipsis.\n- `Normal` - The text will wrap (without truncation).", "name": "wrapping-type", "default": "\"None\"", "fieldName": "wrappingType", "type": { "text": "\"None\" | \"Normal\"" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "SearchItemGroup", "module": "dist/SearchItemGroup.js" } }, { "kind": "custom-element-definition", "name": "ui5-search-item-group", "declaration": { "name": "SearchItemGroup", "module": "dist/SearchItemGroup.js" } } ] }, { "kind": "javascript-module", "path": "dist/SearchItemShowMore.js", "declarations": [ { "kind": "class", "description": "### Overview\n\nA `ui5-search-item-show-more` is a special type of ui5-li that acts as a button to progressively reveal additional (overflow) items within a group.\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-fiori/dist/SearchItemShowMore.js\";`", "name": "SearchItemShowMore", "members": [ { "kind": "field", "name": "itemsToShowCount", "type": { "text": "number | undefined" }, "description": "Specifies the number of additional items available to show.\nIf no value is defined, the control shows \"Show more\" (without any counter).\nIf a number is provided, it displays \"Show more (N)\", where N is that number.", "privacy": "public", "default": "undefined" }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Defines whether the show more item is selected.", "privacy": "public" } ], "events": [ { "name": "click", "_ui5privacy": "public", "type": { "text": "CustomEvent<ShowMoreItemClickEventDetail>", "references": [ { "name": "ShowMoreItemClickEventDetail", "package": "@ui5/webcomponents-fiori", "module": "dist/SearchItemShowMore.js" } ] }, "description": "Fired when the component is activated, either with a mouse/tap\nor by pressing the Enter or Space keys.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": true, "_ui5parameters": [ { "type": { "text": "boolean" }, "name": "fromKeyboard", "_ui5privacy": "public", "description": "Indicates whether the event was fired\ndue to keyboard interaction (Enter or Space) rather than mouse/tap." } ] } ], "attributes": [ { "description": "Specifies the number of additional items available to show.\nIf no value is defined, the control shows \"Show more\" (without any counter).\nIf a number is provided, it displays \"Show more (N)\", where N is that number.", "name": "items-to-show-count", "default": "undefined", "fieldName": "itemsToShowCount", "type": { "text": "number | undefined" } }, { "description": "Defines whether the show more item is selected.", "name": "selected", "default": "false", "fieldName": "selected", "type": { "text": "boolean" } } ], "superclass": { "name": "ListItemBase", "package": "@ui5/webcomponents", "module": "dist/ListItemBase.js" }, "tagName": "ui5-search-item-show-more", "customElement": true, "_ui5experimental": true, "_ui5since": "2.14.0", "_ui5privacy": "public" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "SearchItemShowMore", "module": "dist/SearchItemShowMore.js" } }, { "kind": "custom-element-definition", "name": "ui5-search-item-show-more", "declaration": { "name": "SearchItemShowMore", "module": "dist/SearchItemShowMore.js" } } ] }, { "kind": "javascript-module", "path": "dist/SearchMessageArea.js", "declarations": [ { "kind": "class", "description": "`import \"@ui5/webcomponents-fiori/dist/SearchMessageArea.js\";`", "name": "SearchMessageArea", "members": [ { "kind": "field", "name": "description", "type": { "text": "string | undefined" }, "description": "Defines the description text to be displayed.", "default": "undefined", "privacy": "public" }, { "kind": "field", "name": "text", "type": { "text": "string | undefined" }, "description": "Defines the text to be displayed.", "default": "undefined", "privacy": "public" } ], "attributes": [ { "description": "Defines the description text to be displayed.", "name": "description", "default": "undefined", "fieldName": "description", "type": { "text": "string | undefined" } }, { "description": "Defines the text to be displayed.", "name": "text", "default": "undefined", "fieldName": "text", "type": { "text": "string | undefined" } } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-search-message-area", "customElement": true, "_ui5experimental": true, "_ui5since": "2.9.0", "_ui5privacy": "public" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "SearchMessageArea", "module": "dist/SearchMessageArea.js" } }, { "kind": "custom-element-definition", "name": "ui5-search-message-area", "declaration": { "name": "SearchMessageArea", "module": "dist/SearchMessageArea.js" } } ] }, { "kind": "javascript-module", "path": "dist/SearchScope.js", "declarations": [ { "kind": "class", "description": "The `ui5-search-scope` represents the options for the scope in `ui5-search`.", "name": "SearchScope", "members": [ { "kind": "field", "name": "text", "type": { "text": "string" }, "description": "Defines the text of the component.", "default": "\"\"", "privacy": "public" }, { "kind": "field", "name": "value", "type": { "text": "string | undefined" }, "description": "Defines the value of the `ui5-search-scope`.\nUsed for selection in Search scopes.", "default": "undefined", "privacy": "public" } ], "attributes": [ { "description": "Defines the text of the component.", "name": "text", "default": "\"\"", "fieldName": "text", "type": { "text": "string" } }, { "description": "Defines the value of the `ui5-search-scope`.\nUsed for selection in Search scopes.", "name": "value", "default": "undefined", "fieldName": "value", "type": { "text": "string | undefined" } } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-search-scope", "customElement": true, "_ui5experimental": true, "_ui5since": "2.9.0", "_ui5privacy": "public", "_ui5abstract": true, "_ui5implements": [ { "name": "ISearchScope", "package": "@ui5/webcomponents-fiori", "module": "dist/SearchField.js" } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "SearchScope", "module": "dist/SearchScope.js" } }, { "kind": "custom-element-definition", "name": "ui5-search-scope", "declaration": { "name": "SearchScope", "module": "dist/SearchScope.js" } } ] }, { "kind": "javascript-module", "path": "dist/ShellBar.js", "declarations": [ { "kind": "class", "description": "### Overview\n\nThe `ui5-shellbar` is meant to serve as an application header\nand includes numerous built-in features, such as: logo, profile image/icon, title, search field, notifications and so on.\n\n### Stable DOM Refs\n\nYou can use the following stable DOM refs for the `ui5-shellbar`:\n\n- logo\n- notifications\n- overflow\n- profile\n- product-switch\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`import \"@ui5/webcomponents-fiori/dist/ShellBar.js\";`", "name": "ShellBar", "cssParts": [ { "description": "Used to style the outermost wrapper of the `ui5-shellbar`", "name": "root" } ], "slots": [ { "name": "assistant", "description": "Defines the assistant slot.", "_ui5since": "2.0.0", "_ui5type": { "text": "Array<IButton>", "references": [ { "name": "IButton", "package": "@ui5/webcomponents", "module": "dist/Button.js" } ] }, "_ui5privacy": "public" }, { "name": "branding", "description": "Defines the branding slot.\nThe `ui5-shellbar-branding` component is intended to be placed inside this slot.\nContent placed here takes precedence over the `primaryTitle` property and the `logo` content slot.\n\n**Note:** The `branding` slot is in an experimental state and is a subject to change.", "_ui5since": "2.12.0", "_ui5type": { "text": "Array<ShellBarBranding>", "references": [ { "name": "ShellBarBranding", "package": "@ui5/webcomponents-fiori", "module": "dist/ShellBarBranding.js" } ] }, "_ui5privacy": "public" }, { "name": "content", "description": "Define the items displayed in the content area.\n\nUse the `data-hide-order` attribute with numeric value to specify the order of the items to be hidden when the space is not enough.\nLower values will be hidden first.\n\n**Note:** The `content` slot is in an experimental state and is a subject to change.", "_ui5since": "2.7.0", "_ui5type": { "text": "Array<HTMLElement>" }, "_ui5privacy": "public" }, { "name": "default", "description": "Defines the `ui5-shellbar` additional items.\n\n**Note:**\nYou can use the `<ui5-shellbar-item></ui5-shellbar-item>`.", "_ui5propertyName": "items", "_ui5type": { "text": "Array<ShellBarItem>", "references": [ { "name": "ShellBarItem", "package": "@ui5/webcomponents-fiori", "module": "dist/ShellBarItem.js" } ] }, "_ui5privacy": "public" }, { "name": "logo", "description": "Defines the logo of the `ui5-shellbar`.\nFor example, you can use `ui5-avatar` or `img` elements as logo.", "_ui5since": "1.0.0-rc.8", "_ui5type": { "text": "Array<HTMLElement>" }, "_ui5privacy": "public" }, { "name": "menuItems", "description": "Defines the items displayed in menu after a click on a start button.\n\n**Note:** You can use the `<ui5-li></ui5-li>` and its ancestors.", "_ui5since": "0.10", "_ui5type": { "text": "Array<ListItemBase>", "references": [ { "name": "ListItemBase", "package": "@ui5/webcomponents", "module": "dist/ListItemBase.js" } ] }, "_ui5privacy": "public" }, { "name": "profile", "description": "You can pass `ui5-avatar` to set the profile image/icon.\nIf no profile slot is set - profile will be excluded from actions.\n\n**Note:** We recommend not using the `size` attribute of `ui5-avatar` because\nit should have specific size by design in the context of `ui5-shellbar` profile.", "_ui5since": "1.0.0-rc.6", "_ui5type": { "text": "Array<HTMLElement>" }, "_ui5privacy": "public" }, { "name": "searchField", "description": "Defines the `ui5-input`, that will be used as a search field.", "_ui5type": { "text": "Array<IShellBarSearchField>", "references": [ { "name": "IShellBarSearchField", "package": "@ui5/webcomponents-fiori", "module": "dist/ShellBar.js" } ] }, "_ui5privacy": "public" }, { "name": "startButton", "description": "Defines a `ui5-button` in the bar that will be placed in the beginning.\nWe encourage this slot to be used for a menu button.\nIt gets overstyled to match ShellBar's styling.", "_ui5type": { "text": "Array<IButton>", "references": [ { "name": "IButton", "package": "@ui5/webcomponents", "module": "dist/Button.js" } ] }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "accessibilityAttributes", "type": { "text": "ShellBarAccessibilityAttributes", "references": [ { "name": "ShellBarAccessibilityAttributes", "package": "@ui5/webcomponents-fiori", "module": "dist/shellbar/ShellBarAccessibility.js" } ] }, "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.hasPopup`.\n- **overflow** - `overflow.expanded` and `overflow.hasPopup`.\n- **branding** - `branding.name`.\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" }, { "kind": "method", "name": "closeOverflow", "return": { "type": { "text": "void" } }, "description": "Closes the overflow popover.", "privacy": "public" }, { "kind": "field", "name": "disableSearchCollapse", "type": { "text": "boolean" }, "default": "false", "description": "Disables the automatic search field expansion/collapse when the available space is not enough.\n\n**Note:** The `disableSearchCollapse` property is in an experimental state and is a subject to change.", "privacy": "public" }, { "kind": "method", "name": "getSearchButtonDomRef", "return": { "type": { "text": "Promise<HTMLElement | null>" } }, "description": "Returns the search button DOM reference.", "privacy": "public" }, { "kind": "field", "name": "hideSearchButton", "type": { "text": "boolean" }, "default": "false", "description": "Defines the visibility state of the search button.\n\n**Note:** The `hideSearchButton` property is in an experimental state and is a subject to change.", "privacy": "public" }, { "kind": "field", "name": "logoDomRef", "type": { "text": "HTMLElement | null" }, "description": "Returns the `logo` DOM ref.", "privacy": "public", "default": "null", "readonly": true, "_ui5since": "1.0.0-rc.16" }, { "kind": "field", "name": "notificationsCount", "type": { "text": "string | undefined" }, "description": "Defines the `notificationsCount`,\ndisplayed in the notification icon top-right corner.", "default": "undefined", "privacy": "public" }, { "kind": "field", "name": "notificationsDomRef", "type": { "text": "HTMLElement | null" }, "description": "Returns the `notifications` icon DOM ref.", "privacy": "public", "default": "null", "readonly": true, "_ui5since": "1.0.0-rc.16" }, { "kind": "field", "name": "overflowDomRef", "type": { "text": "HTMLElement | null" }, "description": "Returns the `overflow` icon DOM ref.", "privacy": "public", "default": "null", "readonly": true, "_ui5since": "1.0.0-rc.16" }, { "kind": "field", "name": "primaryTitle", "type": { "text": "string | undefined" }, "description": "Defines the `primaryTitle`.\n\n**Note:** The `primaryTitle` would be hidden on S screen size (less than approx. 700px).", "default": "undefined", "privacy": "public" }, { "kind": "field", "name": "productSwitchDomRef", "type": { "text": "HTMLElement | null" }, "description": "Returns the `product-switch` icon DOM ref.", "privacy": "public", "default": "null", "readonly": true, "_ui5since": "1.0.0-rc.16" }, { "kind": "field", "name": "profileDomRef", "type": { "text": "HTMLElement | null" }, "description": "Returns the `profile` icon DOM ref.", "privacy": "public", "default": "null", "readonly": true, "_ui5since": "1.0.0-rc.16" }, { "kind": "field", "name": "secondaryTitle", "type": { "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": "undefined", "privacy": "public" }, { "kind": "field", "name": "showNotifications", "type": { "text": "boolean" }, "default": "false", "description": "Defines, if the notification icon would be displayed.", "privacy": "public" }, { "kind": "field", "name": "showProductSwitch", "type": { "text": "boolean" }, "default": "false", "description": "Defines, if the product switch icon would be displayed.", "privacy": "public" }, { "kind": "field", "name": "showSearchField", "type": { "text": "boolean" }, "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" } ], "events": [ { "name": "content-item-visibility-change", "_ui5privacy": "public", "type": { "text": "CustomEvent<ShellBarContentItemVisibilityChangeEventDetail>", "references": [ { "name": "ShellBarContentItemVisibilityChangeEventDetail", "package": "@ui5/webcomponents-fiori", "module": "dist/ShellBar.js" } ] }, "description": "Fired, when an item from the content slot is hidden or shown.\n**Note:** The `content-item-visibility-change` event is in an experimental state and is a subject to change.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5since": "2.7.0", "_ui5parameters": [ { "type": { "text": "Array<HTMLElement>" }, "name": "array", "_ui5privacy": "public", "description": "of all the items that are hidden" } ] }, { "name": "logo-click", "_ui5privacy": "public", "type": { "text": "CustomEvent<ShellBarLogoClickEventDetail>", "references": [ { "name": "ShellBarLogoClickEventDetail", "package": "@ui5/webcomponents-fiori", "module": "dist/ShellBar.js" } ] }, "description": "Fired, when the logo is activated.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5since": "0.10", "_ui5parameters": [ { "type": { "text": "HTMLElement" }, "name": "targetRef", "_ui5privacy": "public", "description": "dom ref of the activated element" } ] }, { "name": "menu-item-click", "_ui5privacy": "public", "type": { "text": "CustomEvent<ShellBarMenuItemClickEventDetail>", "references": [ { "name": "ShellBarMenuItemClickEventDetail", "package": "@ui5/webcomponents-fiori", "module": "dist/ShellBar.js" } ] }, "description": "Fired, when a menu item is activated\n\n**Note:** You can prevent closing of overflow popover by calling `event.preventDefault()`.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": true, "_ui5since": "0.10", "_ui5parameters": [ { "type": { "text": "HTMLElement" }, "name": "item", "_ui5privacy": "public", "description": "DOM ref of the activated list item" } ] }, { "name": "notifications-click", "_ui5privacy": "public", "type": { "text": "CustomEvent<ShellBarNotificationsClickEventDetail>", "references": [ { "name": "ShellBarNotificationsClickEventDetail", "package": "@ui5/webcomponents-fiori", "module": "dist/ShellBar.js" } ] }, "description": "Fired, when the notification icon is activated.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": true, "_ui5parameters": [ { "type": { "text": "HTMLElement" }, "name": "targetRef", "_ui5privacy": "public", "description": "dom ref of the activated element" } ] }, { "name": "product-switch-click", "_ui5privacy": "public", "type": { "text": "CustomEvent<ShellBarProductSwitchClickEventDetail>", "references": [ { "name": "ShellBarProductSwitchClickEventDetail", "package": "@ui5/webcomponents-fiori", "module": "dist/ShellBar.js" } ] }, "description": "Fired, when the product switch icon is activated.\n\n**Note:** You can prevent closing of overflow popover by calling `event.preventDefault()`.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": true, "_ui5parameters": [ { "type": { "text": "HTMLElement" }, "name": "targetRef", "_ui5privacy": "public", "description": "dom ref of the activated element" } ] }, { "name": "profile-click", "_ui5privacy": "public", "type": { "text": "CustomEvent<ShellBarProfileClickEventDetail>", "references": [ { "name": "ShellBarProfileClickEventDetail", "package": "@ui5/webcomponents-fiori", "module": "dist/ShellBar.js" } ] }, "description": "Fired, when the profile slot is present.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5parameters": [ { "type": { "text": "HTMLElement" }, "name": "targetRef", "_ui5privacy": "public", "description": "dom ref of the activated element" } ] }, { "name": "search-button-click", "_ui5privacy": "public", "type": { "text": "CustomEvent<ShellBarSearchButtonEventDetail>", "references": [ { "name": "ShellBarSearchButtonEventDetail", "package": "@ui5/webcomponents-fiori", "module": "dist/ShellBar.js" } ] }, "description": "Fired, when the search button is activated.\n\n**Note:** You can prevent expanding/collapsing of the search field by calling `event.preventDefault()`.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": true, "_ui5parameters": [ { "type": { "text": "Boolean" }, "name": "searchFieldVisible", "_ui5privacy": "public", "description": "whether the search field is visible" }, { "type": { "text": "HTMLElement" }, "name": "targetRef", "_ui5privacy": "public", "description": "dom ref of the activated element" } ] }, { "name": "search-field-clear", "_ui5privacy": "public", "type": { "text": "CustomEvent<ShellBarSearchFieldClearEventDetail>", "references": [ { "name": "ShellBarSearchFieldClearEventDetail", "package": "@ui5/webcomponents-fiori", "module": "dist/ShellBar.js" } ] }, "description": "Fired, when the search cancel button is activated.\n\n**Note:** You can prevent the default behavior (clearing the search field value) by calling `event.preventDefault()`. The search will still be closed.\n**Note:** The `search-field-clear` event is in an experimental state and is a subject to change.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": true, "_ui5since": "2.14.0", "_ui5parameters": [ { "type": { "text": "HTMLElement" }, "name": "targetRef", "_ui5privacy": "public", "description": "dom ref of the cancel button element" } ] }, { "name": "search-field-toggle", "_ui5privacy": "public", "type": { "text": "CustomEvent<ShellBarSearchFieldToggleEventDetail>", "references": [ { "name": "ShellBarSearchFieldToggleEventDetail", "package": "@ui5/webcomponents-fiori", "module": "dist/ShellBar.js" } ] }, "description": "Fired, when the search field is expanded or collapsed.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5since": "2.10.0", "_ui5parameters": [ { "type": { "text": "Boolean" }, "name": "expanded", "_ui5privacy": "public", "description": "whether the search field is expanded" } ] } ], "attributes": [ { "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.hasPopup`.\n- **overflow** - `overflow.expanded` and `overflow.hasPopup`.\n- **branding** - `branding.name`.\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.", "name": "accessibility-attributes", "default": "{}", "fieldName": "accessibilityAttributes", "type": { "text": "ShellBarAccessibilityAttributes" } }, { "description": "Disables the automatic search field expansion/collapse when the available space is not enough.\n\n**Note:** The `disableSearchCollapse` property is in an experimental state and is a subject to change.", "name": "disable-search-collapse", "default": "false", "fieldName": "disableSearchCollapse", "type": { "text": "boolean" } }, { "description": "Defines the visibility state of the search button.\n\n**Note:** The `hideSearchButton` property is in an experimental state and is a subject to change.", "name": "hide-search-button", "default": "false", "fieldName": "hideSearchButton", "type": { "text": "boolean" } }, { "description": "Returns the `logo` DOM ref.", "name": "logo-dom-ref", "default": "null", "fieldName": "logoDomRef", "type": { "text": "any" } }, { "description": "Defines the `notificationsCount`,\ndisplayed in the notification icon top-right corner.", "name": "notifications-count", "default": "undefined", "fieldName": "notificationsCount", "type": { "text": "string | undefined" } }, { "description": "Returns the `notifications` icon DOM ref.", "name": "notifications-dom-ref", "default": "null", "fieldName": "notificationsDomRef", "type": { "text": "any" } }, { "description": "Returns the `overflow` icon DOM ref.", "name": "overflow-dom-ref", "default": "null", "fieldName": "overflowDomRef", "type": { "text": "any" } }, { "description": "Defines the `primaryTitle`.\n\n**Note:** The `primaryTitle` would be hidden on S screen size (less than approx. 700px).", "name": "primary-title", "default": "undefined", "fieldName": "primaryTitle", "type": { "text": "string | undefined" } }, { "description": "Returns the `product-switch` icon DOM ref.", "name": "product-switch-dom-ref", "default": "null", "fieldName": "productSwitchDomRef", "type": { "text": "any" } }, { "description": "Returns the `profile` icon DOM ref.", "name": "profile-dom-ref", "default": "null", "fieldName": "profileDomRef", "type": { "text": "any" } }, { "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": "undefined", "fieldName": "secondaryTitle", "type": { "text": "string | undefined" } }, { "description": "Defines, if the notification icon would be displayed.", "name": "show-notifications", "default": "false", "fieldName": "showNotifications", "type": { "text": "boolean" } }, { "description": "Defines, if the product switch icon would be displayed.", "name": "show-product-switch", "default": "false", "fieldName": "showProductSwitch", "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.", "name": "show-search-field", "default": "false", "fieldName": "showSearchField", "type": { "text": "boolean" } } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-shellbar", "customElement": true, "_ui5since": "0.8.0", "_ui5privacy": "public" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "ShellBar", "module": "dist/ShellBar.js" } }, { "kind": "custom-element-definition", "name": "ui5-shellbar", "declaration": { "name": "ShellBar", "module": "dist/ShellBar.js" } } ] }, { "kind": "javascript-module", "path": "dist/ShellBarBranding.js", "declarations": [ { "kind": "class", "description": "### Overview\nThe `ui5-shellbar-branding` component is intended to be placed inside the branding slot of the\n`ui5-shellbar` component. Its content has higher priority than the `primaryTitle` property\nand the `logo` slot of `ui5-shellbar`.", "name": "ShellBarBranding", "slots": [ { "name": "default", "description": "Defines the title for the ui5-shellbar-branding 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.", "_ui5propertyName": "content", "_ui5type": { "text": "Array<HTMLElement>" }, "_ui5privacy": "public" }, { "name": "logo", "description": "Defines the logo of the `ui5-shellbar`.\nFor example, you can use `ui5-avatar` or `img` elements as logo.", "_ui5type": { "text": "Array<HTMLElement>" }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "accessibleName", "type": { "text": "string | undefined" }, "description": "Defines the text alternative of the component.\nIf not provided a default text alternative will be set, if present.", "default": "undefined", "privacy": "public" }, { "kind": "field", "name": "href", "type": { "text": "string | undefined" }, "description": "Defines the component href.\n\n**Note:** Standard hyperlink behavior is supported.", "default": "undefined", "privacy": "public" }, { "kind": "field", "name": "target", "type": { "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": "undefined", "privacy": "public" } ], "events": [ { "name": "click", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired, when the logo is activated.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true } ], "attributes": [ { "description": "Defines the text alternative of the component.\nIf not provided a default text alternative will be set, if present.", "name": "accessible-name", "default": "undefined", "fieldName": "accessibleName", "type": { "text": "string | undefined" } }, { "description": "Defines the component href.\n\n**Note:** Standard hyperlink behavior is supported.", "name": "href", "default": "undefined", "fieldName": "href", "type": { "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": "undefined", "fieldName": "target", "type": { "text": "string | undefined" } } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-shellbar-branding", "customElement": true, "_ui5experimental": true, "_ui5since": "2.12.0", "_ui5privacy": "public" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "ShellBarBranding", "module": "dist/ShellBarBranding.js" } }, { "kind": "custom-element-definition", "name": "ui5-shellbar-branding", "declaration": { "name": "ShellBarBranding", "module": "dist/ShellBarBranding.js" } } ] }, { "kind": "javascript-module", "path": "dist/ShellBarItem.js", "declarations": [ { "kind": "class", "description": "The `ui5-shellbar-item` represents a custom item for `ui5-shellbar`.\n\n### ES6 Module Import\n`import \"@ui5/webcomponents-fiori/dist/ShellBarItem.js\";`", "name": "ShellBarItem", "members": [ { "kind": "field", "name": "accessibilityAttributes", "type": { "text": "ShellBarItemAccessibilityAttributes", "references": [ { "name": "ShellBarItemAccessibilityAttributes", "package": "@ui5/webcomponents-fiori", "module": "dist/ShellBarItem.js" } ] }, "default": "{}", "description": "Defines additional accessibility attributes on Shellbar Items.\n\nThe accessibility attributes support the following values:\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\n- **controls**: Identifies the element (or elements) whose contents\nor presence are controlled by the component.\nAccepts a lowercase string value, referencing the ID of the element it controls.", "privacy": "public", "_ui5since": "2.9.0" }, { "kind": "field", "name": "count", "type": { "text": "string | undefined" }, "description": "Defines the count displayed in badge.", "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.6" }, { "kind": "field", "name": "icon", "type": { "text": "string | undefined" }, "description": "Defines the item's icon.", "default": "undefined", "privacy": "public" }, { "kind": "field", "name": "text", "type": { "text": "string | undefined" }, "description": "Defines the item text.\n\n**Note:** The text is only displayed inside the overflow popover list view.", "default": "undefined", "privacy": "public" } ], "events": [ { "name": "click", "_ui5privacy": "public", "type": { "text": "CustomEvent<ShellBarItemClickEventDetail>", "references": [ { "name": "ShellBarItemClickEventDetail", "package": "@ui5/webcomponents-fiori", "module": "dist/ShellBarItem.js" } ] }, "description": "Fired when the item is clicked.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": true, "_ui5parameters": [ { "type": { "text": "HTMLElement" }, "name": "targetRef", "_ui5privacy": "public", "description": "DOM ref of the clicked element" } ] } ], "attributes": [ { "description": "Defines additional accessibility attributes on Shellbar Items.\n\nThe accessibility attributes support the following values:\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\n- **controls**: Identifies the element (or elements) whose contents\nor presence are controlled by the component.\nAccepts a lowercase string value, referencing the ID of the element it controls.", "name": "accessibility-attributes", "default": "{}", "fieldName": "accessibilityAttributes", "type": { "text": "ShellBarItemAccessibilityAttributes" } }, { "description": "Defines the count displayed in badge.", "name": "count", "default": "undefined", "fieldName": "count", "type": { "text": "string | undefined" } }, { "description": "Defines the item's icon.", "name": "icon", "default": "undefined", "fieldName": "icon", "type": { "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": "undefined", "fieldName": "text", "type": { "text": "string | undefined" } } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-shellbar-item", "customElement": true, "_ui5privacy": "public" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "ShellBarItem", "module": "dist/ShellBarItem.js" } }, { "kind": "custom-element-definition", "name": "ui5-shellbar-item", "declaration": { "name": "ShellBarItem", "module": "dist/ShellBarItem.js" } } ] }, { "kind": "javascript-module", "path": "dist/ShellBarSearch.js", "declarations": [ { "kind": "class", "description": "Search field for the ShellBar component.", "name": "ShellBarSearch", "members": [ { "kind": "field", "name": "autoOpen", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the suggestions popover should be opened on focus.", "privacy": "public" }, { "kind": "field", "name": "accessibleDescription", "type": { "text": "string | undefined" }, "description": "Defines the accessible ARIA description of the field.", "privacy": "public", "default": "undefined" }, { "kind": "field", "name": "accessibleName", "type": { "text": "string | undefined" }, "description": "Defines the accessible ARIA name of the component.", "privacy": "public", "default": "undefined" }, { "kind": "field", "name": "fieldLoading", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether a loading indicator should be shown in the input field.", "privacy": "public", "_ui5since": "2.19.0" }, { "kind": "field", "name": "loading", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether a loading indicator should be shown in the popup.", "privacy": "public" }, { "kind": "field", "name": "noTypeahead", "type": { "text": "boolean" }, "default": "false", "description": "Defines whether the value will be autcompleted to match an item.", "privacy": "public" }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the items picker is open.", "privacy": "public" }, { "kind": "field", "name": "placeholder", "type": { "text": "string | undefined" }, "description": "Defines a short hint intended to aid the user with data entry when the\ncomponent has no value.", "default": "undefined", "privacy": "public" }, { "kind": "field", "name": "scopeValue", "type": { "text": "string | undefined" }, "description": "Defines the value of the component:\n\nApplications are responsible for setting the correct scope value.\n\n**Note:** If the given value does not match any existing scopes,\nno scope will be selected and the SearchField scope component will be displayed as empty.", "privacy": "public", "default": "\"\"", "_ui5since": "2.18.0" }, { "kind": "field", "name": "showClearIcon", "type": { "text": "boolean" }, "default": "false", "description": "Defines whether the clear icon of the search will be shown.", "privacy": "public" }, { "kind": "field", "name": "value", "type": { "text": "string" }, "default": "\"\"", "description": "Defines the value of the component.\n\n**Note:** The property is updated upon typing.", "privacy": "public" } ], "attributes": [ { "description": "Indicates whether the suggestions popover should be opened on focus.", "name": "auto-open", "default": "false", "fieldName": "autoOpen", "type": { "text": "boolean" } }, { "description": "Defines the accessible ARIA description of the field.", "name": "accessible-description", "default": "undefined", "fieldName": "accessibleDescription", "type": { "text": "string | undefined" } }, { "description": "Defines the accessible ARIA name of the component.", "name": "accessible-name", "default": "undefined", "fieldName": "accessibleName", "type": { "text": "string | undefined" } }, { "description": "Indicates whether a loading indicator should be shown in the input field.", "name": "field-loading", "default": "false", "fieldName": "fieldLoading", "type": { "text": "boolean" } }, { "description": "Indicates whether a loading indicator should be shown in the popup.", "name": "loading", "default": "false", "fieldName": "loading", "type": { "text": "boolean" } }, { "description": "Defines whether the value will be autcompleted to match an item.", "name": "no-typeahead", "default": "false", "fieldName": "noTypeahead", "type": { "text": "boolean" } }, { "description": "Indicates whether the items picker is open.", "name": "open", "default": "false", "fieldName": "open", "type": { "text": "boolean" } }, { "description": "Defines a short hint intended to aid the user with data entry when the\ncomponent has no value.", "name": "placeholder", "default": "undefined", "fieldName": "placeholder", "type": { "text": "string | undefined" } }, { "description": "Defines the value of the component:\n\nApplications are responsible for setting the correct scope value.\n\n**Note:** If the given value does not match any existing scopes,\nno scope will be selected and the SearchField scope component will be displayed as empty.", "name": "scope-value", "default": "\"\"", "fieldName": "scopeValue", "type": { "text": "string | undefined" } }, { "description": "Defines whether the clear icon of the search will be shown.", "name": "show-clear-icon", "default": "false", "fieldName": "showClearIcon", "type": { "text": "boolean" } }, { "description": "Defines the value of the component.\n\n**Note:** The property is updated upon typing.", "name": "value", "default": "\"\"", "fieldName": "value", "type": { "text": "string" } } ], "superclass": { "name": "Search", "package": "@ui5/webcomponents-fiori", "module": "dist/Search.js" }, "tagName": "ui5-shellbar-search", "customElement": true, "_ui5experimental": true, "_ui5since": "2.10.0", "_ui5privacy": "public", "slots": [ { "name": "action", "description": "Defines the popup footer action button.", "_ui5type": { "text": "Array<Button>", "references": [ { "name": "Button", "package": "@ui5/webcomponents", "module": "dist/Button.js" } ] }, "_ui5privacy": "public" }, { "name": "default", "description": "Defines the Search suggestion items.", "_ui5propertyName": "items", "_ui5type": { "text": "Array<SearchItem | SearchItemGroup>" }, "_ui5privacy": "public" }, { "name": "filterButton", "description": "Defines the filter button slot, used to display an additional filtering button.\nThis slot is intended for passing a `ui5-button` with a filter icon to provide extended filtering options.\n\n**Note:** Scope button and Filter button are mutually exclusive.", "_ui5since": "2.11.0", "_ui5type": { "text": "Array<Button>", "references": [ { "name": "Button", "package": "@ui5/webcomponents", "module": "dist/Button.js" } ] }, "_ui5privacy": "public" }, { "name": "illustration", "description": "Defines the illustrated message to be shown in the popup.", "_ui5type": { "text": "Array<IllustratedMessage>", "references": [ { "name": "IllustratedMessage", "package": "@ui5/webcomponents-fiori", "module": "dist/IllustratedMessage.js" } ] }, "_ui5privacy": "public" }, { "name": "messageArea", "description": "Defines the illustrated message to be shown in the popup.", "_ui5type": { "text": "Array<SearchMessageArea>", "references": [ { "name": "SearchMessageArea", "package": "@ui5/webcomponents-fiori", "module": "dist/SearchMessageArea.js" } ] }, "_ui5privacy": "public" }, { "name": "scopes", "description": "Defines the component scope options.", "_ui5type": { "text": "Array<ISearchScope>", "references": [ { "name": "ISearchScope", "package": "@ui5/webcomponents-fiori", "module": "dist/SearchField.js" } ] }, "_ui5privacy": "public" } ], "events": [ { "name": "close", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the popup is closed.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": false }, { "name": "input", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when typing in input or clear icon is pressed.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true }, { "name": "open", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the popup is opened.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": false }, { "name": "scope-change", "_ui5privacy": "public", "type": { "text": "CustomEvent<SearchFieldScopeSelectionChangeDetails>", "references": [ { "name": "SearchFieldScopeSelectionChangeDetails", "package": "@ui5/webcomponents-fiori", "module": "dist/SearchField.js" } ] }, "description": "Fired when the scope has changed.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5parameters": [ { "type": { "text": "HTMLElement" }, "name": "scope", "_ui5privacy": "public", "description": "The newly selected scope" } ] }, { "name": "search", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the user has triggered search with Enter key or Search Button press.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": true } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "ShellBarSearch", "module": "dist/ShellBarSearch.js" } }, { "kind": "custom-element-definition", "name": "ui5-shellbar-search", "declaration": { "name": "ShellBarSearch", "module": "dist/ShellBarSearch.js" } } ] }, { "kind": "javascript-module", "path": "dist/ShellBarSpacer.js", "declarations": [ { "kind": "class", "description": "### Overview\nThe `ui5-shellbar-spacer` is an element, used for visual separation between the two content parts of the `ui5-shellbar`.\n**Note:** The `ui5-shellbar-spacer` component is in an experimental state and is a subject to change.", "name": "ShellBarSpacer", "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-shellbar-spacer", "customElement": true, "_ui5since": "2.7.0", "_ui5privacy": "public", "_ui5abstract": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "ShellBarSpacer", "module": "dist/ShellBarSpacer.js" } }, { "kind": "custom-element-definition", "name": "ui5-shellbar-spacer", "declaration": { "name": "ShellBarSpacer", "module": "dist/ShellBarSpacer.js" } } ] }, { "kind": "javascript-module", "path": "dist/SideNavigation.js", "declarations": [ { "kind": "class", "description": "### Overview\n\nThe `SideNavigation` is used as a standard menu in applications.\nIt consists of three containers: header (top-aligned), main navigation section (top-aligned) and the secondary section (bottom-aligned).\n\n - The header is meant for displaying user related information - profile data, avatar, etc.\n - The main navigation section is related to the user's current work context.\n - The secondary section is mostly used to link additional information that may be of interest (legal information, developer communities, external help, contact information and so on).\n\n### Usage\n\nUse the available `ui5-side-navigation-group`, `ui5-side-navigation-item`\nand `ui5-side-navigation-sub-item` components to build your menu.\nThe items can consist of text only or an icon with text. The use or non-use of icons must be consistent for all items on one level.\nYou must not combine entries with and without icons on the same level. We strongly recommend that you do not use icons on the second level.\n\nThe `ui5-side-navigation` component is designed to be used within a `ui5-navigation-layout` component to ensure an optimal user experience.\n\nUsing it standalone may not match the intended design and functionality.\nFor example, the side navigation may not exhibit the correct behavior on smaller screens.\nAdditionally, the padding of the `ui5-shellbar` will not match the padding of the side navigation.\n\n### Keyboard Handling\n\n### Fast Navigation\nThis component provides a build in fast navigation group which can be used via [F6] / [Shift] + [F6] / [Ctrl] + [Alt/Option] / [Down] or [Ctrl] + [Alt/Option] + [Up].\nIn order to use this functionality, you need to import the following module:\n`import \"@ui5/webcomponents-base/dist/features/F6Navigation.js\"`\n\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-fiori/dist/SideNavigation.js\"`\n\n`import \"@ui5/webcomponents-fiori/dist/SideNavigationGroup.js\";` (for `ui5-side-navigation-group`)\n\n`import \"@ui5/webcomponents-fiori/dist/SideNavigationItem.js\";` (for `ui5-side-navigation-item`)\n\n`import \"@ui5/webcomponents-fiori/dist/SideNavigationSubItem.js\";` (for `ui5-side-navigation-sub-item`)", "name": "SideNavigation", "slots": [ { "name": "default", "description": "Defines the main items of the component.", "_ui5propertyName": "items", "_ui5type": { "text": "Array<SideNavigationItemBase>", "references": [ { "name": "SideNavigationItemBase", "package": "@ui5/webcomponents-fiori", "module": "dist/SideNavigationItemBase.js" } ] }, "_ui5privacy": "public" }, { "name": "fixedItems", "description": "Defines the fixed items at the bottom of the component.\n\n**Note:** In order to achieve the best user experience, it is recommended that you keep the fixed items \"flat\" (do not pass sub-items)", "_ui5type": { "text": "Array<SideNavigationItemBase>", "references": [ { "name": "SideNavigationItemBase", "package": "@ui5/webcomponents-fiori", "module": "dist/SideNavigationItemBase.js" } ] }, "_ui5privacy": "public" }, { "name": "header", "description": "Defines the header of the `ui5-side-navigation`.\n\n**Note:** The header is displayed when the component is expanded - the property `collapsed` is false;", "_ui5since": "1.0.0-rc.11", "_ui5type": { "text": "Array<HTMLElement>" }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "accessibleName", "type": { "text": "string | undefined" }, "description": "Defines the accessible ARIA name of the component.", "default": "undefined", "privacy": "public", "_ui5since": "2.9.0" }, { "kind": "field", "name": "collapsed", "type": { "text": "boolean" }, "default": "false", "description": "Defines whether the `ui5-side-navigation` is expanded or collapsed.\n\n**Note:** On small screens (screen width of 599px or less) the collapsed mode is not supported, and in\nexpanded mode the side navigation will take the whole width of the screen.\nThe `ui5-side-navigation` component is intended to be used within a `ui5-navigation-layout`\ncomponent to ensure proper responsive behavior. If you choose not to use the\n`ui5-navigation-layout`, you will need to implement the appropriate responsive patterns yourself,\nparticularly for smaller screens where the collapsed mode should not be used.", "privacy": "public" } ], "events": [ { "name": "item-click", "_ui5privacy": "public", "type": { "text": "CustomEvent<SideNavigationItemClickEventDetail>", "references": [ { "name": "SideNavigationItemClickEventDetail", "package": "@ui5/webcomponents-fiori", "module": "dist/SideNavigation.js" } ] }, "description": "Fired when an item is clicked.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": true, "_ui5since": "2.20.0", "_ui5parameters": [ { "type": { "text": "SideNavigationSelectableItemBase", "references": [ { "name": "SideNavigationSelectableItemBase", "package": "@ui5/webcomponents-fiori", "module": "dist/SideNavigationSelectableItemBase.js" } ] }, "name": "item", "_ui5privacy": "public", "description": "The clicked item." } ] }, { "name": "selection-change", "_ui5privacy": "public", "type": { "text": "CustomEvent<SideNavigationSelectionChangeEventDetail>", "references": [ { "name": "SideNavigationSelectionChangeEventDetail", "package": "@ui5/webcomponents-fiori", "module": "dist/SideNavigation.js" } ] }, "description": "Fired when the selection has changed via user interaction.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": true, "_ui5parameters": [ { "type": { "text": "SideNavigationSelectableItemBase", "references": [ { "name": "SideNavigationSelectableItemBase", "package": "@ui5/webcomponents-fiori", "module": "dist/SideNavigationSelectableItemBase.js" } ] }, "name": "item", "_ui5privacy": "public", "description": "The selected item." } ] } ], "attributes": [ { "description": "Defines the accessible ARIA name of the component.", "name": "accessible-name", "default": "undefined", "fieldName": "accessibleName", "type": { "text": "string | undefined" } }, { "description": "Defines whether the `ui5-side-navigation` is expanded or collapsed.\n\n**Note:** On small screens (screen width of 599px or less) the collapsed mode is not supported, and in\nexpanded mode the side navigation will take the whole width of the screen.\nThe `ui5-side-navigation` component is intended to be used within a `ui5-navigation-layout`\ncomponent to ensure proper responsive behavior. If you choose not to use the\n`ui5-navigation-layout`, you will need to implement the appropriate responsive patterns yourself,\nparticularly for smaller screens where the collapsed mode should not be used.", "name": "collapsed", "default": "false", "fieldName": "collapsed", "type": { "text": "boolean" } } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-side-navigation", "customElement": true, "_ui5since": "1.0.0-rc.8", "_ui5privacy": "public" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "SideNavigation", "module": "dist/SideNavigation.js" } }, { "kind": "custom-element-definition", "name": "ui5-side-navigation", "declaration": { "name": "SideNavigation", "module": "dist/SideNavigation.js" } } ] }, { "kind": "javascript-module", "path": "dist/SideNavigationGroup.js", "declarations": [ { "kind": "class", "description": "### Overview\n\nRepresents a group of navigation actions within `ui5-side-navigation`.\nThe `ui5-side-navigation-group` can only be used inside a `ui5-side-navigation`.\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-fiori/dist/SideNavigationGroup.js\";`", "name": "SideNavigationGroup", "slots": [ { "name": "default", "description": "Defines nested items by passing `ui5-side-navigation-item` to the default slot.", "_ui5propertyName": "items", "_ui5type": { "text": "Array<SideNavigationItem>", "references": [ { "name": "SideNavigationItem", "package": "@ui5/webcomponents-fiori", "module": "dist/SideNavigationItem.js" } ] }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Defines whether the component is disabled.\nA disabled component can't be pressed or\nfocused, and it is not in the tab chain.", "privacy": "public", "_ui5since": "1.19.0" }, { "kind": "field", "name": "expanded", "type": { "text": "boolean" }, "default": "false", "description": "Defines if the item is expanded", "privacy": "public" }, { "kind": "field", "name": "text", "type": { "text": "string | undefined" }, "description": "Defines the text of the item.", "privacy": "public", "default": "undefined" }, { "kind": "field", "name": "tooltip", "type": { "text": "string | undefined" }, "description": "Defines the tooltip of the component.\n\nA tooltip attribute should be provided, in order to represent meaning/function,\nwhen the component is collapsed (\"icon only\" design is visualized) or the item text is truncated.", "default": "undefined", "privacy": "public", "_ui5since": "2.0.0" } ], "attributes": [ { "description": "Defines whether the component is disabled.\nA disabled component can't be pressed or\nfocused, and it is not in the tab chain.", "name": "disabled", "default": "false", "fieldName": "disabled", "type": { "text": "boolean" } }, { "description": "Defines if the item is expanded", "name": "expanded", "default": "false", "fieldName": "expanded", "type": { "text": "boolean" } }, { "description": "Defines the text of the item.", "name": "text", "default": "undefined", "fieldName": "text", "type": { "text": "string | undefined" } }, { "description": "Defines the tooltip of the component.\n\nA tooltip attribute should be provided, in order to represent meaning/function,\nwhen the component is collapsed (\"icon only\" design is visualized) or the item text is truncated.", "name": "tooltip", "default": "undefined", "fieldName": "tooltip", "type": { "text": "string | undefined" } } ], "superclass": { "name": "SideNavigationItemBase", "package": "@ui5/webcomponents-fiori", "module": "dist/SideNavigationItemBase.js" }, "tagName": "ui5-side-navigation-group", "customElement": true, "_ui5since": "1.24.0", "_ui5privacy": "public", "_ui5abstract": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "SideNavigationGroup", "module": "dist/SideNavigationGroup.js" } }, { "kind": "custom-element-definition", "name": "ui5-side-navigation-group", "declaration": { "name": "SideNavigationGroup", "module": "dist/SideNavigationGroup.js" } } ] }, { "kind": "javascript-module", "path": "dist/SideNavigationItem.js", "declarations": [ { "kind": "class", "description": "### Overview\n\nRepresents a navigation action. It can provide sub items.\nThe `ui5-side-navigation-item` is used within `ui5-side-navigation` or `ui5-side-navigation-group` only.\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-fiori/dist/SideNavigationItem.js\";`", "name": "SideNavigationItem", "slots": [ { "name": "default", "description": "Defines nested items by passing `ui5-side-navigation-sub-item` to the default slot.", "_ui5propertyName": "items", "_ui5type": { "text": "Array<SideNavigationSubItem>", "references": [ { "name": "SideNavigationSubItem", "package": "@ui5/webcomponents-fiori", "module": "dist/SideNavigationSubItem.js" } ] }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "accessibilityAttributes", "type": { "text": "SideNavigationItemAccessibilityAttributes", "references": [ { "name": "SideNavigationItemAccessibilityAttributes", "package": "@ui5/webcomponents-fiori", "module": "dist/SideNavigationSelectableItemBase.js" } ] }, "default": "{}", "description": "Defines the additional accessibility attributes that will be applied to the component.\nThe following fields are 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`.\n\n**Note:** Do not use it on parent items, as it will be overridden if the item is in the overflow menu.", "privacy": "public", "_ui5since": "2.7.0" }, { "kind": "field", "name": "design", "type": { "text": "SideNavigationItemDesign", "references": [ { "name": "SideNavigationItemDesign", "package": "@ui5/webcomponents-fiori", "module": "dist/types/SideNavigationItemDesign.js" } ] }, "default": "\"Default\"", "description": "Item design.\n\n**Note:** Items with \"Action\" design must not have sub-items.", "privacy": "public", "_ui5since": "2.7.0" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Defines whether the component is disabled.\nA disabled component can't be pressed or\nfocused, and it is not in the tab chain.", "privacy": "public", "_ui5since": "1.19.0" }, { "kind": "field", "name": "expanded", "type": { "text": "boolean" }, "default": "false", "description": "Defines if the item is expanded", "privacy": "public" }, { "kind": "field", "name": "href", "type": { "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": "undefined", "_ui5since": "1.19.0" }, { "kind": "field", "name": "icon", "type": { "text": "string | undefined" }, "description": "Defines the icon of the item.\n\n**Note:** Icons on second-level (child) navigation items are not recommended according to the design specification.\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": "undefined" }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Defines whether the item is selected.\n\n**Note:** Items that have a set `href` and `target` set to `_blank` should not be selectable.", "privacy": "public" }, { "kind": "field", "name": "target", "type": { "text": "string | undefined" }, "description": "Defines the component target.\n\nPossible values:\n\n- `_self`\n- `_top`\n- `_blank`\n- `_parent`\n- `framename`\n\n**Note:** Items that have a defined `href` and `target`\nattribute set to `_blank` should not be selectable.", "privacy": "public", "default": "undefined", "_ui5since": "1.19.0" }, { "kind": "field", "name": "text", "type": { "text": "string | undefined" }, "description": "Defines the text of the item.", "privacy": "public", "default": "undefined" }, { "kind": "field", "name": "tooltip", "type": { "text": "string | undefined" }, "description": "Defines the tooltip of the component.\n\nA tooltip attribute should be provided, in order to represent meaning/function,\nwhen the component is collapsed (\"icon only\" design is visualized) or the item text is truncated.", "default": "undefined", "privacy": "public", "_ui5since": "2.0.0" }, { "kind": "field", "name": "unselectable", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the navigation item is selectable. By default, all items are selectable unless specifically marked as unselectable.\n\nWhen a parent item is marked as unselectable, selecting it will only expand or collapse its sub-items.\nTo improve user experience do not mix unselectable parent items with selectable parent items in a single side navigation.\n\n\n**Guidelines**:\n- Items with an assigned `href` and a target of `_blank` should be marked as unselectable.\n- Items that trigger actions (with design \"Action\") should be marked as unselectable.", "privacy": "public", "_ui5since": "2.7.0" } ], "attributes": [ { "description": "Defines the additional accessibility attributes that will be applied to the component.\nThe following fields are 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`.\n\n**Note:** Do not use it on parent items, as it will be overridden if the item is in the overflow menu.", "name": "accessibility-attributes", "default": "{}", "fieldName": "accessibilityAttributes", "type": { "text": "SideNavigationItemAccessibilityAttributes" } }, { "description": "Item design.\n\n**Note:** Items with \"Action\" design must not have sub-items.", "name": "design", "default": "\"Default\"", "fieldName": "design", "type": { "text": "\"Default\" | \"Action\"" } }, { "description": "Defines whether the component is disabled.\nA disabled component can't be pressed or\nfocused, and it is not in the tab chain.", "name": "disabled", "default": "false", "fieldName": "disabled", "type": { "text": "boolean" } }, { "description": "Defines if the item is expanded", "name": "expanded", "default": "false", "fieldName": "expanded", "type": { "text": "boolean" } }, { "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": "undefined", "fieldName": "href", "type": { "text": "string | undefined" } }, { "description": "Defines the icon of the item.\n\n**Note:** Icons on second-level (child) navigation items are not recommended according to the design specification.\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": "undefined", "fieldName": "icon", "type": { "text": "string | undefined" } }, { "description": "Defines whether the item is selected.\n\n**Note:** Items that have a set `href` and `target` set to `_blank` should not be selectable.", "name": "selected", "default": "false", "fieldName": "selected", "type": { "text": "boolean" } }, { "description": "Defines the component target.\n\nPossible values:\n\n- `_self`\n- `_top`\n- `_blank`\n- `_parent`\n- `framename`\n\n**Note:** Items that have a defined `href` and `target`\nattribute set to `_blank` should not be selectable.", "name": "target", "default": "undefined", "fieldName": "target", "type": { "text": "string | undefined" } }, { "description": "Defines the text of the item.", "name": "text", "default": "undefined", "fieldName": "text", "type": { "text": "string | undefined" } }, { "description": "Defines the tooltip of the component.\n\nA tooltip attribute should be provided, in order to represent meaning/function,\nwhen the component is collapsed (\"icon only\" design is visualized) or the item text is truncated.", "name": "tooltip", "default": "undefined", "fieldName": "tooltip", "type": { "text": "string | undefined" } }, { "description": "Indicates whether the navigation item is selectable. By default, all items are selectable unless specifically marked as unselectable.\n\nWhen a parent item is marked as unselectable, selecting it will only expand or collapse its sub-items.\nTo improve user experience do not mix unselectable parent items with selectable parent items in a single side navigation.\n\n\n**Guidelines**:\n- Items with an assigned `href` and a target of `_blank` should be marked as unselectable.\n- Items that trigger actions (with design \"Action\") should be marked as unselectable.", "name": "unselectable", "default": "false", "fieldName": "unselectable", "type": { "text": "boolean" } } ], "superclass": { "name": "SideNavigationSelectableItemBase", "package": "@ui5/webcomponents-fiori", "module": "dist/SideNavigationSelectableItemBase.js" }, "tagName": "ui5-side-navigation-item", "customElement": true, "_ui5since": "1.0.0-rc.8", "_ui5privacy": "public", "_ui5abstract": true, "events": [ { "name": "click", "_ui5privacy": "public", "type": { "text": "CustomEvent<SideNavigationItemClickEventDetail>", "references": [ { "name": "SideNavigationItemClickEventDetail", "package": "@ui5/webcomponents-fiori", "module": "dist/SideNavigationItemBase.js" } ] }, "description": "Fired when the component is activated either with a click/tap or by using the [Enter] or [Space] keys.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": true, "_ui5parameters": [ { "type": { "text": "boolean" }, "name": "altKey", "_ui5privacy": "public", "description": "Returns whether the \"ALT\" key was pressed when the event was triggered." }, { "type": { "text": "boolean" }, "name": "ctrlKey", "_ui5privacy": "public", "description": "Returns whether the \"CTRL\" key was pressed when the event was triggered." }, { "type": { "text": "boolean" }, "name": "metaKey", "_ui5privacy": "public", "description": "Returns whether the \"META\" key was pressed when the event was triggered." }, { "type": { "text": "boolean" }, "name": "shiftKey", "_ui5privacy": "public", "description": "Returns whether the \"SHIFT\" key was pressed when the event was triggered." } ] } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "SideNavigationItem", "module": "dist/SideNavigationItem.js" } }, { "kind": "custom-element-definition", "name": "ui5-side-navigation-item", "declaration": { "name": "SideNavigationItem", "module": "dist/SideNavigationItem.js" } } ] }, { "kind": "javascript-module", "path": "dist/SideNavigationItemBase.js", "declarations": [ { "kind": "class", "description": "Base class for the items that are accepted by the `ui5-side-navigation` component.", "name": "SideNavigationItemBase", "members": [ { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Defines whether the component is disabled.\nA disabled component can't be pressed or\nfocused, and it is not in the tab chain.", "privacy": "public", "_ui5since": "1.19.0" }, { "kind": "field", "name": "text", "type": { "text": "string | undefined" }, "description": "Defines the text of the item.", "privacy": "public", "default": "undefined" }, { "kind": "field", "name": "tooltip", "type": { "text": "string | undefined" }, "description": "Defines the tooltip of the component.\n\nA tooltip attribute should be provided, in order to represent meaning/function,\nwhen the component is collapsed (\"icon only\" design is visualized) or the item text is truncated.", "default": "undefined", "privacy": "public", "_ui5since": "2.0.0" } ], "attributes": [ { "description": "Defines whether the component is disabled.\nA disabled component can't be pressed or\nfocused, and it is not in the tab chain.", "name": "disabled", "default": "false", "fieldName": "disabled", "type": { "text": "boolean" } }, { "description": "Defines the text of the item.", "name": "text", "default": "undefined", "fieldName": "text", "type": { "text": "string | undefined" } }, { "description": "Defines the tooltip of the component.\n\nA tooltip attribute should be provided, in order to represent meaning/function,\nwhen the component is collapsed (\"icon only\" design is visualized) or the item text is truncated.", "name": "tooltip", "default": "undefined", "fieldName": "tooltip", "type": { "text": "string | undefined" } } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "customElement": true, "_ui5since": "1.19.0", "_ui5privacy": "public", "_ui5abstract": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "SideNavigationItemBase", "module": "dist/SideNavigationItemBase.js" } } ] }, { "kind": "javascript-module", "path": "dist/SideNavigationSelectableItemBase.js", "declarations": [ { "kind": "class", "description": "Base class for the navigation items that support actions.", "name": "SideNavigationSelectableItemBase", "members": [ { "kind": "field", "name": "accessibilityAttributes", "type": { "text": "SideNavigationItemAccessibilityAttributes", "references": [ { "name": "SideNavigationItemAccessibilityAttributes", "package": "@ui5/webcomponents-fiori", "module": "dist/SideNavigationSelectableItemBase.js" } ] }, "default": "{}", "description": "Defines the additional accessibility attributes that will be applied to the component.\nThe following fields are 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`.\n\n**Note:** Do not use it on parent items, as it will be overridden if the item is in the overflow menu.", "privacy": "public", "_ui5since": "2.7.0" }, { "kind": "field", "name": "design", "type": { "text": "SideNavigationItemDesign", "references": [ { "name": "SideNavigationItemDesign", "package": "@ui5/webcomponents-fiori", "module": "dist/types/SideNavigationItemDesign.js" } ] }, "default": "\"Default\"", "description": "Item design.\n\n**Note:** Items with \"Action\" design must not have sub-items.", "privacy": "public", "_ui5since": "2.7.0" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Defines whether the component is disabled.\nA disabled component can't be pressed or\nfocused, and it is not in the tab chain.", "privacy": "public", "_ui5since": "1.19.0" }, { "kind": "field", "name": "href", "type": { "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": "undefined", "_ui5since": "1.19.0" }, { "kind": "field", "name": "icon", "type": { "text": "string | undefined" }, "description": "Defines the icon of the item.\n\n**Note:** Icons on second-level (child) navigation items are not recommended according to the design specification.\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": "undefined" }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Defines whether the item is selected.\n\n**Note:** Items that have a set `href` and `target` set to `_blank` should not be selectable.", "privacy": "public" }, { "kind": "field", "name": "target", "type": { "text": "string | undefined" }, "description": "Defines the component target.\n\nPossible values:\n\n- `_self`\n- `_top`\n- `_blank`\n- `_parent`\n- `framename`\n\n**Note:** Items that have a defined `href` and `target`\nattribute set to `_blank` should not be selectable.", "privacy": "public", "default": "undefined", "_ui5since": "1.19.0" }, { "kind": "field", "name": "text", "type": { "text": "string | undefined" }, "description": "Defines the text of the item.", "privacy": "public", "default": "undefined" }, { "kind": "field", "name": "tooltip", "type": { "text": "string | undefined" }, "description": "Defines the tooltip of the component.\n\nA tooltip attribute should be provided, in order to represent meaning/function,\nwhen the component is collapsed (\"icon only\" design is visualized) or the item text is truncated.", "default": "undefined", "privacy": "public", "_ui5since": "2.0.0" }, { "kind": "field", "name": "unselectable", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the navigation item is selectable. By default, all items are selectable unless specifically marked as unselectable.\n\nWhen a parent item is marked as unselectable, selecting it will only expand or collapse its sub-items.\nTo improve user experience do not mix unselectable parent items with selectable parent items in a single side navigation.\n\n\n**Guidelines**:\n- Items with an assigned `href` and a target of `_blank` should be marked as unselectable.\n- Items that trigger actions (with design \"Action\") should be marked as unselectable.", "privacy": "public", "_ui5since": "2.7.0" } ], "events": [ { "name": "click", "_ui5privacy": "public", "type": { "text": "CustomEvent<SideNavigationItemClickEventDetail>", "references": [ { "name": "SideNavigationItemClickEventDetail", "package": "@ui5/webcomponents-fiori", "module": "dist/SideNavigationItemBase.js" } ] }, "description": "Fired when the component is activated either with a click/tap or by using the [Enter] or [Space] keys.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": true, "_ui5parameters": [ { "type": { "text": "boolean" }, "name": "altKey", "_ui5privacy": "public", "description": "Returns whether the \"ALT\" key was pressed when the event was triggered." }, { "type": { "text": "boolean" }, "name": "ctrlKey", "_ui5privacy": "public", "description": "Returns whether the \"CTRL\" key was pressed when the event was triggered." }, { "type": { "text": "boolean" }, "name": "metaKey", "_ui5privacy": "public", "description": "Returns whether the \"META\" key was pressed when the event was triggered." }, { "type": { "text": "boolean" }, "name": "shiftKey", "_ui5privacy": "public", "description": "Returns whether the \"SHIFT\" key was pressed when the event was triggered." } ] } ], "attributes": [ { "description": "Defines the additional accessibility attributes that will be applied to the component.\nThe following fields are 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`.\n\n**Note:** Do not use it on parent items, as it will be overridden if the item is in the overflow menu.", "name": "accessibility-attributes", "default": "{}", "fieldName": "accessibilityAttributes", "type": { "text": "SideNavigationItemAccessibilityAttributes" } }, { "description": "Item design.\n\n**Note:** Items with \"Action\" design must not have sub-items.", "name": "design", "default": "\"Default\"", "fieldName": "design", "type": { "text": "\"Default\" | \"Action\"" } }, { "description": "Defines whether the component is disabled.\nA disabled component can't be pressed or\nfocused, and it is not in the tab chain.", "name": "disabled", "default": "false", "fieldName": "disabled", "type": { "text": "boolean" } }, { "description": "Defines the 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": "undefined", "fieldName": "href", "type": { "text": "string | undefined" } }, { "description": "Defines the icon of the item.\n\n**Note:** Icons on second-level (child) navigation items are not recommended according to the design specification.\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": "undefined", "fieldName": "icon", "type": { "text": "string | undefined" } }, { "description": "Defines whether the item is selected.\n\n**Note:** Items that have a set `href` and `target` set to `_blank` should not be selectable.", "name": "selected", "default": "false", "fieldName": "selected", "type": { "text": "boolean" } }, { "description": "Defines the component target.\n\nPossible values:\n\n- `_self`\n- `_top`\n- `_blank`\n- `_parent`\n- `framename`\n\n**Note:** Items that have a defined `href` and `target`\nattribute set to `_blank` should not be selectable.", "name": "target", "default": "undefined", "fieldName": "target", "type": { "text": "string | undefined" } }, { "description": "Defines the text of the item.", "name": "text", "default": "undefined", "fieldName": "text", "type": { "text": "string | undefined" } }, { "description": "Defines the tooltip of the component.\n\nA tooltip attribute should be provided, in order to represent meaning/function,\nwhen the component is collapsed (\"icon only\" design is visualized) or the item text is truncated.", "name": "tooltip", "default": "undefined", "fieldName": "tooltip", "type": { "text": "string | undefined" } }, { "description": "Indicates whether the navigation item is selectable. By default, all items are selectable unless specifically marked as unselectable.\n\nWhen a parent item is marked as unselectable, selecting it will only expand or collapse its sub-items.\nTo improve user experience do not mix unselectable parent items with selectable parent items in a single side navigation.\n\n\n**Guidelines**:\n- Items with an assigned `href` and a target of `_blank` should be marked as unselectable.\n- Items that trigger actions (with design \"Action\") should be marked as unselectable.", "name": "unselectable", "default": "false", "fieldName": "unselectable", "type": { "text": "boolean" } } ], "superclass": { "name": "SideNavigationItemBase", "package": "@ui5/webcomponents-fiori", "module": "dist/SideNavigationItemBase.js" }, "customElement": true, "_ui5since": "1.24.0", "_ui5privacy": "public", "_ui5abstract": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "SideNavigationSelectableItemBase", "module": "dist/SideNavigationSelectableItemBase.js" } } ] }, { "kind": "javascript-module", "path": "dist/SideNavigationSubItem.js", "declarations": [ { "kind": "class", "description": "### Overview\nRepresents a single navigation action within `ui5-side-navigation-item`.\nThe `ui5-side-navigation-sub-item` is intended to be used inside a `ui5-side-navigation-item` only.\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-fiori/dist/SideNavigationSubItem.js\";`", "name": "SideNavigationSubItem", "members": [ { "kind": "field", "name": "accessibilityAttributes", "type": { "text": "SideNavigationItemAccessibilityAttributes", "references": [ { "name": "SideNavigationItemAccessibilityAttributes", "package": "@ui5/webcomponents-fiori", "module": "dist/SideNavigationSelectableItemBase.js" } ] }, "default": "{}", "description": "Defines the additional accessibility attributes that will be applied to the component.\nThe following fields are 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`.\n\n**Note:** Do not use it on parent items, as it will be overridden if the item is in the overflow menu.", "privacy": "public", "_ui5since": "2.7.0" }, { "kind": "field", "name": "design", "type": { "text": "SideNavigationItemDesign", "references": [ { "name": "SideNavigationItemDesign", "package": "@ui5/webcomponents-fiori", "module": "dist/types/SideNavigationItemDesign.js" } ] }, "default": "\"Default\"", "description": "Item design.\n\n**Note:** Items with \"Action\" design must not have sub-items.", "privacy": "public", "_ui5since": "2.7.0" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Defines whether the component is disabled.\nA disabled component can't be pressed or\nfocused, and it is not in the tab chain.", "privacy": "public", "_ui5since": "1.19.0" }, { "kind": "field", "name": "href", "type": { "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": "undefined", "_ui5since": "1.19.0" }, { "kind": "field", "name": "icon", "type": { "text": "string | undefined" }, "description": "Defines the icon of the item.\n\n**Note:** Icons on second-level (child) navigation items are not recommended according to the design specification.\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": "undefined" }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Defines whether the item is selected.\n\n**Note:** Items that have a set `href` and `target` set to `_blank` should not be selectable.", "privacy": "public" }, { "kind": "field", "name": "target", "type": { "text": "string | undefined" }, "description": "Defines the component target.\n\nPossible values:\n\n- `_self`\n- `_top`\n- `_blank`\n- `_parent`\n- `framename`\n\n**Note:** Items that have a defined `href` and `target`\nattribute set to `_blank` should not be selectable.", "privacy": "public", "default": "undefined", "_ui5since": "1.19.0" }, { "kind": "field", "name": "text", "type": { "text": "string | undefined" }, "description": "Defines the text of the item.", "privacy": "public", "default": "undefined" }, { "kind": "field", "name": "tooltip", "type": { "text": "string | undefined" }, "description": "Defines the tooltip of the component.\n\nA tooltip attribute should be provided, in order to represent meaning/function,\nwhen the component is collapsed (\"icon only\" design is visualized) or the item text is truncated.", "default": "undefined", "privacy": "public", "_ui5since": "2.0.0" }, { "kind": "field", "name": "unselectable", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the navigation item is selectable. By default, all items are selectable unless specifically marked as unselectable.\n\nWhen a parent item is marked as unselectable, selecting it will only expand or collapse its sub-items.\nTo improve user experience do not mix unselectable parent items with selectable parent items in a single side navigation.\n\n\n**Guidelines**:\n- Items with an assigned `href` and a target of `_blank` should be marked as unselectable.\n- Items that trigger actions (with design \"Action\") should be marked as unselectable.", "privacy": "public", "_ui5since": "2.7.0" } ], "superclass": { "name": "SideNavigationSelectableItemBase", "package": "@ui5/webcomponents-fiori", "module": "dist/SideNavigationSelectableItemBase.js" }, "tagName": "ui5-side-navigation-sub-item", "customElement": true, "_ui5since": "1.0.0-rc.8", "_ui5privacy": "public", "_ui5abstract": true, "attributes": [ { "description": "Defines the additional accessibility attributes that will be applied to the component.\nThe following fields are 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`.\n\n**Note:** Do not use it on parent items, as it will be overridden if the item is in the overflow menu.", "name": "accessibility-attributes", "default": "{}", "fieldName": "accessibilityAttributes", "type": { "text": "SideNavigationItemAccessibilityAttributes" } }, { "description": "Item design.\n\n**Note:** Items with \"Action\" design must not have sub-items.", "name": "design", "default": "\"Default\"", "fieldName": "design", "type": { "text": "\"Default\" | \"Action\"" } }, { "description": "Defines whether the component is disabled.\nA disabled component can't be pressed or\nfocused, and it is not in the tab chain.", "name": "disabled", "default": "false", "fieldName": "disabled", "type": { "text": "boolean" } }, { "description": "Defines the 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": "undefined", "fieldName": "href", "type": { "text": "string | undefined" } }, { "description": "Defines the icon of the item.\n\n**Note:** Icons on second-level (child) navigation items are not recommended according to the design specification.\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": "undefined", "fieldName": "icon", "type": { "text": "string | undefined" } }, { "description": "Defines whether the item is selected.\n\n**Note:** Items that have a set `href` and `target` set to `_blank` should not be selectable.", "name": "selected", "default": "false", "fieldName": "selected", "type": { "text": "boolean" } }, { "description": "Defines the component target.\n\nPossible values:\n\n- `_self`\n- `_top`\n- `_blank`\n- `_parent`\n- `framename`\n\n**Note:** Items that have a defined `href` and `target`\nattribute set to `_blank` should not be selectable.", "name": "target", "default": "undefined", "fieldName": "target", "type": { "text": "string | undefined" } }, { "description": "Defines the text of the item.", "name": "text", "default": "undefined", "fieldName": "text", "type": { "text": "string | undefined" } }, { "description": "Defines the tooltip of the component.\n\nA tooltip attribute should be provided, in order to represent meaning/function,\nwhen the component is collapsed (\"icon only\" design is visualized) or the item text is truncated.", "name": "tooltip", "default": "undefined", "fieldName": "tooltip", "type": { "text": "string | undefined" } }, { "description": "Indicates whether the navigation item is selectable. By default, all items are selectable unless specifically marked as unselectable.\n\nWhen a parent item is marked as unselectable, selecting it will only expand or collapse its sub-items.\nTo improve user experience do not mix unselectable parent items with selectable parent items in a single side navigation.\n\n\n**Guidelines**:\n- Items with an assigned `href` and a target of `_blank` should be marked as unselectable.\n- Items that trigger actions (with design \"Action\") should be marked as unselectable.", "name": "unselectable", "default": "false", "fieldName": "unselectable", "type": { "text": "boolean" } } ], "events": [ { "name": "click", "_ui5privacy": "public", "type": { "text": "CustomEvent<SideNavigationItemClickEventDetail>", "references": [ { "name": "SideNavigationItemClickEventDetail", "package": "@ui5/webcomponents-fiori", "module": "dist/SideNavigationItemBase.js" } ] }, "description": "Fired when the component is activated either with a click/tap or by using the [Enter] or [Space] keys.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": true, "_ui5parameters": [ { "type": { "text": "boolean" }, "name": "altKey", "_ui5privacy": "public", "description": "Returns whether the \"ALT\" key was pressed when the event was triggered." }, { "type": { "text": "boolean" }, "name": "ctrlKey", "_ui5privacy": "public", "description": "Returns whether the \"CTRL\" key was pressed when the event was triggered." }, { "type": { "text": "boolean" }, "name": "metaKey", "_ui5privacy": "public", "description": "Returns whether the \"META\" key was pressed when the event was triggered." }, { "type": { "text": "boolean" }, "name": "shiftKey", "_ui5privacy": "public", "description": "Returns whether the \"SHIFT\" key was pressed when the event was triggered." } ] } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "SideNavigationSubItem", "module": "dist/SideNavigationSubItem.js" } }, { "kind": "custom-element-definition", "name": "ui5-side-navigation-sub-item", "declaration": { "name": "SideNavigationSubItem", "module": "dist/SideNavigationSubItem.js" } } ] }, { "kind": "javascript-module", "path": "dist/SortItem.js", "declarations": [ { "kind": "class", "description": "### Overview\n\nThe `ui5-sort-item` component defines the sorting criteria for data in `ui5-view-settings-dialog`.\nIt represents a single sort option that users can select to organize data in ascending or descending order.\n\n### Usage\n\nThe `ui5-sort-item` is used within the `ui5-view-settings-dialog` to provide sorting options.\nEach sort item represents a column or field by which data can be sorted.\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-fiori/dist/SortItem.js\";`", "name": "SortItem", "members": [ { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Defines if the sort item is selected.", "privacy": "public" }, { "kind": "field", "name": "text", "type": { "text": "string | undefined" }, "description": "Defines the text of the sort item.", "default": "undefined", "privacy": "public" } ], "attributes": [ { "description": "Defines if the sort item is selected.", "name": "selected", "default": "false", "fieldName": "selected", "type": { "text": "boolean" } }, { "description": "Defines the text of the sort item.", "name": "text", "default": "undefined", "fieldName": "text", "type": { "text": "string | undefined" } } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-sort-item", "customElement": true, "_ui5since": "1.0.0-rc.16", "_ui5privacy": "public", "_ui5abstract": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "SortItem", "module": "dist/SortItem.js" } }, { "kind": "custom-element-definition", "name": "ui5-sort-item", "declaration": { "name": "SortItem", "module": "dist/SortItem.js" } } ] }, { "kind": "javascript-module", "path": "dist/Timeline.js", "declarations": [ { "kind": "interface", "name": "ITimelineItem", "description": "Interface for components that may be slotted inside `ui5-timeline` as items", "_ui5privacy": "public" }, { "kind": "class", "description": "### Overview\n\nThe `ui5-timeline` component shows entries (such as objects, events, or posts) in chronological order.\nA common use case is to provide information about changes to an object, or events related to an object.\nThese entries can be generated by the system (for example, value XY changed from A to B), or added manually.\nThere are two distinct variants of the timeline: basic and social. The basic timeline is read-only,\nwhile the social timeline offers a high level of interaction and collaboration, and is integrated within SAP Jam.", "name": "Timeline", "slots": [ { "name": "default", "description": "Determines the content of the `ui5-timeline`.", "_ui5propertyName": "items", "_ui5type": { "text": "Array<ITimelineItem>", "references": [ { "name": "ITimelineItem", "package": "@ui5/webcomponents-fiori", "module": "dist/Timeline.js" } ] }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "accessibleName", "type": { "text": "string | undefined" }, "description": "Defines the accessible ARIA name of the component.", "default": "undefined", "privacy": "public", "_ui5since": "1.2.0" }, { "kind": "field", "name": "growing", "type": { "text": "TimelineGrowingMode", "references": [ { "name": "TimelineGrowingMode", "package": "@ui5/webcomponents-fiori", "module": "dist/types/TimelineGrowingMode.js" } ] }, "default": "\"None\"", "description": "Defines whether the Timeline will have growing capability either by pressing a \"More\" button,\nor via user scroll. In both cases a `load-more` event is fired.\n\nAvailable options:\n\n`Button` - Displays a button at the end of the Timeline, which when pressed triggers the `load-more` event.\n\n`Scroll` -Triggers the `load-more` event when the user scrolls to the end of the Timeline.\n\n`None` (default) - The growing functionality is off.", "privacy": "public", "_ui5since": "2.7.0" }, { "kind": "field", "name": "layout", "type": { "text": "TimelineLayout", "references": [ { "name": "TimelineLayout", "package": "@ui5/webcomponents-fiori", "module": "dist/types/TimelineLayout.js" } ] }, "default": "\"Vertical\"", "description": "Defines the items orientation.", "privacy": "public", "_ui5since": "1.0.0-rc.15" }, { "kind": "field", "name": "loading", "type": { "text": "boolean" }, "default": "false", "description": "Defines if the component should display a loading indicator over the Timeline.", "privacy": "public", "_ui5since": "2.7.0" }, { "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" } ], "events": [ { "name": "load-more", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the user presses the `More` button or scrolls to the Timeline's end.\n\n**Note:** The event will be fired if `growing` is set to `Button` or `Scroll`.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5since": "2.7.0" } ], "attributes": [ { "description": "Defines the accessible ARIA name of the component.", "name": "accessible-name", "default": "undefined", "fieldName": "accessibleName", "type": { "text": "string | undefined" } }, { "description": "Defines whether the Timeline will have growing capability either by pressing a \"More\" button,\nor via user scroll. In both cases a `load-more` event is fired.\n\nAvailable options:\n\n`Button` - Displays a button at the end of the Timeline, which when pressed triggers the `load-more` event.\n\n`Scroll` -Triggers the `load-more` event when the user scrolls to the end of the Timeline.\n\n`None` (default) - The growing functionality is off.", "name": "growing", "default": "\"None\"", "fieldName": "growing", "type": { "text": "\"Button\" | \"None\" | \"Scroll\"" } }, { "description": "Defines the items orientation.", "name": "layout", "default": "\"Vertical\"", "fieldName": "layout", "type": { "text": "\"Vertical\" | \"Horizontal\"" } }, { "description": "Defines if the component should display a loading indicator over the Timeline.", "name": "loading", "default": "false", "fieldName": "loading", "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": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-timeline", "customElement": true, "_ui5since": "0.8.0", "_ui5privacy": "public" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "Timeline", "module": "dist/Timeline.js" } }, { "kind": "custom-element-definition", "name": "ui5-timeline", "declaration": { "name": "Timeline", "module": "dist/Timeline.js" } } ] }, { "kind": "javascript-module", "path": "dist/TimelineGroupItem.js", "declarations": [ { "kind": "class", "description": "### Overview\n\nAn entry posted on the timeline.\nIt is intented to represent a group of `<ui5-timeline-item>`s.\n\n**Note**: Please do not use empty groups in order to preserve the intended design.", "name": "TimelineGroupItem", "slots": [ { "name": "default", "description": "Determines the content of the `ui5-timeline-group-item`.", "_ui5propertyName": "items", "_ui5type": { "text": "Array<ITimelineItem>", "references": [ { "name": "ITimelineItem", "package": "@ui5/webcomponents-fiori", "module": "dist/Timeline.js" } ] }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "collapsed", "type": { "text": "boolean" }, "default": "false", "description": "Determines if the group is collapsed or expanded.", "privacy": "public" }, { "kind": "field", "name": "groupName", "type": { "text": "string | undefined" }, "description": "Defines the text of the button that expands and collapses the group.", "default": "undefined", "privacy": "public" } ], "events": [ { "name": "toggle", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the group item is expanded or collapsed.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true } ], "attributes": [ { "description": "Determines if the group is collapsed or expanded.", "name": "collapsed", "default": "false", "fieldName": "collapsed", "type": { "text": "boolean" } }, { "description": "Defines the text of the button that expands and collapses the group.", "name": "group-name", "default": "undefined", "fieldName": "groupName", "type": { "text": "string | undefined" } } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-timeline-group-item", "customElement": true, "_ui5since": "2.1.0", "_ui5privacy": "public", "_ui5implements": [ { "name": "ITimelineItem", "package": "@ui5/webcomponents-fiori", "module": "dist/Timeline.js" } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "TimelineGroupItem", "module": "dist/TimelineGroupItem.js" } }, { "kind": "custom-element-definition", "name": "ui5-timeline-group-item", "declaration": { "name": "TimelineGroupItem", "module": "dist/TimelineGroupItem.js" } } ] }, { "kind": "javascript-module", "path": "dist/TimelineItem.js", "declarations": [ { "kind": "class", "description": "### Overview\n\nAn entry posted on the timeline.", "name": "TimelineItem", "slots": [ { "name": "default", "description": "Defines the content of the `ui5-timeline-item`.", "_ui5propertyName": "content", "_ui5type": { "text": "Array<Node>" }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "icon", "type": { "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": "undefined", "privacy": "public" }, { "kind": "field", "name": "name", "type": { "text": "string | undefined" }, "description": "Defines the name of the item, displayed before the `title-text`.", "default": "undefined", "privacy": "public" }, { "kind": "field", "name": "nameClickable", "type": { "text": "boolean" }, "default": "false", "description": "Defines if the `name` is clickable.", "privacy": "public" }, { "kind": "field", "name": "state", "type": { "text": "ValueState", "references": [ { "name": "ValueState", "package": "@ui5/webcomponents-base", "module": "dist/types/ValueState.js" } ] }, "default": "\"None\"", "description": "Defines the state of the icon displayed in the `ui5-timeline-item`.", "privacy": "public", "_ui5since": "2.7.0" }, { "kind": "field", "name": "subtitleText", "type": { "text": "string | undefined" }, "description": "Defines the subtitle text of the component.", "default": "undefined", "privacy": "public" }, { "kind": "field", "name": "titleText", "type": { "text": "string | undefined" }, "description": "Defines the title text of the component.", "default": "undefined", "privacy": "public" } ], "events": [ { "name": "name-click", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the item name is pressed either with a\nclick/tap or by using the Enter or Space key.\n\n**Note:** The event will not be fired if the `name-clickable`\nattribute is not set.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true } ], "attributes": [ { "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": "undefined", "fieldName": "icon", "type": { "text": "string | undefined" } }, { "description": "Defines the name of the item, displayed before the `title-text`.", "name": "name", "default": "undefined", "fieldName": "name", "type": { "text": "string | undefined" } }, { "description": "Defines if the `name` is clickable.", "name": "name-clickable", "default": "false", "fieldName": "nameClickable", "type": { "text": "boolean" } }, { "description": "Defines the state of the icon displayed in the `ui5-timeline-item`.", "name": "state", "default": "\"None\"", "fieldName": "state", "type": { "text": "\"None\" | \"Positive\" | \"Critical\" | \"Negative\" | \"Information\"" } }, { "description": "Defines the subtitle text of the component.", "name": "subtitle-text", "default": "undefined", "fieldName": "subtitleText", "type": { "text": "string | undefined" } }, { "description": "Defines the title text of the component.", "name": "title-text", "default": "undefined", "fieldName": "titleText", "type": { "text": "string | undefined" } } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-timeline-item", "customElement": true, "_ui5privacy": "public", "_ui5implements": [ { "name": "ITimelineItem", "package": "@ui5/webcomponents-fiori", "module": "dist/Timeline.js" } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "TimelineItem", "module": "dist/TimelineItem.js" } }, { "kind": "custom-element-definition", "name": "ui5-timeline-item", "declaration": { "name": "TimelineItem", "module": "dist/TimelineItem.js" } } ] }, { "kind": "javascript-module", "path": "dist/UploadCollection.js", "declarations": [ { "kind": "class", "description": "### Overview\nThis component allows you to represent files before uploading them to a server, with the help of `ui5-upload-collection-item`.\nIt also allows you to show already uploaded files.\n\n### ES6 Module Import\n`import \"@ui5/webcomponents-fiori/dist/UploadCollection.js\";`\n\n`import \"@ui5/webcomponents-fiori/dist/UploadCollectionItem.js\";` (for `ui5-upload-collection-item`)", "name": "UploadCollection", "slots": [ { "name": "default", "description": "Defines the items of the `ui5-upload-collection`.\n\n**Note:** Use `ui5-upload-collection-item` for the intended design.", "_ui5propertyName": "items", "_ui5type": { "text": "Array<UploadCollectionItem>", "references": [ { "name": "UploadCollectionItem", "package": "@ui5/webcomponents-fiori", "module": "dist/UploadCollectionItem.js" } ] }, "_ui5privacy": "public" }, { "name": "header", "description": "Defines the `ui5-upload-collection` header.\n\n**Note:** If `header` slot is provided,\nthe labelling of the `UploadCollection` is a responsibility of the application developer.\n`accessibleName` should be used.", "_ui5type": { "text": "Array<HTMLElement>" }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "accessibleName", "type": { "text": "string | undefined" }, "description": "Defines the accessible ARIA name of the component.", "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.16" }, { "kind": "field", "name": "hideDragOverlay", "type": { "text": "boolean" }, "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" }, { "kind": "field", "name": "noDataDescription", "type": { "text": "string | undefined" }, "description": "Allows you to set your own text for the 'No data' description.", "default": "undefined", "privacy": "public" }, { "kind": "field", "name": "noDataHeaderLevel", "type": { "text": "TitleLevel", "references": [ { "name": "TitleLevel", "package": "@ui5/webcomponents", "module": "dist/types/TitleLevel.js" } ] }, "default": "\"H2\"", "description": "Defines the header level of the 'No data' text.", "privacy": "public", "_ui5since": "2.16.0" }, { "kind": "field", "name": "noDataText", "type": { "text": "string | undefined" }, "description": "Allows you to set your own text for the 'No data' text.", "default": "undefined", "privacy": "public" }, { "kind": "field", "name": "selectionMode", "type": { "text": "UploadCollectionSelectionMode", "references": [ { "name": "UploadCollectionSelectionMode", "package": "@ui5/webcomponents-fiori", "module": "dist/types/UploadCollectionSelectionMode.js" } ] }, "default": "\"None\"", "description": "Defines the selection mode of the `ui5-upload-collection`.", "privacy": "public" } ], "events": [ { "name": "item-delete", "_ui5privacy": "public", "type": { "text": "CustomEvent<UploadCollectionItemDeleteEventDetail>", "references": [ { "name": "UploadCollectionItemDeleteEventDetail", "package": "@ui5/webcomponents-fiori", "module": "dist/UploadCollection.js" } ] }, "description": "Fired when an element is dropped inside the drag and drop overlay.\n\n**Note:** The `drop` event is fired only when elements are dropped within the drag and drop overlay and ignored for the other parts of the `ui5-upload-collection`.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5parameters": [ { "type": { "text": "DataTransfer" }, "name": "dataTransfer", "_ui5privacy": "public", "description": "The `drop` event operation data." } ] }, { "name": "selection-change", "_ui5privacy": "public", "type": { "text": "CustomEvent<UploadCollectionSelectionChangeEventDetail>", "references": [ { "name": "UploadCollectionSelectionChangeEventDetail", "package": "@ui5/webcomponents-fiori", "module": "dist/UploadCollection.js" } ] }, "description": "Fired when selection is changed by user interaction\nin `Single` and `Multiple` modes.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5parameters": [ { "type": { "text": "Array" }, "name": "selectedItems", "_ui5privacy": "public", "description": "An array of the selected items." } ] } ], "attributes": [ { "description": "Defines the accessible ARIA name of the component.", "name": "accessible-name", "default": "undefined", "fieldName": "accessibleName", "type": { "text": "string | undefined" } }, { "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.", "name": "hide-drag-overlay", "default": "false", "fieldName": "hideDragOverlay", "type": { "text": "boolean" } }, { "description": "Allows you to set your own text for the 'No data' description.", "name": "no-data-description", "default": "undefined", "fieldName": "noDataDescription", "type": { "text": "string | undefined" } }, { "description": "Defines the header level of the 'No data' text.", "name": "no-data-header-level", "default": "\"H2\"", "fieldName": "noDataHeaderLevel", "type": { "text": "\"H1\" | \"H2\" | \"H3\" | \"H4\" | \"H5\" | \"H6\"" } }, { "description": "Allows you to set your own text for the 'No data' text.", "name": "no-data-text", "default": "undefined", "fieldName": "noDataText", "type": { "text": "string | undefined" } }, { "description": "Defines the selection mode of the `ui5-upload-collection`.", "name": "selection-mode", "default": "\"None\"", "fieldName": "selectionMode", "type": { "text": "\"None\" | \"Single\" | \"SingleStart\" | \"SingleEnd\" | \"SingleAuto\" | \"Multiple\"" } } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-upload-collection", "customElement": true, "_ui5since": "1.0.0-rc.7", "_ui5privacy": "public" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "UploadCollection", "module": "dist/UploadCollection.js" } }, { "kind": "custom-element-definition", "name": "ui5-upload-collection", "declaration": { "name": "UploadCollection", "module": "dist/UploadCollection.js" } } ] }, { "kind": "javascript-module", "path": "dist/UploadCollectionItem.js", "declarations": [ { "kind": "class", "description": "### Overview\nA component to be used within the `ui5-upload-collection`.\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-fiori/dist/UploadCollectionItem.js\";`", "name": "UploadCollectionItem", "slots": [ { "description": "Hold the description of the `ui5-upload-collection-item`. Will be shown below the file name.", "name": "default", "_ui5privacy": "public", "_ui5type": { "text": "Array<Node>" } }, { "name": "thumbnail", "description": "A thumbnail, which will be shown in the beginning of the `ui5-upload-collection-item`.\n\n**Note:** Use `ui5-icon` or `img` for the intended design.", "_ui5type": { "text": "Array<HTMLElement>" }, "_ui5privacy": "public" }, { "name": "deleteButton", "description": "Defines the delete button, displayed in \"Delete\" mode.\n**Note:** While the slot allows custom buttons, to match\ndesign guidelines, please use the `ui5-button` component.\n**Note:** When the slot is not present, a built-in delete button will be displayed.", "_ui5since": "1.9.0", "_ui5type": { "text": "Array<IButton>", "references": [ { "name": "IButton", "package": "@ui5/webcomponents", "module": "dist/Button.js" } ] }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "disableDeleteButton", "type": { "text": "boolean" }, "default": "false", "description": "Disables the delete button.", "privacy": "public" }, { "kind": "field", "name": "file", "type": { "text": "File | null" }, "default": "null", "description": "Holds an instance of `File` associated with this item.", "privacy": "public", "_ui5noAttribute": true }, { "kind": "field", "name": "fileName", "type": { "text": "string" }, "default": "\"\"", "description": "The name of the file.", "privacy": "public" }, { "kind": "field", "name": "fileNameClickable", "type": { "text": "boolean" }, "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" }, { "kind": "field", "name": "hideDeleteButton", "type": { "text": "boolean" }, "default": "false", "description": "Hides the delete button.", "privacy": "public" }, { "kind": "field", "name": "hideRetryButton", "type": { "text": "boolean" }, "default": "false", "description": "Hides the retry button when `uploadState` property is `Error`.", "privacy": "public" }, { "kind": "field", "name": "hideTerminateButton", "type": { "text": "boolean" }, "default": "false", "description": "Hides the terminate button when `uploadState` property is `Uploading`.", "privacy": "public" }, { "kind": "field", "name": "progress", "type": { "text": "number" }, "default": "0", "description": "The upload progress in percentage.\n\n**Note:** Expected values are in the interval [0, 100].", "privacy": "public" }, { "kind": "field", "name": "uploadState", "type": { "text": "UploadState", "references": [ { "name": "UploadState", "package": "@ui5/webcomponents-fiori", "module": "dist/types/UploadState.js" } ] }, "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" }, { "kind": "field", "name": "accessibilityAttributes", "type": { "text": "ListItemAccessibilityAttributes", "references": [ { "name": "ListItemAccessibilityAttributes", "package": "@ui5/webcomponents", "module": "dist/ListItem.js" } ] }, "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" }, { "kind": "field", "name": "highlight", "type": { "text": "Highlight", "references": [ { "name": "Highlight", "package": "@ui5/webcomponents", "module": "dist/types/Highlight.js" } ] }, "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" }, { "kind": "field", "name": "navigated", "type": { "text": "boolean" }, "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" }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Defines the selected state of the component.", "privacy": "public" }, { "kind": "field", "name": "tooltip", "type": { "text": "string | undefined" }, "description": "Defines the text of the tooltip that would be displayed for the list item.", "default": "undefined", "privacy": "public", "_ui5since": "1.23.0" }, { "kind": "field", "name": "type", "type": { "text": "ListItemType", "references": [ { "name": "ListItemType", "package": "@ui5/webcomponents", "module": "dist/types/ListItemType.js" } ] }, "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" } ], "events": [ { "name": "file-name-click", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the file name is clicked.\n\n**Note:** This event is only available when `fileNameClickable` property is `true`.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true }, { "name": "rename", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the `fileName` property gets changed.\n\n**Note:** An edit button is displayed on each item,\nwhen the `ui5-upload-collection-item` `type` property is set to `Detail`.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true }, { "name": "retry", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the retry button is pressed.\n\n**Note:** Retry button is displayed when `uploadState` property is set to `Error`.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true }, { "name": "terminate", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the terminate button is pressed.\n\n**Note:** Terminate button is displayed when `uploadState` property is set to `Uploading`.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true }, { "name": "detail-click", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the user clicks on the detail button when type is `Detail`.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true } ], "attributes": [ { "description": "Disables the delete button.", "name": "disable-delete-button", "default": "false", "fieldName": "disableDeleteButton", "type": { "text": "boolean" } }, { "description": "Holds an instance of `File` associated with this item.", "name": "file", "default": "null", "fieldName": "file", "type": { "text": "File | null" } }, { "description": "The name of the file.", "name": "file-name", "default": "\"\"", "fieldName": "fileName", "type": { "text": "string" } }, { "description": "If set to `true` the file name will be clickable and it will fire `file-name-click` event upon click.", "name": "file-name-clickable", "default": "false", "fieldName": "fileNameClickable", "type": { "text": "boolean" } }, { "description": "Hides the delete button.", "name": "hide-delete-button", "default": "false", "fieldName": "hideDeleteButton", "type": { "text": "boolean" } }, { "description": "Hides the retry button when `uploadState` property is `Error`.", "name": "hide-retry-button", "default": "false", "fieldName": "hideRetryButton", "type": { "text": "boolean" } }, { "description": "Hides the terminate button when `uploadState` property is `Uploading`.", "name": "hide-terminate-button", "default": "false", "fieldName": "hideTerminateButton", "type": { "text": "boolean" } }, { "description": "The upload progress in percentage.\n\n**Note:** Expected values are in the interval [0, 100].", "name": "progress", "default": "0", "fieldName": "progress", "type": { "text": "number" } }, { "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.", "name": "upload-state", "default": "\"Ready\"", "fieldName": "uploadState", "type": { "text": "\"Complete\" | \"Error\" | \"Ready\" | \"Uploading\"" } }, { "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.", "name": "accessibility-attributes", "default": "{}", "fieldName": "accessibilityAttributes", "type": { "text": "ListItemAccessibilityAttributes" } }, { "description": "Defines the highlight state of the list items.\nAvailable options are: `\"None\"` (by default), `\"Positive\"`, `\"Critical\"`, `\"Information\"` and `\"Negative\"`.", "name": "highlight", "default": "\"None\"", "fieldName": "highlight", "type": { "text": "\"None\" | \"Positive\" | \"Critical\" | \"Negative\" | \"Information\"" } }, { "description": "The navigated state of the list item.\nIf set to `true`, a navigation indicator is displayed at the end of the list item.", "name": "navigated", "default": "false", "fieldName": "navigated", "type": { "text": "boolean" } }, { "description": "Defines the selected state of the component.", "name": "selected", "default": "false", "fieldName": "selected", "type": { "text": "boolean" } }, { "description": "Defines the text of the tooltip that would be displayed for the list item.", "name": "tooltip", "default": "undefined", "fieldName": "tooltip", "type": { "text": "string | undefined" } }, { "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.", "name": "type", "default": "\"Active\"", "fieldName": "type", "type": { "text": "\"Navigation\" | \"Inactive\" | \"Active\" | \"Detail\"" } } ], "superclass": { "name": "ListItem", "package": "@ui5/webcomponents", "module": "dist/ListItem.js" }, "tagName": "ui5-upload-collection-item", "customElement": true, "_ui5since": "1.0.0-rc.7", "_ui5privacy": "public" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "UploadCollectionItem", "module": "dist/UploadCollectionItem.js" } }, { "kind": "custom-element-definition", "name": "ui5-upload-collection-item", "declaration": { "name": "UploadCollectionItem", "module": "dist/UploadCollectionItem.js" } } ] }, { "kind": "javascript-module", "path": "dist/UserMenu.js", "declarations": [ { "kind": "class", "description": "### Overview\n\nThe `ui5-user-menu` is an SAP Fiori specific web component that is used in `ui5-shellbar`\nand allows the user to easily see information and settings for the current user and all other logged in accounts.\n\n### ES6 Module Import\n`import \"@ui5/webcomponents-fiori/dist/UserMenu.js\";`\n\n`import \"@ui5/webcomponents-fiori/dist/UserMenuItem.js\";` (for `ui5-user-menu-item`)", "name": "UserMenu", "slots": [ { "name": "accounts", "description": "Defines the user accounts.\n\n**Note:** If one item is used, it will be shown as the selected one. If more than one item is used, the first one will be shown as selected unless\nthere is an item with `selected` property set to `true`.", "_ui5type": { "text": "Array<UserMenuAccount>", "references": [ { "name": "UserMenuAccount", "package": "@ui5/webcomponents-fiori", "module": "dist/UserMenuAccount.js" } ] }, "_ui5privacy": "public" }, { "name": "default", "description": "Defines the menu items.", "_ui5propertyName": "menuItems", "_ui5type": { "text": "Array<UserMenuItem>", "references": [ { "name": "UserMenuItem", "package": "@ui5/webcomponents-fiori", "module": "dist/UserMenuItem.js" } ] }, "_ui5privacy": "public" }, { "name": "footer", "description": "Defines custom footer content.\n\n**Note:** When provided, replaces the default \"Sign Out\" button. Use an empty element to hide the footer completely.", "_ui5since": "2.20.0", "_ui5type": { "text": "Array<HTMLElement>" }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Defines if the User Menu is opened.", "privacy": "public" }, { "kind": "field", "name": "opener", "type": { "text": "HTMLElement | string | null | undefined" }, "description": "Defines the ID or DOM Reference of the element at which the user 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": "undefined" }, { "kind": "field", "name": "showEditAccounts", "type": { "text": "boolean" }, "default": "false", "description": "Defines if the User Menu shows the Edit Accounts option.", "privacy": "public" }, { "kind": "field", "name": "showEditButton", "type": { "text": "boolean" }, "default": "false", "description": "Defines if the User menu shows edit button.", "privacy": "public", "_ui5since": "2.7.0" }, { "kind": "field", "name": "showManageAccount", "type": { "text": "boolean" }, "default": "false", "description": "Defines if the User Menu shows the Manage Account option.", "privacy": "public" }, { "kind": "field", "name": "showOtherAccounts", "type": { "text": "boolean" }, "default": "false", "description": "Defines if the User Menu shows the Other Accounts option.", "privacy": "public" } ], "events": [ { "name": "avatar-click", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the account avatar is selected.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": false }, { "name": "change-account", "_ui5privacy": "public", "type": { "text": "CustomEvent<UserMenuOtherAccountClickEventDetail>", "references": [ { "name": "UserMenuOtherAccountClickEventDetail", "package": "@ui5/webcomponents-fiori", "module": "dist/UserMenu.js" } ] }, "description": "Fired when the account is switched to a different one.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": false, "_ui5parameters": [ { "type": { "text": "UserMenuAccount", "references": [ { "name": "UserMenuAccount", "package": "@ui5/webcomponents-fiori", "module": "dist/UserMenuAccount.js" } ] }, "name": "prevSelectedAccount", "_ui5privacy": "public", "description": "The previously selected account." }, { "type": { "text": "UserMenuAccount", "references": [ { "name": "UserMenuAccount", "package": "@ui5/webcomponents-fiori", "module": "dist/UserMenuAccount.js" } ] }, "name": "selectedAccount", "_ui5privacy": "public", "description": "The selected account." } ] }, { "name": "close", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when a user menu is close.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": false, "_ui5since": "2.6.0" }, { "name": "edit-accounts-click", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the \"Edit Accounts\" button is selected.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": false }, { "name": "item-click", "_ui5privacy": "public", "type": { "text": "CustomEvent<UserMenuItemClickEventDetail>", "references": [ { "name": "UserMenuItemClickEventDetail", "package": "@ui5/webcomponents-fiori", "module": "dist/UserMenu.js" } ] }, "description": "Fired when a menu item is selected.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": false, "_ui5parameters": [ { "type": { "text": "UserMenuItem", "references": [ { "name": "UserMenuItem", "package": "@ui5/webcomponents-fiori", "module": "dist/UserMenuItem.js" } ] }, "name": "item", "_ui5privacy": "public", "description": "The selected `user menu item`." } ] }, { "name": "manage-account-click", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the \"Manage Account\" button is selected.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": false }, { "name": "open", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when a user menu is open.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": false, "_ui5since": "2.6.0" }, { "name": "sign-out-click", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the \"Sign Out\" button is selected.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": false, "_ui5since": "2.6.0" } ], "attributes": [ { "description": "Defines if the User Menu is opened.", "name": "open", "default": "false", "fieldName": "open", "type": { "text": "boolean" } }, { "description": "Defines the ID or DOM Reference of the element at which the user 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": "undefined", "fieldName": "opener", "type": { "text": "string | HTMLElement | null | undefined" } }, { "description": "Defines if the User Menu shows the Edit Accounts option.", "name": "show-edit-accounts", "default": "false", "fieldName": "showEditAccounts", "type": { "text": "boolean" } }, { "description": "Defines if the User menu shows edit button.", "name": "show-edit-button", "default": "false", "fieldName": "showEditButton", "type": { "text": "boolean" } }, { "description": "Defines if the User Menu shows the Manage Account option.", "name": "show-manage-account", "default": "false", "fieldName": "showManageAccount", "type": { "text": "boolean" } }, { "description": "Defines if the User Menu shows the Other Accounts option.", "name": "show-other-accounts", "default": "false", "fieldName": "showOtherAccounts", "type": { "text": "boolean" } } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-user-menu", "customElement": true, "_ui5since": "2.5.0", "_ui5privacy": "public" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "UserMenu", "module": "dist/UserMenu.js" } }, { "kind": "custom-element-definition", "name": "ui5-user-menu", "declaration": { "name": "UserMenu", "module": "dist/UserMenu.js" } } ] }, { "kind": "javascript-module", "path": "dist/UserMenuAccount.js", "declarations": [ { "kind": "class", "description": "### Overview\n\nThe `ui5-user-menu-account` represents an account in the `ui5-user-menu`.\n\n### ES6 Module Import\n`import \"@ui5/webcomponents-fiori/dist/UserMenuAccount.js\";`", "name": "UserMenuAccount", "members": [ { "kind": "field", "name": "additionalInfo", "type": { "text": "string" }, "default": "\"\"", "description": "Defines additional information for the user.", "privacy": "public" }, { "kind": "field", "name": "avatarColorScheme", "type": { "text": "AvatarColorScheme", "references": [ { "name": "AvatarColorScheme", "package": "@ui5/webcomponents", "module": "dist/types/AvatarColorScheme.js" } ] }, "default": "\"Auto\"", "description": "Defines the background color of the desired image.\nIf `avatarColorScheme` is set to `Auto`, the avatar will be displayed with the `Accent6` color.", "privacy": "public" }, { "kind": "field", "name": "avatarInitials", "type": { "text": "string | undefined" }, "description": "Defines the avatar initials of the user.", "default": "undefined", "privacy": "public" }, { "kind": "field", "name": "avatarSrc", "type": { "text": "string | undefined" }, "description": "Defines the avatar image url of the user.", "default": "\"\"", "privacy": "public" }, { "kind": "field", "name": "description", "type": { "text": "string" }, "default": "\"\"", "description": "Defines description of the user.", "privacy": "public" }, { "kind": "field", "name": "loading", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether a loading indicator should be shown.", "privacy": "public", "_ui5since": "2.9.0" }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Defines if the user is selected.", "privacy": "public" }, { "kind": "field", "name": "subtitleText", "type": { "text": "string" }, "default": "\"\"", "description": "Defines additional text of the user.", "privacy": "public" }, { "kind": "field", "name": "titleText", "type": { "text": "string" }, "default": "\"\"", "description": "Defines the title text of the user.", "privacy": "public" } ], "attributes": [ { "description": "Defines additional information for the user.", "name": "additional-info", "default": "\"\"", "fieldName": "additionalInfo", "type": { "text": "string" } }, { "description": "Defines the background color of the desired image.\nIf `avatarColorScheme` is set to `Auto`, the avatar will be displayed with the `Accent6` color.", "name": "avatar-color-scheme", "default": "\"Auto\"", "fieldName": "avatarColorScheme", "type": { "text": "\"Auto\" | \"Transparent\" | \"Accent1\" | \"Accent2\" | \"Accent3\" | \"Accent4\" | \"Accent5\" | \"Accent6\" | \"Accent7\" | \"Accent8\" | \"Accent9\" | \"Accent10\" | \"Placeholder\"" } }, { "description": "Defines the avatar initials of the user.", "name": "avatar-initials", "default": "undefined", "fieldName": "avatarInitials", "type": { "text": "string | undefined" } }, { "description": "Defines the avatar image url of the user.", "name": "avatar-src", "default": "\"\"", "fieldName": "avatarSrc", "type": { "text": "string | undefined" } }, { "description": "Defines description of the user.", "name": "description", "default": "\"\"", "fieldName": "description", "type": { "text": "string" } }, { "description": "Indicates whether a loading indicator should be shown.", "name": "loading", "default": "false", "fieldName": "loading", "type": { "text": "boolean" } }, { "description": "Defines if the user is selected.", "name": "selected", "default": "false", "fieldName": "selected", "type": { "text": "boolean" } }, { "description": "Defines additional text of the user.", "name": "subtitle-text", "default": "\"\"", "fieldName": "subtitleText", "type": { "text": "string" } }, { "description": "Defines the title text of the user.", "name": "title-text", "default": "\"\"", "fieldName": "titleText", "type": { "text": "string" } } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-user-menu-account", "customElement": true, "_ui5since": "2.5.0", "_ui5privacy": "public" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "UserMenuAccount", "module": "dist/UserMenuAccount.js" } }, { "kind": "custom-element-definition", "name": "ui5-user-menu-account", "declaration": { "name": "UserMenuAccount", "module": "dist/UserMenuAccount.js" } } ] }, { "kind": "javascript-module", "path": "dist/UserMenuItem.js", "declarations": [ { "kind": "class", "description": "### Overview\n\n`ui5-user-menu-item` is the item to use inside a `ui5-user-menu`.\nAn arbitrary hierarchy structure can be represented by recursively nesting menu items.\n\n### Usage\n\n`ui5-user-menu-item` represents a node in a `ui5-user-menu`. The user menu itself is rendered as a list,\nand each `ui5-menu-item` is represented by a menu item in that menu. Therefore, you should only use\n`ui5-user-menu-item` directly in your apps. The `ui5-menu` menu item is internal for the menu, and not intended for public use.\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-fiori/dist/UserMenuItem.js\";`", "name": "UserMenuItem", "slots": [ { "name": "default", "description": "Defines the items of this component.\n\n**Note:** Use `ui5-user-menu-item` for the intended design.", "_ui5propertyName": "items", "_ui5type": { "text": "Array<UserMenuItem>", "references": [ { "name": "UserMenuItem", "package": "@ui5/webcomponents-fiori", "module": "dist/UserMenuItem.js" } ] }, "_ui5privacy": "public" }, { "name": "deleteButton", "description": "Defines the delete button, displayed in \"Delete\" mode.\n**Note:** While the slot allows custom buttons, to match\ndesign guidelines, please use the `ui5-button` component.\n**Note:** When the slot is not present, a built-in delete button will be displayed.", "_ui5since": "1.9.0", "_ui5type": { "text": "Array<IButton>", "references": [ { "name": "IButton", "package": "@ui5/webcomponents", "module": "dist/Button.js" } ] }, "_ui5privacy": "public" }, { "name": "endContent", "description": "Defines the components that should be displayed at the end of the menu item.\n\n**Note:** It is highly recommended to slot only components of type `ui5-button`,`ui5-link`\nor `ui5-icon` in order to preserve the intended design. If there are components added to this slot,\nand there is text set in `additionalText`, it will not be displayed. If there are items added to `items` slot,\nnether `additionalText` nor components added to this slot would 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`.\n\nApplication developers are responsible for ensuring that interactive elements placed in the `endContent` slot\nhave the correct accessibility behaviour, including their enabled or disabled states.\nThe menu does not manage these aspects when the menu item state changes.", "_ui5since": "2.0.0", "_ui5type": { "text": "Array<HTMLElement>" }, "_ui5privacy": "public" } ], "superclass": { "name": "MenuItem", "package": "@ui5/webcomponents", "module": "dist/MenuItem.js" }, "tagName": "ui5-user-menu-item", "customElement": true, "_ui5since": "2.5.0", "_ui5privacy": "public", "members": [ { "kind": "field", "name": "accessibilityAttributes", "type": { "text": "MenuItemAccessibilityAttributes", "references": [ { "name": "MenuItemAccessibilityAttributes", "package": "@ui5/webcomponents", "module": "dist/MenuItem.js" } ] }, "default": "{}", "description": "Defines the additional accessibility attributes that will be applied to the component.\nThe following fields are supported:\n\n- **ariaKeyShortcuts**: Indicated the availability of a keyboard shortcuts defined for the menu item.\n\n- **role**: Defines the role of the menu item. If not set, menu item will have default role=\"menuitem\".", "privacy": "public", "_ui5since": "2.1.0" }, { "kind": "field", "name": "accessibleName", "type": { "text": "string | undefined" }, "description": "Defines the accessible ARIA name of the component.", "default": "undefined", "privacy": "public", "_ui5since": "1.7.0" }, { "kind": "field", "name": "additionalText", "type": { "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": "undefined", "privacy": "public", "_ui5since": "1.8.0" }, { "kind": "field", "name": "checked", "type": { "text": "boolean" }, "default": "false", "description": "Defines whether menu item is in checked state.\n\n**Note:** checked state is only taken into account when menu item is added to menu item group\nwith `checkMode` other than `None`.\n\n**Note:** A checked menu item has a checkmark displayed at its end.", "privacy": "public", "_ui5since": "2.12.0" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Defines whether menu item is in disabled state.\n\n**Note:** A disabled menu item is noninteractive.", "privacy": "public" }, { "kind": "field", "name": "highlight", "type": { "text": "Highlight", "references": [ { "name": "Highlight", "package": "@ui5/webcomponents", "module": "dist/types/Highlight.js" } ] }, "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" }, { "kind": "field", "name": "icon", "type": { "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": "undefined", "privacy": "public" }, { "kind": "field", "name": "loading", "type": { "text": "boolean" }, "default": "false", "description": "Defines the delay in milliseconds, after which the loading indicator will be displayed inside the corresponding menu popover.\n\n**Note:** If set to `true` a busy indicator component will be displayed into the related one to the current menu item sub-menu popover.", "privacy": "public", "_ui5since": "1.13.0" }, { "kind": "field", "name": "loadingDelay", "type": { "text": "number" }, "default": "1000", "description": "Defines the delay in milliseconds, after which the loading indicator will be displayed inside the corresponding menu popover.", "privacy": "public", "_ui5since": "1.13.0" }, { "kind": "field", "name": "navigated", "type": { "text": "boolean" }, "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" }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Defines the selected state of the component.", "privacy": "public" }, { "kind": "field", "name": "text", "type": { "text": "string | undefined" }, "description": "Defines the text of the tree item.", "default": "undefined", "privacy": "public" }, { "kind": "field", "name": "tooltip", "type": { "text": "string | undefined" }, "description": "Defines the text of the tooltip for the menu item.", "default": "undefined", "privacy": "public", "_ui5since": "1.23.0" }, { "kind": "field", "name": "type", "type": { "text": "ListItemType", "references": [ { "name": "ListItemType", "package": "@ui5/webcomponents", "module": "dist/types/ListItemType.js" } ] }, "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" } ], "events": [ { "name": "before-close", "_ui5privacy": "public", "type": { "text": "CustomEvent<MenuBeforeCloseEventDetail>", "references": [ { "name": "MenuBeforeCloseEventDetail", "package": "@ui5/webcomponents", "module": "dist/MenuItem.js" } ] }, "description": "Fired before the menu is closed. This event can be cancelled, which will prevent the menu from closing.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": false, "_ui5since": "1.10.0", "_ui5parameters": [ { "type": { "text": "boolean" }, "name": "escPressed", "_ui5privacy": "public", "description": "Indicates that `ESC` key has triggered the event." } ] }, { "name": "before-open", "_ui5privacy": "public", "type": { "text": "CustomEvent<MenuBeforeOpenEventDetail>", "references": [ { "name": "MenuBeforeOpenEventDetail", "package": "@ui5/webcomponents", "module": "dist/MenuItem.js" } ] }, "description": "Fired before the menu is opened. This event can be cancelled, which will prevent the menu from opening.\n\n**Note:** Since 1.14.0 the event is also fired before a sub-menu opens.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": false, "_ui5since": "1.10.0", "_ui5parameters": [ { "type": { "text": "HTMLElement" }, "name": "item", "_ui5privacy": "public", "description": "The menu item that triggers opening of the sub-menu or undefined when fired upon root menu opening." } ] }, { "name": "check", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when an item is checked or unchecked.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5since": "2.12.0" }, { "name": "close", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired after the menu is closed.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": false, "_ui5since": "1.10.0" }, { "name": "detail-click", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the user clicks on the detail button when type is `Detail`.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true }, { "name": "open", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired after the menu is opened.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": false } ], "attributes": [ { "description": "Defines the additional accessibility attributes that will be applied to the component.\nThe following fields are supported:\n\n- **ariaKeyShortcuts**: Indicated the availability of a keyboard shortcuts defined for the menu item.\n\n- **role**: Defines the role of the menu item. If not set, menu item will have default role=\"menuitem\".", "name": "accessibility-attributes", "default": "{}", "fieldName": "accessibilityAttributes", "type": { "text": "MenuItemAccessibilityAttributes" } }, { "description": "Defines the accessible ARIA name of the component.", "name": "accessible-name", "default": "undefined", "fieldName": "accessibleName", "type": { "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": "undefined", "fieldName": "additionalText", "type": { "text": "string | undefined" } }, { "description": "Defines whether menu item is in checked state.\n\n**Note:** checked state is only taken into account when menu item is added to menu item group\nwith `checkMode` other than `None`.\n\n**Note:** A checked menu item has a checkmark displayed at its end.", "name": "checked", "default": "false", "fieldName": "checked", "type": { "text": "boolean" } }, { "description": "Defines whether menu item is in disabled state.\n\n**Note:** A disabled menu item is noninteractive.", "name": "disabled", "default": "false", "fieldName": "disabled", "type": { "text": "boolean" } }, { "description": "Defines the highlight state of the list items.\nAvailable options are: `\"None\"` (by default), `\"Positive\"`, `\"Critical\"`, `\"Information\"` and `\"Negative\"`.", "name": "highlight", "default": "\"None\"", "fieldName": "highlight", "type": { "text": "\"None\" | \"Positive\" | \"Critical\" | \"Negative\" | \"Information\"" } }, { "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": "undefined", "fieldName": "icon", "type": { "text": "string | undefined" } }, { "description": "Defines the delay in milliseconds, after which the loading indicator will be displayed inside the corresponding menu popover.\n\n**Note:** If set to `true` a busy indicator component will be displayed into the related one to the current menu item sub-menu popover.", "name": "loading", "default": "false", "fieldName": "loading", "type": { "text": "boolean" } }, { "description": "Defines the delay in milliseconds, after which the loading indicator will be displayed inside the corresponding menu popover.", "name": "loading-delay", "default": "1000", "fieldName": "loadingDelay", "type": { "text": "number" } }, { "description": "The navigated state of the list item.\nIf set to `true`, a navigation indicator is displayed at the end of the list item.", "name": "navigated", "default": "false", "fieldName": "navigated", "type": { "text": "boolean" } }, { "description": "Defines the selected state of the component.", "name": "selected", "default": "false", "fieldName": "selected", "type": { "text": "boolean" } }, { "description": "Defines the text of the tree item.", "name": "text", "default": "undefined", "fieldName": "text", "type": { "text": "string | undefined" } }, { "description": "Defines the text of the tooltip for the menu item.", "name": "tooltip", "default": "undefined", "fieldName": "tooltip", "type": { "text": "string | undefined" } }, { "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.", "name": "type", "default": "\"Active\"", "fieldName": "type", "type": { "text": "\"Navigation\" | \"Inactive\" | \"Active\" | \"Detail\"" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "UserMenuItem", "module": "dist/UserMenuItem.js" } }, { "kind": "custom-element-definition", "name": "ui5-user-menu-item", "declaration": { "name": "UserMenuItem", "module": "dist/UserMenuItem.js" } } ] }, { "kind": "javascript-module", "path": "dist/UserMenuItemGroup.js", "declarations": [ { "kind": "class", "description": "### Overview\n\nThe `ui5-user-menu-item-group` component represents a group of items designed for use inside a `ui5-user-menu`.\nItems belonging to the same group should be wrapped by a `ui5-user-menu-item-group`.\nEach group can have an `itemCheckMode` property, which defines the check mode for the items within the group.\nThe possible values for `itemCheckMode` are:\n- 'None' (default) - no items can be checked\n- 'Single' - Only one item can be checked at a time\n- 'Multiple' - Multiple items can be checked simultaneously\n\n**Note:** If the `itemCheckMode` property is set to 'Single', only one item can remain checked at any given time.\nIf multiple items are marked as checked, the last checked item will take precedence.\n\n### Usage\n\n`ui5-user-menu-item-group` represents a collection of `ui5-user-menu-item` components that can have the same check mode.\nThe items are addeed to the group's `items` slot.\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents/dist/UserMenuItemGroup.js\";`", "name": "UserMenuItemGroup", "superclass": { "name": "MenuItemGroup", "package": "@ui5/webcomponents", "module": "dist/MenuItemGroup.js" }, "tagName": "ui5-user-menu-item-group", "customElement": true, "_ui5since": "2.12.0", "_ui5privacy": "public", "slots": [ { "name": "default", "description": "Defines the items of this component.\n**Note:** The slot can hold any combination of components of type `ui5-menu-item` or `ui5-menu-separator` or both.", "_ui5propertyName": "items", "_ui5type": { "text": "Array<IMenuItem>", "references": [ { "name": "IMenuItem", "package": "@ui5/webcomponents", "module": "dist/Menu.js" } ] }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "checkMode", "type": { "text": "MenuItemGroupCheckMode", "references": [ { "name": "MenuItemGroupCheckMode", "package": "@ui5/webcomponents", "module": "dist/types/MenuItemGroupCheckMode.js" } ] }, "default": "\"None\"", "description": "Defines the component's check mode.", "privacy": "public" } ], "attributes": [ { "description": "Defines the component's check mode.", "name": "check-mode", "default": "\"None\"", "fieldName": "checkMode", "type": { "text": "\"None\" | \"Single\" | \"Multiple\"" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "UserMenuItemGroup", "module": "dist/UserMenuItemGroup.js" } }, { "kind": "custom-element-definition", "name": "ui5-user-menu-item-group", "declaration": { "name": "UserMenuItemGroup", "module": "dist/UserMenuItemGroup.js" } } ] }, { "kind": "javascript-module", "path": "dist/UserSettingsAccountView.js", "declarations": [ { "kind": "class", "description": "### Overview\n\nThe `ui5-user-settings-account-view` represents a view displayed in the `ui5-user-settings-item`.", "name": "UserSettingsAccountView", "slots": [ { "name": "account", "description": "Defines the user account.", "_ui5type": { "text": "Array<UserMenuAccount>", "references": [ { "name": "UserMenuAccount", "package": "@ui5/webcomponents-fiori", "module": "dist/UserMenuAccount.js" } ] }, "_ui5privacy": "public" }, { "name": "default", "description": "Defines the content of the view.", "_ui5propertyName": "content", "_ui5type": { "text": "Array<HTMLElement>" }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "secondary", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the view is secondary. It is relevant only if the view is used in `pages` slot of `ui5-user-settings-item`\nand controls the visibility of the back button.", "privacy": "public" }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Defines whether the view is selected. There can be just one selected view at a time.", "privacy": "public" }, { "kind": "field", "name": "showManageAccount", "type": { "text": "boolean" }, "default": "false", "description": "Defines if the User Menu shows the `Manage Account` option.", "privacy": "public" }, { "kind": "field", "name": "text", "type": { "text": "string | undefined" }, "description": "Defines the title text of the user settings view.", "privacy": "public", "default": "undefined" } ], "events": [ { "name": "edit-accounts-click", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the `Edit Accounts` button is selected.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": false }, { "name": "manage-account-click", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the `Manage Account` button is selected.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": false } ], "attributes": [ { "description": "Indicates whether the view is secondary. It is relevant only if the view is used in `pages` slot of `ui5-user-settings-item`\nand controls the visibility of the back button.", "name": "secondary", "default": "false", "fieldName": "secondary", "type": { "text": "boolean" } }, { "description": "Defines whether the view is selected. There can be just one selected view at a time.", "name": "selected", "default": "false", "fieldName": "selected", "type": { "text": "boolean" } }, { "description": "Defines if the User Menu shows the `Manage Account` option.", "name": "show-manage-account", "default": "false", "fieldName": "showManageAccount", "type": { "text": "boolean" } }, { "description": "Defines the title text of the user settings view.", "name": "text", "default": "undefined", "fieldName": "text", "type": { "text": "string | undefined" } } ], "superclass": { "name": "UserSettingsView", "package": "@ui5/webcomponents-fiori", "module": "dist/UserSettingsView.js" }, "tagName": "ui5-user-settings-account-view", "customElement": true, "_ui5since": "2.17.0", "_ui5privacy": "public" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "UserSettingsAccountView", "module": "dist/UserSettingsAccountView.js" } }, { "kind": "custom-element-definition", "name": "ui5-user-settings-account-view", "declaration": { "name": "UserSettingsAccountView", "module": "dist/UserSettingsAccountView.js" } } ] }, { "kind": "javascript-module", "path": "dist/UserSettingsAppearanceView.js", "declarations": [ { "kind": "class", "description": "### Overview\n\nThe `ui5-user-settings-appearance-view` represents a view displayed in the `ui5-user-settings-item`.\n\n### ES6 Module Import\n`import \"@ui5/webcomponents-fiori/dist/UserSettingsAppearanceView.js\";`", "name": "UserSettingsAppearanceView", "slots": [ { "name": "additionalContent", "description": "Defines additional content displayed below the items list.", "_ui5type": { "text": "Array<HTMLElement>" }, "_ui5privacy": "public" }, { "name": "default", "description": "Defines the items of the component.", "_ui5propertyName": "items", "_ui5type": { "text": "Array<UserSettingsAppearanceViewGroup | UserSettingsAppearanceViewItem>" }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "secondary", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the view is secondary. It is relevant only if the view is used in `pages` slot of `ui5-user-settings-item`\nand controls the visibility of the back button.", "privacy": "public" }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Defines whether the view is selected. There can be just one selected view at a time.", "privacy": "public" }, { "kind": "field", "name": "text", "type": { "text": "string | undefined" }, "description": "Defines the title text of the user settings view.", "privacy": "public", "default": "undefined" } ], "events": [ { "name": "selection-change", "_ui5privacy": "public", "type": { "text": "CustomEvent<UserSettingsAppearanceViewItemSelectEventDetail>", "references": [ { "name": "UserSettingsAppearanceViewItemSelectEventDetail", "package": "@ui5/webcomponents-fiori", "module": "dist/UserSettingsAppearanceView.js" } ] }, "description": "Fired when an item is selected.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": false, "_ui5parameters": [ { "type": { "text": "UserSettingsAppearanceViewItem", "references": [ { "name": "UserSettingsAppearanceViewItem", "package": "@ui5/webcomponents-fiori", "module": "dist/UserSettingsAppearanceViewItem.js" } ] }, "name": "item", "_ui5privacy": "public", "description": "The selected `user settings appearance view item`." } ] } ], "superclass": { "name": "UserSettingsView", "package": "@ui5/webcomponents-fiori", "module": "dist/UserSettingsView.js" }, "tagName": "ui5-user-settings-appearance-view", "customElement": true, "_ui5since": "2.17.0", "_ui5privacy": "public", "attributes": [ { "description": "Indicates whether the view is secondary. It is relevant only if the view is used in `pages` slot of `ui5-user-settings-item`\nand controls the visibility of the back button.", "name": "secondary", "default": "false", "fieldName": "secondary", "type": { "text": "boolean" } }, { "description": "Defines whether the view is selected. There can be just one selected view at a time.", "name": "selected", "default": "false", "fieldName": "selected", "type": { "text": "boolean" } }, { "description": "Defines the title text of the user settings view.", "name": "text", "default": "undefined", "fieldName": "text", "type": { "text": "string | undefined" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "UserSettingsAppearanceView", "module": "dist/UserSettingsAppearanceView.js" } }, { "kind": "custom-element-definition", "name": "ui5-user-settings-appearance-view", "declaration": { "name": "UserSettingsAppearanceView", "module": "dist/UserSettingsAppearanceView.js" } } ] }, { "kind": "javascript-module", "path": "dist/UserSettingsAppearanceViewGroup.js", "declarations": [ { "kind": "class", "description": "### Overview\n\nThe `ui5-user-settings-appearance-view-group` is a special list item group used to group appearance view items.\n\nThis is the item to use inside a `ui5-user-settings-appearance-view`.\n\n### ES6 Module Import\n`import \"@ui5/webcomponents-fiori/dist/UserSettingsAppearanceViewGroup.js\";`", "name": "UserSettingsAppearanceViewGroup", "slots": [ { "name": "default", "description": "Defines the items of the <code>ui5-user-settings-appearance-view-group</code>.", "_ui5propertyName": "items", "_ui5type": { "text": "Array<UserSettingsAppearanceViewItem>", "references": [ { "name": "UserSettingsAppearanceViewItem", "package": "@ui5/webcomponents-fiori", "module": "dist/UserSettingsAppearanceViewItem.js" } ] }, "_ui5privacy": "public" }, { "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<ListItemBase>", "references": [ { "name": "ListItemBase", "package": "@ui5/webcomponents", "module": "dist/ListItemBase.js" } ] }, "_ui5privacy": "public" } ], "superclass": { "name": "ListItemGroup", "package": "@ui5/webcomponents", "module": "dist/ListItemGroup.js" }, "tagName": "ui5-user-settings-appearance-view-group", "customElement": true, "_ui5since": "2.17.0", "_ui5privacy": "public", "cssParts": [ { "description": "Used to style the header item of the group", "name": "header" }, { "description": "Used to style the title of the group header", "name": "title" } ], "members": [ { "kind": "field", "name": "headerAccessibleName", "type": { "text": "string | undefined" }, "description": "Defines the accessible name of the header.", "privacy": "public", "default": "undefined" }, { "kind": "field", "name": "headerText", "type": { "text": "string | undefined" }, "description": "Defines the header text of the <code>ui5-li-group</code>.", "privacy": "public", "default": "undefined" }, { "kind": "field", "name": "wrappingType", "type": { "text": "WrappingType", "references": [ { "name": "WrappingType", "package": "@ui5/webcomponents", "module": "dist/types/WrappingType.js" } ] }, "default": "\"None\"", "description": "Defines if the text of the component should wrap when it's too long.\nWhen set to \"Normal\", the content (title, description) will be wrapped\nusing the `ui5-expandable-text` component.<br/>\n\nThe text can wrap up to 100 characters on small screens (size S) and\nup to 300 characters on larger screens (size M and above). When text exceeds\nthese limits, it truncates with an ellipsis followed by a text expansion trigger.\n\nAvailable options are:\n- `None` (default) - The text will truncate with an ellipsis.\n- `Normal` - The text will wrap (without truncation).", "privacy": "public", "_ui5since": "2.15.0" } ], "events": [ { "name": "move", "_ui5privacy": "public", "type": { "text": "CustomEvent<ListItemGroupMoveEventDetail>", "references": [ { "name": "ListItemGroupMoveEventDetail", "package": "@ui5/webcomponents", "module": "dist/ListItemGroup.js" } ] }, "description": "Fired when a movable list item is dropped onto a drop target.\n\n**Note:** `move` event is fired only if there was a preceding `move-over` with prevented default action.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5since": "2.1.0", "_ui5parameters": [ { "type": { "text": "object" }, "name": "destination", "_ui5privacy": "public", "description": "Contains information about the destination of the moved element. Has `element` and `placement` properties." }, { "type": { "text": "object" }, "name": "source", "_ui5privacy": "public", "description": "Contains information about the moved element under `element` property." } ] }, { "name": "move-over", "_ui5privacy": "public", "type": { "text": "CustomEvent<ListItemGroupMoveEventDetail>", "references": [ { "name": "ListItemGroupMoveEventDetail", "package": "@ui5/webcomponents", "module": "dist/ListItemGroup.js" } ] }, "description": "Fired when a movable list item is moved over a potential drop target during a dragging operation.\n\nIf the new position is valid, prevent the default action of the event using `preventDefault()`.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": true, "_ui5since": "2.1.0", "_ui5parameters": [ { "type": { "text": "object" }, "name": "destination", "_ui5privacy": "public", "description": "Contains information about the destination of the moved element. Has `element` and `placement` properties." }, { "type": { "text": "object" }, "name": "source", "_ui5privacy": "public", "description": "Contains information about the moved element under `element` property." } ] } ], "attributes": [ { "description": "Defines the accessible name of the header.", "name": "header-accessible-name", "default": "undefined", "fieldName": "headerAccessibleName", "type": { "text": "string | undefined" } }, { "description": "Defines the header text of the <code>ui5-li-group</code>.", "name": "header-text", "default": "undefined", "fieldName": "headerText", "type": { "text": "string | undefined" } }, { "description": "Defines if the text of the component should wrap when it's too long.\nWhen set to \"Normal\", the content (title, description) will be wrapped\nusing the `ui5-expandable-text` component.<br/>\n\nThe text can wrap up to 100 characters on small screens (size S) and\nup to 300 characters on larger screens (size M and above). When text exceeds\nthese limits, it truncates with an ellipsis followed by a text expansion trigger.\n\nAvailable options are:\n- `None` (default) - The text will truncate with an ellipsis.\n- `Normal` - The text will wrap (without truncation).", "name": "wrapping-type", "default": "\"None\"", "fieldName": "wrappingType", "type": { "text": "\"None\" | \"Normal\"" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "UserSettingsAppearanceViewGroup", "module": "dist/UserSettingsAppearanceViewGroup.js" } }, { "kind": "custom-element-definition", "name": "ui5-user-settings-appearance-view-group", "declaration": { "name": "UserSettingsAppearanceViewGroup", "module": "dist/UserSettingsAppearanceViewGroup.js" } } ] }, { "kind": "javascript-module", "path": "dist/UserSettingsAppearanceViewItem.js", "declarations": [ { "kind": "class", "description": "### Overview\n\nThe `ui5-user-settings-appearance-view-item` represents a theme/appearance option item\nwithin the `ui5-user-settings-appearance-view`.\n\nIt displays a theme with an avatar icon, text label, and can be selected.\n\n### ES6 Module Import\n`import \"@ui5/webcomponents-fiori/dist/UserSettingsAppearanceViewItem.js\";`", "name": "UserSettingsAppearanceViewItem", "members": [ { "kind": "field", "name": "colorScheme", "type": { "text": "string" }, "default": "\"Accent7\"", "description": "Defines the color scheme of the avatar.", "privacy": "public" }, { "kind": "field", "name": "icon", "type": { "text": "string" }, "default": "\"product\"", "description": "Defines the icon of the appearance item.", "privacy": "public" }, { "kind": "field", "name": "itemKey", "type": { "text": "string" }, "default": "\"\"", "description": "Defines the unique identifier of the item.", "privacy": "public" }, { "kind": "field", "name": "text", "type": { "text": "string" }, "default": "\"\"", "description": "Defines the text label displayed for the appearance item.", "privacy": "public" }, { "kind": "field", "name": "accessibilityAttributes", "type": { "text": "ListItemAccessibilityAttributes", "references": [ { "name": "ListItemAccessibilityAttributes", "package": "@ui5/webcomponents", "module": "dist/ListItem.js" } ] }, "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" }, { "kind": "field", "name": "accessibleName", "type": { "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": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15" }, { "kind": "field", "name": "highlight", "type": { "text": "Highlight", "references": [ { "name": "Highlight", "package": "@ui5/webcomponents", "module": "dist/types/Highlight.js" } ] }, "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" }, { "kind": "field", "name": "movable", "type": { "text": "boolean" }, "default": "false", "description": "Defines whether the item is movable.", "privacy": "public", "_ui5since": "2.0.0" }, { "kind": "field", "name": "navigated", "type": { "text": "boolean" }, "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" }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Defines the selected state of the component.", "privacy": "public" }, { "kind": "field", "name": "tooltip", "type": { "text": "string | undefined" }, "description": "Defines the text of the tooltip that would be displayed for the list item.", "default": "undefined", "privacy": "public", "_ui5since": "1.23.0" }, { "kind": "field", "name": "type", "type": { "text": "ListItemType", "references": [ { "name": "ListItemType", "package": "@ui5/webcomponents", "module": "dist/types/ListItemType.js" } ] }, "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" } ], "attributes": [ { "description": "Defines the color scheme of the avatar.", "name": "color-scheme", "default": "\"Accent7\"", "fieldName": "colorScheme", "type": { "text": "string" } }, { "description": "Defines the icon of the appearance item.", "name": "icon", "default": "\"product\"", "fieldName": "icon", "type": { "text": "string" } }, { "description": "Defines the unique identifier of the item.", "name": "item-key", "default": "\"\"", "fieldName": "itemKey", "type": { "text": "string" } }, { "description": "Defines the text label displayed for the appearance item.", "name": "text", "default": "\"\"", "fieldName": "text", "type": { "text": "string" } }, { "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.", "name": "accessibility-attributes", "default": "{}", "fieldName": "accessibilityAttributes", "type": { "text": "ListItemAccessibilityAttributes" } }, { "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": "undefined", "fieldName": "accessibleName", "type": { "text": "string | undefined" } }, { "description": "Defines the highlight state of the list items.\nAvailable options are: `\"None\"` (by default), `\"Positive\"`, `\"Critical\"`, `\"Information\"` and `\"Negative\"`.", "name": "highlight", "default": "\"None\"", "fieldName": "highlight", "type": { "text": "\"None\" | \"Positive\" | \"Critical\" | \"Negative\" | \"Information\"" } }, { "description": "Defines whether the item is movable.", "name": "movable", "default": "false", "fieldName": "movable", "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.", "name": "navigated", "default": "false", "fieldName": "navigated", "type": { "text": "boolean" } }, { "description": "Defines the selected state of the component.", "name": "selected", "default": "false", "fieldName": "selected", "type": { "text": "boolean" } }, { "description": "Defines the text of the tooltip that would be displayed for the list item.", "name": "tooltip", "default": "undefined", "fieldName": "tooltip", "type": { "text": "string | undefined" } }, { "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.", "name": "type", "default": "\"Active\"", "fieldName": "type", "type": { "text": "\"Navigation\" | \"Inactive\" | \"Active\" | \"Detail\"" } } ], "superclass": { "name": "ListItemCustom", "package": "@ui5/webcomponents", "module": "dist/ListItemCustom.js" }, "tagName": "ui5-user-settings-appearance-view-item", "customElement": true, "_ui5since": "2.17.0", "_ui5privacy": "public", "cssParts": [ { "description": "Used to style the checkbox rendered when the list item is in multiple selection mode", "name": "checkbox" }, { "description": "Used to style the content area of the list item", "name": "content" }, { "description": "Used to style the button rendered when the list item is in delete mode", "name": "delete-button" }, { "description": "Used to style the button rendered when the list item is of type detail", "name": "detail-button" }, { "description": "Used to style the main li tag of the list item", "name": "native-li" }, { "description": "Used to style the radio button rendered when the list item is in single selection mode", "name": "radio" } ], "slots": [ { "description": "Defines the content of the component.", "name": "default", "_ui5privacy": "public", "_ui5type": { "text": "Array<Node>" } }, { "name": "deleteButton", "description": "Defines the delete button, displayed in \"Delete\" mode.\n**Note:** While the slot allows custom buttons, to match\ndesign guidelines, please use the `ui5-button` component.\n**Note:** When the slot is not present, a built-in delete button will be displayed.", "_ui5since": "1.9.0", "_ui5type": { "text": "Array<IButton>", "references": [ { "name": "IButton", "package": "@ui5/webcomponents", "module": "dist/Button.js" } ] }, "_ui5privacy": "public" } ], "events": [ { "name": "detail-click", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when the user clicks on the detail button when type is `Detail`.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "UserSettingsAppearanceViewItem", "module": "dist/UserSettingsAppearanceViewItem.js" } }, { "kind": "custom-element-definition", "name": "ui5-user-settings-appearance-view-item", "declaration": { "name": "UserSettingsAppearanceViewItem", "module": "dist/UserSettingsAppearanceViewItem.js" } } ] }, { "kind": "javascript-module", "path": "dist/UserSettingsDialog.js", "declarations": [ { "kind": "class", "description": "### Overview\n\nThe `ui5-user-settings-dialog` is an SAP Fiori-specific web component used in the `ui5-user-menu`.\nIt allows the user to easily view information and settings for an account.\n\n### ES6 Module Import\n`import \"@ui5/webcomponents-fiori/dist/UserSettingsDialog.js\";`", "name": "UserSettingsDialog", "slots": [ { "name": "default", "description": "Defines the user settings items.\n\n**Note:** If no setting item is set as `selected`, the first one will be selected.", "_ui5propertyName": "items", "_ui5type": { "text": "Array<UserSettingsItem>", "references": [ { "name": "UserSettingsItem", "package": "@ui5/webcomponents-fiori", "module": "dist/UserSettingsItem.js" } ] }, "_ui5privacy": "public" }, { "name": "fixedItems", "description": "Defines the fixed user settings items.", "_ui5type": { "text": "Array<UserSettingsItem>", "references": [ { "name": "UserSettingsItem", "package": "@ui5/webcomponents-fiori", "module": "dist/UserSettingsItem.js" } ] }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "headerText", "type": { "text": "string | undefined" }, "description": "Defines the headerText of the item.", "privacy": "public", "default": "undefined" }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Defines, if the User Settings Dialog is opened.", "privacy": "public" }, { "kind": "field", "name": "showSearchField", "type": { "text": "boolean" }, "default": "false", "description": "Defines if the Search Field would be displayed.\n\n**Note:** By default the Search Field is not displayed.", "privacy": "public" } ], "events": [ { "name": "before-close", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired before the settings dialog is closed.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": false }, { "name": "close", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when a settings dialog is closed.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": false }, { "name": "open", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired when a settings dialog is open.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": false }, { "name": "selection-change", "_ui5privacy": "public", "type": { "text": "CustomEvent<UserSettingsItemSelectEventDetail>", "references": [ { "name": "UserSettingsItemSelectEventDetail", "package": "@ui5/webcomponents-fiori", "module": "dist/UserSettingsDialog.js" } ] }, "description": "Fired when an item is selected.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": false, "_ui5parameters": [ { "type": { "text": "UserSettingsItem", "references": [ { "name": "UserSettingsItem", "package": "@ui5/webcomponents-fiori", "module": "dist/UserSettingsItem.js" } ] }, "name": "item", "_ui5privacy": "public", "description": "The selected `user settings item`." } ] } ], "attributes": [ { "description": "Defines the headerText of the item.", "name": "header-text", "default": "undefined", "fieldName": "headerText", "type": { "text": "string | undefined" } }, { "description": "Defines, if the User Settings Dialog is opened.", "name": "open", "default": "false", "fieldName": "open", "type": { "text": "boolean" } }, { "description": "Defines if the Search Field would be displayed.\n\n**Note:** By default the Search Field is not displayed.", "name": "show-search-field", "default": "false", "fieldName": "showSearchField", "type": { "text": "boolean" } } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-user-settings-dialog", "customElement": true, "_ui5since": "2.8.0", "_ui5privacy": "public" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "UserSettingsDialog", "module": "dist/UserSettingsDialog.js" } }, { "kind": "custom-element-definition", "name": "ui5-user-settings-dialog", "declaration": { "name": "UserSettingsDialog", "module": "dist/UserSettingsDialog.js" } } ] }, { "kind": "javascript-module", "path": "dist/UserSettingsItem.js", "declarations": [ { "kind": "class", "description": "### Overview\n\nThe `ui5-user-settings-item` represents an item in the `ui5-user-settings-dialog`.\n\n### ES6 Module Import\n`import \"@ui5/webcomponents-fiori/dist/UserSettingsItem.js\";`\n\nYou can disable the <code>UserSettingsItem</code> by setting the <code>enabled</code> property to <code>false</code>,\nor use the <code>UserSettingsItem</code> in read-only mode by setting the <code>editable</code> property to false.\n\n<b>Note:</b> Disabled and read-only states shouldn't be used together.", "name": "UserSettingsItem", "slots": [ { "name": "default", "description": "Defines the page views of the user settings item.\n\nIf there are no tab views, the first page view will be shown unless there is selected one. If there is selected page\nview it will be shown no matter if there are tab views.\n\nThe page views are displayed by default if there is no selected tab view.", "_ui5propertyName": "pages", "_ui5type": { "text": "Array<UserSettingsView>", "references": [ { "name": "UserSettingsView", "package": "@ui5/webcomponents-fiori", "module": "dist/UserSettingsView.js" } ] }, "_ui5privacy": "public" }, { "name": "tabs", "description": "Defines the tab views of the user settings item.", "_ui5type": { "text": "Array<UserSettingsView>", "references": [ { "name": "UserSettingsView", "package": "@ui5/webcomponents-fiori", "module": "dist/UserSettingsView.js" } ] }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "accessibleName", "type": { "text": "string | undefined" }, "description": "Defines the accessible ARIA name of the component.", "default": "undefined", "privacy": "public" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Defines whether the component is in disabled state.\n\n**Note:** A disabled component is completely noninteractive.", "privacy": "public" }, { "kind": "field", "name": "headerText", "type": { "text": "string | undefined" }, "description": "Defines the headerText of the item.", "privacy": "public", "default": "\"\"" }, { "kind": "field", "name": "icon", "type": { "text": "string" }, "default": "\"globe\"", "description": "Defines the icon of the component.", "privacy": "public" }, { "kind": "field", "name": "loading", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether a loading indicator should be shown.", "privacy": "public" }, { "kind": "field", "name": "loadingReason", "type": { "text": "string | undefined" }, "description": "Indicates why the control is in loading state.", "default": "undefined", "privacy": "public" }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Shows item tab.", "privacy": "public" }, { "kind": "field", "name": "text", "type": { "text": "string" }, "default": "\"\"", "description": "Defines the text of the user settings item.", "privacy": "public" }, { "kind": "field", "name": "tooltip", "type": { "text": "string" }, "default": "\"\"", "description": "Defines the tooltip of the component.\n\nA tooltip attribute should be provided to represent the meaning or function when the component is collapsed and only the icon is visible.", "privacy": "public" } ], "events": [ { "name": "selection-change", "_ui5privacy": "public", "type": { "text": "CustomEvent<UserSettingsItemViewSelectEventDetail>", "references": [ { "name": "UserSettingsItemViewSelectEventDetail", "package": "@ui5/webcomponents-fiori", "module": "dist/UserSettingsItem.js" } ] }, "description": "Fired when a selected view changed.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": false, "_ui5parameters": [ { "type": { "text": "UserSettingsView", "references": [ { "name": "UserSettingsView", "package": "@ui5/webcomponents-fiori", "module": "dist/UserSettingsView.js" } ] }, "name": "view", "_ui5privacy": "public", "description": "The selected `view`." } ] } ], "attributes": [ { "description": "Defines the accessible ARIA name of the component.", "name": "accessible-name", "default": "undefined", "fieldName": "accessibleName", "type": { "text": "string | undefined" } }, { "description": "Defines whether the component is in disabled state.\n\n**Note:** A disabled component is completely noninteractive.", "name": "disabled", "default": "false", "fieldName": "disabled", "type": { "text": "boolean" } }, { "description": "Defines the headerText of the item.", "name": "header-text", "default": "\"\"", "fieldName": "headerText", "type": { "text": "string | undefined" } }, { "description": "Defines the icon of the component.", "name": "icon", "default": "\"globe\"", "fieldName": "icon", "type": { "text": "string" } }, { "description": "Indicates whether a loading indicator should be shown.", "name": "loading", "default": "false", "fieldName": "loading", "type": { "text": "boolean" } }, { "description": "Indicates why the control is in loading state.", "name": "loading-reason", "default": "undefined", "fieldName": "loadingReason", "type": { "text": "string | undefined" } }, { "description": "Shows item tab.", "name": "selected", "default": "false", "fieldName": "selected", "type": { "text": "boolean" } }, { "description": "Defines the text of the user settings item.", "name": "text", "default": "\"\"", "fieldName": "text", "type": { "text": "string" } }, { "description": "Defines the tooltip of the component.\n\nA tooltip attribute should be provided to represent the meaning or function when the component is collapsed and only the icon is visible.", "name": "tooltip", "default": "\"\"", "fieldName": "tooltip", "type": { "text": "string" } } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-user-settings-item", "customElement": true, "_ui5since": "2.8.0", "_ui5privacy": "public" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "UserSettingsItem", "module": "dist/UserSettingsItem.js" } }, { "kind": "custom-element-definition", "name": "ui5-user-settings-item", "declaration": { "name": "UserSettingsItem", "module": "dist/UserSettingsItem.js" } } ] }, { "kind": "javascript-module", "path": "dist/UserSettingsView.js", "declarations": [ { "kind": "class", "description": "### Overview\n\nThe `ui5-user-settings-view` represents a view displayed in the `ui5-user-settings-item`.", "name": "UserSettingsView", "slots": [ { "name": "default", "description": "Defines the content of the view.", "_ui5propertyName": "content", "_ui5type": { "text": "Array<HTMLElement>" }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "secondary", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the view is secondary. It is relevant only if the view is used in `pages` slot of `ui5-user-settings-item`\nand controls the visibility of the back button.", "privacy": "public" }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Defines whether the view is selected. There can be just one selected view at a time.", "privacy": "public" }, { "kind": "field", "name": "text", "type": { "text": "string | undefined" }, "description": "Defines the title text of the user settings view.", "privacy": "public", "default": "undefined" } ], "attributes": [ { "description": "Indicates whether the view is secondary. It is relevant only if the view is used in `pages` slot of `ui5-user-settings-item`\nand controls the visibility of the back button.", "name": "secondary", "default": "false", "fieldName": "secondary", "type": { "text": "boolean" } }, { "description": "Defines whether the view is selected. There can be just one selected view at a time.", "name": "selected", "default": "false", "fieldName": "selected", "type": { "text": "boolean" } }, { "description": "Defines the title text of the user settings view.", "name": "text", "default": "undefined", "fieldName": "text", "type": { "text": "string | undefined" } } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-user-settings-view", "customElement": true, "_ui5since": "2.8.0", "_ui5privacy": "public" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "UserSettingsView", "module": "dist/UserSettingsView.js" } }, { "kind": "custom-element-definition", "name": "ui5-user-settings-view", "declaration": { "name": "UserSettingsView", "module": "dist/UserSettingsView.js" } } ] }, { "kind": "javascript-module", "path": "dist/ViewSettingsDialog.js", "declarations": [ { "kind": "class", "description": "### Overview\nThe `ui5-view-settings-dialog` component helps the user to sort data within a list or a table.\nIt consists of several lists like `Sort order` which is built-in and `Sort By` and `Filter By` lists,\nfor which you must be provide items(`ui5-sort-item` & `ui5-filter-item` respectively)\nThese options can be used to create sorters for a table.\n\nThe `ui5-view-settings-dialog` interrupts the current application processing as it is the only focused UI element and\nthe main screen is dimmed/blocked.\nThe `ui5-view-settings-dialog` is modal, which means that user action is required before returning to the parent window is possible.\n\n### Structure\nA `ui5-view-settings-dialog` consists of a header, content, and a footer for action buttons.\nThe `ui5-view-settings-dialog` is usually displayed at the center of the screen.\n\n### Responsive Behavior\n`ui5-view-settings-dialog` stretches on full screen on phones.\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-fiori/dist/ViewSettingsDialog.js\";`", "name": "ViewSettingsDialog", "cssParts": [ { "description": "Used to style the header.", "name": "header" } ], "slots": [ { "name": "filterItems", "description": "Defines the `filterItems` list.\n\n**Note:** If you want to use this slot, you need to import used item: `import \"@ui5/webcomponents-fiori/dist/FilterItem.js\";`", "_ui5type": { "text": "Array<FilterItem>", "references": [ { "name": "FilterItem", "package": "@ui5/webcomponents-fiori", "module": "dist/FilterItem.js" } ] }, "_ui5privacy": "public" }, { "name": "groupItems", "description": "Defines the list of items against which the user could group data.\n\n**Note:** If you want to use this slot, you need to import used item: `import \"@ui5/webcomponents-fiori/dist/GroupItem.js\";`", "_ui5type": { "text": "Array<GroupItem>", "references": [ { "name": "GroupItem", "package": "@ui5/webcomponents-fiori", "module": "dist/GroupItem.js" } ] }, "_ui5privacy": "public" }, { "name": "sortItems", "description": "Defines the list of items against which the user could sort data.\n\n**Note:** If you want to use this slot, you need to import used item: `import \"@ui5/webcomponents-fiori/dist/SortItem.js\";`", "_ui5type": { "text": "Array<SortItem>", "references": [ { "name": "SortItem", "package": "@ui5/webcomponents-fiori", "module": "dist/SortItem.js" } ] }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "groupDescending", "type": { "text": "boolean" }, "default": "false", "description": "Defines the initial group order.", "privacy": "public", "_ui5since": "2.13.0" }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Indicates if the dialog is open.", "privacy": "public", "_ui5since": "2.0.0" }, { "kind": "method", "name": "setConfirmedSettings", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "settings", "type": { "text": "VSDSettings", "references": [ { "name": "VSDSettings", "package": "@ui5/webcomponents-fiori", "module": "dist/ViewSettingsDialog.js" } ] }, "description": "predefined settings.", "_ui5privacy": "public" } ], "description": "Sets a JavaScript object, as settings to the `ui5-view-settings-dialog`.\nThis method can be used after the dialog is initially open, as the dialog needs\nto set its initial settings.\nThe `ui5-view-settings-dialog` throws an event called \"before-open\",\nwhich can be used as a trigger point.\nThe object should have the following format:", "privacy": "public" }, { "kind": "field", "name": "sortDescending", "type": { "text": "boolean" }, "default": "false", "description": "Defines the initial sort order.", "privacy": "public" } ], "events": [ { "name": "before-open", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired before the component is opened.", "_ui5Cancelable": true, "_ui5allowPreventDefault": true, "_ui5Bubbles": false }, { "name": "cancel", "_ui5privacy": "public", "type": { "text": "CustomEvent<ViewSettingsDialogCancelEventDetail>", "references": [ { "name": "ViewSettingsDialogCancelEventDetail", "package": "@ui5/webcomponents-fiori", "module": "dist/ViewSettingsDialog.js" } ] }, "description": "Fired when cancel button is activated.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5parameters": [ { "type": { "text": "Array" }, "name": "filters", "_ui5privacy": "public", "description": "The selected filters items." }, { "type": { "text": "String" }, "name": "groupBy", "_ui5privacy": "public", "description": "The currently selected `ui5-group-item` text attribute." }, { "type": { "text": "HTMLElement" }, "name": "groupByItem", "_ui5privacy": "public", "description": "The currently selected `ui5-group-item`." }, { "type": { "text": "Boolean" }, "name": "groupDescending", "_ui5privacy": "public", "description": "The selected group order (true = descending, false = ascending)." }, { "type": { "text": "String" }, "name": "groupOrder", "_ui5privacy": "public", "description": "The current group order selected." }, { "type": { "text": "String" }, "name": "sortBy", "_ui5privacy": "public", "description": "The currently selected `ui5-sort-item` text attribute." }, { "type": { "text": "HTMLElement" }, "name": "sortByItem", "_ui5privacy": "public", "description": "The currently selected `ui5-sort-item`." }, { "type": { "text": "Boolean" }, "name": "sortDescending", "_ui5privacy": "public", "description": "The selected sort order (true = descending, false = ascending)." }, { "type": { "text": "String" }, "name": "sortOrder", "_ui5privacy": "public", "description": "The current sort order selected." } ] }, { "name": "close", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired after the dialog is closed.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5since": "2.0.0" }, { "name": "confirm", "_ui5privacy": "public", "type": { "text": "CustomEvent<ViewSettingsDialogConfirmEventDetail>", "references": [ { "name": "ViewSettingsDialogConfirmEventDetail", "package": "@ui5/webcomponents-fiori", "module": "dist/ViewSettingsDialog.js" } ] }, "description": "Fired when confirmation button is activated.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5parameters": [ { "type": { "text": "Array" }, "name": "filters", "_ui5privacy": "public", "description": "The selected filters items." }, { "type": { "text": "String" }, "name": "groupBy", "_ui5privacy": "public", "description": "The currently selected `ui5-group-item` text attribute." }, { "type": { "text": "HTMLElement" }, "name": "groupByItem", "_ui5privacy": "public", "description": "The currently selected `ui5-group-item`." }, { "type": { "text": "Boolean" }, "name": "groupDescending", "_ui5privacy": "public", "description": "The selected group order (true = descending, false = ascending)." }, { "type": { "text": "String" }, "name": "groupOrder", "_ui5privacy": "public", "description": "The current group order selected." }, { "type": { "text": "String" }, "name": "sortBy", "_ui5privacy": "public", "description": "The currently selected `ui5-sort-item` text attribute." }, { "type": { "text": "HTMLElement" }, "name": "sortByItem", "_ui5privacy": "public", "description": "The currently selected `ui5-sort-item`." }, { "type": { "text": "Boolean" }, "name": "sortDescending", "_ui5privacy": "public", "description": "The selected sort order (true = descending, false = ascending)." }, { "type": { "text": "String" }, "name": "sortOrder", "_ui5privacy": "public", "description": "The current sort order selected." } ] }, { "name": "open", "_ui5privacy": "public", "type": { "text": "CustomEvent" }, "description": "Fired after the dialog is opened.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5since": "2.0.0" } ], "attributes": [ { "description": "Defines the initial group order.", "name": "group-descending", "default": "false", "fieldName": "groupDescending", "type": { "text": "boolean" } }, { "description": "Indicates if the dialog is open.", "name": "open", "default": "false", "fieldName": "open", "type": { "text": "boolean" } }, { "description": "Defines the initial sort order.", "name": "sort-descending", "default": "false", "fieldName": "sortDescending", "type": { "text": "boolean" } } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-view-settings-dialog", "customElement": true, "_ui5since": "1.0.0-rc.16", "_ui5privacy": "public" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "ViewSettingsDialog", "module": "dist/ViewSettingsDialog.js" } }, { "kind": "custom-element-definition", "name": "ui5-view-settings-dialog", "declaration": { "name": "ViewSettingsDialog", "module": "dist/ViewSettingsDialog.js" } } ] }, { "kind": "javascript-module", "path": "dist/Wizard.js", "declarations": [ { "kind": "class", "description": "### Overview\n\nThe `ui5-wizard` helps users to complete a complex task by dividing it into sections and guiding them through it.\nIt has two main areas - a navigation area at the top showing the step sequence and a content area below it.\n\n### Structure\n#### Navigation area\nThe top most area of the `ui5-wizard` is occupied by the navigation area.\nIt shows the sequence of steps, where the recommended number of steps is between 3 and 8 steps.\n\n- Steps can have different visual representations - numbers or icons.\n- Steps might have labels for better readability - titleText and subTitleText.\n- Steps are defined by using the `ui5-wizard-step` as slotted element within the `ui5-wizard`.\n\n**Note:** If no selected step is defined, the first step will be auto selected.\n\n**Note:** If multiple selected steps are defined, the last step will be selected.\n\n### Keyboard Handling\nThe user can navigate using the following keyboard shortcuts:\n\n#### Wizard Progress Navigation\n\n\t- [Left] or [Down] - Focus moves backward to the WizardProgressNavAnchors.\n\t- [Up] or [Right] - Focus moves forward to the WizardProgressNavAnchor.\n\t- [Space] / [Enter] or [Return] - Selects an active step\n\t- [Home] or [PAGE UP] - Focus goes to the first step\n\t- [End] or [PAGE DOWN] - Focus goes to the last step\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#### Content\nThe content occupies the main part of the page. It can hold any type of HTML elements.\nIt's defined by using the `ui5-wizard-step` as slotted element within the `ui5-wizard`.\n\n### Scrolling\nThe component handles user scrolling by selecting the closest step, based on the current scroll position\nand scrolls to particular place, when the user clicks on the step within the navigation area.\n\n**Important:** In order the component's scrolling behaviour to work, it has to be limited from the outside parent element in terms of height.\nThe component or its parent has to be given percentage or absolute height. Otherwise, the component will be scrolled out with the entire page.\n\n**For example:**\n\n```html\n<ui5-dialog style=\"height: 80%\">\n\t<ui5-wizard></ui5-wizard>\n</ui5-dialog>\n```\n\n#### Moving to next step\nThe `ui5-wizard-step` provides the necessary API and it's up to the user of the component to use it to move to the next step.\nYou have to set its `selected` property (and remove the `disabled` one if set) to `true`.\nThe `ui5-wizard` will automatically scroll to the content of the newly selected step.\n\nThe Fiori 3 guidelines recommends having a \"nextStep\" button in the content area.\nYou can place a button, or any other type of element to trigger step change, inside the `ui5-wizard-step`,\nand show/hide it when certain fields are filled or user defined criteria is met.\n\n### Usage\n#### When to use:\nWhen the user has to accomplish a long or unfamiliar task.\n\n#### When not to use:\nWhen the task has less than 3 steps.\n\n### Responsive Behavior\nOn small widths the step's titleText, subtitleText and separators in the navigation area shrink and from particular point the steps are grouped together and overlap.\nTapping on them will show a popover to select the step to navigate to. On mobile device, the grouped steps are presented within a dialog.\n\n### ES6 Module Import\n`import \"@ui5/webcomponents-fiori/dist/Wizard.js\";` (includes <ui5-wizard-step/>)", "name": "Wizard", "cssParts": [ { "description": "Used to style the progress navigator of the `ui5-wizard`.", "name": "navigator" }, { "description": "Used to style a `ui5-wizard-step` container.", "name": "step-content" } ], "slots": [ { "name": "default", "description": "Defines the steps.\n\n**Note:** Use the available `ui5-wizard-step` component.", "_ui5propertyName": "steps", "_ui5type": { "text": "Array<WizardStep>", "references": [ { "name": "WizardStep", "package": "@ui5/webcomponents-fiori", "module": "dist/WizardStep.js" } ] }, "_ui5privacy": "public" } ], "members": [ { "kind": "field", "name": "contentLayout", "type": { "text": "WizardContentLayout", "references": [ { "name": "WizardContentLayout", "package": "@ui5/webcomponents-fiori", "module": "dist/types/WizardContentLayout.js" } ] }, "default": "\"MultipleSteps\"", "description": "Defines how the content of the `ui5-wizard` would be visualized.", "privacy": "public", "_ui5since": "1.14.0" } ], "events": [ { "name": "step-change", "_ui5privacy": "public", "type": { "text": "CustomEvent<WizardStepChangeEventDetail>", "references": [ { "name": "WizardStepChangeEventDetail", "package": "@ui5/webcomponents-fiori", "module": "dist/Wizard.js" } ] }, "description": "Fired when the step is changed by user interaction - either with scrolling,\nor by clicking on the steps within the component header.", "_ui5Cancelable": false, "_ui5allowPreventDefault": false, "_ui5Bubbles": true, "_ui5parameters": [ { "type": { "text": "WizardStep", "references": [ { "name": "WizardStep", "package": "@ui5/webcomponents-fiori", "module": "dist/WizardStep.js" } ] }, "name": "previousStep", "_ui5privacy": "public", "description": "The previous step." }, { "type": { "text": "WizardStep", "references": [ { "name": "WizardStep", "package": "@ui5/webcomponents-fiori", "module": "dist/WizardStep.js" } ] }, "name": "step", "_ui5privacy": "public", "description": "The new step." }, { "type": { "text": "boolean" }, "name": "withScroll", "_ui5privacy": "public", "description": "true when the event occurs due to user scrolling." } ] } ], "attributes": [ { "description": "Defines how the content of the `ui5-wizard` would be visualized.", "name": "content-layout", "default": "\"MultipleSteps\"", "fieldName": "contentLayout", "type": { "text": "\"MultipleSteps\" | \"SingleStep\"" } } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-wizard", "customElement": true, "_ui5since": "1.0.0-rc.10", "_ui5privacy": "public" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "Wizard", "module": "dist/Wizard.js" } }, { "kind": "custom-element-definition", "name": "ui5-wizard", "declaration": { "name": "Wizard", "module": "dist/Wizard.js" } } ] }, { "kind": "javascript-module", "path": "dist/WizardStep.js", "declarations": [ { "kind": "class", "description": "### Overview\n\nA component that represents a logical step as part of the `ui5-wizard`.\nIt is meant to aggregate arbitrary HTML elements that form the content of a single step.\n\n### Structure\n\n- Each wizard step has arbitrary content.\n- Each wizard step might have texts - defined by the `titleText` and `subtitleText` properties.\n- Each wizard step might have an icon - defined by the `icon` property.\n- Each wizard step might display a number in place of the `icon`, when it's missing.\n\n### Usage\nThe `ui5-wizard-step` component should be used only as slot of the `ui5-wizard` component\nand should not be used standalone.", "name": "WizardStep", "slots": [ { "description": "Defines the step content.", "name": "default", "_ui5privacy": "public", "_ui5type": { "text": "Array<Node>" } } ], "members": [ { "kind": "field", "name": "branching", "type": { "text": "boolean" }, "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" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "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" }, { "kind": "field", "name": "icon", "type": { "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": "undefined", "privacy": "public" }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "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" }, { "kind": "field", "name": "subtitleText", "type": { "text": "string | undefined" }, "description": "Defines the `subtitleText` of the step.\n\n**Note:** the text is displayed in the `ui5-wizard` navigation header.", "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15" }, { "kind": "field", "name": "titleText", "type": { "text": "string | undefined" }, "description": "Defines the `titleText` of the step.\n\n**Note:** The text is displayed in the `ui5-wizard` navigation header.", "default": "undefined", "privacy": "public", "_ui5since": "1.0.0-rc.15" } ], "attributes": [ { "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.", "name": "branching", "default": "false", "fieldName": "branching", "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.", "name": "disabled", "default": "false", "fieldName": "disabled", "type": { "text": "boolean" } }, { "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": "undefined", "fieldName": "icon", "type": { "text": "string | undefined" } }, { "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.", "name": "selected", "default": "false", "fieldName": "selected", "type": { "text": "boolean" } }, { "description": "Defines the `subtitleText` of the step.\n\n**Note:** the text is displayed in the `ui5-wizard` navigation header.", "name": "subtitle-text", "default": "undefined", "fieldName": "subtitleText", "type": { "text": "string | undefined" } }, { "description": "Defines the `titleText` of the step.\n\n**Note:** The text is displayed in the `ui5-wizard` navigation header.", "name": "title-text", "default": "undefined", "fieldName": "titleText", "type": { "text": "string | undefined" } } ], "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-wizard-step", "customElement": true, "_ui5since": "1.0.0-rc.10", "_ui5privacy": "public", "_ui5abstract": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "WizardStep", "module": "dist/WizardStep.js" } }, { "kind": "custom-element-definition", "name": "ui5-wizard-step", "declaration": { "name": "WizardStep", "module": "dist/WizardStep.js" } } ] }, { "kind": "javascript-module", "path": "dist/WizardTab.js", "declarations": [ { "kind": "class", "description": "### Overview\nPrivate component, used internally by the `ui5-wizard`\nto represent a \"step\" in the navigation header of the `ui5-wizard`.\n\n### Usage\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents/dist/WizardTab.js\";` (imported with <ui5-wizard>)", "name": "WizardTab", "superclass": { "name": "UI5Element", "package": "@ui5/webcomponents-base", "module": "dist/UI5Element.js" }, "tagName": "ui5-wizard-tab", "customElement": true, "_ui5privacy": "private" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "WizardTab", "module": "dist/WizardTab.js" } }, { "kind": "custom-element-definition", "name": "ui5-wizard-tab", "declaration": { "name": "WizardTab", "module": "dist/WizardTab.js" } } ] }, { "kind": "javascript-module", "path": "dist/ssr-zxing-shim.js", "declarations": [], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "ZXing", "module": "dist/ssr-zxing-shim.js" } } ] }, { "kind": "javascript-module", "path": "dist/ssr-zxing.js", "declarations": [], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "ZXing", "module": "dist/ssr-zxing.js" } } ] }, { "kind": "javascript-module", "path": "dist/fcl-utils/FCLLayout.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "dist/illustrations/AllIllustrations.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "dist/shellbar/IShellBarSearchController.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "dist/shellbar/ShellBarAccessibility.js", "declarations": [], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "ShellBarAccessibility", "module": "dist/shellbar/ShellBarAccessibility.js" } } ] }, { "kind": "javascript-module", "path": "dist/shellbar/ShellBarItemNavigation.js", "declarations": [], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "ShellBarItemNavigation", "module": "dist/shellbar/ShellBarItemNavigation.js" } } ] }, { "kind": "javascript-module", "path": "dist/shellbar/ShellBarLegacy.js", "declarations": [], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "ShellBarLegacy", "module": "dist/shellbar/ShellBarLegacy.js" } } ] }, { "kind": "javascript-module", "path": "dist/shellbar/ShellBarOverflow.js", "declarations": [], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "ShellBarOverflow", "module": "dist/shellbar/ShellBarOverflow.js" } } ] }, { "kind": "javascript-module", "path": "dist/shellbar/ShellBarSearch.js", "declarations": [], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "ShellBarSearch", "module": "dist/shellbar/ShellBarSearch.js" } } ] }, { "kind": "javascript-module", "path": "dist/shellbar/ShellBarSearchLegacy.js", "declarations": [], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "ShellBarSearchLegacy", "module": "dist/shellbar/ShellBarSearchLegacy.js" } } ] }, { "kind": "javascript-module", "path": "dist/types/FCLLayout.js", "declarations": [ { "kind": "enum", "name": "FCLLayout", "description": "Different types of FCLLayout.", "_ui5privacy": "public", "members": [ { "kind": "field", "static": true, "privacy": "public", "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 }, { "kind": "field", "static": true, "privacy": "public", "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 }, { "kind": "field", "static": true, "privacy": "public", "description": "The layout will display 1 column.", "default": "OneColumn", "name": "OneColumn", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "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 }, { "kind": "field", "static": true, "privacy": "public", "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 }, { "kind": "field", "static": true, "privacy": "public", "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 }, { "kind": "field", "static": true, "privacy": "public", "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 }, { "kind": "field", "static": true, "privacy": "public", "description": "Desktop: Defaults to 0 - 33 - 67 percent widths of columns. Start is hidden, Mid and End (expanded) columns are displayed.\nTablet: Defaults to 0 - 33 - 67 percent widths of columns. Start is hidden, Mid and End (expanded) columns are displayed.\nPhone: Fixed -- 100 percent width of the End column, only the End column is displayed.\n\nUse to display the Mid column and expanded End column while the grip of the separator is not visible.", "default": "ThreeColumnsStartHiddenEndExpanded", "name": "ThreeColumnsStartHiddenEndExpanded", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "Desktop: Defaults to 0 - 67 - 33 percent widths of columns. Start is hidden, Mid (expanded) and End columns are displayed.\nTablet: Defaults to 0 - 67 - 33 percent widths of columns. Start is hidden, Mid (expanded) and End columns are displayed.\nPhone: Fixed -- 100 percent width of the Mid column, only the Mid column is displayed.\n\nUse to display the Mid and End columns while the Start column is hidden.", "default": "ThreeColumnsStartHiddenMidExpanded", "name": "ThreeColumnsStartHiddenMidExpanded", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "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 }, { "kind": "field", "static": true, "privacy": "public", "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 } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "FCLLayout", "module": "dist/types/FCLLayout.js" } } ] }, { "kind": "javascript-module", "path": "dist/types/IllustrationMessageDesign.js", "declarations": [ { "kind": "enum", "name": "IllustrationMessageDesign", "description": "Different types of IllustrationMessageDesign.", "_ui5privacy": "public", "_ui5since": "2.0.0", "members": [ { "kind": "field", "static": true, "privacy": "public", "description": "Automatically decides the <code>Illustration</code> size (<code>Base</code>, <code>Dot</code>, <code>Spot</code>,\n<code>Dialog</code>, or <code>Scene</code>) depending on the <code>IllustratedMessage</code> container width.\n\n**Note:** `Auto` is the only option where the illustration size is changed according to\nthe available container width. If any other `IllustratedMessageSize` is chosen, it remains\nuntil changed by the app developer.", "default": "Auto", "name": "Auto", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "Base `Illustration` size (XS breakpoint). Suitable for cards (two columns).\n\n**Note:** When `Base` is in use, no illustration is displayed.", "default": "Base", "name": "Base", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "Dialog `Illustration` size (M breakpoint). Suitable for dialogs.", "default": "Dialog", "deprecated": "Since 2.10.0, use Medium instead", "name": "Dialog", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "Dot <code>Illustration</code> size (XS breakpoint). Suitable for table rows.", "default": "Dot", "deprecated": "Since 2.10.0, use ExtraSmall instead", "name": "Dot", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "ExtraSmall <code>Illustration</code> size (XS breakpoint). Suitable for table rows.", "default": "ExtraSmall", "name": "ExtraSmall", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "Large `Illustration` size (L breakpoint). Suitable for a `Page` or a table.", "default": "Large", "name": "Large", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "Medium `Illustration` size (M breakpoint). Suitable for dialogs.", "default": "Medium", "name": "Medium", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "Scene `Illustration` size (L breakpoint). Suitable for a `Page` or a table.", "default": "Scene", "deprecated": "Since 2.10.0, use Large instead", "name": "Scene", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "Small <code>Illustration</code> size (S breakpoint). Suitable for cards (four columns).", "default": "Small", "name": "Small", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "Spot <code>Illustration</code> size (S breakpoint). Suitable for cards (four columns).", "default": "Spot", "deprecated": "Since 2.10.0, use Small instead", "name": "Spot", "readonly": true } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IllustrationMessageDesign", "module": "dist/types/IllustrationMessageDesign.js" } } ] }, { "kind": "javascript-module", "path": "dist/types/IllustrationMessageType.js", "declarations": [ { "kind": "enum", "name": "IllustrationMessageType", "description": "Different illustration types of Illustrated Message.", "_ui5privacy": "public", "members": [ { "kind": "field", "static": true, "privacy": "public", "description": "\"Achievement\" illustration type.", "default": "Achievement", "name": "Achievement", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Add Column\" illustration type.", "default": "AddColumn", "deprecated": "Deprecated as of version 2.11.0, use AddingColumns instead.", "name": "AddColumn", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Add Dimensions\" illustration type.", "default": "AddDimensions", "name": "AddDimensions", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Adding Columns\" illustration type.", "default": "AddingColumns", "name": "AddingColumns", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Add People\" illustration type.", "default": "AddPeople", "deprecated": "Deprecated as of version 2.11.0, use AddPeopleToCalendar instead.", "name": "AddPeople", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Add People To Calendar\" illustration type.", "default": "AddPeopleToCalendar", "name": "AddPeopleToCalendar", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Balloon Sky\" illustration type.", "default": "BalloonSky", "deprecated": "Deprecated as of version 2.11.0, use ReceiveAppreciation instead.", "name": "BalloonSky", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Before Search\" illustration type.", "default": "BeforeSearch", "name": "BeforeSearch", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Connection\" illustration type.", "default": "Connection", "deprecated": "Deprecated as of version 2.11.0, use UnableToLoad instead.", "name": "Connection", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Drag Files To Upload\" illustration type.", "default": "DragFilesToUpload", "name": "DragFilesToUpload", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Empty Calendar\" illustration type.", "default": "EmptyCalendar", "deprecated": "Deprecated as of version 2.11.0, use NoActivities instead.", "name": "EmptyCalendar", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Empty List\" illustration type.", "default": "EmptyList", "deprecated": "Deprecated as of version 2.11.0, use NoEntries instead.", "name": "EmptyList", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Empty Planning Calendar\" illustration type.", "default": "EmptyPlanningCalendar", "name": "EmptyPlanningCalendar", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Error Screen\" illustration type.", "default": "ErrorScreen", "deprecated": "Deprecated as of version 2.11.0, use UnableToUpload instead.", "name": "ErrorScreen", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Filtering Columns\" illustration type.", "default": "FilteringColumns", "name": "FilteringColumns", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Filter Table\" illustration type.", "default": "FilterTable", "deprecated": "Deprecated as of version 2.11.0, use FilteringColumns instead.", "name": "FilterTable", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Grouping Columns\" illustration type.", "default": "GroupingColumns", "name": "GroupingColumns", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Group Table\" illustration type.", "default": "GroupTable", "deprecated": "Deprecated as of version 2.11.0, use GroupingColumns instead.", "name": "GroupTable", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Key Task\" illustration type.", "default": "KeyTask", "name": "KeyTask", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"New Mail\" illustration type.", "default": "NewMail", "name": "NewMail", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"No Activities\" illustration type.", "default": "NoActivities", "name": "NoActivities", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"No Chart Data\" illustration type.", "default": "NoChartData", "name": "NoChartData", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"No Columns Set\" illustration type.", "default": "NoColumnsSet", "name": "NoColumnsSet", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"No Data\" illustration type.", "default": "NoData", "name": "NoData", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"No Dimensions Set\" illustration type.", "default": "NoDimensionsSet", "deprecated": "Deprecated as of version 2.11.0, use NoChartData instead.", "name": "NoDimensionsSet", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"No Entries\" illustration type.", "default": "NoEntries", "name": "NoEntries", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"No Filter Results\" illustration type.", "default": "NoFilterResults", "name": "NoFilterResults", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"No Email\" illustration type.", "default": "NoMail", "name": "NoMail", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"No Email v1\" illustration type.", "default": "NoMail_v1", "deprecated": "Deprecated as of version 2.11.0, use NoMail instead.", "name": "NoMail_v1", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"No Notifications\" illustration type.", "default": "NoNotifications", "name": "NoNotifications", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"No Saved Items\" illustration type.", "default": "NoSavedItems", "name": "NoSavedItems", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"No Saved Items v1\" illustration type.", "default": "NoSavedItems_v1", "deprecated": "Deprecated as of version 2.11.0, use NoSavedItems instead.", "name": "NoSavedItems_v1", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"No Search Results\" illustration type.", "default": "NoSearchResults", "name": "NoSearchResults", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"No Tasks\" illustration type.", "default": "NoTasks", "name": "NoTasks", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"No Tasks v1\" illustration type.", "default": "NoTasks_v1", "deprecated": "Deprecated as of version 2.11.0, use NoTasks instead.", "name": "NoTasks_v1", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Page Not Found\" illustration type.", "default": "PageNotFound", "name": "PageNotFound", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Receive Appreciation\" illustration type.", "default": "ReceiveAppreciation", "name": "ReceiveAppreciation", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Reload Screen\" illustration type.", "default": "ReloadScreen", "deprecated": "Deprecated as of version 2.11.0, use UnableToLoad instead.", "name": "ReloadScreen", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Resize Column\" illustration type.", "default": "ResizeColumn", "deprecated": "Deprecated as of version 2.11.0, use ResizingColumns instead.", "name": "ResizeColumn", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Resizing Columns\" illustration type.", "default": "ResizingColumns", "name": "ResizingColumns", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Search Earth\" illustration type.", "default": "SearchEarth", "deprecated": "Deprecated as of version 2.11.0, use BeforeSearch instead.", "name": "SearchEarth", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Search Folder\" illustration type.", "default": "SearchFolder", "deprecated": "Deprecated as of version 2.11.0, use NoSearchResults instead.", "name": "SearchFolder", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Sign Out\" illustration type.", "default": "SignOut", "name": "SignOut", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Simple Balloon\" illustration type.", "default": "SimpleBalloon", "deprecated": "Deprecated as of version 2.11.0, use ReceiveAppreciation instead.", "name": "SimpleBalloon", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Simple Bell\" illustration type.", "default": "SimpleBell", "deprecated": "Deprecated as of version 2.11.0, use NoNotifications instead.", "name": "SimpleBell", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Simple Calendar\" illustration type.", "default": "SimpleCalendar", "deprecated": "Deprecated as of version 2.11.0, use NoActivities instead.", "name": "SimpleCalendar", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Simple CheckMark\" illustration type.", "default": "SimpleCheckMark", "deprecated": "Deprecated as of version 2.11.0, use KeyTask instead.", "name": "SimpleCheckMark", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Simple Connection\" illustration type.", "default": "SimpleConnection", "deprecated": "Deprecated as of version 2.11.0, use UnableToLoad instead.", "name": "SimpleConnection", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Simple Empty Doc\" illustration type.", "default": "SimpleEmptyDoc", "deprecated": "Deprecated as of version 2.11.0, use NoData instead.", "name": "SimpleEmptyDoc", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Simple Empty List\" illustration type.", "default": "SimpleEmptyList", "deprecated": "Deprecated as of version 2.11.0, use NoEntries instead.", "name": "SimpleEmptyList", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Simple Error\" illustration type.", "default": "SimpleError", "deprecated": "Deprecated as of version 2.11.0, use UnableToUpload instead.", "name": "SimpleError", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Simple Magnifier\" illustration type.", "default": "SimpleMagnifier", "deprecated": "Deprecated as of version 2.11.0, use BeforeSearch instead.", "name": "SimpleMagnifier", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Simple Mail\" illustration type.", "default": "SimpleMail", "deprecated": "Deprecated as of version 2.11.0, use NoMail instead.", "name": "SimpleMail", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Simple No Saved Items\" illustration type.", "default": "SimpleNoSavedItems", "deprecated": "Deprecated as of version 2.11.0, use NoSavedItems instead.", "name": "SimpleNoSavedItems", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Simple Not Found Magnifier\" illustration type.", "default": "SimpleNotFoundMagnifier", "deprecated": "Deprecated as of version 2.11.0, use NoSearchResults instead.", "name": "SimpleNotFoundMagnifier", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Simple Reload\" illustration type.", "default": "SimpleReload", "deprecated": "Deprecated as of version 2.11.0, use UnableToLoad instead.", "name": "SimpleReload", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Simple Task\" illustration type.", "default": "SimpleTask", "deprecated": "Deprecated as of version 2.11.0, use NoTasks instead.", "name": "SimpleTask", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Sleeping Bell\" illustration type.", "default": "SleepingBell", "deprecated": "Deprecated as of version 2.11.0, use NoNotifications instead.", "name": "SleepingBell", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Sort Column\" illustration type.", "default": "SortColumn", "deprecated": "Deprecated as of version 2.11.0, use SortingColumns instead.", "name": "SortColumn", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Sorting Columns\" illustration type.", "default": "SortingColumns", "name": "SortingColumns", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Success Balloon\" illustration type.", "default": "SuccessBalloon", "deprecated": "Deprecated as of version 2.11.0, use ReceiveAppreciation instead.", "name": "SuccessBalloon", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Success CheckMark\" illustration type.", "default": "SuccessCheckMark", "deprecated": "Deprecated as of version 2.11.0, use KeyTask instead.", "name": "SuccessCheckMark", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Success HighFive\" illustration type.", "default": "SuccessHighFive", "deprecated": "Deprecated as of version 2.11.0, use ReceiveAppreciation instead.", "name": "SuccessHighFive", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Success Screen\" illustration type.", "default": "SuccessScreen", "deprecated": "Deprecated as of version 2.11.0, use KeyTask instead.", "name": "SuccessScreen", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Survey\" illustration type.", "default": "Survey", "name": "Survey", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Tent\" illustration type.", "default": "Tent", "deprecated": "Deprecated as of version 2.11.0, use NoData instead.", "name": "Tent", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntAvatar\" illustration type.", "default": "TntAvatar", "name": "TntAvatar", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntCalculator\" illustration type.", "default": "TntCalculator", "name": "TntCalculator", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntChartArea\" illustration type.", "default": "TntChartArea", "name": "TntChartArea", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntChartArea2\" illustration type.", "default": "TntChartArea2", "name": "TntChartArea2", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntChartBar\" illustration type.", "default": "TntChartBar", "name": "TntChartBar", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntChartBPMNFlow\" illustration type.", "default": "TntChartBPMNFlow", "name": "TntChartBPMNFlow", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntChartBullet\" illustration type.", "default": "TntChartBullet", "name": "TntChartBullet", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntChartDoughnut\" illustration type.", "default": "TntChartDoughnut", "name": "TntChartDoughnut", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntChartFlow\" illustration type.", "default": "TntChartFlow", "name": "TntChartFlow", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntChartGantt\" illustration type.", "default": "TntChartGantt", "name": "TntChartGantt", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntChartOrg\" illustration type.", "default": "TntChartOrg", "name": "TntChartOrg", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntChartPie\" illustration type.", "default": "TntChartPie", "name": "TntChartPie", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntCodePlaceholder\" illustration type.", "default": "TntCodePlaceholder", "name": "TntCodePlaceholder", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntCompany\" illustration type.", "default": "TntCompany", "name": "TntCompany", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntCompass\" illustration type.", "default": "TntCompass", "name": "TntCompass", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntComponents\" illustration type.", "default": "TntComponents", "name": "TntComponents", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntDialog\" illustration type.", "default": "TntDialog", "name": "TntDialog", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntEmptyContentPane\" illustration type.", "default": "TntEmptyContentPane", "name": "TntEmptyContentPane", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntExternalLink\" illustration type.", "default": "TntExternalLink", "name": "TntExternalLink", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntFaceID\" illustration type.", "default": "TntFaceID", "name": "TntFaceID", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntFingerprint\" illustration type.", "default": "TntFingerprint", "name": "TntFingerprint", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntHandshake\" illustration type.", "default": "TntHandshake", "name": "TntHandshake", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntHelp\" illustration type.", "default": "TntHelp", "name": "TntHelp", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntLock\" illustration type.", "default": "TntLock", "name": "TntLock", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntMission\" illustration type.", "default": "TntMission", "name": "TntMission", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntMissionFailed\" illustration type.", "default": "TntMissionFailed", "name": "TntMissionFailed", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntNoApplications\" illustration type.", "default": "TntNoApplications", "name": "TntNoApplications", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntNoFlows\" illustration type.", "default": "TntNoFlows", "name": "TntNoFlows", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntNoUsers\" illustration type.", "default": "TntNoUsers", "name": "TntNoUsers", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntRadar\" illustration type.", "default": "TntRadar", "name": "TntRadar", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntRoadMap\" illustration type.", "default": "TntRoadMap", "name": "TntRoadMap", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntSecrets\" illustration type.", "default": "TntSecrets", "name": "TntSecrets", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntServices\" illustration type.", "default": "TntServices", "name": "TntServices", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntSessionExpired\" illustration type.", "default": "TntSessionExpired", "name": "TntSessionExpired", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntSessionExpiring\" illustration type.", "default": "TntSessionExpiring", "name": "TntSessionExpiring", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntSettings\" illustration type.", "default": "TntSettings", "name": "TntSettings", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntSuccess\" illustration type.", "default": "TntSuccess", "name": "TntSuccess", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntSuccessfulAuth\" illustration type.", "default": "TntSuccessfulAuth", "name": "TntSuccessfulAuth", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntSystems\" illustration type.", "default": "TntSystems", "name": "TntSystems", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntTeams\" illustration type.", "default": "TntTeams", "name": "TntTeams", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntTools\" illustration type.", "default": "TntTools", "name": "TntTools", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntTutorials\" illustration type.", "default": "TntTutorials", "name": "TntTutorials", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntUnableToLoad\" illustration type.", "default": "TntUnableToLoad", "name": "TntUnableToLoad", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntUnlock\" illustration type.", "default": "TntUnlock", "name": "TntUnlock", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntUnsuccessfulAuth\" illustration type.", "default": "TntUnsuccessfulAuth", "name": "TntUnsuccessfulAuth", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"TntUser2\" illustration type.", "default": "TntUser2", "name": "TntUser2", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Unable To Load\" illustration type.", "default": "UnableToLoad", "name": "UnableToLoad", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Unable To Load Image\" illustration type.", "default": "UnableToLoadImage", "name": "UnableToLoadImage", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Unable To Upload\" illustration type.", "default": "UnableToUpload", "name": "UnableToUpload", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Upload Collection\" illustration type.", "default": "UploadCollection", "deprecated": "Deprecated as of version 2.11.0, use DragFilesToUpload instead.", "name": "UploadCollection", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"Upload To Cloud\" illustration type.", "default": "UploadToCloud", "name": "UploadToCloud", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "\"User Has Signed Up\" illustration type.", "default": "UserHasSignedUp", "name": "UserHasSignedUp", "readonly": true } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IllustrationMessageType", "module": "dist/types/IllustrationMessageType.js" } } ] }, { "kind": "javascript-module", "path": "dist/types/MediaGalleryItemLayout.js", "declarations": [ { "kind": "enum", "name": "MediaGalleryItemLayout", "description": "Defines the layout of the content displayed in the `ui5-media-gallery-item`.", "_ui5privacy": "public", "members": [ { "kind": "field", "static": true, "privacy": "public", "description": "Recommended to use when the item contains an image.\n\nWhen a thumbnail is selected, it makes the corresponding enlarged content appear in a square display area.", "default": "Square", "name": "Square", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "Recommended to use when the item contains video content.\n\nWhen a thumbnail is selected, it makes the corresponding enlarged content appear in a wide display area\n(stretched to fill all of the available width) for optimal user experiance.", "default": "Wide", "name": "Wide", "readonly": true } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "MediaGalleryItemLayout", "module": "dist/types/MediaGalleryItemLayout.js" } } ] }, { "kind": "javascript-module", "path": "dist/types/MediaGalleryLayout.js", "declarations": [ { "kind": "enum", "name": "MediaGalleryLayout", "description": "Defines the layout type of the thumbnails list of the `ui5-media-gallery` component.", "_ui5privacy": "public", "members": [ { "kind": "field", "static": true, "privacy": "public", "description": "The layout is determined automatically.", "default": "Auto", "name": "Auto", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "Displays the layout as a horizontal split between the thumbnails list and the selected image.", "default": "Horizontal", "name": "Horizontal", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "Displays the layout as a vertical split between the thumbnails list and the selected image.", "default": "Vertical", "name": "Vertical", "readonly": true } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "MediaGalleryLayout", "module": "dist/types/MediaGalleryLayout.js" } } ] }, { "kind": "javascript-module", "path": "dist/types/MediaGalleryMenuHorizontalAlign.js", "declarations": [ { "kind": "enum", "name": "MediaGalleryMenuHorizontalAlign", "description": "Defines the horizontal alignment of the thumbnails menu of the `ui5-media-gallery` component.", "_ui5privacy": "public", "members": [ { "kind": "field", "static": true, "privacy": "public", "description": "Displays the menu on the left side of the target.", "default": "Left", "name": "Left", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "Displays the menu on the right side of the target.", "default": "Right", "name": "Right", "readonly": true } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "MediaGalleryMenuHorizontalAlign", "module": "dist/types/MediaGalleryMenuHorizontalAlign.js" } } ] }, { "kind": "javascript-module", "path": "dist/types/MediaGalleryMenuVerticalAlign.js", "declarations": [ { "kind": "enum", "name": "MediaGalleryMenuVerticalAlign", "description": "Types for the vertical alignment of the thumbnails menu of the `ui5-media-gallery` component.", "_ui5privacy": "public", "members": [ { "kind": "field", "static": true, "privacy": "public", "description": "Displays the menu at the bottom of the reference control.", "default": "Bottom", "name": "Bottom", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "Displays the menu at the top of the reference control.", "default": "Top", "name": "Top", "readonly": true } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "MediaGalleryMenuVerticalAlign", "module": "dist/types/MediaGalleryMenuVerticalAlign.js" } } ] }, { "kind": "javascript-module", "path": "dist/types/NavigationLayoutMode.js", "declarations": [ { "kind": "enum", "name": "NavigationLayoutMode", "description": "Specifies the navigation layout mode.", "_ui5privacy": "public", "members": [ { "kind": "field", "static": true, "privacy": "public", "description": "Automatically calculates the navigation layout mode based on the screen width.\n`Collapsed` on small screens (screen width of 599px or less) and `Expanded` on larger screens (screen width of 600px or more).", "default": "Auto", "name": "Auto", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "Collapsed side navigation.", "default": "Collapsed", "name": "Collapsed", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "Expanded side navigation.", "default": "Expanded", "name": "Expanded", "readonly": true } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "NavigationLayoutMode", "module": "dist/types/NavigationLayoutMode.js" } } ] }, { "kind": "javascript-module", "path": "dist/types/NotificationListItemImportance.js", "declarations": [ { "kind": "enum", "name": "NotificationListItemImportance", "description": "Different types of NotificationListItemImportance.", "_ui5privacy": "public", "members": [ { "kind": "field", "static": true, "privacy": "public", "default": "Important", "name": "Important", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "default": "Standard", "name": "Standard", "readonly": true } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "NotificationListItemImportance", "module": "dist/types/NotificationListItemImportance.js" } } ] }, { "kind": "javascript-module", "path": "dist/types/PageBackgroundDesign.js", "declarations": [ { "kind": "enum", "name": "PageBackgroundDesign", "description": "Available Page Background Design.", "_ui5privacy": "public", "members": [ { "kind": "field", "static": true, "privacy": "public", "description": "Page background color when a List is set as the Page content.", "default": "List", "name": "List", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "A solid background color dependent on the theme.", "default": "Solid", "name": "Solid", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "Transparent background for the page.", "default": "Transparent", "name": "Transparent", "readonly": true } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "PageBackgroundDesign", "module": "dist/types/PageBackgroundDesign.js" } } ] }, { "kind": "javascript-module", "path": "dist/types/SearchMode.js", "declarations": [ { "kind": "enum", "name": "SearchMode", "description": "Search mode options.", "_ui5privacy": "public", "members": [ { "kind": "field", "static": true, "privacy": "public", "description": "Search field with default appearance.", "default": "Default", "name": "Default", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "Search field with additional scope select.", "default": "Scoped", "name": "Scoped", "readonly": true } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "SearchMode", "module": "dist/types/SearchMode.js" } } ] }, { "kind": "javascript-module", "path": "dist/types/SideContentFallDown.js", "declarations": [ { "kind": "enum", "name": "SideContentFallDown", "description": "SideContent FallDown options.", "_ui5privacy": "public", "members": [ { "kind": "field", "static": true, "privacy": "public", "description": "Side content falls down on breakpoints below L", "default": "BelowL", "name": "BelowL", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "Side content falls down on breakpoints below M", "default": "BelowM", "name": "BelowM", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "Side content falls down on breakpoints below XL", "default": "BelowXL", "name": "BelowXL", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "Side content falls down on breakpoint M and the minimum width for the side content", "default": "OnMinimumWidth", "name": "OnMinimumWidth", "readonly": true } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "SideContentFallDown", "module": "dist/types/SideContentFallDown.js" } } ] }, { "kind": "javascript-module", "path": "dist/types/SideContentPosition.js", "declarations": [ { "kind": "enum", "name": "SideContentPosition", "description": "Side Content position options.", "_ui5privacy": "public", "members": [ { "kind": "field", "static": true, "privacy": "public", "description": "The side content is on the right side of the main container\nin left-to-right mode and on the left side in right-to-left mode.", "default": "End", "name": "End", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "The side content is on the left side of the main container\nin left-to-right mode and on the right side in right-to-left mode.", "default": "Start", "name": "Start", "readonly": true } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "SideContentPosition", "module": "dist/types/SideContentPosition.js" } } ] }, { "kind": "javascript-module", "path": "dist/types/SideContentVisibility.js", "declarations": [ { "kind": "enum", "name": "SideContentVisibility", "description": "Side Content visibility options.", "_ui5privacy": "public", "members": [ { "kind": "field", "static": true, "privacy": "public", "description": "Show the side content on any breakpoint", "default": "AlwaysShow", "name": "AlwaysShow", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "Don't show the side content on any breakpoints", "default": "NeverShow", "name": "NeverShow", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "Show the side content on XL breakpoint", "default": "ShowAboveL", "name": "ShowAboveL", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "Show the side content on L and XL breakpoints", "default": "ShowAboveM", "name": "ShowAboveM", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "Show the side content on M, L and XL breakpoints", "default": "ShowAboveS", "name": "ShowAboveS", "readonly": true } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "SideContentVisibility", "module": "dist/types/SideContentVisibility.js" } } ] }, { "kind": "javascript-module", "path": "dist/types/SideNavigationItemDesign.js", "declarations": [ { "kind": "enum", "name": "SideNavigationItemDesign", "description": "SideNavigationItem designs.", "_ui5privacy": "public", "_ui5since": "2.7.0", "members": [ { "kind": "field", "static": true, "privacy": "public", "description": "Design for items that trigger an action, such as opening a dialog.\n\n**Note:** Items with this design must not have sub-items.\n\n**Note:** Items that open a dialog must set `hasPopup=\"dialog\"` via `accessibilityAttributes` property.", "default": "Action", "name": "Action", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "Design for items that perform navigation, contain navigation child items, or both.", "default": "Default", "name": "Default", "readonly": true } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "SideNavigationItemDesign", "module": "dist/types/SideNavigationItemDesign.js" } } ] }, { "kind": "javascript-module", "path": "dist/types/TimelineGrowingMode.js", "declarations": [ { "kind": "enum", "name": "TimelineGrowingMode", "description": "Timeline growing modes.", "_ui5privacy": "public", "_ui5since": "2.7.0", "members": [ { "kind": "field", "static": true, "privacy": "public", "description": "Event `load-more` is fired\nupon pressing a \"More\" button at the end.", "default": "Button", "name": "Button", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "The growing feature is not enabled.", "default": "None", "name": "None", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "Event `load-more` is fired upon scroll.", "default": "Scroll", "name": "Scroll", "readonly": true } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "TimelineGrowingMode", "module": "dist/types/TimelineGrowingMode.js" } } ] }, { "kind": "javascript-module", "path": "dist/types/TimelineLayout.js", "declarations": [ { "kind": "enum", "name": "TimelineLayout", "description": "Available Timeline layout orientation", "_ui5privacy": "public", "members": [ { "kind": "field", "static": true, "privacy": "public", "description": "Horizontal layout", "default": "Horizontal", "name": "Horizontal", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "Vertical layout\nDefault type", "default": "Vertical", "name": "Vertical", "readonly": true } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "TimelineLayout", "module": "dist/types/TimelineLayout.js" } } ] }, { "kind": "javascript-module", "path": "dist/types/UploadCollectionDnDMode.js", "declarations": [], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "UploadCollectionDnDOverlayMode", "module": "dist/types/UploadCollectionDnDMode.js" } } ] }, { "kind": "javascript-module", "path": "dist/types/UploadCollectionSelectionMode.js", "declarations": [ { "kind": "enum", "name": "UploadCollectionSelectionMode", "description": "Different UploadCollection selection modes.", "_ui5privacy": "public", "members": [ { "kind": "field", "static": true, "privacy": "public", "description": "Multi selection mode (more than one list item can be selected).", "default": "Multiple", "name": "Multiple", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "Default mode (no selection).", "default": "None", "name": "None", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "Right-positioned single selection mode (only one list item can be selected).", "default": "Single", "name": "Single", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "Selected item is highlighted and selection is changed upon arrow navigation\n(only one list item can be selected - this is always the focused item).", "default": "SingleAuto", "name": "SingleAuto", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "Selected item is highlighted but no selection element is visible\n(only one list item can be selected).", "default": "SingleEnd", "name": "SingleEnd", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "Left-positioned single selection mode (only one list item can be selected).", "default": "SingleStart", "name": "SingleStart", "readonly": true } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "UploadCollectionSelectionMode", "module": "dist/types/UploadCollectionSelectionMode.js" } } ] }, { "kind": "javascript-module", "path": "dist/types/UploadState.js", "declarations": [ { "kind": "enum", "name": "UploadState", "description": "Different types of UploadState.", "_ui5privacy": "public", "members": [ { "kind": "field", "static": true, "privacy": "public", "description": "The file has been uploaded successfully.", "default": "Complete", "name": "Complete", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "The file cannot be uploaded due to an error.", "default": "Error", "name": "Error", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "The file is awaiting an explicit command to start being uploaded.", "default": "Ready", "name": "Ready", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "The file is currently being uploaded.", "default": "Uploading", "name": "Uploading", "readonly": true } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "UploadState", "module": "dist/types/UploadState.js" } } ] }, { "kind": "javascript-module", "path": "dist/types/ViewSettingsDialogMode.js", "declarations": [ { "kind": "enum", "name": "ViewSettingsDialogMode", "description": "Different types of ViewSettings.", "_ui5privacy": "public", "members": [ { "kind": "field", "static": true, "privacy": "public", "_ui5since": "1.0.0-rc.16", "description": "Filter type", "default": "Filter", "name": "Filter", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "_ui5since": "2.13.0", "description": "Group type", "default": "Group", "name": "Group", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "_ui5since": "1.0.0-rc.16", "description": "Default type", "default": "Sort", "name": "Sort", "readonly": true } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "ViewSettingsDialogMode", "module": "dist/types/ViewSettingsDialogMode.js" } } ] }, { "kind": "javascript-module", "path": "dist/types/WizardContentLayout.js", "declarations": [ { "kind": "enum", "name": "WizardContentLayout", "description": "Enumeration for different content layouts of the `ui5-wizard`.", "_ui5privacy": "public", "members": [ { "kind": "field", "static": true, "privacy": "public", "description": "Display the content of the `ui5-wizard` as multiple steps in a scroll section.", "default": "MultipleSteps", "name": "MultipleSteps", "readonly": true }, { "kind": "field", "static": true, "privacy": "public", "description": "Display the content of the `ui5-wizard` as single step.", "default": "SingleStep", "name": "SingleStep", "readonly": true } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "WizardContentLayout", "module": "dist/types/WizardContentLayout.js" } } ] }, { "kind": "javascript-module", "path": "dist/upload-utils/UploadCollectionBodyDnD.js", "declarations": [], "exports": [] } ] }