|
1344 | 1344 | }
|
1345 | 1345 | ]
|
1346 | 1346 | },
|
| 1347 | + { |
| 1348 | + "kind": "javascript-module", |
| 1349 | + "path": "dist/types/NavigationLayoutMode.js", |
| 1350 | + "declarations": [ |
| 1351 | + { |
| 1352 | + "kind": "enum", |
| 1353 | + "name": "NavigationLayoutMode", |
| 1354 | + "description": "Specifies the navigation layout mode.", |
| 1355 | + "_ui5privacy": "public", |
| 1356 | + "members": [ |
| 1357 | + { |
| 1358 | + "kind": "field", |
| 1359 | + "static": true, |
| 1360 | + "privacy": "public", |
| 1361 | + "description": "Automatically calculates the navigation layout mode based on the screen device type.\n`Expanded` on desktop and `Collapsed` on tablet and phone.", |
| 1362 | + "default": "Auto", |
| 1363 | + "name": "Auto", |
| 1364 | + "readonly": true |
| 1365 | + }, |
| 1366 | + { |
| 1367 | + "kind": "field", |
| 1368 | + "static": true, |
| 1369 | + "privacy": "public", |
| 1370 | + "description": "Collapsed side navigation.", |
| 1371 | + "default": "Collapsed", |
| 1372 | + "name": "Collapsed", |
| 1373 | + "readonly": true |
| 1374 | + }, |
| 1375 | + { |
| 1376 | + "kind": "field", |
| 1377 | + "static": true, |
| 1378 | + "privacy": "public", |
| 1379 | + "description": "Expanded side navigation.", |
| 1380 | + "default": "Expanded", |
| 1381 | + "name": "Expanded", |
| 1382 | + "readonly": true |
| 1383 | + } |
| 1384 | + ] |
| 1385 | + } |
| 1386 | + ], |
| 1387 | + "exports": [ |
| 1388 | + { |
| 1389 | + "kind": "js", |
| 1390 | + "name": "default", |
| 1391 | + "declaration": { |
| 1392 | + "name": "NavigationLayoutMode", |
| 1393 | + "module": "dist/types/NavigationLayoutMode.js" |
| 1394 | + } |
| 1395 | + } |
| 1396 | + ] |
| 1397 | + }, |
1347 | 1398 | {
|
1348 | 1399 | "kind": "javascript-module",
|
1349 | 1400 | "path": "dist/types/NotificationListItemImportance.js",
|
|
2566 | 2617 | "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.",
|
2567 | 2618 | "privacy": "public"
|
2568 | 2619 | },
|
| 2620 | + { |
| 2621 | + "kind": "field", |
| 2622 | + "name": "accessibilityAttributes", |
| 2623 | + "type": { |
| 2624 | + "text": "DynamicSideContentAccessibilityAttributes", |
| 2625 | + "references": [ |
| 2626 | + { |
| 2627 | + "name": "DynamicSideContentAccessibilityAttributes", |
| 2628 | + "package": "@ui5/webcomponents-fiori", |
| 2629 | + "module": "dist/DynamicSideContent.js" |
| 2630 | + } |
| 2631 | + ] |
| 2632 | + }, |
| 2633 | + "default": "{}", |
| 2634 | + "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.", |
| 2635 | + "privacy": "public", |
| 2636 | + "_ui5since": "2.6.0" |
| 2637 | + }, |
2569 | 2638 | {
|
2570 | 2639 | "kind": "method",
|
2571 | 2640 | "name": "toggleContents",
|
|
2686 | 2755 | "type": {
|
2687 | 2756 | "text": "boolean"
|
2688 | 2757 | }
|
| 2758 | + }, |
| 2759 | + { |
| 2760 | + "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.", |
| 2761 | + "name": "accessibility-attributes", |
| 2762 | + "default": "{}", |
| 2763 | + "fieldName": "accessibilityAttributes", |
| 2764 | + "type": { |
| 2765 | + "text": "DynamicSideContentAccessibilityAttributes" |
| 2766 | + } |
2689 | 2767 | }
|
2690 | 2768 | ],
|
2691 | 2769 | "superclass": {
|
|
3790 | 3868 | "declarations": [
|
3791 | 3869 | {
|
3792 | 3870 | "kind": "class",
|
3793 |
| - "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 desktop and tablet devices, the side navigation remains visible and can\nbe expanded or collapsed using the `sideCollapsed` property. On phone devices, the side navigation\nis hidden by default but can be displayed using the same `sideCollapsed` property.\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-fiori/dist/NavigationLayout.js\";`", |
| 3871 | + "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 desktop and tablet devices, the side navigation is visible\nby default and can be expanded or collapsed using the `mode` property.\nOn phone devices, the side navigation is hidden by default and can\nbe displayed using the `mode` property.\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-fiori/dist/NavigationLayout.js\";`", |
3794 | 3872 | "name": "NavigationLayout",
|
3795 | 3873 | "slots": [
|
3796 | 3874 | {
|
|
3829 | 3907 | "members": [
|
3830 | 3908 | {
|
3831 | 3909 | "kind": "field",
|
3832 |
| - "name": "sideCollapsed", |
3833 |
| - "description": "Indicates whether the side navigation is collapsed.", |
3834 |
| - "default": "false", |
3835 |
| - "privacy": "public", |
| 3910 | + "name": "mode", |
3836 | 3911 | "type": {
|
3837 |
| - "text": "boolean" |
3838 |
| - } |
| 3912 | + "text": "NavigationLayoutMode", |
| 3913 | + "references": [ |
| 3914 | + { |
| 3915 | + "name": "NavigationLayoutMode", |
| 3916 | + "package": "@ui5/webcomponents-fiori", |
| 3917 | + "module": "dist/types/NavigationLayoutMode.js" |
| 3918 | + } |
| 3919 | + ] |
| 3920 | + }, |
| 3921 | + "default": "\"Auto\"", |
| 3922 | + "description": "Specifies the navigation layout mode.", |
| 3923 | + "privacy": "public" |
| 3924 | + }, |
| 3925 | + { |
| 3926 | + "kind": "method", |
| 3927 | + "name": "isSideCollapsed", |
| 3928 | + "return": { |
| 3929 | + "type": { |
| 3930 | + "text": "boolean" |
| 3931 | + } |
| 3932 | + }, |
| 3933 | + "description": "Gets whether the side navigation is collapsed.", |
| 3934 | + "privacy": "public" |
3839 | 3935 | }
|
3840 | 3936 | ],
|
3841 | 3937 | "attributes": [
|
3842 | 3938 | {
|
3843 |
| - "description": "Indicates whether the side navigation is collapsed.", |
3844 |
| - "name": "side-collapsed", |
3845 |
| - "default": "false", |
3846 |
| - "fieldName": "sideCollapsed", |
| 3939 | + "description": "Specifies the navigation layout mode.", |
| 3940 | + "name": "mode", |
| 3941 | + "default": "\"Auto\"", |
| 3942 | + "fieldName": "mode", |
3847 | 3943 | "type": {
|
3848 |
| - "text": "any" |
| 3944 | + "text": "\"Auto\" | \"Collapsed\" | \"Expanded\"" |
3849 | 3945 | }
|
3850 | 3946 | }
|
3851 | 3947 | ],
|
|
8158 | 8254 | }
|
8159 | 8255 | ]
|
8160 | 8256 | },
|
| 8257 | + { |
| 8258 | + "name": "open", |
| 8259 | + "_ui5privacy": "public", |
| 8260 | + "type": { |
| 8261 | + "text": "CustomEvent" |
| 8262 | + }, |
| 8263 | + "description": "Fired when a user menu is open.", |
| 8264 | + "_ui5Cancelable": false, |
| 8265 | + "_ui5allowPreventDefault": false, |
| 8266 | + "_ui5Bubbles": false, |
| 8267 | + "_ui5since": "2.6.0" |
| 8268 | + }, |
| 8269 | + { |
| 8270 | + "name": "close", |
| 8271 | + "_ui5privacy": "public", |
| 8272 | + "type": { |
| 8273 | + "text": "CustomEvent" |
| 8274 | + }, |
| 8275 | + "description": "Fired when a user menu is close.", |
| 8276 | + "_ui5Cancelable": false, |
| 8277 | + "_ui5allowPreventDefault": false, |
| 8278 | + "_ui5Bubbles": false, |
| 8279 | + "_ui5since": "2.6.0" |
| 8280 | + }, |
8161 | 8281 | {
|
8162 | 8282 | "name": "sign-out-click",
|
8163 | 8283 | "_ui5privacy": "public",
|
|
8167 | 8287 | "description": "Fired when the \"Sign Out\" button is selected.",
|
8168 | 8288 | "_ui5Cancelable": true,
|
8169 | 8289 | "_ui5allowPreventDefault": true,
|
8170 |
| - "_ui5Bubbles": false |
| 8290 | + "_ui5Bubbles": false, |
| 8291 | + "_ui5since": "2.6.0" |
8171 | 8292 | }
|
8172 | 8293 | ],
|
8173 | 8294 | "attributes": [
|
|
0 commit comments