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