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 * CheckboxGroup SelectStatus 23 * 24 * @enum { number } 25 * @syscap SystemCapability.ArkUI.ArkUI.Full 26 * @since 8 27 */ 28/** 29 * CheckboxGroup SelectStatus 30 * 31 * @enum { number } 32 * @syscap SystemCapability.ArkUI.ArkUI.Full 33 * @form 34 * @since 9 35 */ 36/** 37 * CheckboxGroup SelectStatus 38 * 39 * @enum { number } 40 * @syscap SystemCapability.ArkUI.ArkUI.Full 41 * @crossplatform 42 * @form 43 * @since 10 44 */ 45/** 46 * CheckboxGroup SelectStatus 47 * 48 * @enum { number } 49 * @syscap SystemCapability.ArkUI.ArkUI.Full 50 * @crossplatform 51 * @form 52 * @atomicservice 53 * @since 11 54 */ 55declare enum SelectStatus { 56 /** 57 * All checkboxes are selected. 58 * 59 * @syscap SystemCapability.ArkUI.ArkUI.Full 60 * @since 8 61 */ 62 /** 63 * All checkboxes are selected. 64 * 65 * @syscap SystemCapability.ArkUI.ArkUI.Full 66 * @form 67 * @since 9 68 */ 69 /** 70 * All checkboxes are selected. 71 * 72 * @syscap SystemCapability.ArkUI.ArkUI.Full 73 * @crossplatform 74 * @form 75 * @since 10 76 */ 77 /** 78 * All checkboxes are selected. 79 * 80 * @syscap SystemCapability.ArkUI.ArkUI.Full 81 * @crossplatform 82 * @form 83 * @atomicservice 84 * @since 11 85 */ 86 All, 87 /** 88 * Part of the checkbox is selected. 89 * 90 * @syscap SystemCapability.ArkUI.ArkUI.Full 91 * @since 8 92 */ 93 /** 94 * Part of the checkbox is selected. 95 * 96 * @syscap SystemCapability.ArkUI.ArkUI.Full 97 * @form 98 * @since 9 99 */ 100 /** 101 * Part of the checkbox is selected. 102 * 103 * @syscap SystemCapability.ArkUI.ArkUI.Full 104 * @crossplatform 105 * @form 106 * @since 10 107 */ 108 /** 109 * Part of the checkbox is selected. 110 * 111 * @syscap SystemCapability.ArkUI.ArkUI.Full 112 * @crossplatform 113 * @form 114 * @atomicservice 115 * @since 11 116 */ 117 Part, 118 /** 119 * None of the checkbox is selected. 120 * 121 * @syscap SystemCapability.ArkUI.ArkUI.Full 122 * @since 8 123 */ 124 /** 125 * None of the checkbox is selected. 126 * 127 * @syscap SystemCapability.ArkUI.ArkUI.Full 128 * @form 129 * @since 9 130 */ 131 /** 132 * None of the checkbox is selected. 133 * 134 * @syscap SystemCapability.ArkUI.ArkUI.Full 135 * @crossplatform 136 * @form 137 * @since 10 138 */ 139 /** 140 * None of the checkbox is selected. 141 * 142 * @syscap SystemCapability.ArkUI.ArkUI.Full 143 * @crossplatform 144 * @form 145 * @atomicservice 146 * @since 11 147 */ 148 None, 149} 150 151/** 152 * Defines the options of CheckboxGroup. 153 * 154 * @interface CheckboxGroupOptions 155 * @syscap SystemCapability.ArkUI.ArkUI.Full 156 * @since 8 157 */ 158/** 159 * Defines the options of CheckboxGroup. 160 * 161 * @interface CheckboxGroupOptions 162 * @syscap SystemCapability.ArkUI.ArkUI.Full 163 * @form 164 * @since 9 165 */ 166/** 167 * Defines the options of CheckboxGroup. 168 * 169 * @interface CheckboxGroupOptions 170 * @syscap SystemCapability.ArkUI.ArkUI.Full 171 * @crossplatform 172 * @form 173 * @since 10 174 */ 175/** 176 * Defines the options of CheckboxGroup. 177 * 178 * @interface CheckboxGroupOptions 179 * @syscap SystemCapability.ArkUI.ArkUI.Full 180 * @crossplatform 181 * @form 182 * @atomicservice 183 * @since 11 184 */ 185declare interface CheckboxGroupOptions { 186 /** 187 * Setting the group of CheckboxGroup. 188 * 189 * @type { ?string } 190 * @syscap SystemCapability.ArkUI.ArkUI.Full 191 * @since 8 192 */ 193 /** 194 * Setting the group of CheckboxGroup. 195 * 196 * @type { ?string } 197 * @syscap SystemCapability.ArkUI.ArkUI.Full 198 * @form 199 * @since 9 200 */ 201 /** 202 * Setting the group of CheckboxGroup. 203 * 204 * @type { ?string } 205 * @syscap SystemCapability.ArkUI.ArkUI.Full 206 * @crossplatform 207 * @form 208 * @since 10 209 */ 210 /** 211 * Setting the group of CheckboxGroup. 212 * 213 * @type { ?string } 214 * @syscap SystemCapability.ArkUI.ArkUI.Full 215 * @crossplatform 216 * @form 217 * @atomicservice 218 * @since 11 219 */ 220 group?: string; 221} 222 223/** 224 * Defines the options of CheckboxGroupResult. 225 * 226 * @interface CheckboxGroupResult 227 * @syscap SystemCapability.ArkUI.ArkUI.Full 228 * @since 8 229 */ 230/** 231 * Defines the options of CheckboxGroupResult. 232 * 233 * @interface CheckboxGroupResult 234 * @syscap SystemCapability.ArkUI.ArkUI.Full 235 * @form 236 * @since 9 237 */ 238/** 239 * Defines the options of CheckboxGroupResult. 240 * 241 * @interface CheckboxGroupResult 242 * @syscap SystemCapability.ArkUI.ArkUI.Full 243 * @crossplatform 244 * @form 245 * @since 10 246 */ 247/** 248 * Defines the options of CheckboxGroupResult. 249 * 250 * @interface CheckboxGroupResult 251 * @syscap SystemCapability.ArkUI.ArkUI.Full 252 * @crossplatform 253 * @form 254 * @atomicservice 255 * @since 11 256 */ 257declare interface CheckboxGroupResult { 258 /** 259 * Checkbox name. 260 * 261 * @type { Array<string> } 262 * @syscap SystemCapability.ArkUI.ArkUI.Full 263 * @since 8 264 */ 265 /** 266 * Checkbox name. 267 * 268 * @type { Array<string> } 269 * @syscap SystemCapability.ArkUI.ArkUI.Full 270 * @form 271 * @since 9 272 */ 273 /** 274 * Checkbox name. 275 * 276 * @type { Array<string> } 277 * @syscap SystemCapability.ArkUI.ArkUI.Full 278 * @crossplatform 279 * @form 280 * @since 10 281 */ 282 /** 283 * Checkbox name. 284 * 285 * @type { Array<string> } 286 * @syscap SystemCapability.ArkUI.ArkUI.Full 287 * @crossplatform 288 * @form 289 * @atomicservice 290 * @since 11 291 */ 292 name: Array<string>; 293 /** 294 * Set the group of status. 295 * 296 * @type { SelectStatus } 297 * @syscap SystemCapability.ArkUI.ArkUI.Full 298 * @since 8 299 */ 300 /** 301 * Set the group of status. 302 * 303 * @type { SelectStatus } 304 * @syscap SystemCapability.ArkUI.ArkUI.Full 305 * @form 306 * @since 9 307 */ 308 /** 309 * Set the group of status. 310 * 311 * @type { SelectStatus } 312 * @syscap SystemCapability.ArkUI.ArkUI.Full 313 * @crossplatform 314 * @form 315 * @since 10 316 */ 317 /** 318 * Set the group of status. 319 * 320 * @type { SelectStatus } 321 * @syscap SystemCapability.ArkUI.ArkUI.Full 322 * @crossplatform 323 * @form 324 * @atomicservice 325 * @since 11 326 */ 327 status: SelectStatus; 328} 329 330/** 331 * Provides an interface for the CheckboxGroup component. 332 * 333 * @interface CheckboxGroupInterface 334 * @syscap SystemCapability.ArkUI.ArkUI.Full 335 * @since 8 336 */ 337/** 338 * Provides an interface for the CheckboxGroup component. 339 * 340 * @interface CheckboxGroupInterface 341 * @syscap SystemCapability.ArkUI.ArkUI.Full 342 * @form 343 * @since 9 344 */ 345/** 346 * Provides an interface for the CheckboxGroup component. 347 * 348 * @interface CheckboxGroupInterface 349 * @syscap SystemCapability.ArkUI.ArkUI.Full 350 * @crossplatform 351 * @form 352 * @since 10 353 */ 354/** 355 * Provides an interface for the CheckboxGroup component. 356 * 357 * @interface CheckboxGroupInterface 358 * @syscap SystemCapability.ArkUI.ArkUI.Full 359 * @crossplatform 360 * @form 361 * @atomicservice 362 * @since 11 363 */ 364interface CheckboxGroupInterface { 365 /** 366 * Called when the CheckboxGroup component is used. 367 * 368 * @param { CheckboxGroupOptions } options 369 * @returns { CheckboxGroupAttribute } 370 * @syscap SystemCapability.ArkUI.ArkUI.Full 371 * @since 8 372 */ 373 /** 374 * Called when the CheckboxGroup component is used. 375 * 376 * @param { CheckboxGroupOptions } options 377 * @returns { CheckboxGroupAttribute } 378 * @syscap SystemCapability.ArkUI.ArkUI.Full 379 * @form 380 * @since 9 381 */ 382 /** 383 * Called when the CheckboxGroup component is used. 384 * 385 * @param { CheckboxGroupOptions } options 386 * @returns { CheckboxGroupAttribute } 387 * @syscap SystemCapability.ArkUI.ArkUI.Full 388 * @crossplatform 389 * @form 390 * @since 10 391 */ 392 /** 393 * Called when the CheckboxGroup component is used. 394 * 395 * @param { CheckboxGroupOptions } options 396 * @returns { CheckboxGroupAttribute } 397 * @syscap SystemCapability.ArkUI.ArkUI.Full 398 * @crossplatform 399 * @form 400 * @atomicservice 401 * @since 11 402 */ 403 (options?: CheckboxGroupOptions): CheckboxGroupAttribute; 404} 405 406/** 407 * Defines a CheckboxGroup callback when onChange. 408 * Anonymous Object Rectification. 409 * 410 * @typedef { function } OnCheckboxGroupChangeCallback 411 * @param { CheckboxGroupResult } value - checkbox group result 412 * @syscap SystemCapability.ArkUI.ArkUI.Full 413 * @crossplatform 414 * @form 415 * @atomicservice 416 * @since 18 417 */ 418declare type OnCheckboxGroupChangeCallback = (value: CheckboxGroupResult) => void; 419 420/** 421 * Defines the attribute functions of CheckboxGroup. 422 * 423 * @extends CommonMethod<CheckboxGroupAttribute> 424 * @syscap SystemCapability.ArkUI.ArkUI.Full 425 * @since 8 426 */ 427/** 428 * Defines the attribute functions of CheckboxGroup. 429 * 430 * @extends CommonMethod<CheckboxGroupAttribute> 431 * @syscap SystemCapability.ArkUI.ArkUI.Full 432 * @form 433 * @since 9 434 */ 435/** 436 * Defines the attribute functions of CheckboxGroup. 437 * 438 * @extends CommonMethod<CheckboxGroupAttribute> 439 * @syscap SystemCapability.ArkUI.ArkUI.Full 440 * @crossplatform 441 * @form 442 * @since 10 443 */ 444/** 445 * Defines the attribute functions of CheckboxGroup. 446 * 447 * @extends CommonMethod<CheckboxGroupAttribute> 448 * @syscap SystemCapability.ArkUI.ArkUI.Full 449 * @crossplatform 450 * @form 451 * @atomicservice 452 * @since 11 453 */ 454declare class CheckboxGroupAttribute extends CommonMethod<CheckboxGroupAttribute> { 455 /** 456 * setting whether all checkbox is selected. 457 * 458 * @param { boolean } value 459 * @returns { CheckboxGroupAttribute } 460 * @syscap SystemCapability.ArkUI.ArkUI.Full 461 * @since 8 462 */ 463 /** 464 * setting whether all checkbox is selected. 465 * 466 * @param { boolean } value 467 * @returns { CheckboxGroupAttribute } 468 * @syscap SystemCapability.ArkUI.ArkUI.Full 469 * @form 470 * @since 9 471 */ 472 /** 473 * setting whether all checkbox is selected. 474 * 475 * @param { boolean } value 476 * @returns { CheckboxGroupAttribute } 477 * @syscap SystemCapability.ArkUI.ArkUI.Full 478 * @crossplatform 479 * @form 480 * @since 10 481 */ 482 /** 483 * setting whether all checkbox is selected. 484 * 485 * @param { boolean } value 486 * @returns { CheckboxGroupAttribute } 487 * @syscap SystemCapability.ArkUI.ArkUI.Full 488 * @crossplatform 489 * @form 490 * @atomicservice 491 * @since 11 492 */ 493 selectAll(value: boolean): CheckboxGroupAttribute; 494 495 /** 496 * setting whether all checkbox is selected. 497 * 498 * @param { Optional<boolean> } isAllSelected 499 * @returns { CheckboxGroupAttribute } 500 * @syscap SystemCapability.ArkUI.ArkUI.Full 501 * @crossplatform 502 * @form 503 * @atomicservice 504 * @since 18 505 */ 506 selectAll(isAllSelected: Optional<boolean>): CheckboxGroupAttribute; 507 508 /** 509 * setting the display color of checkbox. 510 * 511 * @param { ResourceColor } value 512 * @returns { CheckboxGroupAttribute } 513 * @syscap SystemCapability.ArkUI.ArkUI.Full 514 * @since 8 515 */ 516 /** 517 * setting the display color of checkbox. 518 * 519 * @param { ResourceColor } value 520 * @returns { CheckboxGroupAttribute } 521 * @syscap SystemCapability.ArkUI.ArkUI.Full 522 * @form 523 * @since 9 524 */ 525 /** 526 * setting the display color of checkbox. 527 * 528 * @param { ResourceColor } value 529 * @returns { CheckboxGroupAttribute } 530 * @syscap SystemCapability.ArkUI.ArkUI.Full 531 * @crossplatform 532 * @form 533 * @since 10 534 */ 535 /** 536 * setting the display color of checkbox. 537 * 538 * @param { ResourceColor } value 539 * @returns { CheckboxGroupAttribute } 540 * @syscap SystemCapability.ArkUI.ArkUI.Full 541 * @crossplatform 542 * @form 543 * @atomicservice 544 * @since 11 545 */ 546 selectedColor(value: ResourceColor): CheckboxGroupAttribute; 547 548 /** 549 * setting the display color of checkbox. 550 * 551 * @param { Optional<ResourceColor> } resColor 552 * @returns { CheckboxGroupAttribute } 553 * @syscap SystemCapability.ArkUI.ArkUI.Full 554 * @crossplatform 555 * @form 556 * @atomicservice 557 * @since 18 558 */ 559 selectedColor(resColor: Optional<ResourceColor>): CheckboxGroupAttribute; 560 561 /** 562 * Set the display border color of unselected checkbox. 563 * 564 * @param { ResourceColor } value - The color of border when checkboxgroup unselected. 565 * @returns { CheckboxGroupAttribute } 566 * @syscap SystemCapability.ArkUI.ArkUI.Full 567 * @crossplatform 568 * @since 10 569 */ 570 /** 571 * Set the display border color of unselected checkbox. 572 * 573 * @param { ResourceColor } value - The color of border when checkboxgroup unselected. 574 * @returns { CheckboxGroupAttribute } 575 * @syscap SystemCapability.ArkUI.ArkUI.Full 576 * @crossplatform 577 * @atomicservice 578 * @since 11 579 */ 580 unselectedColor(value: ResourceColor): CheckboxGroupAttribute; 581 582 /** 583 * Set the display border color of unselected checkbox. 584 * 585 * @param { Optional<ResourceColor> } resColor - The color of border when checkboxgroup unselected. 586 * @returns { CheckboxGroupAttribute } 587 * @syscap SystemCapability.ArkUI.ArkUI.Full 588 * @crossplatform 589 * @atomicservice 590 * @since 18 591 */ 592 unselectedColor(resColor: Optional<ResourceColor>): CheckboxGroupAttribute; 593 594 /** 595 * Set the mark style of checkbox. 596 * 597 * @param { MarkStyle } value - The style configuration of checkboxgroup mark. 598 * @returns { CheckboxGroupAttribute } 599 * @syscap SystemCapability.ArkUI.ArkUI.Full 600 * @crossplatform 601 * @since 10 602 */ 603 /** 604 * Set the mark style of checkbox. 605 * 606 * @param { MarkStyle } value - The style configuration of checkboxgroup mark. 607 * @returns { CheckboxGroupAttribute } 608 * @syscap SystemCapability.ArkUI.ArkUI.Full 609 * @crossplatform 610 * @atomicservice 611 * @since 11 612 */ 613 mark(value: MarkStyle): CheckboxGroupAttribute; 614 615 /** 616 * Set the mark style of checkbox. 617 * 618 * @param { Optional<MarkStyle> } style - The style configuration of checkboxgroup mark. 619 * @returns { CheckboxGroupAttribute } 620 * @syscap SystemCapability.ArkUI.ArkUI.Full 621 * @crossplatform 622 * @atomicservice 623 * @since 18 624 */ 625 mark(style: Optional<MarkStyle>): CheckboxGroupAttribute; 626 627 /** 628 * Called when the selection status changes. 629 * 630 * @param { function } callback 631 * @returns { CheckboxGroupAttribute } 632 * @syscap SystemCapability.ArkUI.ArkUI.Full 633 * @since 8 634 */ 635 /** 636 * Called when the selection status changes. 637 * 638 * @param { function } callback 639 * @returns { CheckboxGroupAttribute } 640 * @syscap SystemCapability.ArkUI.ArkUI.Full 641 * @form 642 * @since 9 643 */ 644 /** 645 * Called when the selection status changes. 646 * 647 * @param { function } callback 648 * @returns { CheckboxGroupAttribute } 649 * @syscap SystemCapability.ArkUI.ArkUI.Full 650 * @crossplatform 651 * @form 652 * @since 10 653 */ 654 /** 655 * Called when the selection status changes. 656 * 657 * @param { function } callback 658 * @returns { CheckboxGroupAttribute } 659 * @syscap SystemCapability.ArkUI.ArkUI.Full 660 * @crossplatform 661 * @form 662 * @atomicservice 663 * @since 11 664 */ 665 /** 666 * Called when the selection status changes. 667 * Anonymous Object Rectification. 668 * 669 * @param { OnCheckboxGroupChangeCallback } callback 670 * @returns { CheckboxGroupAttribute } 671 * @syscap SystemCapability.ArkUI.ArkUI.Full 672 * @crossplatform 673 * @form 674 * @atomicservice 675 * @since 18 676 */ 677 onChange(callback: OnCheckboxGroupChangeCallback): CheckboxGroupAttribute; 678 679 /** 680 * Called when the selection status changes. 681 * 682 * @param { Optional<OnCheckboxGroupChangeCallback> } callback 683 * @returns { CheckboxGroupAttribute } 684 * @syscap SystemCapability.ArkUI.ArkUI.Full 685 * @crossplatform 686 * @form 687 * @atomicservice 688 * @since 18 689 */ 690 onChange(callback: Optional<OnCheckboxGroupChangeCallback>): CheckboxGroupAttribute; 691 692 /** 693 * Setting the shape of checkbox group. 694 * 695 * @param { CheckBoxShape } value - The configuration of checkbox group shape. 696 * @returns { CheckboxGroupAttribute } 697 * @syscap SystemCapability.ArkUI.ArkUI.Full 698 * @crossplatform 699 * @form 700 * @atomicservice 701 * @since 12 702 */ 703 checkboxShape(value: CheckBoxShape): CheckboxGroupAttribute; 704 705 /** 706 * Setting the shape of checkbox group. 707 * 708 * @param { Optional<CheckBoxShape> } shape - The configuration of checkbox group shape. 709 * @returns { CheckboxGroupAttribute } 710 * @syscap SystemCapability.ArkUI.ArkUI.Full 711 * @crossplatform 712 * @form 713 * @atomicservice 714 * @since 18 715 */ 716 checkboxShape(shape: Optional<CheckBoxShape>): CheckboxGroupAttribute; 717} 718 719/** 720 * Defines CheckboxGroup Component. 721 * 722 * @syscap SystemCapability.ArkUI.ArkUI.Full 723 * @since 8 724 */ 725/** 726 * Defines CheckboxGroup Component. 727 * 728 * @syscap SystemCapability.ArkUI.ArkUI.Full 729 * @form 730 * @since 9 731 */ 732/** 733 * Defines CheckboxGroup Component. 734 * 735 * @syscap SystemCapability.ArkUI.ArkUI.Full 736 * @crossplatform 737 * @form 738 * @since 10 739 */ 740/** 741 * Defines CheckboxGroup Component. 742 * 743 * @syscap SystemCapability.ArkUI.ArkUI.Full 744 * @crossplatform 745 * @form 746 * @atomicservice 747 * @since 11 748 */ 749declare const CheckboxGroup: CheckboxGroupInterface; 750 751/** 752 * Defines CheckboxGroup Component instance. 753 * 754 * @syscap SystemCapability.ArkUI.ArkUI.Full 755 * @since 8 756 */ 757/** 758 * Defines CheckboxGroup Component instance. 759 * 760 * @syscap SystemCapability.ArkUI.ArkUI.Full 761 * @form 762 * @since 9 763 */ 764/** 765 * Defines CheckboxGroup Component instance. 766 * 767 * @syscap SystemCapability.ArkUI.ArkUI.Full 768 * @crossplatform 769 * @form 770 * @since 10 771 */ 772/** 773 * Defines CheckboxGroup Component instance. 774 * 775 * @syscap SystemCapability.ArkUI.ArkUI.Full 776 * @crossplatform 777 * @form 778 * @atomicservice 779 * @since 11 780 */ 781declare const CheckboxGroupInstance: CheckboxGroupAttribute; 782