1/* 2 * Copyright (c) 2021-2024 Huawei Device Co., Ltd. 3 * Licensed under the Apache License, Version 2.0 (the "License"); 4 * you may not use this file except in compliance with the License. 5 * You may obtain a copy of the License at 6 * 7 * http://www.apache.org/licenses/LICENSE-2.0 8 * 9 * Unless required by applicable law or agreed to in writing, software 10 * distributed under the License is distributed on an "AS IS" BASIS, 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 * See the License for the specific language governing permissions and 13 * limitations under the License. 14 */ 15 16/** 17 * @file 18 * @kit ArkUI 19 */ 20 21/** 22 * Import the SystemBarStyle type for Navigation. 23 * 24 * @typedef { import('../api/@ohos.window').default.SystemBarStyle } SystemBarStyle 25 * @syscap SystemCapability.ArkUI.ArkUI.Full 26 * @atomicservice 27 * @since 12 28 */ 29declare type SystemBarStyle = import('../api/@ohos.window').default.SystemBarStyle; 30 31/** 32 * Defines the navigation common title. 33 * 34 * @interface NavigationCommonTitle 35 * @syscap SystemCapability.ArkUI.ArkUI.Full 36 * @since 9 37 */ 38/** 39 * Defines the navigation common title. 40 * 41 * @interface NavigationCommonTitle 42 * @syscap SystemCapability.ArkUI.ArkUI.Full 43 * @crossplatform 44 * @since 10 45 */ 46/** 47 * Defines the navigation common title. 48 * 49 * @interface NavigationCommonTitle 50 * @syscap SystemCapability.ArkUI.ArkUI.Full 51 * @crossplatform 52 * @atomicservice 53 * @since 11 54 */ 55declare interface NavigationCommonTitle { 56 /** 57 * Sets the main title. 58 * 59 * @type { string } 60 * @syscap SystemCapability.ArkUI.ArkUI.Full 61 * @since 9 62 */ 63 /** 64 * Sets the main title. 65 * 66 * @type { string } 67 * @syscap SystemCapability.ArkUI.ArkUI.Full 68 * @crossplatform 69 * @since 10 70 */ 71 /** 72 * Sets the main title. 73 * 74 * @type { string } 75 * @syscap SystemCapability.ArkUI.ArkUI.Full 76 * @crossplatform 77 * @atomicservice 78 * @since 11 79 */ 80 main: string; 81 82 /** 83 * Sets the sub title. 84 * 85 * @type { string } 86 * @syscap SystemCapability.ArkUI.ArkUI.Full 87 * @since 9 88 */ 89 /** 90 * Sets the sub title. 91 * 92 * @type { string } 93 * @syscap SystemCapability.ArkUI.ArkUI.Full 94 * @crossplatform 95 * @since 10 96 */ 97 /** 98 * Sets the sub title. 99 * 100 * @type { string } 101 * @syscap SystemCapability.ArkUI.ArkUI.Full 102 * @crossplatform 103 * @atomicservice 104 * @since 11 105 */ 106 sub: string; 107} 108 109/** 110 * Defines the navigation custom title. 111 * 112 * @interface NavigationCustomTitle 113 * @syscap SystemCapability.ArkUI.ArkUI.Full 114 * @since 9 115 */ 116/** 117 * Defines the navigation custom title. 118 * 119 * @interface NavigationCustomTitle 120 * @syscap SystemCapability.ArkUI.ArkUI.Full 121 * @crossplatform 122 * @since 10 123 */ 124/** 125 * Defines the navigation custom title. 126 * 127 * @interface NavigationCustomTitle 128 * @syscap SystemCapability.ArkUI.ArkUI.Full 129 * @crossplatform 130 * @atomicservice 131 * @since 11 132 */ 133declare interface NavigationCustomTitle { 134 /** 135 * Sets the custom title builder. 136 * 137 * @type { CustomBuilder } 138 * @syscap SystemCapability.ArkUI.ArkUI.Full 139 * @since 9 140 */ 141 /** 142 * Sets the custom title builder. 143 * 144 * @type { CustomBuilder } 145 * @syscap SystemCapability.ArkUI.ArkUI.Full 146 * @crossplatform 147 * @since 10 148 */ 149 /** 150 * Sets the custom title builder. 151 * 152 * @type { CustomBuilder } 153 * @syscap SystemCapability.ArkUI.ArkUI.Full 154 * @crossplatform 155 * @atomicservice 156 * @since 11 157 */ 158 builder: CustomBuilder; 159 160 /** 161 * Sets the custom title height. 162 * 163 * @type { TitleHeight | Length } 164 * @syscap SystemCapability.ArkUI.ArkUI.Full 165 * @since 9 166 */ 167 /** 168 * Sets the custom title height. 169 * 170 * @type { TitleHeight | Length } 171 * @syscap SystemCapability.ArkUI.ArkUI.Full 172 * @crossplatform 173 * @since 10 174 */ 175 /** 176 * Sets the custom title height. 177 * 178 * @type { TitleHeight | Length } 179 * @syscap SystemCapability.ArkUI.ArkUI.Full 180 * @crossplatform 181 * @atomicservice 182 * @since 11 183 */ 184 height: TitleHeight | Length; 185} 186 187 188/** 189 * Navigation mode 190 * 191 * @enum { number } 192 * @syscap SystemCapability.ArkUI.ArkUI.Full 193 * @since 9 194 */ 195/** 196 * Navigation mode 197 * 198 * @enum { number } 199 * @syscap SystemCapability.ArkUI.ArkUI.Full 200 * @crossplatform 201 * @since 10 202 */ 203/** 204 * Navigation mode 205 * 206 * @enum { number } 207 * @syscap SystemCapability.ArkUI.ArkUI.Full 208 * @crossplatform 209 * @atomicservice 210 * @since 11 211 */ 212declare enum NavigationMode { 213 /** 214 * The navigation bar and the content area are displayed in stack. 215 * 216 * @syscap SystemCapability.ArkUI.ArkUI.Full 217 * @since 9 218 */ 219 /** 220 * The navigation bar and the content area are displayed in stack. 221 * 222 * @syscap SystemCapability.ArkUI.ArkUI.Full 223 * @crossplatform 224 * @since 10 225 */ 226 /** 227 * The navigation bar and the content area are displayed in stack. 228 * 229 * @syscap SystemCapability.ArkUI.ArkUI.Full 230 * @crossplatform 231 * @atomicservice 232 * @since 11 233 */ 234 Stack, 235 236 /** 237 * The navigation bar and the content area are displayed side by side. 238 * 239 * @syscap SystemCapability.ArkUI.ArkUI.Full 240 * @since 9 241 */ 242 /** 243 * The navigation bar and the content area are displayed side by side. 244 * 245 * @syscap SystemCapability.ArkUI.ArkUI.Full 246 * @crossplatform 247 * @since 10 248 */ 249 /** 250 * The navigation bar and the content area are displayed side by side. 251 * 252 * @syscap SystemCapability.ArkUI.ArkUI.Full 253 * @crossplatform 254 * @atomicservice 255 * @since 11 256 */ 257 Split, 258 259 /** 260 * If the window width is greater than 520vp, the navigation component is displayed in split mode. 261 * Otherwise it's displayed in stack mode. 262 * 263 * @syscap SystemCapability.ArkUI.ArkUI.Full 264 * @since 9 265 */ 266 /** 267 * If the window width is greater than the sum of minNavBarWidth and minContentWidth, the navigation component is displayed in split mode. 268 * Otherwise it's displayed in stack mode. 269 * 270 * @syscap SystemCapability.ArkUI.ArkUI.Full 271 * @crossplatform 272 * @since 10 273 */ 274 /** 275 * If the window width is greater than the sum of minNavBarWidth and minContentWidth, the navigation component is displayed in split mode. 276 * Otherwise it's displayed in stack mode. 277 * 278 * @syscap SystemCapability.ArkUI.ArkUI.Full 279 * @crossplatform 280 * @atomicservice 281 * @since 11 282 */ 283 Auto, 284} 285 286/** 287 * Navigation bar position 288 * 289 * @enum { number } 290 * @syscap SystemCapability.ArkUI.ArkUI.Full 291 * @since 9 292 */ 293/** 294 * Navigation bar position 295 * 296 * @enum { number } 297 * @syscap SystemCapability.ArkUI.ArkUI.Full 298 * @crossplatform 299 * @since 10 300 */ 301/** 302 * Navigation bar position 303 * 304 * @enum { number } 305 * @syscap SystemCapability.ArkUI.ArkUI.Full 306 * @crossplatform 307 * @atomicservice 308 * @since 11 309 */ 310declare enum NavBarPosition { 311 /** 312 * The navigation bar is on the Start of the container 313 * 314 * @syscap SystemCapability.ArkUI.ArkUI.Full 315 * @since 9 316 */ 317 /** 318 * The navigation bar is on the Start of the container 319 * 320 * @syscap SystemCapability.ArkUI.ArkUI.Full 321 * @crossplatform 322 * @since 10 323 */ 324 /** 325 * The navigation bar is on the Start of the container 326 * 327 * @syscap SystemCapability.ArkUI.ArkUI.Full 328 * @crossplatform 329 * @atomicservice 330 * @since 11 331 */ 332 Start, 333 334 /** 335 * The navigation bar is on the End of the container 336 * 337 * @syscap SystemCapability.ArkUI.ArkUI.Full 338 * @since 9 339 */ 340 /** 341 * The navigation bar is on the End of the container 342 * 343 * @syscap SystemCapability.ArkUI.ArkUI.Full 344 * @crossplatform 345 * @since 10 346 */ 347 /** 348 * The navigation bar is on the End of the container 349 * 350 * @syscap SystemCapability.ArkUI.ArkUI.Full 351 * @crossplatform 352 * @atomicservice 353 * @since 11 354 */ 355 End, 356} 357 358/** 359 * Navigation title mode. 360 * 361 * @enum { number } 362 * @syscap SystemCapability.ArkUI.ArkUI.Full 363 * @since 8 364 */ 365/** 366 * Navigation title mode. 367 * 368 * @enum { number } 369 * @syscap SystemCapability.ArkUI.ArkUI.Full 370 * @crossplatform 371 * @since 10 372 */ 373/** 374 * Navigation title mode. 375 * 376 * @enum { number } 377 * @syscap SystemCapability.ArkUI.ArkUI.Full 378 * @crossplatform 379 * @atomicservice 380 * @since 11 381 */ 382declare enum NavigationTitleMode { 383 /** 384 * The title is free mode. 385 * 386 * @syscap SystemCapability.ArkUI.ArkUI.Full 387 * @since 8 388 */ 389 /** 390 * The title is free mode. 391 * 392 * @syscap SystemCapability.ArkUI.ArkUI.Full 393 * @crossplatform 394 * @since 10 395 */ 396 /** 397 * The title is free mode. 398 * 399 * @syscap SystemCapability.ArkUI.ArkUI.Full 400 * @crossplatform 401 * @atomicservice 402 * @since 11 403 */ 404 Free = 0, 405 406 /** 407 * The title is full mode. 408 * 409 * @syscap SystemCapability.ArkUI.ArkUI.Full 410 * @since 8 411 */ 412 /** 413 * The title is full mode. 414 * 415 * @syscap SystemCapability.ArkUI.ArkUI.Full 416 * @crossplatform 417 * @since 10 418 */ 419 /** 420 * The title is full mode. 421 * 422 * @syscap SystemCapability.ArkUI.ArkUI.Full 423 * @crossplatform 424 * @atomicservice 425 * @since 11 426 */ 427 Full, 428 429 /** 430 * The title is mini mode. 431 * 432 * @syscap SystemCapability.ArkUI.ArkUI.Full 433 * @since 8 434 */ 435 /** 436 * The title is mini mode. 437 * 438 * @syscap SystemCapability.ArkUI.ArkUI.Full 439 * @crossplatform 440 * @since 10 441 */ 442 /** 443 * The title is mini mode. 444 * 445 * @syscap SystemCapability.ArkUI.ArkUI.Full 446 * @crossplatform 447 * @atomicservice 448 * @since 11 449 */ 450 Mini, 451} 452 453/** 454 * Navigation menu item, include menu icon and menu info 455 * 456 * @interface NavigationMenuItem 457 * @syscap SystemCapability.ArkUI.ArkUI.Full 458 * @since 8 459 */ 460/** 461 * Navigation menu item, include menu icon and menu info 462 * 463 * @interface NavigationMenuItem 464 * @syscap SystemCapability.ArkUI.ArkUI.Full 465 * @crossplatform 466 * @since 10 467 */ 468/** 469 * Navigation menu item, include menu icon and menu info 470 * 471 * @interface NavigationMenuItem 472 * @syscap SystemCapability.ArkUI.ArkUI.Full 473 * @crossplatform 474 * @atomicservice 475 * @since 11 476 */ 477declare interface NavigationMenuItem { 478 /** 479 * The value of navigation menu item. 480 * 481 * @type { string } 482 * @syscap SystemCapability.ArkUI.ArkUI.Full 483 * @since 8 484 */ 485 /** 486 * The value of navigation menu item. 487 * 488 * @type { string } 489 * @syscap SystemCapability.ArkUI.ArkUI.Full 490 * @crossplatform 491 * @since 10 492 */ 493 /** 494 * The value of navigation menu item. 495 * 496 * @type { string } 497 * @syscap SystemCapability.ArkUI.ArkUI.Full 498 * @crossplatform 499 * @atomicservice 500 * @since 11 501 */ 502 value: string; 503 504 /** 505 * The icon of navigation menu item. 506 * 507 * @type { ?string } 508 * @syscap SystemCapability.ArkUI.ArkUI.Full 509 * @since 8 510 */ 511 /** 512 * The icon of navigation menu item. 513 * 514 * @type { ?string } 515 * @syscap SystemCapability.ArkUI.ArkUI.Full 516 * @crossplatform 517 * @since 10 518 */ 519 /** 520 * The icon of navigation menu item. 521 * 522 * @type { ?string } 523 * @syscap SystemCapability.ArkUI.ArkUI.Full 524 * @crossplatform 525 * @atomicservice 526 * @since 11 527 */ 528 icon?: string; 529 530 /** 531 * The symbol of navigation menu item. 532 * 533 * @type { ?SymbolGlyphModifier } 534 * @syscap SystemCapability.ArkUI.ArkUI.Full 535 * @crossplatform 536 * @atomicservice 537 * @since 12 538 */ 539 symbolIcon?: SymbolGlyphModifier; 540 541 /** 542 * Whether to enable this menu item. 543 * 544 * @type { ?boolean } 545 * @syscap SystemCapability.ArkUI.ArkUI.Full 546 * @crossplatform 547 * @atomicservice 548 * @since 12 549 */ 550 isEnabled?: boolean; 551 552 /** 553 * Trigger by navigation menu item click. 554 * 555 * @type { ?(() => void) } 556 * @syscap SystemCapability.ArkUI.ArkUI.Full 557 * @since 8 558 */ 559 /** 560 * Trigger by navigation menu item click. 561 * 562 * @type { ?function } 563 * @syscap SystemCapability.ArkUI.ArkUI.Full 564 * @crossplatform 565 * @since 10 566 */ 567 /** 568 * Trigger by navigation menu item click. 569 * 570 * @type { ?function } 571 * @syscap SystemCapability.ArkUI.ArkUI.Full 572 * @crossplatform 573 * @atomicservice 574 * @since 11 575 */ 576 action?: () => void; 577} 578 579/** 580 * Indicates the information of the popped page. 581 * 582 * @interface PopInfo 583 * @syscap SystemCapability.ArkUI.ArkUI.Full 584 * @crossplatform 585 * @since 11 586 */ 587/** 588 * Indicates the information of the popped page. 589 * 590 * @interface PopInfo 591 * @syscap SystemCapability.ArkUI.ArkUI.Full 592 * @crossplatform 593 * @atomicservice 594 * @since 12 595 */ 596declare interface PopInfo { 597 /** 598 * The info of the popped page. 599 * 600 * @type { NavPathInfo } 601 * @syscap SystemCapability.ArkUI.ArkUI.Full 602 * @crossplatform 603 * @since 11 604 */ 605 /** 606 * The info of the popped page. 607 * 608 * @type { NavPathInfo } 609 * @syscap SystemCapability.ArkUI.ArkUI.Full 610 * @crossplatform 611 * @atomicservice 612 * @since 12 613 */ 614 info: NavPathInfo; 615 616 /** 617 * The result of the popped page. 618 * 619 * @type { Object } 620 * @syscap SystemCapability.ArkUI.ArkUI.Full 621 * @crossplatform 622 * @since 11 623 */ 624 /** 625 * The result of the popped page. 626 * 627 * @type { Object } 628 * @syscap SystemCapability.ArkUI.ArkUI.Full 629 * @crossplatform 630 * @atomicservice 631 * @since 12 632 */ 633 result: Object; 634} 635 636/** 637 * Indicates the information of NavDestination. 638 * 639 * @syscap SystemCapability.ArkUI.ArkUI.Full 640 * @crossplatform 641 * @since 10 642 */ 643/** 644 * Indicates the information of NavDestination. 645 * 646 * @syscap SystemCapability.ArkUI.ArkUI.Full 647 * @crossplatform 648 * @atomicservice 649 * @since 11 650 */ 651declare class NavPathInfo { 652 /** 653 * Creates an instance of NavPathInfo. 654 * 655 * @param { string } name - The name of NavDestination. 656 * @param { unknown } param - The detailed parameter of the NavDestination. 657 * @syscap SystemCapability.ArkUI.ArkUI.Full 658 * @crossplatform 659 * @since 10 660 */ 661 /** 662 * Creates an instance of NavPathInfo. 663 * 664 * @param { string } name - The name of NavDestination. 665 * @param { unknown } param - The detailed parameter of the NavDestination. 666 * @param { ?import('../api/@ohos.base').Callback<PopInfo> } onPop - The callback when next page returns. 667 * @syscap SystemCapability.ArkUI.ArkUI.Full 668 * @crossplatform 669 * @atomicservice 670 * @since 11 671 */ 672 /** 673 * Creates an instance of NavPathInfo. 674 * 675 * @param { string } name - The name of NavDestination. 676 * @param { unknown } param - The detailed parameter of the NavDestination. 677 * @param { ?import('../api/@ohos.base').Callback<PopInfo> } onPop - The callback when next page returns. 678 * @param { ?boolean } isEntry - Indicates whether it is an entry destination. 679 * @syscap SystemCapability.ArkUI.ArkUI.Full 680 * @crossplatform 681 * @atomicservice 682 * @since 12 683 */ 684 constructor(name: string, param: unknown, onPop?: import('../api/@ohos.base').Callback<PopInfo>, isEntry?: boolean); 685 686 /** 687 * The name of NavDestination. 688 * 689 * @type { string } 690 * @syscap SystemCapability.ArkUI.ArkUI.Full 691 * @crossplatform 692 * @since 10 693 */ 694 /** 695 * The name of NavDestination. 696 * 697 * @type { string } 698 * @syscap SystemCapability.ArkUI.ArkUI.Full 699 * @crossplatform 700 * @atomicservice 701 * @since 11 702 */ 703 name: string; 704 705 /** 706 * The detailed parameter of the NavDestination. 707 * 708 * @type { ?unknown } 709 * @syscap SystemCapability.ArkUI.ArkUI.Full 710 * @crossplatform 711 * @since 10 712 */ 713 /** 714 * The detailed parameter of the NavDestination. 715 * 716 * @type { ?unknown } 717 * @syscap SystemCapability.ArkUI.ArkUI.Full 718 * @crossplatform 719 * @atomicservice 720 * @since 11 721 */ 722 param?: unknown; 723 724 /** 725 * The callback when next page returns. 726 * 727 * @type { ?import('../api/@ohos.base').Callback<PopInfo> } 728 * @syscap SystemCapability.ArkUI.ArkUI.Full 729 * @crossplatform 730 * @since 11 731 */ 732 /** 733 * The callback when next page returns. 734 * 735 * @type { ?import('../api/@ohos.base').Callback<PopInfo> } 736 * @syscap SystemCapability.ArkUI.ArkUI.Full 737 * @crossplatform 738 * @atomicservice 739 * @since 12 740 */ 741 onPop?: import('../api/@ohos.base').Callback<PopInfo>; 742 743 /** 744 * Indicates whether it is an entry destination. 745 * 746 * @type { ?boolean } 747 * @syscap SystemCapability.ArkUI.ArkUI.Full 748 * @crossplatform 749 * @atomicservice 750 * @since 12 751 */ 752 isEntry?: boolean; 753} 754 755/** 756 * Defines the mode of stack operation. 757 * 758 * @enum { number } 759 * @syscap SystemCapability.ArkUI.ArkUI.Full 760 * @crossplatform 761 * @atomicservice 762 * @since 12 763 */ 764declare enum LaunchMode { 765 /** 766 * The default mode of stack operation. 767 * 768 * @syscap SystemCapability.ArkUI.ArkUI.Full 769 * @crossplatform 770 * @atomicservice 771 * @since 12 772 */ 773 STANDARD = 0, 774 775 /** 776 * When the NavDestination with a specified name exists, it will be moved to top of stack, 777 * otherwise, the behavior will be consistent with the STANDARD mode. 778 * 779 * @syscap SystemCapability.ArkUI.ArkUI.Full 780 * @crossplatform 781 * @atomicservice 782 * @since 12 783 */ 784 MOVE_TO_TOP_SINGLETON = 1, 785 786 /** 787 * When the NavDestination with a specified name exists, the stack will pop until that NavDestination, 788 * otherwise, the behavior will be consistent with the STANDARD mode. 789 * 790 * @syscap SystemCapability.ArkUI.ArkUI.Full 791 * @crossplatform 792 * @atomicservice 793 * @since 12 794 */ 795 POP_TO_SINGLETON = 2, 796 797 /** 798 * Forced to create a new NavDestination instance. 799 * 800 * @syscap SystemCapability.ArkUI.ArkUI.Full 801 * @crossplatform 802 * @atomicservice 803 * @since 12 804 */ 805 NEW_INSTANCE = 3, 806} 807 808/** 809 * Indicates the options of stack operation. 810 * 811 * @interface NavigationOptions 812 * @syscap SystemCapability.ArkUI.ArkUI.Full 813 * @crossplatform 814 * @atomicservice 815 * @since 12 816 */ 817declare interface NavigationOptions { 818 /** 819 * Indicates the launchMode of stack operation. 820 * 821 * @type { ?LaunchMode } 822 * @syscap SystemCapability.ArkUI.ArkUI.Full 823 * @crossplatform 824 * @atomicservice 825 * @since 12 826 */ 827 launchMode?: LaunchMode; 828 829 /** 830 * Indicates whether the transition is animated. 831 * 832 * @type { ?boolean } 833 * @syscap SystemCapability.ArkUI.ArkUI.Full 834 * @crossplatform 835 * @atomicservice 836 * @since 12 837 */ 838 animated?: boolean; 839} 840 841/** 842 * Indicates the information of NavDestinations. Providers methods for controlling destination page in the stack 843 * 844 * @syscap SystemCapability.ArkUI.ArkUI.Full 845 * @crossplatform 846 * @since 10 847 */ 848/** 849 * Indicates the information of NavDestinations. Providers methods for controlling destination page in the stack 850 * 851 * @syscap SystemCapability.ArkUI.ArkUI.Full 852 * @crossplatform 853 * @atomicservice 854 * @since 11 855 */ 856declare class NavPathStack { 857 /** 858 * Creates an instance of NavPathStack. 859 * 860 * @syscap SystemCapability.ArkUI.ArkUI.Full 861 * @crossplatform 862 * @since 10 863 */ 864 /** 865 * Creates an instance of NavPathStack. 866 * 867 * @syscap SystemCapability.ArkUI.ArkUI.Full 868 * @crossplatform 869 * @atomicservice 870 * @since 11 871 */ 872 constructor(); 873 874 /** 875 * Pushes the NavDestination into the stack. 876 * 877 * @param { NavPathInfo } info - Indicates the NavDestination to be pushed. 878 * @syscap SystemCapability.ArkUI.ArkUI.Full 879 * @crossplatform 880 * @since 10 881 */ 882 /** 883 * Pushes the NavDestination into the stack. 884 * 885 * @param { NavPathInfo } info - Indicates the NavDestination to be pushed. 886 * @param { boolean } [animated] - Indicates whether the transition is animated. 887 * @syscap SystemCapability.ArkUI.ArkUI.Full 888 * @crossplatform 889 * @atomicservice 890 * @since 11 891 */ 892 pushPath(info: NavPathInfo, animated?: boolean): void; 893 894 /** 895 * Pushes the NavDestination into the stack. 896 * 897 * @param { NavPathInfo } info - Indicates the NavDestination to be pushed. 898 * @param { NavigationOptions } [options] - Indicates options of stack operation. 899 * @syscap SystemCapability.ArkUI.ArkUI.Full 900 * @crossplatform 901 * @atomicservice 902 * @since 12 903 */ 904 pushPath(info: NavPathInfo, options?: NavigationOptions): void; 905 906 /** 907 * Pushes the NavDestination into the stack. 908 * 909 * @param { NavPathInfo } info - Indicates the NavDestination to be pushed. 910 * @param { boolean } [animated] - Indicates whether the transition is animated. 911 * @returns { Promise<void> } The promise returned by the function. 912 * @throws { BusinessError } 401 - Parameter error. Possible causes: 913 * 1. Mandatory parameters are left unspecified. 914 * 2. Incorrect parameters types. 915 * 3. Parameter verification failed. 916 * @throws { BusinessError } 100001 - Internal error. 917 * @throws { BusinessError } 100005 - Builder function not registered. 918 * @throws { BusinessError } 100006 - NavDestination not found. 919 * @syscap SystemCapability.ArkUI.ArkUI.Full 920 * @crossplatform 921 * @since 11 922 */ 923 /** 924 * Pushes the NavDestination into the stack. 925 * 926 * @param { NavPathInfo } info - Indicates the NavDestination to be pushed. 927 * @param { boolean } [animated] - Indicates whether the transition is animated. 928 * @returns { Promise<void> } The promise returned by the function. 929 * @throws { BusinessError } 401 - Parameter error. Possible causes: 930 * 1. Mandatory parameters are left unspecified. 931 * 2. Incorrect parameters types. 932 * 3. Parameter verification failed. 933 * @throws { BusinessError } 100001 - Internal error. 934 * @throws { BusinessError } 100005 - Builder function not registered. 935 * @throws { BusinessError } 100006 - NavDestination not found. 936 * @syscap SystemCapability.ArkUI.ArkUI.Full 937 * @crossplatform 938 * @atomicservice 939 * @since 12 940 */ 941 pushDestination(info: NavPathInfo, animated?: boolean): Promise<void>; 942 943 /** 944 * Pushes the NavDestination into the stack. 945 * 946 * @param { NavPathInfo } info - Indicates the NavDestination to be pushed. 947 * @param { NavigationOptions } [options] - Indicates options of stack operation. 948 * @returns { Promise<void> } The promise returned by the function. 949 * @throws { BusinessError } 401 - Parameter error. Possible causes: 950 * 1. Mandatory parameters are left unspecified. 951 * 2. Incorrect parameters types. 952 * 3. Parameter verification failed. 953 * @throws { BusinessError } 100001 - Internal error. 954 * @throws { BusinessError } 100005 - Builder function not registered. 955 * @throws { BusinessError } 100006 - NavDestination not found. 956 * @syscap SystemCapability.ArkUI.ArkUI.Full 957 * @crossplatform 958 * @atomicservice 959 * @since 12 960 */ 961 pushDestination(info: NavPathInfo, options?: NavigationOptions): Promise<void>; 962 963 /** 964 * Pushes the specified NavDestination into the stack. 965 * 966 * @param { string } name - Indicates the name of the NavDestination to be pushed. 967 * @param { unknown } param - Indicates the detailed parameter of the NavDestination to be pushed. 968 * @syscap SystemCapability.ArkUI.ArkUI.Full 969 * @crossplatform 970 * @since 10 971 */ 972 /** 973 * Pushes the specified NavDestination into the stack. 974 * 975 * @param { string } name - Indicates the name of the NavDestination to be pushed. 976 * @param { unknown } param - Indicates the detailed parameter of the NavDestination to be pushed. 977 * @param { boolean } [animated] - Indicates whether the transition is animated. 978 * @syscap SystemCapability.ArkUI.ArkUI.Full 979 * @crossplatform 980 * @atomicservice 981 * @since 11 982 */ 983 pushPathByName(name: string, param: unknown, animated?: boolean): void; 984 985 /** 986 * Pushes the specified NavDestination into the stack. 987 * 988 * @param { string } name - Indicates the name of the NavDestination to be pushed. 989 * @param { Object } param - Indicates the detailed parameter of the NavDestination to be pushed. 990 * @param { import('../api/@ohos.base').Callback<PopInfo> } onPop - The callback when next page returns. 991 * @param { boolean } [animated] - Indicates whether the transition is animated. 992 * @syscap SystemCapability.ArkUI.ArkUI.Full 993 * @crossplatform 994 * @since 11 995 */ 996 /** 997 * Pushes the specified NavDestination into the stack. 998 * 999 * @param { string } name - Indicates the name of the NavDestination to be pushed. 1000 * @param { Object } param - Indicates the detailed parameter of the NavDestination to be pushed. 1001 * @param { import('../api/@ohos.base').Callback<PopInfo> } onPop - The callback when next page returns. 1002 * @param { boolean } [animated] - Indicates whether the transition is animated. 1003 * @syscap SystemCapability.ArkUI.ArkUI.Full 1004 * @crossplatform 1005 * @atomicservice 1006 * @since 12 1007 */ 1008 pushPathByName(name: string, param: Object, onPop: import('../api/@ohos.base').Callback<PopInfo>, animated?: boolean): void; 1009 1010 /** 1011 * Pushes the specified NavDestination into the stack. 1012 * 1013 * @param { string } name - Indicates the name of the NavDestination to be pushed. 1014 * @param { Object } param - Indicates the detailed parameter of the NavDestination to be pushed. 1015 * @param { boolean } [animated] - Indicates whether the transition is animated. 1016 * @returns { Promise<void> } The promise returned by the function. 1017 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1018 * 1. Mandatory parameters are left unspecified. 1019 * 2. Incorrect parameters types. 1020 * 3. Parameter verification failed. 1021 * @throws { BusinessError } 100001 - Internal error. 1022 * @throws { BusinessError } 100005 - Builder function not registered. 1023 * @throws { BusinessError } 100006 - NavDestination not found. 1024 * @syscap SystemCapability.ArkUI.ArkUI.Full 1025 * @crossplatform 1026 * @since 11 1027 */ 1028 /** 1029 * Pushes the specified NavDestination into the stack. 1030 * 1031 * @param { string } name - Indicates the name of the NavDestination to be pushed. 1032 * @param { Object } param - Indicates the detailed parameter of the NavDestination to be pushed. 1033 * @param { boolean } [animated] - Indicates whether the transition is animated. 1034 * @returns { Promise<void> } The promise returned by the function. 1035 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1036 * 1. Mandatory parameters are left unspecified. 1037 * 2. Incorrect parameters types. 1038 * 3. Parameter verification failed. 1039 * @throws { BusinessError } 100001 - Internal error. 1040 * @throws { BusinessError } 100005 - Builder function not registered. 1041 * @throws { BusinessError } 100006 - NavDestination not found. 1042 * @syscap SystemCapability.ArkUI.ArkUI.Full 1043 * @crossplatform 1044 * @atomicservice 1045 * @since 12 1046 */ 1047 pushDestinationByName(name: string, param: Object, animated?: boolean): Promise<void>; 1048 1049 /** 1050 * Pushes the specified NavDestination into the stack. 1051 * 1052 * @param { string } name - Indicates the name of the NavDestination to be pushed. 1053 * @param { Object } param - Indicates the detailed parameter of the NavDestination to be pushed. 1054 * @param { import('../api/@ohos.base').Callback<PopInfo> } onPop - The callback when next page returns. 1055 * @param { boolean } [animated] - Indicates whether the transition is animated. 1056 * @returns { Promise<void> } The promise returned by the function. 1057 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1058 * 1. Mandatory parameters are left unspecified. 1059 * 2. Incorrect parameters types. 1060 * 3. Parameter verification failed. 1061 * @throws { BusinessError } 100001 - Internal error. 1062 * @throws { BusinessError } 100005 - Builder function not registered. 1063 * @throws { BusinessError } 100006 - NavDestination not found. 1064 * @syscap SystemCapability.ArkUI.ArkUI.Full 1065 * @crossplatform 1066 * @since 11 1067 */ 1068 /** 1069 * Pushes the specified NavDestination into the stack. 1070 * 1071 * @param { string } name - Indicates the name of the NavDestination to be pushed. 1072 * @param { Object } param - Indicates the detailed parameter of the NavDestination to be pushed. 1073 * @param { import('../api/@ohos.base').Callback<PopInfo> } onPop - The callback when next page returns. 1074 * @param { boolean } [animated] - Indicates whether the transition is animated. 1075 * @returns { Promise<void> } The promise returned by the function. 1076 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1077 * 1. Mandatory parameters are left unspecified. 1078 * 2. Incorrect parameters types. 1079 * 3. Parameter verification failed. 1080 * @throws { BusinessError } 100001 - Internal error. 1081 * @throws { BusinessError } 100005 - Builder function not registered. 1082 * @throws { BusinessError } 100006 - NavDestination not found. 1083 * @syscap SystemCapability.ArkUI.ArkUI.Full 1084 * @crossplatform 1085 * @atomicservice 1086 * @since 12 1087 */ 1088 pushDestinationByName(name: string, param: Object, onPop: import('../api/@ohos.base').Callback<PopInfo>, animated?: boolean): Promise<void>; 1089 1090 /** 1091 * Replace the current NavDestination with the specific one.The current NavDestination will be destroyed. 1092 * 1093 * @param { NavPathInfo } info - Indicates the new NavDestination in top of the stack. 1094 * @param { boolean } [animated] - Indicates whether the transition is animated. 1095 * @syscap SystemCapability.ArkUI.ArkUI.Full 1096 * @crossplatform 1097 * @since 11 1098 */ 1099 /** 1100 * Replace the current NavDestination with the specific one.The current NavDestination will be destroyed. 1101 * 1102 * @param { NavPathInfo } info - Indicates the new NavDestination in top of the stack. 1103 * @param { boolean } [animated] - Indicates whether the transition is animated. 1104 * @syscap SystemCapability.ArkUI.ArkUI.Full 1105 * @crossplatform 1106 * @atomicservice 1107 * @since 12 1108 */ 1109 replacePath(info: NavPathInfo, animated?: boolean): void; 1110 1111 /** 1112 * Replace the current NavDestination with the specific one.The current NavDestination will be destroyed. 1113 * 1114 * @param { NavPathInfo } info - Indicates the new NavDestination in top of the stack. 1115 * @param { NavigationOptions } [options] - Indicates options of stack operation. 1116 * @syscap SystemCapability.ArkUI.ArkUI.Full 1117 * @crossplatform 1118 * @atomicservice 1119 * @since 12 1120 */ 1121 replacePath(info: NavPathInfo, options?: NavigationOptions): void; 1122 1123 /** 1124 * Replace the current NavDestination with the specific one.The current NavDestination will be destroyed. 1125 * 1126 * @param { string } name - Indicates name of the new NavDestination in top of stack. 1127 * @param { Object } param - Indicates the detailed parameter of the new NavDestination in top of the stack. 1128 * @param { boolean } [animated] - Indicates whether the transition is animated. 1129 * @syscap SystemCapability.ArkUI.ArkUI.Full 1130 * @crossplatform 1131 * @since 11 1132 */ 1133 /** 1134 * Replace the current NavDestination with the specific one.The current NavDestination will be destroyed. 1135 * 1136 * @param { string } name - Indicates name of the new NavDestination in top of stack. 1137 * @param { Object } param - Indicates the detailed parameter of the new NavDestination in top of the stack. 1138 * @param { boolean } [animated] - Indicates whether the transition is animated. 1139 * @syscap SystemCapability.ArkUI.ArkUI.Full 1140 * @crossplatform 1141 * @atomicservice 1142 * @since 12 1143 */ 1144 replacePathByName(name: string, param: Object, animated?: boolean): void; 1145 1146 /** 1147 * Remove the specified NavDestinations by indexes. 1148 * 1149 * @param { Array<number> } indexes - Indicates the indexes of the NavDestinations to be removed. 1150 * @returns { number } Returns the number of removed pages. Invalid indexes will be ignored. 1151 * @syscap SystemCapability.ArkUI.ArkUI.Full 1152 * @crossplatform 1153 * @since 11 1154 */ 1155 /** 1156 * Remove the specified NavDestinations by indexes. 1157 * 1158 * @param { Array<number> } indexes - Indicates the indexes of the NavDestinations to be removed. 1159 * @returns { number } Returns the number of removed pages. Invalid indexes will be ignored. 1160 * @syscap SystemCapability.ArkUI.ArkUI.Full 1161 * @crossplatform 1162 * @atomicservice 1163 * @since 12 1164 */ 1165 removeByIndexes(indexes: Array<number>): number; 1166 1167 /** 1168 * Remove the specified NavDestination by name. 1169 * 1170 * @param { string } name - Indicates the name of the NavDestination to be removed. 1171 * @returns { number } Returns the number of removed NavDestinations. 1172 * @syscap SystemCapability.ArkUI.ArkUI.Full 1173 * @crossplatform 1174 * @since 11 1175 */ 1176 /** 1177 * Remove the specified NavDestination by name. 1178 * 1179 * @param { string } name - Indicates the name of the NavDestination to be removed. 1180 * @returns { number } Returns the number of removed NavDestinations. 1181 * @syscap SystemCapability.ArkUI.ArkUI.Full 1182 * @crossplatform 1183 * @atomicservice 1184 * @since 12 1185 */ 1186 removeByName(name: string): number; 1187 1188 /** 1189 * Remove the specified NavDestination by its navDestinationId. 1190 * 1191 * @param { string } navDestinationId - Indicates the navDestinationId of the NavDestination to be removed. 1192 * @returns { boolean } Returns true if remove successfully, otherwise returns false. 1193 * @syscap SystemCapability.ArkUI.ArkUI.Full 1194 * @crossplatform 1195 * @atomicservice 1196 * @since 12 1197 */ 1198 removeByNavDestinationId(navDestinationId: string): boolean; 1199 1200 /** 1201 * Pops the top NavDestination out of the stack. 1202 * 1203 * @returns { NavPathInfo | undefined } Returns the top NavPathInfo if the stack is not empty, otherwise returns undefined. 1204 * @syscap SystemCapability.ArkUI.ArkUI.Full 1205 * @crossplatform 1206 * @since 10 1207 */ 1208 /** 1209 * Pops the top NavDestination out of the stack. 1210 * 1211 * @param { boolean } [animated] - Indicates whether the transition is animated. 1212 * @returns { NavPathInfo | undefined } Returns the top NavPathInfo if the stack is not empty, otherwise returns undefined. 1213 * @syscap SystemCapability.ArkUI.ArkUI.Full 1214 * @crossplatform 1215 * @atomicservice 1216 * @since 11 1217 */ 1218 pop(animated?: boolean): NavPathInfo | undefined; 1219 1220 /** 1221 * Pops the top NavDestination out of the stack. 1222 * 1223 * @param { Object } result - The result of the NavDestination. 1224 * @param { boolean } [animated] - Indicates whether the transition is animated. 1225 * @returns { NavPathInfo | undefined } Returns the top NavPathInfo if the stack is not empty, otherwise returns undefined. 1226 * @syscap SystemCapability.ArkUI.ArkUI.Full 1227 * @crossplatform 1228 * @since 11 1229 */ 1230 /** 1231 * Pops the top NavDestination out of the stack. 1232 * 1233 * @param { Object } result - The result of the NavDestination. 1234 * @param { boolean } [animated] - Indicates whether the transition is animated. 1235 * @returns { NavPathInfo | undefined } Returns the top NavPathInfo if the stack is not empty, otherwise returns undefined. 1236 * @syscap SystemCapability.ArkUI.ArkUI.Full 1237 * @crossplatform 1238 * @atomicservice 1239 * @since 12 1240 */ 1241 pop(result: Object, animated?: boolean): NavPathInfo | undefined; 1242 1243 /** 1244 * Pops the specified NavDestination out of the stack. 1245 * 1246 * @param { string } name - Indicates the name of the NavDestination to be popped. 1247 * @returns { number } Returns the index of the NavDestination if it exists in the stack, otherwise returns -1; 1248 * @syscap SystemCapability.ArkUI.ArkUI.Full 1249 * @crossplatform 1250 * @since 10 1251 */ 1252 /** 1253 * Pops the specified NavDestination out of the stack. 1254 * 1255 * @param { string } name - Indicates the name of the NavDestination to be popped. 1256 * @param { boolean } [animated] - Indicates whether the transition is animated. 1257 * @returns { number } Returns the index of the NavDestination if it exists in the stack, otherwise returns -1; 1258 * @syscap SystemCapability.ArkUI.ArkUI.Full 1259 * @crossplatform 1260 * @atomicservice 1261 * @since 11 1262 */ 1263 popToName(name: string, animated?: boolean): number; 1264 1265 /** 1266 * Pops the specified NavDestination out of the stack. 1267 * 1268 * @param { string } name - Indicates the name of the NavDestination to be popped. 1269 * @param { Object } result - The result of the NavDestination. 1270 * @param { boolean } [animated] - Indicates whether the transition is animated. 1271 * @returns { number } Returns the index of the NavDestination if it exists in the stack, otherwise returns -1; 1272 * @syscap SystemCapability.ArkUI.ArkUI.Full 1273 * @crossplatform 1274 * @since 11 1275 */ 1276 /** 1277 * Pops the specified NavDestination out of the stack. 1278 * 1279 * @param { string } name - Indicates the name of the NavDestination to be popped. 1280 * @param { Object } result - The result of the NavDestination. 1281 * @param { boolean } [animated] - Indicates whether the transition is animated. 1282 * @returns { number } Returns the index of the NavDestination if it exists in the stack, otherwise returns -1; 1283 * @syscap SystemCapability.ArkUI.ArkUI.Full 1284 * @crossplatform 1285 * @atomicservice 1286 * @since 12 1287 */ 1288 popToName(name: string, result: Object, animated?: boolean): number; 1289 1290 /** 1291 * Pops the specified NavDestination out of the stack. 1292 * 1293 * @param { number } index - Indicates the index of the NavDestination to be popped. 1294 * @syscap SystemCapability.ArkUI.ArkUI.Full 1295 * @crossplatform 1296 * @since 10 1297 */ 1298 /** 1299 * Pops the specified NavDestination out of the stack. 1300 * 1301 * @param { number } index - Indicates the index of the NavDestination to be popped. 1302 * @param { boolean } [animated] - Indicates whether the transition is animated. 1303 * @syscap SystemCapability.ArkUI.ArkUI.Full 1304 * @crossplatform 1305 * @atomicservice 1306 * @since 11 1307 */ 1308 popToIndex(index: number, animated?: boolean): void; 1309 1310 /** 1311 * Pops the specified NavDestination out of the stack. 1312 * 1313 * @param { number } index - Indicates the index of the NavDestination to be popped. 1314 * @param { Object } result - The result of the NavDestination. 1315 * @param { boolean } [animated] - Indicates whether the transition is animated. 1316 * @syscap SystemCapability.ArkUI.ArkUI.Full 1317 * @crossplatform 1318 * @atomicservice 1319 * @since 11 1320 */ 1321 popToIndex(index: number, result: Object, animated?: boolean): void; 1322 1323 /** 1324 * Moves the specified NavDestination to stack top. 1325 * 1326 * @param { string } name - Indicates the name of the NavDestination to be moved to the top. 1327 * @returns { number } Returns the index of the NavDestination if it exists in the stack, otherwise returns -1; 1328 * @syscap SystemCapability.ArkUI.ArkUI.Full 1329 * @crossplatform 1330 * @since 10 1331 */ 1332 /** 1333 * Moves the specified NavDestination to stack top. 1334 * 1335 * @param { string } name - Indicates the name of the NavDestination to be moved to the top. 1336 * @param { boolean } [animated] - Indicates whether the transition is animated. 1337 * @returns { number } Returns the index of the NavDestination if it exists in the stack, otherwise returns -1; 1338 * @syscap SystemCapability.ArkUI.ArkUI.Full 1339 * @crossplatform 1340 * @atomicservice 1341 * @since 11 1342 */ 1343 moveToTop(name: string, animated?: boolean): number; 1344 1345 /** 1346 * Moves the specified NavDestination to stack top. 1347 * 1348 * @param { number } index - Indicates the index of the NavDestination to be moved to the top. 1349 * @syscap SystemCapability.ArkUI.ArkUI.Full 1350 * @crossplatform 1351 * @since 10 1352 */ 1353 /** 1354 * Moves the specified NavDestination to stack top. 1355 * 1356 * @param { number } index - Indicates the index of the NavDestination to be moved to the top. 1357 * @param { boolean } [animated] - Indicates whether the transition is animated. 1358 * @syscap SystemCapability.ArkUI.ArkUI.Full 1359 * @crossplatform 1360 * @atomicservice 1361 * @since 11 1362 */ 1363 moveIndexToTop(index: number, animated?: boolean): void; 1364 1365 /** 1366 * Clears the stack. 1367 * 1368 * @syscap SystemCapability.ArkUI.ArkUI.Full 1369 * @crossplatform 1370 * @since 10 1371 */ 1372 /** 1373 * Clears the stack. 1374 * 1375 * @param { boolean } [animated] - Indicates whether the transition is animated. 1376 * @syscap SystemCapability.ArkUI.ArkUI.Full 1377 * @crossplatform 1378 * @atomicservice 1379 * @since 11 1380 */ 1381 clear(animated?: boolean): void; 1382 1383 /** 1384 * Obtains all the NavDestination name in the stack. 1385 * 1386 * @returns { Array<string> } Returns all the NavDestination name in the stack; 1387 * @syscap SystemCapability.ArkUI.ArkUI.Full 1388 * @crossplatform 1389 * @since 10 1390 */ 1391 /** 1392 * Obtains all the NavDestination name in the stack. 1393 * 1394 * @returns { Array<string> } Returns all the NavDestination name in the stack; 1395 * @syscap SystemCapability.ArkUI.ArkUI.Full 1396 * @crossplatform 1397 * @atomicservice 1398 * @since 11 1399 */ 1400 getAllPathName(): Array<string>; 1401 1402 /** 1403 * Obtains the param of the specified NavDestination. 1404 * 1405 * @param { number } index - Indicates the index of the NavDestination. 1406 * @returns { unknown | undefined } Returns the detailed parameter of the NavDestination if it exists in the stack, otherwise returns undefined; 1407 * @syscap SystemCapability.ArkUI.ArkUI.Full 1408 * @crossplatform 1409 * @since 10 1410 */ 1411 /** 1412 * Obtains the param of the specified NavDestination. 1413 * 1414 * @param { number } index - Indicates the index of the NavDestination. 1415 * @returns { unknown | undefined } Returns the detailed parameter of the NavDestination if it exists in the stack, otherwise returns undefined; 1416 * @syscap SystemCapability.ArkUI.ArkUI.Full 1417 * @crossplatform 1418 * @atomicservice 1419 * @since 11 1420 */ 1421 getParamByIndex(index: number): unknown | undefined; 1422 1423 /** 1424 * Obtains the param of the specified NavDestination. 1425 * 1426 * @param { string } name - Indicates the name of the NavDestination. 1427 * @returns { Array<unknown> } Returns the detailed parameter of all the NavDestinations. 1428 * @syscap SystemCapability.ArkUI.ArkUI.Full 1429 * @crossplatform 1430 * @since 10 1431 */ 1432 /** 1433 * Obtains the param of the specified NavDestination. 1434 * 1435 * @param { string } name - Indicates the name of the NavDestination. 1436 * @returns { Array<unknown> } Returns the detailed parameter of all the NavDestinations. 1437 * @syscap SystemCapability.ArkUI.ArkUI.Full 1438 * @crossplatform 1439 * @atomicservice 1440 * @since 11 1441 */ 1442 getParamByName(name: string): Array<unknown>; 1443 1444 /** 1445 * Obtains the index of the specified NavDestination. 1446 * 1447 * @param { string } name - Indicates the name of the NavDestination. 1448 * @returns { Array<number> } Returns the index of all the NavDestinations. 1449 * @syscap SystemCapability.ArkUI.ArkUI.Full 1450 * @crossplatform 1451 * @since 10 1452 */ 1453 /** 1454 * Obtains the index of the specified NavDestination. 1455 * 1456 * @param { string } name - Indicates the name of the NavDestination. 1457 * @returns { Array<number> } Returns the index of all the NavDestinations. 1458 * @syscap SystemCapability.ArkUI.ArkUI.Full 1459 * @crossplatform 1460 * @atomicservice 1461 * @since 11 1462 */ 1463 getIndexByName(name: string): Array<number>; 1464 1465 /** 1466 * Obtains the parent of the current stack. 1467 * 1468 * @returns { NavPathStack | null } Returns the parent of the current stack. If no parent, it returns null. 1469 * @syscap SystemCapability.ArkUI.ArkUI.Full 1470 * @crossplatform 1471 * @atomicservice 1472 * @since 11 1473 */ 1474 getParent(): NavPathStack | null; 1475 1476 /** 1477 * Obtains the size of the stack. 1478 * 1479 * @returns { number } Returns the size of the stack. 1480 * @syscap SystemCapability.ArkUI.ArkUI.Full 1481 * @crossplatform 1482 * @since 10 1483 */ 1484 /** 1485 * Obtains the size of the stack. 1486 * 1487 * @returns { number } Returns the size of the stack. 1488 * @syscap SystemCapability.ArkUI.ArkUI.Full 1489 * @crossplatform 1490 * @atomicservice 1491 * @since 11 1492 */ 1493 size(): number; 1494 1495 /** 1496 * disable or enable all transition animation in this navigation stack. 1497 * 1498 * @param { boolean } value - Indicates whether the transition is animated. 1499 * @syscap SystemCapability.ArkUI.ArkUI.Full 1500 * @crossplatform 1501 * @since 11 1502 */ 1503 /** 1504 * disable or enable all transition animation in this navigation stack. 1505 * 1506 * @param { boolean } value - Indicates whether the transition is animated. 1507 * @syscap SystemCapability.ArkUI.ArkUI.Full 1508 * @crossplatform 1509 * @atomicservice 1510 * @since 12 1511 */ 1512 disableAnimation(value: boolean): void; 1513 1514 /** 1515 * set navigation transition interception.It will be called in navPathStack changes or navigation mode changes. 1516 * 1517 * @param { NavigationInterception } interception - the instance to intercept in navigation changes. 1518 * @syscap SystemCapability.ArkUI.ArkUI.Full 1519 * @crossplatform 1520 * @atomicservice 1521 * @since 12 1522 */ 1523 setInterception(interception: NavigationInterception): void; 1524} 1525 1526/** 1527 * Navigation home name 1528 * 1529 * @typedef { 'navBar' } NavBar 1530 * @syscap SystemCapability.ArkUI.ArkUI.Full 1531 * @crossplatform 1532 * @atomicservice 1533 * @since 12 1534 */ 1535declare type NavBar = 'navBar' 1536 1537/** 1538 * navigation interception callback using in willShow and didShow 1539 * 1540 * @typedef { function } InterceptionShowCallback 1541 * @param { NavDestinationContext | NavBar } from - Indicates the starting NavDestination or NavBar. 1542 * @param { NavDestinationContext | NavBar } to - Indicates the destination NavDestination or NavBar. 1543 * @param { NavigationOperation } operation - Indicates the type of stack operation. 1544 * @param { boolean } isAnimated - Indicates whether the transition is animated. 1545 * @syscap SystemCapability.ArkUI.ArkUI.Full 1546 * @crossplatform 1547 * @atomicservice 1548 * @since 12 1549 */ 1550declare type InterceptionShowCallback = (from: NavDestinationContext|NavBar, to: NavDestinationContext|NavBar, operation: NavigationOperation, isAnimated: boolean) => void; 1551 1552/** 1553 * navigation interception callback using in navigation mode change 1554 * 1555 * @typedef { function } InterceptionModeCallback 1556 * @param { NavigationMode } mode - Indicates the mode of Navigation. 1557 * @syscap SystemCapability.ArkUI.ArkUI.Full 1558 * @crossplatform 1559 * @atomicservice 1560 * @since 12 1561 */ 1562declare type InterceptionModeCallback = (mode: NavigationMode) => void; 1563 1564/** 1565 * Provide navigation transition interception 1566 * 1567 * @interface NavigationInterception 1568 * @syscap SystemCapability.ArkUI.ArkUI.Full 1569 * @crossplatform 1570 * @atomicservice 1571 * @since 12 1572 */ 1573declare interface NavigationInterception { 1574 /** 1575 * Called before destination transition.NavPathStack can be changed in this callback, 1576 * it will takes effect during this transition.For details, see { @Link InterceptionShowCallback}. 1577 * 1578 * @type { ?InterceptionShowCallback } 1579 * @syscap SystemCapability.ArkUI.ArkUI.Full 1580 * @crossplatform 1581 * @atomicservice 1582 * @since 12 1583 */ 1584 willShow?: InterceptionShowCallback; 1585 1586 /** 1587 * Called after destination transition.For details, see { @Link InterceptionShowCallback}. 1588 * 1589 * @type { ?InterceptionShowCallback } 1590 * @syscap SystemCapability.ArkUI.ArkUI.Full 1591 * @crossplatform 1592 * @atomicservice 1593 * @since 12 1594 */ 1595 didShow?: InterceptionShowCallback; 1596 1597 /** 1598 * Called when navigation mode changed.For details, see { @Link InterceptionModeCallback}. 1599 * 1600 * @type { ?InterceptionModeCallback } 1601 * @syscap SystemCapability.ArkUI.ArkUI.Full 1602 * @crossplatform 1603 * @atomicservice 1604 * @since 12 1605 */ 1606 modeChange?: InterceptionModeCallback; 1607} 1608 1609/** 1610 * Provide navigator view interface 1611 * 1612 * @interface NavigationInterface 1613 * @syscap SystemCapability.ArkUI.ArkUI.Full 1614 * @since 8 1615 */ 1616/** 1617 * Provide navigator view interface 1618 * 1619 * @interface NavigationInterface 1620 * @syscap SystemCapability.ArkUI.ArkUI.Full 1621 * @crossplatform 1622 * @since 10 1623 */ 1624/** 1625 * Provide navigator view interface 1626 * 1627 * @interface NavigationInterface 1628 * @syscap SystemCapability.ArkUI.ArkUI.Full 1629 * @crossplatform 1630 * @atomicservice 1631 * @since 11 1632 */ 1633interface NavigationInterface { 1634 /** 1635 * Called when the navigator view interface is used. 1636 * 1637 * @returns { NavigationAttribute } 1638 * @syscap SystemCapability.ArkUI.ArkUI.Full 1639 * @since 8 1640 */ 1641 /** 1642 * Called when the navigator view interface is used. 1643 * 1644 * @returns { NavigationAttribute } 1645 * @syscap SystemCapability.ArkUI.ArkUI.Full 1646 * @crossplatform 1647 * @since 10 1648 */ 1649 /** 1650 * Called when the navigator view interface is used. 1651 * 1652 * @returns { NavigationAttribute } 1653 * @syscap SystemCapability.ArkUI.ArkUI.Full 1654 * @crossplatform 1655 * @atomicservice 1656 * @since 11 1657 */ 1658 (): NavigationAttribute; 1659 1660 /** 1661 * Called when the navigator view interface is used, with route table provided. 1662 * 1663 * @param { NavPathStack } pathInfos - The stack of the route table. 1664 * @returns { NavigationAttribute } Returns the instance of the NavigationAttribute. 1665 * @syscap SystemCapability.ArkUI.ArkUI.Full 1666 * @crossplatform 1667 * @since 10 1668 */ 1669 /** 1670 * Called when the navigator view interface is used, with route table provided. 1671 * 1672 * @param { NavPathStack } pathInfos - The stack of the route table. 1673 * @returns { NavigationAttribute } Returns the instance of the NavigationAttribute. 1674 * @syscap SystemCapability.ArkUI.ArkUI.Full 1675 * @crossplatform 1676 * @atomicservice 1677 * @since 11 1678 */ 1679 (pathInfos: NavPathStack): NavigationAttribute; 1680} 1681 1682/** 1683 * Defines the status of toolbar item and it is used in the ToolbarItem interface. 1684 * 1685 * @enum { number } 1686 * @syscap SystemCapability.ArkUI.ArkUI.Full 1687 * @since 10 1688 */ 1689/** 1690 * Defines the status of toolbar item and it is used in the ToolbarItem interface. 1691 * 1692 * @enum { number } 1693 * @syscap SystemCapability.ArkUI.ArkUI.Full 1694 * @crossplatform 1695 * @atomicservice 1696 * @since 11 1697 */ 1698declare enum ToolbarItemStatus { 1699 /** 1700 * Normal state of toolbar item. 1701 * 1702 * @syscap SystemCapability.ArkUI.ArkUI.Full 1703 * @since 10 1704 */ 1705 /** 1706 * Normal state of toolbar item. 1707 * 1708 * @syscap SystemCapability.ArkUI.ArkUI.Full 1709 * @crossplatform 1710 * @atomicservice 1711 * @since 11 1712 */ 1713 NORMAL = 0, 1714 1715 /** 1716 * Disable state of toolbar item. 1717 * 1718 * @syscap SystemCapability.ArkUI.ArkUI.Full 1719 * @since 10 1720 */ 1721 /** 1722 * Disable state of toolbar item. 1723 * 1724 * @syscap SystemCapability.ArkUI.ArkUI.Full 1725 * @crossplatform 1726 * @atomicservice 1727 * @since 11 1728 */ 1729 DISABLED = 1, 1730 1731 /** 1732 * Active state of toolbar item. 1733 * 1734 * @syscap SystemCapability.ArkUI.ArkUI.Full 1735 * @since 10 1736 */ 1737 /** 1738 * Active state of toolbar item. 1739 * 1740 * @syscap SystemCapability.ArkUI.ArkUI.Full 1741 * @crossplatform 1742 * @atomicservice 1743 * @since 11 1744 */ 1745 ACTIVE = 2, 1746} 1747 1748/** 1749 * Defines the operation of current navigation transition. 1750 * 1751 * @enum { number } 1752 * @syscap SystemCapability.ArkUI.ArkUI.Full 1753 * @crossplatform 1754 * @since 11 1755 */ 1756/** 1757 * Defines the operation of current navigation transition. 1758 * 1759 * @enum { number } 1760 * @syscap SystemCapability.ArkUI.ArkUI.Full 1761 * @crossplatform 1762 * @atomicservice 1763 * @since 12 1764 */ 1765declare enum NavigationOperation { 1766 /** 1767 * Push operation of navigation transition. 1768 * 1769 * @syscap SystemCapability.ArkUI.ArkUI.Full 1770 * @crossplatform 1771 * @since 11 1772 */ 1773 /** 1774 * Push operation of navigation transition. 1775 * 1776 * @syscap SystemCapability.ArkUI.ArkUI.Full 1777 * @crossplatform 1778 * @atomicservice 1779 * @since 12 1780 */ 1781 PUSH = 1, 1782 1783 /** 1784 * Pop operation of navigation transition. 1785 * 1786 * @syscap SystemCapability.ArkUI.ArkUI.Full 1787 * @crossplatform 1788 * @since 11 1789 */ 1790 /** 1791 * Pop operation of navigation transition. 1792 * 1793 * @syscap SystemCapability.ArkUI.ArkUI.Full 1794 * @crossplatform 1795 * @atomicservice 1796 * @since 12 1797 */ 1798 POP = 2, 1799 1800 /** 1801 * Replace operation of navigation transition. 1802 * 1803 * @syscap SystemCapability.ArkUI.ArkUI.Full 1804 * @crossplatform 1805 * @since 11 1806 */ 1807 /** 1808 * Replace operation of navigation transition. 1809 * 1810 * @syscap SystemCapability.ArkUI.ArkUI.Full 1811 * @crossplatform 1812 * @atomicservice 1813 * @since 12 1814 */ 1815 REPLACE = 3, 1816} 1817 1818/** 1819 * Defines configurable parameters for toolbar item. 1820 * 1821 * @interface ToolbarItem 1822 * @syscap SystemCapability.ArkUI.ArkUI.Full 1823 * @since 10 1824 */ 1825/** 1826 * Defines configurable parameters for toolbar item. 1827 * 1828 * @interface ToolbarItem 1829 * @syscap SystemCapability.ArkUI.ArkUI.Full 1830 * @atomicservice 1831 * @since 11 1832 */ 1833declare interface ToolbarItem { 1834 /** 1835 * The value of navigation toolbar item. 1836 * 1837 * @type { ResourceStr } 1838 * @syscap SystemCapability.ArkUI.ArkUI.Full 1839 * @crossplatform 1840 * @since 10 1841 */ 1842 /** 1843 * The value of navigation toolbar item. 1844 * 1845 * @type { ResourceStr } 1846 * @syscap SystemCapability.ArkUI.ArkUI.Full 1847 * @crossplatform 1848 * @atomicservice 1849 * @since 11 1850 */ 1851 value: ResourceStr; 1852 1853 /** 1854 * The icon of navigation toolbar item. 1855 * 1856 * @type { ?ResourceStr } 1857 * @syscap SystemCapability.ArkUI.ArkUI.Full 1858 * @crossplatform 1859 * @since 10 1860 */ 1861 /** 1862 * The icon of navigation toolbar item. 1863 * 1864 * @type { ?ResourceStr } 1865 * @syscap SystemCapability.ArkUI.ArkUI.Full 1866 * @crossplatform 1867 * @atomicservice 1868 * @since 11 1869 */ 1870 icon?: ResourceStr; 1871 1872 /** 1873 * The symbol of navigation toolbar item. 1874 * 1875 * @type { ?SymbolGlyphModifier } 1876 * @syscap SystemCapability.ArkUI.ArkUI.Full 1877 * @crossplatform 1878 * @atomicservice 1879 * @since 12 1880 */ 1881 symbolIcon?: SymbolGlyphModifier; 1882 1883 /** 1884 * Trigger by navigation toolbar item click. 1885 * 1886 * @type { ?function } 1887 * @syscap SystemCapability.ArkUI.ArkUI.Full 1888 * @crossplatform 1889 * @since 10 1890 */ 1891 /** 1892 * Trigger by navigation toolbar item click. 1893 * 1894 * @type { ?function } 1895 * @syscap SystemCapability.ArkUI.ArkUI.Full 1896 * @crossplatform 1897 * @atomicservice 1898 * @since 11 1899 */ 1900 action?: () => void; 1901 1902 /** 1903 * The state of navigation toolbar item. 1904 * 1905 * @type { ?ToolbarItemStatus } 1906 * @syscap SystemCapability.ArkUI.ArkUI.Full 1907 * @crossplatform 1908 * @since 10 1909 */ 1910 /** 1911 * The state of navigation toolbar item. 1912 * 1913 * @type { ?ToolbarItemStatus } 1914 * @syscap SystemCapability.ArkUI.ArkUI.Full 1915 * @crossplatform 1916 * @atomicservice 1917 * @since 11 1918 */ 1919 status?: ToolbarItemStatus; 1920 1921 /** 1922 * The icon of navigation toolbar item in active state. 1923 * 1924 * @type { ?ResourceStr } 1925 * @syscap SystemCapability.ArkUI.ArkUI.Full 1926 * @crossplatform 1927 * @since 10 1928 */ 1929 /** 1930 * The icon of navigation toolbar item in active state. 1931 * 1932 * @type { ?ResourceStr } 1933 * @syscap SystemCapability.ArkUI.ArkUI.Full 1934 * @crossplatform 1935 * @atomicservice 1936 * @since 11 1937 */ 1938 activeIcon?: ResourceStr; 1939 1940 /** 1941 * The symbol of navigation toolbar item in active state. 1942 * 1943 * @type { ?SymbolGlyphModifier } 1944 * @syscap SystemCapability.ArkUI.ArkUI.Full 1945 * @crossplatform 1946 * @atomicservice 1947 * @since 12 1948 */ 1949 activeSymbolIcon?: SymbolGlyphModifier; 1950} 1951 1952/** 1953 * Indicates the options of Navigation's Titlebar. 1954 * 1955 * @interface NavigationTitleOptions 1956 * @syscap SystemCapability.ArkUI.ArkUI.Full 1957 * @crossplatform 1958 * @atomicservice 1959 * @since 11 1960 */ 1961declare interface NavigationTitleOptions { 1962 /** 1963 * Background color. 1964 * 1965 * @type { ?ResourceColor } 1966 * @syscap SystemCapability.ArkUI.ArkUI.Full 1967 * @crossplatform 1968 * @atomicservice 1969 * @since 11 1970 */ 1971 backgroundColor?: ResourceColor; 1972 1973 /** 1974 * Background blur style. 1975 * 1976 * @type { ?BlurStyle } 1977 * @syscap SystemCapability.ArkUI.ArkUI.Full 1978 * @crossplatform 1979 * @atomicservice 1980 * @since 11 1981 */ 1982 backgroundBlurStyle?: BlurStyle; 1983 1984 /** 1985 * Set title bar style. 1986 * 1987 * @type { ?BarStyle } 1988 * @default BarStyle.STANDARD 1989 * @syscap SystemCapability.ArkUI.ArkUI.Full 1990 * @crossplatform 1991 * @atomicservice 1992 * @since 12 1993 */ 1994 barStyle?: BarStyle; 1995 1996 /** 1997 * Set title bar start padding. 1998 * 1999 * @type { ?LengthMetrics } 2000 * @default LengthMetrics.resource($r('sys.float.margin_left')) 2001 * @syscap SystemCapability.ArkUI.ArkUI.Full 2002 * @crossplatform 2003 * @atomicservice 2004 * @since 12 2005 */ 2006 paddingStart?: LengthMetrics; 2007 2008 /** 2009 * Set title bar end padding. 2010 * 2011 * @type { ?LengthMetrics } 2012 * @default LengthMetrics.resource($r('sys.float.margin_right')) 2013 * @syscap SystemCapability.ArkUI.ArkUI.Full 2014 * @crossplatform 2015 * @atomicservice 2016 * @since 12 2017 */ 2018 paddingEnd?: LengthMetrics; 2019 2020 /** 2021 * Text modifier for main title. 2022 * 2023 * @type { ?TextModifier } 2024 * @syscap SystemCapability.ArkUI.ArkUI.Full 2025 * @crossplatform 2026 * @atomicservice 2027 * @since 13 2028 */ 2029 mainTitleModifier?: TextModifier; 2030 2031 /** 2032 * Text modifier for sub title. 2033 * 2034 * @type { ?TextModifier } 2035 * @syscap SystemCapability.ArkUI.ArkUI.Full 2036 * @crossplatform 2037 * @atomicservice 2038 * @since 13 2039 */ 2040 subTitleModifier?: TextModifier; 2041 2042 /** 2043 * Defines whether to respond to the hover mode. 2044 * 2045 * @type { ?boolean } 2046 * @default false 2047 * @syscap SystemCapability.ArkUI.ArkUI.Full 2048 * @crossplatform 2049 * @atomicservice 2050 * @since 13 2051 */ 2052 enableHoverMode?: boolean; 2053} 2054 2055/** 2056 * Declare BarStyle enum. 2057 * 2058 * @enum { number } 2059 * @syscap SystemCapability.ArkUI.ArkUI.Full 2060 * @crossplatform 2061 * @atomicservice 2062 * @since 12 2063 */ 2064declare enum BarStyle { 2065 /** 2066 * Standard style means that the bar and content area are column layouts. 2067 * 2068 * @syscap SystemCapability.ArkUI.ArkUI.Full 2069 * @crossplatform 2070 * @atomicservice 2071 * @since 12 2072 */ 2073 STANDARD = 0, 2074 2075 /** 2076 * Stack style means that the bar and content area are stack layouts. 2077 * 2078 * @syscap SystemCapability.ArkUI.ArkUI.Full 2079 * @crossplatform 2080 * @atomicservice 2081 * @since 12 2082 */ 2083 STACK = 1, 2084} 2085 2086/** 2087 * Indicates the options of Navigation's Toolbar. 2088 * 2089 * @interface NavigationToolbarOptions 2090 * @syscap SystemCapability.ArkUI.ArkUI.Full 2091 * @crossplatform 2092 * @atomicservice 2093 * @since 11 2094 */ 2095declare interface NavigationToolbarOptions { 2096 /** 2097 * Background color. 2098 * 2099 * @type { ?ResourceColor } 2100 * @syscap SystemCapability.ArkUI.ArkUI.Full 2101 * @crossplatform 2102 * @atomicservice 2103 * @since 11 2104 */ 2105 backgroundColor?: ResourceColor; 2106 2107 /** 2108 * Background blur style. 2109 * 2110 * @type { ?BlurStyle } 2111 * @syscap SystemCapability.ArkUI.ArkUI.Full 2112 * @crossplatform 2113 * @atomicservice 2114 * @since 11 2115 */ 2116 backgroundBlurStyle?: BlurStyle; 2117} 2118 2119/** 2120 * Declare Navigation view properties. 2121 * 2122 * @extends CommonMethod<NavigationAttribute> 2123 * @syscap SystemCapability.ArkUI.ArkUI.Full 2124 * @since 8 2125 */ 2126/** 2127 * Declare Navigation view properties. 2128 * 2129 * @extends CommonMethod<NavigationAttribute> 2130 * @syscap SystemCapability.ArkUI.ArkUI.Full 2131 * @crossplatform 2132 * @since 10 2133 */ 2134/** 2135 * Declare Navigation view properties. 2136 * 2137 * @extends CommonMethod<NavigationAttribute> 2138 * @syscap SystemCapability.ArkUI.ArkUI.Full 2139 * @crossplatform 2140 * @atomicservice 2141 * @since 11 2142 */ 2143declare class NavigationAttribute extends CommonMethod<NavigationAttribute> { 2144 /** 2145 * Sets the width of navigation bar. 2146 * 2147 * @param { Length } value 2148 * @returns { NavigationAttribute } 2149 * @syscap SystemCapability.ArkUI.ArkUI.Full 2150 * @since 9 2151 */ 2152 /** 2153 * Sets the width of navigation bar. 2154 * 2155 * @param { Length } value 2156 * @returns { NavigationAttribute } 2157 * @syscap SystemCapability.ArkUI.ArkUI.Full 2158 * @crossplatform 2159 * @since 10 2160 */ 2161 /** 2162 * Sets the width of navigation bar. 2163 * 2164 * @param { Length } value 2165 * @returns { NavigationAttribute } 2166 * @syscap SystemCapability.ArkUI.ArkUI.Full 2167 * @crossplatform 2168 * @atomicservice 2169 * @since 11 2170 */ 2171 navBarWidth(value: Length): NavigationAttribute; 2172 2173 /** 2174 * Sets the position of navigation bar. 2175 * 2176 * @param { NavBarPosition } value 2177 * @returns { NavigationAttribute } 2178 * @syscap SystemCapability.ArkUI.ArkUI.Full 2179 * @since 9 2180 */ 2181 /** 2182 * Sets the position of navigation bar. 2183 * 2184 * @param { NavBarPosition } value 2185 * @returns { NavigationAttribute } 2186 * @syscap SystemCapability.ArkUI.ArkUI.Full 2187 * @crossplatform 2188 * @since 10 2189 */ 2190 /** 2191 * Sets the position of navigation bar. 2192 * 2193 * @param { NavBarPosition } value 2194 * @returns { NavigationAttribute } 2195 * @syscap SystemCapability.ArkUI.ArkUI.Full 2196 * @crossplatform 2197 * @atomicservice 2198 * @since 11 2199 */ 2200 navBarPosition(value: NavBarPosition): NavigationAttribute; 2201 2202 /** 2203 * Sets the minimum width and the maximum width of navigation bar. 2204 * 2205 * @param { [Dimension, Dimension] } value - The minimum and the maximum width of navigation bar. 2206 * @returns { NavigationAttribute } 2207 * @syscap SystemCapability.ArkUI.ArkUI.Full 2208 * @crossplatform 2209 * @since 10 2210 */ 2211 /** 2212 * Sets the minimum width and the maximum width of navigation bar. 2213 * 2214 * @param { [Dimension, Dimension] } value - The minimum and the maximum width of navigation bar. 2215 * @returns { NavigationAttribute } 2216 * @syscap SystemCapability.ArkUI.ArkUI.Full 2217 * @crossplatform 2218 * @atomicservice 2219 * @since 11 2220 */ 2221 navBarWidthRange(value: [Dimension, Dimension]): NavigationAttribute; 2222 2223 /** 2224 * Sets the minimum width of content. 2225 * 2226 * @param { Dimension } value - The minimum width of content. 2227 * @returns { NavigationAttribute } 2228 * @syscap SystemCapability.ArkUI.ArkUI.Full 2229 * @crossplatform 2230 * @since 10 2231 */ 2232 /** 2233 * Sets the minimum width of content. 2234 * 2235 * @param { Dimension } value - The minimum width of content. 2236 * @returns { NavigationAttribute } 2237 * @syscap SystemCapability.ArkUI.ArkUI.Full 2238 * @crossplatform 2239 * @atomicservice 2240 * @since 11 2241 */ 2242 minContentWidth(value: Dimension): NavigationAttribute; 2243 2244 /** 2245 * Sets the mode of navigation. 2246 * 2247 * @param { NavigationMode } value 2248 * @returns { NavigationAttribute } 2249 * @syscap SystemCapability.ArkUI.ArkUI.Full 2250 * @since 9 2251 */ 2252 /** 2253 * Sets the mode of navigation. 2254 * 2255 * @param { NavigationMode } value 2256 * @returns { NavigationAttribute } 2257 * @syscap SystemCapability.ArkUI.ArkUI.Full 2258 * @crossplatform 2259 * @since 10 2260 */ 2261 /** 2262 * Sets the mode of navigation. 2263 * 2264 * @param { NavigationMode } value 2265 * @returns { NavigationAttribute } 2266 * @syscap SystemCapability.ArkUI.ArkUI.Full 2267 * @crossplatform 2268 * @atomicservice 2269 * @since 11 2270 */ 2271 mode(value: NavigationMode): NavigationAttribute; 2272 2273 /** 2274 * Sets the back button icon. 2275 * 2276 * @param { string | PixelMap | Resource } value 2277 * @returns { NavigationAttribute } 2278 * @syscap SystemCapability.ArkUI.ArkUI.Full 2279 * @since 9 2280 */ 2281 /** 2282 * Sets the back button icon. 2283 * 2284 * @param { string | PixelMap | Resource } value 2285 * @returns { NavigationAttribute } 2286 * @syscap SystemCapability.ArkUI.ArkUI.Full 2287 * @crossplatform 2288 * @since 10 2289 */ 2290 /** 2291 * Sets the back button icon. 2292 * 2293 * @param { string | PixelMap | Resource } value 2294 * @returns { NavigationAttribute } 2295 * @syscap SystemCapability.ArkUI.ArkUI.Full 2296 * @crossplatform 2297 * @atomicservice 2298 * @since 11 2299 */ 2300 /** 2301 * Sets the back button icon. 2302 * 2303 * @param { string | PixelMap | Resource | SymbolGlyphModifier } value 2304 * @returns { NavigationAttribute } 2305 * @syscap SystemCapability.ArkUI.ArkUI.Full 2306 * @crossplatform 2307 * @atomicservice 2308 * @since 12 2309 */ 2310 backButtonIcon(value: string | PixelMap | Resource | SymbolGlyphModifier): NavigationAttribute; 2311 2312 /** 2313 * Hide the NavBar, which includes title bar, the child of Navigation and tool bar. Supported in split mode. 2314 * 2315 * @param { boolean } value 2316 * @returns { NavigationAttribute } 2317 * @syscap SystemCapability.ArkUI.ArkUI.Full 2318 * @since 9 2319 */ 2320 /** 2321 * Hide the NavBar, which includes title bar, the child of Navigation and tool bar. Supported in split mode. 2322 * 2323 * @param { boolean } value 2324 * @returns { NavigationAttribute } 2325 * @syscap SystemCapability.ArkUI.ArkUI.Full 2326 * @crossplatform 2327 * @since 10 2328 */ 2329 /** 2330 * Hide the NavBar, which includes title bar, the child of Navigation and tool bar. Supported in all mode. 2331 * It will show top page in the NavPathStack directly or empty if there is no page in the NavPathStack. 2332 * 2333 * @param { boolean } value 2334 * @returns { NavigationAttribute } 2335 * @syscap SystemCapability.ArkUI.ArkUI.Full 2336 * @crossplatform 2337 * @atomicservice 2338 * @since 11 2339 */ 2340 hideNavBar(value: boolean): NavigationAttribute; 2341 2342 /** 2343 * Navigation title 2344 * 2345 * @param { string | CustomBuilder } value 2346 * @returns { NavigationAttribute } 2347 * @syscap SystemCapability.ArkUI.ArkUI.Full 2348 * @since 8 2349 */ 2350 /** 2351 * Navigation title 2352 * 2353 * @param { string | CustomBuilder | NavigationCommonTitle | NavigationCustomTitle } value 2354 * @returns { NavigationAttribute } 2355 * @syscap SystemCapability.ArkUI.ArkUI.Full 2356 * @since 9 2357 */ 2358 /** 2359 * Navigation title 2360 * 2361 * @param { ResourceStr | CustomBuilder | NavigationCommonTitle | NavigationCustomTitle } value 2362 * @returns { NavigationAttribute } 2363 * @syscap SystemCapability.ArkUI.ArkUI.Full 2364 * @crossplatform 2365 * @since 10 2366 */ 2367 /** 2368 * Navigation title 2369 * 2370 * @param { ResourceStr | CustomBuilder | NavigationCommonTitle | NavigationCustomTitle } value 2371 * @param { NavigationTitleOptions } [options] - Indicates the options of titlebar. 2372 * @returns { NavigationAttribute } 2373 * @syscap SystemCapability.ArkUI.ArkUI.Full 2374 * @crossplatform 2375 * @atomicservice 2376 * @since 11 2377 */ 2378 title(value: ResourceStr | CustomBuilder | NavigationCommonTitle | NavigationCustomTitle, options?: NavigationTitleOptions): NavigationAttribute; 2379 2380 /** 2381 * Navigation subtitle 2382 * 2383 * @param { string } value 2384 * @returns { NavigationAttribute } 2385 * @syscap SystemCapability.ArkUI.ArkUI.Full 2386 * @since 8 2387 * @deprecated since 9 2388 * @useinstead title 2389 */ 2390 subTitle(value: string): NavigationAttribute; 2391 2392 /** 2393 * Hide navigation title bar 2394 * 2395 * @param { boolean } value 2396 * @returns { NavigationAttribute } 2397 * @syscap SystemCapability.ArkUI.ArkUI.Full 2398 * @since 8 2399 */ 2400 /** 2401 * Hide navigation title bar 2402 * 2403 * @param { boolean } value 2404 * @returns { NavigationAttribute } 2405 * @syscap SystemCapability.ArkUI.ArkUI.Full 2406 * @crossplatform 2407 * @since 10 2408 */ 2409 /** 2410 * Hide navigation title bar 2411 * 2412 * @param { boolean } value 2413 * @returns { NavigationAttribute } 2414 * @syscap SystemCapability.ArkUI.ArkUI.Full 2415 * @crossplatform 2416 * @atomicservice 2417 * @since 11 2418 */ 2419 hideTitleBar(value: boolean): NavigationAttribute; 2420 2421 /** 2422 * Hide navigation title bar 2423 * 2424 * @param { boolean } hide 2425 * @param { boolean } animated 2426 * @returns { NavigationAttribute } 2427 * @syscap SystemCapability.ArkUI.ArkUI.Full 2428 * @crossplatform 2429 * @atomicservice 2430 * @since 13 2431 */ 2432 hideTitleBar(hide: boolean, animated: boolean): NavigationAttribute; 2433 2434 /** 2435 * Hide navigation back button 2436 * 2437 * @param { boolean } value 2438 * @returns { NavigationAttribute } 2439 * @syscap SystemCapability.ArkUI.ArkUI.Full 2440 * @since 8 2441 */ 2442 /** 2443 * Hide navigation back button 2444 * 2445 * @param { boolean } value 2446 * @returns { NavigationAttribute } 2447 * @syscap SystemCapability.ArkUI.ArkUI.Full 2448 * @crossplatform 2449 * @since 10 2450 */ 2451 /** 2452 * Hide navigation back button 2453 * 2454 * @param { boolean } value 2455 * @returns { NavigationAttribute } 2456 * @syscap SystemCapability.ArkUI.ArkUI.Full 2457 * @crossplatform 2458 * @atomicservice 2459 * @since 11 2460 */ 2461 hideBackButton(value: boolean): NavigationAttribute; 2462 2463 /** 2464 * Navigation title mode 2465 * 2466 * @param { NavigationTitleMode } value 2467 * @returns { NavigationAttribute } 2468 * @syscap SystemCapability.ArkUI.ArkUI.Full 2469 * @since 8 2470 */ 2471 /** 2472 * Navigation title mode 2473 * 2474 * @param { NavigationTitleMode } value 2475 * @returns { NavigationAttribute } 2476 * @syscap SystemCapability.ArkUI.ArkUI.Full 2477 * @crossplatform 2478 * @since 10 2479 */ 2480 /** 2481 * Navigation title mode 2482 * 2483 * @param { NavigationTitleMode } value 2484 * @returns { NavigationAttribute } 2485 * @syscap SystemCapability.ArkUI.ArkUI.Full 2486 * @crossplatform 2487 * @atomicservice 2488 * @since 11 2489 */ 2490 titleMode(value: NavigationTitleMode): NavigationAttribute; 2491 2492 /** 2493 * Navigation title bar's menus 2494 * 2495 * @param { Array<NavigationMenuItem> | CustomBuilder } value 2496 * @returns { NavigationAttribute } 2497 * @syscap SystemCapability.ArkUI.ArkUI.Full 2498 * @since 8 2499 */ 2500 /** 2501 * Navigation title bar's menus 2502 * 2503 * @param { Array<NavigationMenuItem> | CustomBuilder } value 2504 * @returns { NavigationAttribute } 2505 * @syscap SystemCapability.ArkUI.ArkUI.Full 2506 * @crossplatform 2507 * @since 10 2508 */ 2509 /** 2510 * Navigation title bar's menus 2511 * 2512 * @param { Array<NavigationMenuItem> | CustomBuilder } value 2513 * @returns { NavigationAttribute } 2514 * @syscap SystemCapability.ArkUI.ArkUI.Full 2515 * @crossplatform 2516 * @atomicservice 2517 * @since 11 2518 */ 2519 menus(value: Array<NavigationMenuItem> | CustomBuilder): NavigationAttribute; 2520 2521 /** 2522 * Tool bar 2523 * 2524 * @param { object | CustomBuilder } value 2525 * @returns { NavigationAttribute } 2526 * @syscap SystemCapability.ArkUI.ArkUI.Full 2527 * @since 8 2528 * @deprecated since 10 2529 * @useinstead navigation/NavigationAttribute#toolbarConfiguration 2530 */ 2531 toolBar(value: object | CustomBuilder): NavigationAttribute; 2532 2533 /** 2534 * Configure toolbar with default style parameter or custom parameter. 2535 * 2536 * @param { Array<ToolbarItem> | CustomBuilder } value - Toolbar configuration parameters. 2537 * @returns { NavigationAttribute } 2538 * @syscap SystemCapability.ArkUI.ArkUI.Full 2539 * @crossplatform 2540 * @form 2541 * @since 10 2542 */ 2543 /** 2544 * Configure toolbar with default style parameter or custom parameter. 2545 * 2546 * @param { Array<ToolbarItem> | CustomBuilder } value - Toolbar configuration parameters. 2547 * @param { NavigationToolbarOptions } [options] - Indicates the options of toolbar. 2548 * @returns { NavigationAttribute } 2549 * @syscap SystemCapability.ArkUI.ArkUI.Full 2550 * @crossplatform 2551 * @form 2552 * @atomicservice 2553 * @since 11 2554 */ 2555 toolbarConfiguration(value: Array<ToolbarItem> | CustomBuilder, options?: NavigationToolbarOptions): NavigationAttribute; 2556 2557 /** 2558 * Hide tool bar 2559 * 2560 * @param { boolean } value 2561 * @returns { NavigationAttribute } 2562 * @syscap SystemCapability.ArkUI.ArkUI.Full 2563 * @since 8 2564 */ 2565 /** 2566 * Hide tool bar 2567 * 2568 * @param { boolean } value 2569 * @returns { NavigationAttribute } 2570 * @syscap SystemCapability.ArkUI.ArkUI.Full 2571 * @crossplatform 2572 * @since 10 2573 */ 2574 /** 2575 * Hide tool bar 2576 * 2577 * @param { boolean } value 2578 * @returns { NavigationAttribute } 2579 * @syscap SystemCapability.ArkUI.ArkUI.Full 2580 * @crossplatform 2581 * @atomicservice 2582 * @since 11 2583 */ 2584 hideToolBar(value: boolean): NavigationAttribute; 2585 2586 /** 2587 * Hide tool bar 2588 * 2589 * @param { boolean } hide 2590 * @param { boolean } animated 2591 * @returns { NavigationAttribute } 2592 * @syscap SystemCapability.ArkUI.ArkUI.Full 2593 * @crossplatform 2594 * @atomicservice 2595 * @since 13 2596 */ 2597 hideToolBar(hide: boolean, animated: boolean): NavigationAttribute; 2598 2599 /** 2600 * Trigger callback when title mode change finished at free mode. 2601 * 2602 * @param { (titleMode: NavigationTitleMode) => void } callback 2603 * @returns { NavigationAttribute } 2604 * @syscap SystemCapability.ArkUI.ArkUI.Full 2605 * @since 8 2606 */ 2607 /** 2608 * Trigger callback when title mode change finished at free mode. 2609 * 2610 * @param { function } callback 2611 * @returns { NavigationAttribute } 2612 * @syscap SystemCapability.ArkUI.ArkUI.Full 2613 * @crossplatform 2614 * @since 10 2615 */ 2616 /** 2617 * Trigger callback when title mode change finished at free mode. 2618 * 2619 * @param { function } callback 2620 * @returns { NavigationAttribute } 2621 * @syscap SystemCapability.ArkUI.ArkUI.Full 2622 * @crossplatform 2623 * @atomicservice 2624 * @since 11 2625 */ 2626 onTitleModeChange(callback: (titleMode: NavigationTitleMode) => void): NavigationAttribute; 2627 2628 /** 2629 * Trigger callback when the visibility of navigation bar change. 2630 * 2631 * @param { (isVisible: boolean) => void } callback 2632 * @returns { NavigationAttribute } 2633 * @syscap SystemCapability.ArkUI.ArkUI.Full 2634 * @since 9 2635 */ 2636 /** 2637 * Trigger callback when the visibility of navigation bar change. 2638 * 2639 * @param { function } callback 2640 * @returns { NavigationAttribute } 2641 * @syscap SystemCapability.ArkUI.ArkUI.Full 2642 * @crossplatform 2643 * @since 10 2644 */ 2645 /** 2646 * Trigger callback when the visibility of navigation bar change. 2647 * 2648 * @param { function } callback 2649 * @returns { NavigationAttribute } 2650 * @syscap SystemCapability.ArkUI.ArkUI.Full 2651 * @crossplatform 2652 * @atomicservice 2653 * @since 11 2654 */ 2655 onNavBarStateChange(callback: (isVisible: boolean) => void): NavigationAttribute; 2656 2657 /** 2658 * Trigger callback when navigation mode changes. 2659 * 2660 * @param { function } callback 2661 * @returns { NavigationAttribute } 2662 * @syscap SystemCapability.ArkUI.ArkUI.Full 2663 * @crossplatform 2664 * @atomicservice 2665 * @since 11 2666 */ 2667 onNavigationModeChange(callback: (mode: NavigationMode) => void): NavigationAttribute; 2668 2669 /** 2670 * Set builder for user-defined NavDestination component. 2671 * 2672 * @param { function } builder - The builder function of NavDestination component. 2673 * @returns { NavigationAttribute } Returns the instance of the NavigationAttribute. 2674 * @syscap SystemCapability.ArkUI.ArkUI.Full 2675 * @crossplatform 2676 * @since 10 2677 */ 2678 /** 2679 * Set builder for user-defined NavDestination component. 2680 * 2681 * @param { function } builder - The builder function of NavDestination component. 2682 * @returns { NavigationAttribute } Returns the instance of the NavigationAttribute. 2683 * @syscap SystemCapability.ArkUI.ArkUI.Full 2684 * @crossplatform 2685 * @atomicservice 2686 * @since 11 2687 */ 2688 navDestination(builder: (name: string, param: unknown) => void): NavigationAttribute; 2689 2690 /** 2691 * Set custom navigation content transition animation. 2692 * 2693 * @param { function } delegate - Custom transition delegate. 2694 * @returns { NavigationAttribute } Returns the instance of the NavigationAttribute. 2695 * @syscap SystemCapability.ArkUI.ArkUI.Full 2696 * @crossplatform 2697 * @since 11 2698 */ 2699 /** 2700 * Set custom navigation content transition animation. 2701 * 2702 * @param { function } delegate - Custom transition delegate. 2703 * @returns { NavigationAttribute } Returns the instance of the NavigationAttribute. 2704 * @syscap SystemCapability.ArkUI.ArkUI.Full 2705 * @crossplatform 2706 * @atomicservice 2707 * @since 12 2708 */ 2709 customNavContentTransition(delegate: (from: NavContentInfo, to: NavContentInfo, operation: NavigationOperation) => NavigationAnimatedTransition | undefined): NavigationAttribute; 2710 2711 /** 2712 * Set navigation content expand types and edges. 2713 * 2714 * @param { Array<LayoutSafeAreaType> } [types] - Indicates the types of the safe area. 2715 * @param { Array<LayoutSafeAreaEdge> } [edges] - Indicates the edges of the safe area. 2716 * @returns { NavigationAttribute } 2717 * @syscap SystemCapability.ArkUI.ArkUI.Full 2718 * @crossplatform 2719 * @atomicservice 2720 * @since 12 2721 */ 2722 ignoreLayoutSafeArea(types?: Array<LayoutSafeAreaType>, edges?: Array<LayoutSafeAreaEdge>): NavigationAttribute; 2723 2724 /** 2725 * Set the style of system bar 2726 * 2727 * @param { Optional<SystemBarStyle> } style - The properties of system bar 2728 * @returns { NavigationAttribute } 2729 * @syscap SystemCapability.ArkUI.ArkUI.Full 2730 * @atomicservice 2731 * @since 12 2732 */ 2733 systemBarStyle(style: Optional<SystemBarStyle>): NavigationAttribute; 2734} 2735 2736/** 2737* Navigation transition animation protocol. 2738* 2739* @interface NavigationAnimatedTransition 2740* @syscap SystemCapability.ArkUI.ArkUI.Full 2741* @crossplatform 2742* @since 11 2743*/ 2744/** 2745* Navigation transition animation protocol. 2746* 2747* @interface NavigationAnimatedTransition 2748* @syscap SystemCapability.ArkUI.ArkUI.Full 2749* @crossplatform 2750* @atomicservice 2751* @since 12 2752*/ 2753declare interface NavigationAnimatedTransition { 2754 /** 2755 * This method is called after the transition ends to notify whether the transition was successful. 2756 * 2757 * @type { ?function } 2758 * @syscap SystemCapability.ArkUI.ArkUI.Full 2759 * @crossplatform 2760 * @since 11 2761 */ 2762 /** 2763 * This method is called after the transition ends to notify whether the transition was successful. 2764 * 2765 * @type { ?function } 2766 * @syscap SystemCapability.ArkUI.ArkUI.Full 2767 * @crossplatform 2768 * @atomicservice 2769 * @since 12 2770 */ 2771 onTransitionEnd?: (success: boolean) => void 2772 2773 /** 2774 * Define the limit duration of the transition animation. 2775 * 2776 * @type { ?number } 2777 * @syscap SystemCapability.ArkUI.ArkUI.Full 2778 * @crossplatform 2779 * @since 11 2780 */ 2781 /** 2782 * Define the limit duration of the transition animation. 2783 * 2784 * @type { ?number } 2785 * @syscap SystemCapability.ArkUI.ArkUI.Full 2786 * @crossplatform 2787 * @atomicservice 2788 * @since 12 2789 */ 2790 timeout?: number; 2791 2792 /** 2793 * Indicates whether it is an interactive transition. 2794 * 2795 * @type { ?boolean } 2796 * @default false 2797 * @syscap SystemCapability.ArkUI.ArkUI.Full 2798 * @crossplatform 2799 * @atomicservice 2800 * @since 12 2801 */ 2802 isInteractive?: boolean; 2803 2804 /** 2805 * Configure the animations associated with custom transition. 2806 * 2807 * @type { function } 2808 * @syscap SystemCapability.ArkUI.ArkUI.Full 2809 * @crossplatform 2810 * @since 11 2811 */ 2812 /** 2813 * Configure the animations associated with custom transition. 2814 * 2815 * @type { function } 2816 * @syscap SystemCapability.ArkUI.ArkUI.Full 2817 * @crossplatform 2818 * @atomicservice 2819 * @since 12 2820 */ 2821 transition: (transitionProxy: NavigationTransitionProxy) => void 2822} 2823 2824/** 2825 * Navigation transition proxy. 2826 * 2827 * @interface NavigationTransitionProxy 2828 * @syscap SystemCapability.ArkUI.ArkUI.Full 2829 * @crossplatform 2830 * @since 11 2831 */ 2832/** 2833 * Navigation transition proxy. 2834 * 2835 * @interface NavigationTransitionProxy 2836 * @syscap SystemCapability.ArkUI.ArkUI.Full 2837 * @crossplatform 2838 * @atomicservice 2839 * @since 12 2840 */ 2841declare interface NavigationTransitionProxy { 2842 /** 2843 * From navigation content info. 2844 * 2845 * @type { NavContentInfo } 2846 * @syscap SystemCapability.ArkUI.ArkUI.Full 2847 * @crossplatform 2848 * @since 11 2849 */ 2850 /** 2851 * From navigation content info. 2852 * 2853 * @type { NavContentInfo } 2854 * @syscap SystemCapability.ArkUI.ArkUI.Full 2855 * @crossplatform 2856 * @atomicservice 2857 * @since 12 2858 */ 2859 from: NavContentInfo; 2860 2861 /** 2862 * To navigation content info. 2863 * 2864 * @type { NavContentInfo } 2865 * @syscap SystemCapability.ArkUI.ArkUI.Full 2866 * @crossplatform 2867 * @since 11 2868 */ 2869 /** 2870 * To navigation content info. 2871 * 2872 * @type { NavContentInfo } 2873 * @syscap SystemCapability.ArkUI.ArkUI.Full 2874 * @crossplatform 2875 * @atomicservice 2876 * @since 12 2877 */ 2878 to: NavContentInfo; 2879 2880 /** 2881 * Indicates whether it is an interactive transition. 2882 * 2883 * @type { ?boolean } 2884 * @default false 2885 * @syscap SystemCapability.ArkUI.ArkUI.Full 2886 * @crossplatform 2887 * @atomicservice 2888 * @since 12 2889 */ 2890 isInteractive?: boolean; 2891 2892 /** 2893 * Notification system transition animation completed. 2894 * 2895 * @syscap SystemCapability.ArkUI.ArkUI.Full 2896 * @crossplatform 2897 * @since 11 2898 */ 2899 /** 2900 * Notification system transition animation completed. 2901 * 2902 * @syscap SystemCapability.ArkUI.ArkUI.Full 2903 * @crossplatform 2904 * @atomicservice 2905 * @since 12 2906 */ 2907 finishTransition(): void; 2908 2909 /** 2910 * Notification system transition animation canceled. 2911 * 2912 * @syscap SystemCapability.ArkUI.ArkUI.Full 2913 * @crossplatform 2914 * @atomicservice 2915 * @since 12 2916 */ 2917 cancelTransition?(): void; 2918 2919 /** 2920 * Notification system transition animation update. 2921 * 2922 * @param { number } progress - The progress of transition animation. 2923 * @syscap SystemCapability.ArkUI.ArkUI.Full 2924 * @crossplatform 2925 * @atomicservice 2926 * @since 12 2927 */ 2928 updateTransition?(progress: number): void; 2929} 2930 2931/** 2932 * Navigation content info. 2933 * 2934 * @interface NavContentInfo 2935 * @syscap SystemCapability.ArkUI.ArkUI.Full 2936 * @crossplatform 2937 * @since 11 2938 */ 2939/** 2940 * Navigation content info. 2941 * 2942 * @interface NavContentInfo 2943 * @syscap SystemCapability.ArkUI.ArkUI.Full 2944 * @crossplatform 2945 * @atomicservice 2946 * @since 12 2947 */ 2948declare interface NavContentInfo { 2949 /** 2950 * Navigation content name. 2951 * 2952 * @type { ?string } 2953 * @syscap SystemCapability.ArkUI.ArkUI.Full 2954 * @crossplatform 2955 * @since 11 2956 */ 2957 /** 2958 * Navigation content name. 2959 * 2960 * @type { ?string } 2961 * @syscap SystemCapability.ArkUI.ArkUI.Full 2962 * @crossplatform 2963 * @atomicservice 2964 * @since 12 2965 */ 2966 name?: string; 2967 2968 /** 2969 * Navigation content index. 2970 * 2971 * @type { number } 2972 * @syscap SystemCapability.ArkUI.ArkUI.Full 2973 * @crossplatform 2974 * @since 11 2975 */ 2976 /** 2977 * Navigation content index. 2978 * 2979 * @type { number } 2980 * @syscap SystemCapability.ArkUI.ArkUI.Full 2981 * @crossplatform 2982 * @atomicservice 2983 * @since 12 2984 */ 2985 index: number; 2986 2987 /** 2988 * Navigation content mode. 2989 * 2990 * @type { ?NavDestinationMode } 2991 * @syscap SystemCapability.ArkUI.ArkUI.Full 2992 * @crossplatform 2993 * @since 11 2994 */ 2995 /** 2996 * Navigation content mode. 2997 * 2998 * @type { ?NavDestinationMode } 2999 * @syscap SystemCapability.ArkUI.ArkUI.Full 3000 * @crossplatform 3001 * @atomicservice 3002 * @since 12 3003 */ 3004 mode?: NavDestinationMode; 3005 3006 /** 3007 * Navigation content param. 3008 * 3009 * @type { ?Object } 3010 * @syscap SystemCapability.ArkUI.ArkUI.Full 3011 * @crossplatform 3012 * @atomicservice 3013 * @since 12 3014 */ 3015 param?: Object; 3016 3017 /** 3018 * The unique id of NavDestination. 3019 * 3020 * @type { ?string } 3021 * @syscap SystemCapability.ArkUI.ArkUI.Full 3022 * @crossplatform 3023 * @atomicservice 3024 * @since 12 3025 */ 3026 navDestinationId?: string; 3027} 3028 3029/** 3030 * Defines Navigation Component. 3031 * 3032 * @syscap SystemCapability.ArkUI.ArkUI.Full 3033 * @since 8 3034 */ 3035/** 3036 * Defines Navigation Component. 3037 * 3038 * @syscap SystemCapability.ArkUI.ArkUI.Full 3039 * @crossplatform 3040 * @since 10 3041 */ 3042/** 3043 * Defines Navigation Component. 3044 * 3045 * @syscap SystemCapability.ArkUI.ArkUI.Full 3046 * @crossplatform 3047 * @atomicservice 3048 * @since 11 3049 */ 3050declare const Navigation: NavigationInterface; 3051 3052/** 3053 * Defines Navigation Component instance. 3054 * 3055 * @syscap SystemCapability.ArkUI.ArkUI.Full 3056 * @since 8 3057 */ 3058/** 3059 * Defines Navigation Component instance. 3060 * 3061 * @syscap SystemCapability.ArkUI.ArkUI.Full 3062 * @crossplatform 3063 * @since 10 3064 */ 3065/** 3066 * Defines Navigation Component instance. 3067 * 3068 * @syscap SystemCapability.ArkUI.ArkUI.Full 3069 * @crossplatform 3070 * @atomicservice 3071 * @since 11 3072 */ 3073declare const NavigationInstance: NavigationAttribute; 3074