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