1/* 2 * Copyright (c) 2021-2023 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 * Sets the sidebar style of showing 23 * 24 * @enum { number } 25 * @syscap SystemCapability.ArkUI.ArkUI.Full 26 * @since 8 27 */ 28/** 29 * Sets the sidebar style of showing 30 * 31 * @enum { number } 32 * @syscap SystemCapability.ArkUI.ArkUI.Full 33 * @crossplatform 34 * @since 10 35 */ 36/** 37 * Sets the sidebar style of showing 38 * 39 * @enum { number } 40 * @syscap SystemCapability.ArkUI.ArkUI.Full 41 * @crossplatform 42 * @atomicservice 43 * @since 11 44 */ 45declare enum SideBarContainerType { 46 /** 47 * The sidebar invisible 48 * 49 * @syscap SystemCapability.ArkUI.ArkUI.Full 50 * @since 8 51 */ 52 /** 53 * The sidebar invisible 54 * 55 * @syscap SystemCapability.ArkUI.ArkUI.Full 56 * @crossplatform 57 * @since 10 58 */ 59 /** 60 * The sidebar invisible 61 * 62 * @syscap SystemCapability.ArkUI.ArkUI.Full 63 * @crossplatform 64 * @atomicservice 65 * @since 11 66 */ 67 Embed, 68 69 /** 70 * The sidebar visible 71 * 72 * @syscap SystemCapability.ArkUI.ArkUI.Full 73 * @since 8 74 */ 75 /** 76 * The sidebar visible 77 * 78 * @syscap SystemCapability.ArkUI.ArkUI.Full 79 * @crossplatform 80 * @since 10 81 */ 82 /** 83 * The sidebar visible 84 * 85 * @syscap SystemCapability.ArkUI.ArkUI.Full 86 * @crossplatform 87 * @atomicservice 88 * @since 11 89 */ 90 Overlay, 91 92 /** 93 * The sidebar AUTO 94 * @syscap SystemCapability.ArkUI.ArkUI.Full 95 * @crossplatform 96 * @since 10 97 */ 98 /** 99 * The sidebar AUTO 100 * @syscap SystemCapability.ArkUI.ArkUI.Full 101 * @crossplatform 102 * @atomicservice 103 * @since 11 104 */ 105 AUTO, 106} 107 108/** 109 * Sets the sidebar position of showing 110 * 111 * @enum { number } 112 * @syscap SystemCapability.ArkUI.ArkUI.Full 113 * @since 9 114 */ 115/** 116 * Sets the sidebar position of showing 117 * 118 * @enum { number } 119 * @syscap SystemCapability.ArkUI.ArkUI.Full 120 * @crossplatform 121 * @since 10 122 */ 123/** 124 * Sets the sidebar position of showing 125 * 126 * @enum { number } 127 * @syscap SystemCapability.ArkUI.ArkUI.Full 128 * @crossplatform 129 * @atomicservice 130 * @since 11 131 */ 132declare enum SideBarPosition { 133 /** 134 * The sidebar is on the Start of the container 135 * 136 * @syscap SystemCapability.ArkUI.ArkUI.Full 137 * @since 9 138 */ 139 /** 140 * The sidebar is on the Start of the container 141 * 142 * @syscap SystemCapability.ArkUI.ArkUI.Full 143 * @crossplatform 144 * @since 10 145 */ 146 /** 147 * The sidebar is on the Start of the container 148 * 149 * @syscap SystemCapability.ArkUI.ArkUI.Full 150 * @crossplatform 151 * @atomicservice 152 * @since 11 153 */ 154 Start, 155 156 /** 157 * The sidebar is on the End of the container 158 * 159 * @syscap SystemCapability.ArkUI.ArkUI.Full 160 * @since 9 161 */ 162 /** 163 * The sidebar is on the End of the container 164 * 165 * @syscap SystemCapability.ArkUI.ArkUI.Full 166 * @crossplatform 167 * @since 10 168 */ 169 /** 170 * The sidebar is on the End of the container 171 * 172 * @syscap SystemCapability.ArkUI.ArkUI.Full 173 * @crossplatform 174 * @atomicservice 175 * @since 11 176 */ 177 End, 178} 179 180/** 181 * ButtonStyle icons. 182 * 183 * @typedef ButtonIconOptions 184 * @syscap SystemCapability.ArkUI.ArkUI.Full 185 * @crossplatform 186 * @atomicservice 187 * @since 18 188 */ 189declare interface ButtonIconOptions { 190 /** 191 * Defines whether an icon is shown. 192 * 193 * @type { string | PixelMap | Resource } 194 * @syscap SystemCapability.ArkUI.ArkUI.Full 195 * @since 8 196 */ 197 /** 198 * Defines whether an icon is shown. 199 * 200 * @type { string | PixelMap | Resource } 201 * @syscap SystemCapability.ArkUI.ArkUI.Full 202 * @crossplatform 203 * @since 10 204 */ 205 /** 206 * Defines whether an icon is shown. 207 * 208 * @type { string | PixelMap | Resource } 209 * @syscap SystemCapability.ArkUI.ArkUI.Full 210 * @crossplatform 211 * @atomicservice 212 * @since 11 213 */ 214 /** 215 * Defines whether an icon is shown. 216 * 217 * Anonymous Object Rectification. 218 * @type { string | PixelMap | Resource } 219 * @syscap SystemCapability.ArkUI.ArkUI.Full 220 * @crossplatform 221 * @atomicservice 222 * @since 18 223 */ 224 shown: string | PixelMap | Resource; 225 226 /** 227 * Defines whether an icon is hidden. 228 * 229 * @type { string | PixelMap | Resource } 230 * @syscap SystemCapability.ArkUI.ArkUI.Full 231 * @since 8 232 */ 233 /** 234 * Defines whether an icon is hidden. 235 * 236 * @type { string | PixelMap | Resource } 237 * @syscap SystemCapability.ArkUI.ArkUI.Full 238 * @crossplatform 239 * @since 10 240 */ 241 /** 242 * Defines whether an icon is hidden. 243 * 244 * @type { string | PixelMap | Resource } 245 * @syscap SystemCapability.ArkUI.ArkUI.Full 246 * @crossplatform 247 * @atomicservice 248 * @since 11 249 */ 250 /** 251 * Defines whether an icon is hidden. 252 * 253 * Anonymous Object Rectification. 254 * @type { string | PixelMap | Resource } 255 * @syscap SystemCapability.ArkUI.ArkUI.Full 256 * @crossplatform 257 * @atomicservice 258 * @since 18 259 */ 260 hidden: string | PixelMap | Resource; 261 262 /** 263 * Defines whether an icon is switching. 264 * 265 * @type { ?(string | PixelMap | Resource) } 266 * @syscap SystemCapability.ArkUI.ArkUI.Full 267 * @since 8 268 */ 269 /** 270 * Defines whether an icon is switching. 271 * 272 * @type { ?(string | PixelMap | Resource) } 273 * @syscap SystemCapability.ArkUI.ArkUI.Full 274 * @crossplatform 275 * @since 10 276 */ 277 /** 278 * Defines whether an icon is switching. 279 * 280 * @type { ?(string | PixelMap | Resource) } 281 * @syscap SystemCapability.ArkUI.ArkUI.Full 282 * @crossplatform 283 * @atomicservice 284 * @since 11 285 */ 286 /** 287 * Defines whether an icon is switching. 288 * 289 * Anonymous Object Rectification. 290 * @type { ?(string | PixelMap | Resource) } 291 * @syscap SystemCapability.ArkUI.ArkUI.Full 292 * @crossplatform 293 * @atomicservice 294 * @since 18 295 */ 296 switching?: string | PixelMap | Resource; 297} 298 299/** 300 * Sets the control button style 301 * 302 * @interface ButtonStyle 303 * @syscap SystemCapability.ArkUI.ArkUI.Full 304 * @since 8 305 */ 306/** 307 * Sets the control button style 308 * 309 * @interface ButtonStyle 310 * @syscap SystemCapability.ArkUI.ArkUI.Full 311 * @crossplatform 312 * @since 10 313 */ 314/** 315 * Sets the control button style 316 * 317 * @interface ButtonStyle 318 * @syscap SystemCapability.ArkUI.ArkUI.Full 319 * @crossplatform 320 * @atomicservice 321 * @since 11 322 */ 323declare interface ButtonStyle { 324 /** 325 * Set the left of control button 326 * default value is 16vp. 327 * 328 * @type { ?number } 329 * @syscap SystemCapability.ArkUI.ArkUI.Full 330 * @since 8 331 */ 332 /** 333 * Set the left of control button 334 * default value is 16vp. 335 * 336 * @type { ?number } 337 * @syscap SystemCapability.ArkUI.ArkUI.Full 338 * @crossplatform 339 * @since 10 340 */ 341 /** 342 * Set the left of control button 343 * default value is 16vp. 344 * 345 * @type { ?number } 346 * @syscap SystemCapability.ArkUI.ArkUI.Full 347 * @crossplatform 348 * @atomicservice 349 * @since 11 350 */ 351 left?: number; 352 353 /** 354 * Set the top of control button 355 * default value is 48vp. 356 * 357 * @type { ?number } 358 * @syscap SystemCapability.ArkUI.ArkUI.Full 359 * @since 8 360 */ 361 /** 362 * Set the top of control button 363 * default value is 48vp. 364 * 365 * @type { ?number } 366 * @syscap SystemCapability.ArkUI.ArkUI.Full 367 * @crossplatform 368 * @since 10 369 */ 370 /** 371 * Set the top of control button 372 * default value is 48vp. 373 * 374 * @type { ?number } 375 * @syscap SystemCapability.ArkUI.ArkUI.Full 376 * @crossplatform 377 * @atomicservice 378 * @since 11 379 */ 380 top?: number; 381 382 /** 383 * Set the width of control button 384 * default value is 32vp. 385 * 386 * @type { ?number } 387 * @syscap SystemCapability.ArkUI.ArkUI.Full 388 * @since 8 389 */ 390 /** 391 * Set the width of control button 392 * default value is 24vp. 393 * 394 * @type { ?number } 395 * @syscap SystemCapability.ArkUI.ArkUI.Full 396 * @crossplatform 397 * @since 10 398 */ 399 /** 400 * Set the width of control button 401 * default value is 24vp. 402 * 403 * @type { ?number } 404 * @syscap SystemCapability.ArkUI.ArkUI.Full 405 * @crossplatform 406 * @atomicservice 407 * @since 11 408 */ 409 width?: number; 410 411 /** 412 * Set the height of control button 413 * default value is 32vp. 414 * 415 * @type { ?number } 416 * @syscap SystemCapability.ArkUI.ArkUI.Full 417 * @since 8 418 */ 419 /** 420 * Set the height of control button 421 * default value is 24vp. 422 * 423 * @type { ?number } 424 * @syscap SystemCapability.ArkUI.ArkUI.Full 425 * @crossplatform 426 * @since 10 427 */ 428 /** 429 * Set the height of control button 430 * default value is 24vp. 431 * 432 * @type { ?number } 433 * @syscap SystemCapability.ArkUI.ArkUI.Full 434 * @crossplatform 435 * @atomicservice 436 * @since 11 437 */ 438 height?: number; 439 440 /** 441 * Set the button icon when sidebar status has changed 442 * 443 * @type { ?object } 444 * @syscap SystemCapability.ArkUI.ArkUI.Full 445 * @since 8 446 */ 447 /** 448 * Set the button icon when sidebar status has changed 449 * 450 * @type { ?object } 451 * @syscap SystemCapability.ArkUI.ArkUI.Full 452 * @crossplatform 453 * @since 10 454 */ 455 /** 456 * Set the button icon when sidebar status has changed 457 * 458 * @type { ?object } 459 * @syscap SystemCapability.ArkUI.ArkUI.Full 460 * @crossplatform 461 * @atomicservice 462 * @since 11 463 */ 464 /** 465 * Set the button icon when sidebar status has changed 466 * 467 * Anonymous Object Rectification. 468 * @type { ?ButtonIconOptions } 469 * @syscap SystemCapability.ArkUI.ArkUI.Full 470 * @crossplatform 471 * @atomicservice 472 * @since 18 473 */ 474 icons?: ButtonIconOptions; 475} 476 477/** 478 * The construct function of sidebar 479 * 480 * @interface SideBarContainerInterface 481 * @syscap SystemCapability.ArkUI.ArkUI.Full 482 * @since 8 483 */ 484/** 485 * The construct function of sidebar 486 * 487 * @interface SideBarContainerInterface 488 * @syscap SystemCapability.ArkUI.ArkUI.Full 489 * @crossplatform 490 * @since 10 491 */ 492/** 493 * The construct function of sidebar 494 * 495 * @interface SideBarContainerInterface 496 * @syscap SystemCapability.ArkUI.ArkUI.Full 497 * @crossplatform 498 * @atomicservice 499 * @since 11 500 */ 501interface SideBarContainerInterface { 502 /** 503 * Called when showing the sidebar of a block entry. 504 * 505 * @param { SideBarContainerType } type 506 * @returns { SideBarContainerAttribute } 507 * @syscap SystemCapability.ArkUI.ArkUI.Full 508 * @since 8 509 */ 510 /** 511 * Called when showing the sidebar of a block entry. 512 * 513 * @param { SideBarContainerType } type 514 * @returns { SideBarContainerAttribute } 515 * @syscap SystemCapability.ArkUI.ArkUI.Full 516 * @crossplatform 517 * @since 10 518 */ 519 /** 520 * Called when showing the sidebar of a block entry. 521 * 522 * @param { SideBarContainerType } type 523 * @returns { SideBarContainerAttribute } 524 * @syscap SystemCapability.ArkUI.ArkUI.Full 525 * @crossplatform 526 * @atomicservice 527 * @since 11 528 */ 529 (type?: SideBarContainerType): SideBarContainerAttribute; 530} 531 532/** 533 * Provides an interface for the style of a divider including stroke width, color, start margin 534 * and end margin 535 * 536 * @interface DividerStyle 537 * @syscap SystemCapability.ArkUI.ArkUI.Full 538 * @crossplatform 539 * @since 10 540 */ 541/** 542 * Provides an interface for the style of a divider including stroke width, color, start margin 543 * and end margin 544 * 545 * @interface DividerStyle 546 * @syscap SystemCapability.ArkUI.ArkUI.Full 547 * @crossplatform 548 * @atomicservice 549 * @since 11 550 */ 551interface DividerStyle { 552 /** 553 * Define the stroke width of the divider 554 * 555 * @type { Length } 556 * @default 1vp 557 * @syscap SystemCapability.ArkUI.ArkUI.Full 558 * @crossplatform 559 * @since 10 560 */ 561 /** 562 * Define the stroke width of the divider 563 * 564 * @type { Length } 565 * @default 1vp 566 * @syscap SystemCapability.ArkUI.ArkUI.Full 567 * @crossplatform 568 * @atomicservice 569 * @since 11 570 */ 571 strokeWidth: Length; 572 573 /** 574 * Define the color of the divider 575 * 576 * @type { ?ResourceColor } 577 * @syscap SystemCapability.ArkUI.ArkUI.Full 578 * @crossplatform 579 * @since 10 580 */ 581 /** 582 * Define the color of the divider 583 * 584 * @type { ?ResourceColor } 585 * @syscap SystemCapability.ArkUI.ArkUI.Full 586 * @crossplatform 587 * @atomicservice 588 * @since 11 589 */ 590 color?: ResourceColor; 591 592 /** 593 * Define the start margin of the divider 594 * 595 * @type { ?Length } 596 * @syscap SystemCapability.ArkUI.ArkUI.Full 597 * @crossplatform 598 * @since 10 599 */ 600 /** 601 * Define the start margin of the divider 602 * 603 * @type { ?Length } 604 * @syscap SystemCapability.ArkUI.ArkUI.Full 605 * @crossplatform 606 * @atomicservice 607 * @since 11 608 */ 609 startMargin?: Length; 610 611 /** 612 * Define the end margin of the divider 613 * 614 * @type { ?Length } 615 * @syscap SystemCapability.ArkUI.ArkUI.Full 616 * @crossplatform 617 * @since 10 618 */ 619 /** 620 * Define the end margin of the divider 621 * 622 * @type { ?Length } 623 * @syscap SystemCapability.ArkUI.ArkUI.Full 624 * @crossplatform 625 * @atomicservice 626 * @since 11 627 */ 628 endMargin?: Length; 629} 630 631/** 632 * The attribute function of sidebar 633 * 634 * @extends CommonMethod<SideBarContainerAttribute> 635 * @syscap SystemCapability.ArkUI.ArkUI.Full 636 * @since 8 637 */ 638/** 639 * The attribute function of sidebar 640 * 641 * @extends CommonMethod<SideBarContainerAttribute> 642 * @syscap SystemCapability.ArkUI.ArkUI.Full 643 * @crossplatform 644 * @since 10 645 */ 646/** 647 * The attribute function of sidebar 648 * 649 * @extends CommonMethod<SideBarContainerAttribute> 650 * @syscap SystemCapability.ArkUI.ArkUI.Full 651 * @crossplatform 652 * @atomicservice 653 * @since 11 654 */ 655declare class SideBarContainerAttribute extends CommonMethod<SideBarContainerAttribute> { 656 /** 657 * Callback showControlButton function when setting the status of sidebar 658 * 659 * @param { boolean } value 660 * @returns { SideBarContainerAttribute } 661 * @syscap SystemCapability.ArkUI.ArkUI.Full 662 * @since 8 663 */ 664 /** 665 * Callback showControlButton function when setting the status of sidebar 666 * 667 * @param { boolean } value 668 * @returns { SideBarContainerAttribute } 669 * @syscap SystemCapability.ArkUI.ArkUI.Full 670 * @crossplatform 671 * @since 10 672 */ 673 /** 674 * Callback showControlButton function when setting the status of sidebar 675 * 676 * @param { boolean } value 677 * @returns { SideBarContainerAttribute } 678 * @syscap SystemCapability.ArkUI.ArkUI.Full 679 * @crossplatform 680 * @atomicservice 681 * @since 11 682 */ 683 showSideBar(value: boolean): SideBarContainerAttribute; 684 685 /** 686 * Callback controlButton function when setting the style of button 687 * 688 * @param { ButtonStyle } value 689 * @returns { SideBarContainerAttribute } 690 * @syscap SystemCapability.ArkUI.ArkUI.Full 691 * @since 8 692 */ 693 /** 694 * Callback controlButton function when setting the style of button 695 * 696 * @param { ButtonStyle } value 697 * @returns { SideBarContainerAttribute } 698 * @syscap SystemCapability.ArkUI.ArkUI.Full 699 * @crossplatform 700 * @since 10 701 */ 702 /** 703 * Callback controlButton function when setting the style of button 704 * 705 * @param { ButtonStyle } value 706 * @returns { SideBarContainerAttribute } 707 * @syscap SystemCapability.ArkUI.ArkUI.Full 708 * @crossplatform 709 * @atomicservice 710 * @since 11 711 */ 712 controlButton(value: ButtonStyle): SideBarContainerAttribute; 713 714 /** 715 * Callback showControlButton function when setting the status of button 716 * 717 * @param { boolean } value 718 * @returns { SideBarContainerAttribute } 719 * @syscap SystemCapability.ArkUI.ArkUI.Full 720 * @since 8 721 */ 722 /** 723 * Callback showControlButton function when setting the status of button 724 * 725 * @param { boolean } value 726 * @returns { SideBarContainerAttribute } 727 * @syscap SystemCapability.ArkUI.ArkUI.Full 728 * @crossplatform 729 * @since 10 730 */ 731 /** 732 * Callback showControlButton function when setting the status of button 733 * 734 * @param { boolean } value 735 * @returns { SideBarContainerAttribute } 736 * @syscap SystemCapability.ArkUI.ArkUI.Full 737 * @crossplatform 738 * @atomicservice 739 * @since 11 740 */ 741 showControlButton(value: boolean): SideBarContainerAttribute; 742 743 /** 744 * Trigger callback when sidebar style of showing change finished. 745 * 746 * @param { function } callback 747 * @returns { SideBarContainerAttribute } 748 * @syscap SystemCapability.ArkUI.ArkUI.Full 749 * @since 8 750 */ 751 /** 752 * Trigger callback when sidebar style of showing change finished. 753 * 754 * @param { function } callback 755 * @returns { SideBarContainerAttribute } 756 * @syscap SystemCapability.ArkUI.ArkUI.Full 757 * @crossplatform 758 * @since 10 759 */ 760 /** 761 * Trigger callback when sidebar style of showing change finished. 762 * 763 * @param { function } callback 764 * @returns { SideBarContainerAttribute } 765 * @syscap SystemCapability.ArkUI.ArkUI.Full 766 * @crossplatform 767 * @atomicservice 768 * @since 11 769 */ 770 onChange(callback: (value: boolean) => void): SideBarContainerAttribute; 771 772 /** 773 * Sets the length of sidebar. 774 * default value is 200vp. 775 * 776 * @param { number } value 777 * @returns { SideBarContainerAttribute } 778 * @syscap SystemCapability.ArkUI.ArkUI.Full 779 * @since 8 780 */ 781 /** 782 * Sets the length of sidebar. 783 * default value is 240vp. 784 * 785 * @param { number } value 786 * @returns { SideBarContainerAttribute } 787 * @syscap SystemCapability.ArkUI.ArkUI.Full 788 * @crossplatform 789 * @since 10 790 */ 791 /** 792 * Sets the length of sidebar. 793 * default value is 240vp. 794 * 795 * @param { number } value 796 * @returns { SideBarContainerAttribute } 797 * @syscap SystemCapability.ArkUI.ArkUI.Full 798 * @crossplatform 799 * @atomicservice 800 * @since 11 801 */ 802 sideBarWidth(value: number): SideBarContainerAttribute; 803 804 /** 805 * Sets the min length of sidebar. 806 * default value is 200vp. 807 * 808 * @param { number } value 809 * @returns { SideBarContainerAttribute } 810 * @syscap SystemCapability.ArkUI.ArkUI.Full 811 * @since 8 812 */ 813 /** 814 * Sets the min length of sidebar. 815 * default value is 240vp. 816 * 817 * @param { number } value 818 * @returns { SideBarContainerAttribute } 819 * @syscap SystemCapability.ArkUI.ArkUI.Full 820 * @crossplatform 821 * @since 10 822 */ 823 /** 824 * Sets the min length of sidebar. 825 * default value is 240vp. 826 * 827 * @param { number } value 828 * @returns { SideBarContainerAttribute } 829 * @syscap SystemCapability.ArkUI.ArkUI.Full 830 * @crossplatform 831 * @atomicservice 832 * @since 11 833 */ 834 minSideBarWidth(value: number): SideBarContainerAttribute; 835 836 /** 837 * Sets the max length of sidebar. 838 * default value is 280vp. 839 * 840 * @param { number } value 841 * @returns { SideBarContainerAttribute } 842 * @syscap SystemCapability.ArkUI.ArkUI.Full 843 * @since 8 844 */ 845 /** 846 * Sets the max length of sidebar. 847 * default value is 280vp. 848 * 849 * @param { number } value 850 * @returns { SideBarContainerAttribute } 851 * @syscap SystemCapability.ArkUI.ArkUI.Full 852 * @crossplatform 853 * @since 10 854 */ 855 /** 856 * Sets the max length of sidebar. 857 * default value is 280vp. 858 * 859 * @param { number } value 860 * @returns { SideBarContainerAttribute } 861 * @syscap SystemCapability.ArkUI.ArkUI.Full 862 * @crossplatform 863 * @atomicservice 864 * @since 11 865 */ 866 maxSideBarWidth(value: number): SideBarContainerAttribute; 867 868 /** 869 * Sets the length of sidebar. 870 * 871 * @param { Length } value 872 * @returns { SideBarContainerAttribute } 873 * @syscap SystemCapability.ArkUI.ArkUI.Full 874 * @since 9 875 */ 876 /** 877 * Sets the length of sidebar. 878 * 879 * @param { Length } value 880 * @returns { SideBarContainerAttribute } 881 * @syscap SystemCapability.ArkUI.ArkUI.Full 882 * @crossplatform 883 * @since 10 884 */ 885 /** 886 * Sets the length of sidebar. 887 * 888 * @param { Length } value 889 * @returns { SideBarContainerAttribute } 890 * @syscap SystemCapability.ArkUI.ArkUI.Full 891 * @crossplatform 892 * @atomicservice 893 * @since 11 894 */ 895 sideBarWidth(value: Length): SideBarContainerAttribute; 896 897 /** 898 * Sets the min length of sidebar. 899 * default value is 200vp. 900 * 901 * @param { Length } value 902 * @returns { SideBarContainerAttribute } 903 * @syscap SystemCapability.ArkUI.ArkUI.Full 904 * @since 9 905 */ 906 /** 907 * Sets the min length of sidebar. 908 * default value is 200vp. 909 * 910 * @param { Length } value 911 * @returns { SideBarContainerAttribute } 912 * @syscap SystemCapability.ArkUI.ArkUI.Full 913 * @crossplatform 914 * @since 10 915 */ 916 /** 917 * Sets the min length of sidebar. 918 * default value is 200vp. 919 * 920 * @param { Length } value 921 * @returns { SideBarContainerAttribute } 922 * @syscap SystemCapability.ArkUI.ArkUI.Full 923 * @crossplatform 924 * @atomicservice 925 * @since 11 926 */ 927 minSideBarWidth(value: Length): SideBarContainerAttribute; 928 929 /** 930 * Sets the max length of sidebar. 931 * default value is 280vp. 932 * 933 * @param { Length } value 934 * @returns { SideBarContainerAttribute } 935 * @syscap SystemCapability.ArkUI.ArkUI.Full 936 * @since 9 937 */ 938 /** 939 * Sets the max length of sidebar. 940 * default value is 280vp. 941 * 942 * @param { Length } value 943 * @returns { SideBarContainerAttribute } 944 * @syscap SystemCapability.ArkUI.ArkUI.Full 945 * @crossplatform 946 * @since 10 947 */ 948 /** 949 * Sets the max length of sidebar. 950 * default value is 280vp. 951 * 952 * @param { Length } value 953 * @returns { SideBarContainerAttribute } 954 * @syscap SystemCapability.ArkUI.ArkUI.Full 955 * @crossplatform 956 * @atomicservice 957 * @since 11 958 */ 959 maxSideBarWidth(value: Length): SideBarContainerAttribute; 960 961 /** 962 * Sets whether to automatically hide when drag sidebar width is less than the minimum width. 963 * default value is true. 964 * 965 * @param { boolean } value 966 * @returns { SideBarContainerAttribute } 967 * @syscap SystemCapability.ArkUI.ArkUI.Full 968 * @since 9 969 */ 970 /** 971 * Sets whether to automatically hide when drag sidebar width is less than the minimum width. 972 * default value is true. 973 * 974 * @param { boolean } value 975 * @returns { SideBarContainerAttribute } 976 * @syscap SystemCapability.ArkUI.ArkUI.Full 977 * @crossplatform 978 * @since 10 979 */ 980 /** 981 * Sets whether to automatically hide when drag sidebar width is less than the minimum width. 982 * default value is true. 983 * 984 * @param { boolean } value 985 * @returns { SideBarContainerAttribute } 986 * @syscap SystemCapability.ArkUI.ArkUI.Full 987 * @crossplatform 988 * @atomicservice 989 * @since 11 990 */ 991 autoHide(value: boolean): SideBarContainerAttribute; 992 993 /** 994 * Called when determining the location of the sidebar. 995 * default value is Start. 996 * 997 * @param { SideBarPosition } value 998 * @returns { SideBarContainerAttribute } 999 * @syscap SystemCapability.ArkUI.ArkUI.Full 1000 * @since 9 1001 */ 1002 /** 1003 * Called when determining the location of the sidebar. 1004 * default value is Start. 1005 * 1006 * @param { SideBarPosition } value 1007 * @returns { SideBarContainerAttribute } 1008 * @syscap SystemCapability.ArkUI.ArkUI.Full 1009 * @crossplatform 1010 * @since 10 1011 */ 1012 /** 1013 * Called when determining the location of the sidebar. 1014 * default value is Start. 1015 * 1016 * @param { SideBarPosition } value 1017 * @returns { SideBarContainerAttribute } 1018 * @syscap SystemCapability.ArkUI.ArkUI.Full 1019 * @crossplatform 1020 * @atomicservice 1021 * @since 11 1022 */ 1023 sideBarPosition(value: SideBarPosition): SideBarContainerAttribute; 1024 1025 /** 1026 * Set divider style for sideBarContainer 1027 * 1028 * @param { DividerStyle | null } value - indicates the style of the divider or whether to show the divider. 1029 * @returns { SideBarContainerAttribute } 1030 * @syscap SystemCapability.ArkUI.ArkUI.Full 1031 * @crossplatform 1032 * @since 10 1033 */ 1034 /** 1035 * Set divider style for sideBarContainer 1036 * 1037 * @param { DividerStyle | null } value - indicates the style of the divider or whether to show the divider. 1038 * @returns { SideBarContainerAttribute } 1039 * @syscap SystemCapability.ArkUI.ArkUI.Full 1040 * @crossplatform 1041 * @atomicservice 1042 * @since 11 1043 */ 1044 divider(value: DividerStyle | null): SideBarContainerAttribute; 1045 1046 /** 1047 * Sets the min length of content. 1048 * default value is 360vp. 1049 * 1050 * @param { Dimension } value - min length of content. 1051 * @returns { SideBarContainerAttribute } 1052 * @syscap SystemCapability.ArkUI.ArkUI.Full 1053 * @crossplatform 1054 * @since 10 1055 */ 1056 /** 1057 * Sets the min length of content. 1058 * default value is 360vp. 1059 * 1060 * @param { Dimension } value - min length of content. 1061 * @returns { SideBarContainerAttribute } 1062 * @syscap SystemCapability.ArkUI.ArkUI.Full 1063 * @crossplatform 1064 * @atomicservice 1065 * @since 11 1066 */ 1067 minContentWidth(value: Dimension): SideBarContainerAttribute; 1068} 1069 1070/** 1071 * Defines SideBarContainer Component. 1072 * 1073 * @syscap SystemCapability.ArkUI.ArkUI.Full 1074 * @since 8 1075 */ 1076/** 1077 * Defines SideBarContainer Component. 1078 * 1079 * @syscap SystemCapability.ArkUI.ArkUI.Full 1080 * @crossplatform 1081 * @since 10 1082 */ 1083/** 1084 * Defines SideBarContainer Component. 1085 * 1086 * @syscap SystemCapability.ArkUI.ArkUI.Full 1087 * @crossplatform 1088 * @atomicservice 1089 * @since 11 1090 */ 1091declare const SideBarContainer: SideBarContainerInterface; 1092 1093/** 1094 * Defines SideBarContainer Component instance. 1095 * 1096 * @syscap SystemCapability.ArkUI.ArkUI.Full 1097 * @since 8 1098 */ 1099/** 1100 * Defines SideBarContainer Component instance. 1101 * 1102 * @syscap SystemCapability.ArkUI.ArkUI.Full 1103 * @crossplatform 1104 * @since 10 1105 */ 1106/** 1107 * Defines SideBarContainer Component instance. 1108 * 1109 * @syscap SystemCapability.ArkUI.ArkUI.Full 1110 * @crossplatform 1111 * @atomicservice 1112 * @since 11 1113 */ 1114declare const SideBarContainerInstance: SideBarContainerAttribute; 1115