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