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 * Defines the struct of DatePickerResult. 23 * 24 * @interface DatePickerResult 25 * @syscap SystemCapability.ArkUI.ArkUI.Full 26 * @since 8 27 */ 28/** 29 * Defines the struct of DatePickerResult. 30 * 31 * @interface DatePickerResult 32 * @syscap SystemCapability.ArkUI.ArkUI.Full 33 * @crossplatform 34 * @since 10 35 */ 36/** 37 * Defines the struct of DatePickerResult. 38 * 39 * @interface DatePickerResult 40 * @syscap SystemCapability.ArkUI.ArkUI.Full 41 * @crossplatform 42 * @atomicservice 43 * @since 11 44 */ 45declare interface DatePickerResult { 46 /** 47 * Application year 48 * 49 * @type { ?number } 50 * @syscap SystemCapability.ArkUI.ArkUI.Full 51 * @since 8 52 */ 53 /** 54 * Application year 55 * 56 * @type { ?number } 57 * @syscap SystemCapability.ArkUI.ArkUI.Full 58 * @crossplatform 59 * @since 10 60 */ 61 /** 62 * Application year 63 * 64 * @type { ?number } 65 * @syscap SystemCapability.ArkUI.ArkUI.Full 66 * @crossplatform 67 * @atomicservice 68 * @since 11 69 */ 70 year?: number; 71 72 /** 73 * Application month 74 * 75 * @type { ?number } 76 * @syscap SystemCapability.ArkUI.ArkUI.Full 77 * @since 8 78 */ 79 /** 80 * Application month 81 * 82 * @type { ?number } 83 * @syscap SystemCapability.ArkUI.ArkUI.Full 84 * @crossplatform 85 * @since 10 86 */ 87 /** 88 * Application month 89 * 90 * @type { ?number } 91 * @syscap SystemCapability.ArkUI.ArkUI.Full 92 * @crossplatform 93 * @atomicservice 94 * @since 11 95 */ 96 month?: number; 97 98 /** 99 * Application day 100 * 101 * @type { ?number } 102 * @syscap SystemCapability.ArkUI.ArkUI.Full 103 * @since 8 104 */ 105 /** 106 * Application day 107 * 108 * @type { ?number } 109 * @syscap SystemCapability.ArkUI.ArkUI.Full 110 * @crossplatform 111 * @since 10 112 */ 113 /** 114 * Application day 115 * 116 * @type { ?number } 117 * @syscap SystemCapability.ArkUI.ArkUI.Full 118 * @crossplatform 119 * @atomicservice 120 * @since 11 121 */ 122 day?: number; 123} 124 125/** 126 * Defines the mode of the date picker. 127 * 128 * @enum { number } 129 * @syscap SystemCapability.ArkUI.ArkUI.Full 130 * @crossplatform 131 * @atomicservice 132 * @since 18 133 */ 134declare enum DatePickerMode { 135 /** 136 * Defines a mode that displays the date in months, days of month, and years. 137 * 138 * @syscap SystemCapability.ArkUI.ArkUI.Full 139 * @crossplatform 140 * @atomicservice 141 * @since 18 142 */ 143 DATE = 0, 144 145 /** 146 * Defines a mode that displays the date in months and years. 147 * 148 * @syscap SystemCapability.ArkUI.ArkUI.Full 149 * @crossplatform 150 * @atomicservice 151 * @since 18 152 */ 153 YEAR_AND_MONTH = 1, 154 155 /** 156 * Defines a mode that displays the date in months and days of the month. 157 * 158 * @syscap SystemCapability.ArkUI.ArkUI.Full 159 * @crossplatform 160 * @atomicservice 161 * @since 18 162 */ 163 MONTH_AND_DAY = 2, 164} 165 166/** 167 * Defines the options of DatePicker. 168 * 169 * @interface DatePickerOptions 170 * @syscap SystemCapability.ArkUI.ArkUI.Full 171 * @since 8 172 */ 173/** 174 * Defines the options of DatePicker. 175 * 176 * @interface DatePickerOptions 177 * @syscap SystemCapability.ArkUI.ArkUI.Full 178 * @crossplatform 179 * @since 10 180 */ 181/** 182 * Defines the options of DatePicker. 183 * 184 * @interface DatePickerOptions 185 * @syscap SystemCapability.ArkUI.ArkUI.Full 186 * @crossplatform 187 * @atomicservice 188 * @since 11 189 */ 190declare interface DatePickerOptions { 191 /** 192 * Specifies the start date of the date selector. 193 * 194 * @type { ?Date } 195 * @syscap SystemCapability.ArkUI.ArkUI.Full 196 * @since 8 197 */ 198 /** 199 * Specifies the start date of the date selector. 200 * 201 * @type { ?Date } 202 * @syscap SystemCapability.ArkUI.ArkUI.Full 203 * @crossplatform 204 * @since 10 205 */ 206 /** 207 * Specifies the start date of the date selector. 208 * 209 * @type { ?Date } 210 * @syscap SystemCapability.ArkUI.ArkUI.Full 211 * @crossplatform 212 * @atomicservice 213 * @since 11 214 */ 215 start?: Date; 216 217 /** 218 * Specifies the end date for the date selector. 219 * 220 * @type { ?Date } 221 * @syscap SystemCapability.ArkUI.ArkUI.Full 222 * @since 8 223 */ 224 /** 225 * Specifies the end date for the date selector. 226 * 227 * @type { ?Date } 228 * @syscap SystemCapability.ArkUI.ArkUI.Full 229 * @crossplatform 230 * @since 10 231 */ 232 /** 233 * Specifies the end date for the date selector. 234 * 235 * @type { ?Date } 236 * @syscap SystemCapability.ArkUI.ArkUI.Full 237 * @crossplatform 238 * @atomicservice 239 * @since 11 240 */ 241 end?: Date; 242 243 /** 244 * Specifies the date selector check date or time selector check time. 245 * 246 * @type { ?Date } 247 * @syscap SystemCapability.ArkUI.ArkUI.Full 248 * @since 8 249 */ 250 /** 251 * Specifies the date selector check date or time selector check time. 252 * 253 * @type { ?Date } 254 * @syscap SystemCapability.ArkUI.ArkUI.Full 255 * @crossplatform 256 * @since 10 257 */ 258 /** 259 * Specifies the date selector check date or time selector check time. 260 * 261 * @type { ?Date } 262 * @syscap SystemCapability.ArkUI.ArkUI.Full 263 * @crossplatform 264 * @atomicservice 265 * @since 11 266 */ 267 selected?: Date; 268 269 /** 270 * Defines the mode of the date picker. 271 * 272 * @type { ?DatePickerMode } 273 * @syscap SystemCapability.ArkUI.ArkUI.Full 274 * @crossplatform 275 * @atomicservice 276 * @since 18 277 */ 278 mode?: DatePickerMode; 279} 280 281/** 282 * Defines the DatePicker Component. 283 * 284 * @interface DatePickerInterface 285 * @syscap SystemCapability.ArkUI.ArkUI.Full 286 * @since 8 287 */ 288/** 289 * Defines the DatePicker Component. 290 * 291 * @interface DatePickerInterface 292 * @syscap SystemCapability.ArkUI.ArkUI.Full 293 * @crossplatform 294 * @since 10 295 */ 296/** 297 * Defines the DatePicker Component. 298 * 299 * @interface DatePickerInterface 300 * @syscap SystemCapability.ArkUI.ArkUI.Full 301 * @crossplatform 302 * @atomicservice 303 * @since 11 304 */ 305interface DatePickerInterface { 306 /** 307 * Defines the DatePicker constructor. 308 * 309 * @param { DatePickerOptions } options 310 * @returns { DatePickerAttribute } 311 * @syscap SystemCapability.ArkUI.ArkUI.Full 312 * @since 8 313 */ 314 /** 315 * Defines the DatePicker constructor. 316 * 317 * @param { DatePickerOptions } options 318 * @returns { DatePickerAttribute } 319 * @syscap SystemCapability.ArkUI.ArkUI.Full 320 * @crossplatform 321 * @since 10 322 */ 323 /** 324 * Defines the DatePicker constructor. 325 * 326 * @param { DatePickerOptions } options 327 * @returns { DatePickerAttribute } 328 * @syscap SystemCapability.ArkUI.ArkUI.Full 329 * @crossplatform 330 * @atomicservice 331 * @since 11 332 */ 333 (options?: DatePickerOptions): DatePickerAttribute; 334} 335 336/** 337 * Defines the DatePicker attribute functions. 338 * 339 * @extends CommonMethod 340 * @syscap SystemCapability.ArkUI.ArkUI.Full 341 * @since 8 342 */ 343/** 344 * Defines the DatePicker attribute functions. 345 * 346 * @extends CommonMethod 347 * @syscap SystemCapability.ArkUI.ArkUI.Full 348 * @crossplatform 349 * @since 10 350 */ 351/** 352 * Defines the DatePicker attribute functions. 353 * 354 * @extends CommonMethod<DatePickerAttribute> 355 * @syscap SystemCapability.ArkUI.ArkUI.Full 356 * @crossplatform 357 * @atomicservice 358 * @since 11 359 */ 360declare class DatePickerAttribute extends CommonMethod<DatePickerAttribute> { 361 /** 362 * Date selector: true: displays the lunar calendar. false: The lunar calendar is not displayed. 363 * 364 * @param { boolean } value 365 * @returns { DatePickerAttribute } 366 * @syscap SystemCapability.ArkUI.ArkUI.Full 367 * @since 8 368 */ 369 /** 370 * Date selector: true: displays the lunar calendar. false: The lunar calendar is not displayed. 371 * 372 * @param { boolean } value 373 * @returns { DatePickerAttribute } 374 * @syscap SystemCapability.ArkUI.ArkUI.Full 375 * @crossplatform 376 * @since 10 377 */ 378 /** 379 * Date selector: true: displays the lunar calendar. false: The lunar calendar is not displayed. 380 * 381 * @param { boolean } value 382 * @returns { DatePickerAttribute } 383 * @syscap SystemCapability.ArkUI.ArkUI.Full 384 * @crossplatform 385 * @atomicservice 386 * @since 11 387 */ 388 lunar(value: boolean): DatePickerAttribute; 389 390 /** 391 * Date selector: true: displays the lunar calendar. false: The lunar calendar is not displayed. 392 * 393 * @param { Optional<boolean> } isLunar 394 * @returns { DatePickerAttribute } 395 * @syscap SystemCapability.ArkUI.ArkUI.Full 396 * @crossplatform 397 * @atomicservice 398 * @since 18 399 */ 400 lunar(isLunar: Optional<boolean>): DatePickerAttribute; 401 402 /** 403 * Sets the text style of disappearing items 404 * 405 * @param { PickerTextStyle } value - indicates the text style of disappearing items. 406 * @returns { DatePickerAttribute } 407 * @syscap SystemCapability.ArkUI.ArkUI.Full 408 * @crossplatform 409 * @since 10 410 */ 411 /** 412 * Sets the text style of disappearing items 413 * 414 * @param { PickerTextStyle } value - indicates the text style of disappearing items. 415 * @returns { DatePickerAttribute } 416 * @syscap SystemCapability.ArkUI.ArkUI.Full 417 * @crossplatform 418 * @atomicservice 419 * @since 11 420 */ 421 disappearTextStyle(value: PickerTextStyle): DatePickerAttribute; 422 423 /** 424 * Sets the text style of disappearing items 425 * 426 * @param { Optional<PickerTextStyle> } style - indicates the text style of disappearing items. 427 * @returns { DatePickerAttribute } 428 * @syscap SystemCapability.ArkUI.ArkUI.Full 429 * @crossplatform 430 * @atomicservice 431 * @since 18 432 */ 433 disappearTextStyle(style: Optional<PickerTextStyle>): DatePickerAttribute; 434 435 /** 436 * Sets the text style of normal items 437 * 438 * @param { PickerTextStyle } value - indicates the text style of normal items. 439 * @returns { DatePickerAttribute } 440 * @syscap SystemCapability.ArkUI.ArkUI.Full 441 * @crossplatform 442 * @since 10 443 */ 444 /** 445 * Sets the text style of normal items 446 * 447 * @param { PickerTextStyle } value - indicates the text style of normal items. 448 * @returns { DatePickerAttribute } 449 * @syscap SystemCapability.ArkUI.ArkUI.Full 450 * @crossplatform 451 * @atomicservice 452 * @since 11 453 */ 454 textStyle(value: PickerTextStyle): DatePickerAttribute; 455 456 /** 457 * Sets the text style of normal items 458 * 459 * @param { Optional<PickerTextStyle> } style - indicates the text style of normal items. 460 * @returns { DatePickerAttribute } 461 * @syscap SystemCapability.ArkUI.ArkUI.Full 462 * @crossplatform 463 * @atomicservice 464 * @since 18 465 */ 466 textStyle(style: Optional<PickerTextStyle>): DatePickerAttribute; 467 468 /** 469 * Sets the text style of selected items 470 * 471 * @param { PickerTextStyle } value - indicates the text style of selected items. 472 * @returns { DatePickerAttribute } 473 * @syscap SystemCapability.ArkUI.ArkUI.Full 474 * @crossplatform 475 * @since 10 476 */ 477 /** 478 * Sets the text style of selected items 479 * 480 * @param { PickerTextStyle } value - indicates the text style of selected items. 481 * @returns { DatePickerAttribute } 482 * @syscap SystemCapability.ArkUI.ArkUI.Full 483 * @crossplatform 484 * @atomicservice 485 * @since 11 486 */ 487 selectedTextStyle(value: PickerTextStyle): DatePickerAttribute; 488 489 /** 490 * Sets the text style of selected items 491 * 492 * @param { Optional<PickerTextStyle> } style - indicates the text style of selected items. 493 * @returns { DatePickerAttribute } 494 * @syscap SystemCapability.ArkUI.ArkUI.Full 495 * @crossplatform 496 * @atomicservice 497 * @since 18 498 */ 499 selectedTextStyle(style: Optional<PickerTextStyle>): DatePickerAttribute; 500 501 /** 502 * This event is triggered when a DatePicker date or time is selected. 503 * 504 * @param { function } callback 505 * @returns { DatePickerAttribute } 506 * @syscap SystemCapability.ArkUI.ArkUI.Full 507 * @since 8 508 * @deprecated since 10 509 * @useinstead datePicker/DatePickerAttribute#onDateChange 510 */ 511 onChange(callback: (value: DatePickerResult) => void): DatePickerAttribute; 512 513 /** 514 * This event is triggered when a DatePicker date or time is selected. 515 * 516 * @param { function } callback 517 * @returns { DatePickerAttribute } 518 * @syscap SystemCapability.ArkUI.ArkUI.Full 519 * @crossplatform 520 * @since 10 521 */ 522 /** 523 * This event is triggered when a DatePicker date or time is selected. 524 * 525 * @param { function } callback 526 * @returns { DatePickerAttribute } 527 * @syscap SystemCapability.ArkUI.ArkUI.Full 528 * @crossplatform 529 * @atomicservice 530 * @since 11 531 */ 532 /** 533 * This event is triggered when a DatePicker date or time is selected. 534 * Anonymous Object Rectification. 535 * 536 * @param { Callback<Date> } callback 537 * @returns { DatePickerAttribute } 538 * @syscap SystemCapability.ArkUI.ArkUI.Full 539 * @crossplatform 540 * @atomicservice 541 * @since 18 542 */ 543 onDateChange(callback: Callback<Date>): DatePickerAttribute; 544 545 /** 546 * This event is triggered when a DatePicker date or time is selected. 547 * 548 * @param { Optional<Callback<Date>> } callback 549 * @returns { DatePickerAttribute } 550 * @syscap SystemCapability.ArkUI.ArkUI.Full 551 * @crossplatform 552 * @atomicservice 553 * @since 18 554 */ 555 onDateChange(callback: Optional<Callback<Date>>): DatePickerAttribute; 556 557 /** 558 * If the attribute is set, the crown rotation sensitivity can be changed. 559 * 560 * @param { Optional<CrownSensitivity> } sensitivity 561 * @returns { DatePickerAttribute } 562 * @syscap SystemCapability.ArkUI.ArkUI.Full 563 * @crossplatform 564 * @atomicservice 565 * @since 18 566 */ 567 digitalCrownSensitivity(sensitivity: Optional<CrownSensitivity>): DatePickerAttribute; 568 569 /** 570 * Enable or disable haptic feedback. 571 * 572 * @param { Optional<boolean> } enable - Default value is true, set false to disable haptic feedback. 573 * @returns { DatePickerAttribute } 574 * @syscap SystemCapability.ArkUI.ArkUI.Full 575 * @atomicservice 576 * @since 18 577 */ 578 enableHapticFeedback(enable: Optional<boolean>): DatePickerAttribute; 579} 580 581/** 582 * Provide an interface for the lunar switch style of DatePickerDialog 583 * 584 * @interface LunarSwitchStyle 585 * @syscap SystemCapability.ArkUI.ArkUI.Full 586 * @crossplatform 587 * @atomicservice 588 * @since 14 589 */ 590declare interface LunarSwitchStyle { 591 /** 592 * Define the selected color of lunar switch. 593 * 594 * @type { ?ResourceColor } 595 * @syscap SystemCapability.ArkUI.ArkUI.Full 596 * @crossplatform 597 * @atomicservice 598 * @since 14 599 */ 600 selectedColor?: ResourceColor; 601 602 /** 603 * Define the unselected color of lunar switch. 604 * 605 * @type { ?ResourceColor } 606 * @syscap SystemCapability.ArkUI.ArkUI.Full 607 * @crossplatform 608 * @atomicservice 609 * @since 14 610 */ 611 unselectedColor?: ResourceColor; 612 613 /** 614 * Define the stroke color of lunar switch. 615 * 616 * @type { ?ResourceColor } 617 * @syscap SystemCapability.ArkUI.ArkUI.Full 618 * @crossplatform 619 * @atomicservice 620 * @since 14 621 */ 622 strokeColor?: ResourceColor; 623} 624 625/** 626 * Defines the DatePickerDialogOptions for Data Picker Dialog. 627 * 628 * @extends DatePickerOptions 629 * @interface DatePickerDialogOptions 630 * @syscap SystemCapability.ArkUI.ArkUI.Full 631 * @since 8 632 */ 633/** 634 * Defines the DatePickerDialogOptions for Data Picker Dialog. 635 * 636 * @extends DatePickerOptions 637 * @interface DatePickerDialogOptions 638 * @syscap SystemCapability.ArkUI.ArkUI.Full 639 * @crossplatform 640 * @since 10 641 */ 642/** 643 * Defines the DatePickerDialogOptions for Data Picker Dialog. 644 * 645 * @extends DatePickerOptions 646 * @interface DatePickerDialogOptions 647 * @syscap SystemCapability.ArkUI.ArkUI.Full 648 * @crossplatform 649 * @atomicservice 650 * @since 11 651 */ 652declare interface DatePickerDialogOptions extends DatePickerOptions { 653 /** 654 * Date selector: true: displays the lunar calendar. false: The lunar calendar is not displayed. 655 * 656 * @type { ?boolean } 657 * @syscap SystemCapability.ArkUI.ArkUI.Full 658 * @since 8 659 */ 660 /** 661 * Date selector: true: displays the lunar calendar. false: The lunar calendar is not displayed. 662 * 663 * @type { ?boolean } 664 * @syscap SystemCapability.ArkUI.ArkUI.Full 665 * @crossplatform 666 * @since 10 667 */ 668 /** 669 * Date selector: true: displays the lunar calendar. false: The lunar calendar is not displayed. 670 * 671 * @type { ?boolean } 672 * @syscap SystemCapability.ArkUI.ArkUI.Full 673 * @crossplatform 674 * @atomicservice 675 * @since 11 676 */ 677 lunar?: boolean; 678 679 /** 680 * Whether to show the switch to display the lunar. 681 * 682 * @type { ?boolean } value - indicates whether to show the switch to display the lunar 683 * @syscap SystemCapability.ArkUI.ArkUI.Full 684 * @crossplatform 685 * @since 10 686 */ 687 /** 688 * Whether to show the switch to display the lunar. 689 * 690 * @type { ?boolean } value - indicates whether to show the switch to display the lunar 691 * @syscap SystemCapability.ArkUI.ArkUI.Full 692 * @crossplatform 693 * @atomicservice 694 * @since 11 695 */ 696 lunarSwitch?: boolean; 697 698 /** 699 * Describes the lunar switch color. 700 * 701 * @type { ?LunarSwitchStyle } 702 * @syscap SystemCapability.ArkUI.ArkUI.Full 703 * @crossplatform 704 * @atomicservice 705 * @since 14 706 */ 707 lunarSwitchStyle?: LunarSwitchStyle; 708 709 /** 710 * Indicates whether to show the time selector. 711 * 712 * @type { ?boolean } 713 * @syscap SystemCapability.ArkUI.ArkUI.Full 714 * @crossplatform 715 * @since 10 716 */ 717 /** 718 * Indicates whether to show the time selector. 719 * 720 * @type { ?boolean } 721 * @syscap SystemCapability.ArkUI.ArkUI.Full 722 * @crossplatform 723 * @atomicservice 724 * @since 11 725 */ 726 showTime?: boolean; 727 728 /** 729 * Indicates whether to display the 24-hour clock. 730 * 731 * @type { ?boolean } 732 * @syscap SystemCapability.ArkUI.ArkUI.Full 733 * @crossplatform 734 * @since 10 735 */ 736 /** 737 * Indicates whether to display the 24-hour clock. 738 * 739 * @type { ?boolean } 740 * @syscap SystemCapability.ArkUI.ArkUI.Full 741 * @crossplatform 742 * @atomicservice 743 * @since 11 744 */ 745 useMilitaryTime?: boolean; 746 747 /** 748 * Text style of disappearing items 749 * 750 * @type { ?PickerTextStyle } 751 * @syscap SystemCapability.ArkUI.ArkUI.Full 752 * @crossplatform 753 * @since 10 754 */ 755 /** 756 * Text style of disappearing items 757 * 758 * @type { ?PickerTextStyle } 759 * @syscap SystemCapability.ArkUI.ArkUI.Full 760 * @crossplatform 761 * @atomicservice 762 * @since 11 763 */ 764 disappearTextStyle?: PickerTextStyle; 765 766 /** 767 * Text style of normal items 768 * 769 * @type { ?PickerTextStyle } 770 * @syscap SystemCapability.ArkUI.ArkUI.Full 771 * @crossplatform 772 * @since 10 773 */ 774 /** 775 * Text style of normal items 776 * 777 * @type { ?PickerTextStyle } 778 * @syscap SystemCapability.ArkUI.ArkUI.Full 779 * @crossplatform 780 * @atomicservice 781 * @since 11 782 */ 783 textStyle?: PickerTextStyle; 784 785 /** 786 * Style of accept button. 787 * 788 * @type { ?PickerDialogButtonStyle } 789 * @syscap SystemCapability.ArkUI.ArkUI.Full 790 * @crossplatform 791 * @atomicservice 792 * @since 12 793 */ 794 acceptButtonStyle?: PickerDialogButtonStyle; 795 796 /** 797 * Style of cancel button. 798 * 799 * @type { ?PickerDialogButtonStyle } 800 * @syscap SystemCapability.ArkUI.ArkUI.Full 801 * @crossplatform 802 * @atomicservice 803 * @since 12 804 */ 805 cancelButtonStyle?: PickerDialogButtonStyle; 806 807 /** 808 * Text style of selected items 809 * 810 * @type { ?PickerTextStyle } 811 * @syscap SystemCapability.ArkUI.ArkUI.Full 812 * @crossplatform 813 * @since 10 814 */ 815 /** 816 * Text style of selected items 817 * 818 * @type { ?PickerTextStyle } 819 * @syscap SystemCapability.ArkUI.ArkUI.Full 820 * @crossplatform 821 * @atomicservice 822 * @since 11 823 */ 824 selectedTextStyle?: PickerTextStyle; 825 826 /** 827 * Mask Region of dialog. The size cannot exceed the main window. 828 * 829 * @type { ?Rectangle } 830 * @syscap SystemCapability.ArkUI.ArkUI.Full 831 * @crossplatform 832 * @since 10 833 */ 834 /** 835 * Mask Region of dialog. The size cannot exceed the main window. 836 * 837 * @type { ?Rectangle } 838 * @syscap SystemCapability.ArkUI.ArkUI.Full 839 * @crossplatform 840 * @atomicservice 841 * @since 11 842 */ 843 maskRect?: Rectangle; 844 845 /** 846 * Defines the dialog alignment of the screen. 847 * 848 * @type { ?DialogAlignment } 849 * @syscap SystemCapability.ArkUI.ArkUI.Full 850 * @crossplatform 851 * @since 10 852 */ 853 /** 854 * Defines the dialog alignment of the screen. 855 * 856 * @type { ?DialogAlignment } 857 * @syscap SystemCapability.ArkUI.ArkUI.Full 858 * @crossplatform 859 * @atomicservice 860 * @since 11 861 */ 862 alignment?: DialogAlignment; 863 864 /** 865 * Defines the dialog offset. 866 * 867 * @type { ?Offset } 868 * @syscap SystemCapability.ArkUI.ArkUI.Full 869 * @crossplatform 870 * @since 10 871 */ 872 /** 873 * Defines the dialog offset. 874 * 875 * @type { ?Offset } 876 * @syscap SystemCapability.ArkUI.ArkUI.Full 877 * @crossplatform 878 * @atomicservice 879 * @since 11 880 */ 881 offset?: Offset; 882 883 /** 884 * Called when the OK button in the dialog is clicked. 885 * 886 * @type { ?function } 887 * @syscap SystemCapability.ArkUI.ArkUI.Full 888 * @since 8 889 * @deprecated since 10 890 * @useinstead datePicker/DatePickerDialogOptions#onDateAccept 891 */ 892 onAccept?: (value: DatePickerResult) => void; 893 894 /** 895 * Called when the Cancel button in the dialog is clicked. 896 * 897 * @type { ?function } 898 * @syscap SystemCapability.ArkUI.ArkUI.Full 899 * @since 8 900 */ 901 /** 902 * Called when the Cancel button in the dialog is clicked. 903 * 904 * @type { ?function } 905 * @syscap SystemCapability.ArkUI.ArkUI.Full 906 * @crossplatform 907 * @since 10 908 */ 909 /** 910 * Called when the Cancel button in the dialog is clicked. 911 * 912 * @type { ?function } 913 * @syscap SystemCapability.ArkUI.ArkUI.Full 914 * @crossplatform 915 * @atomicservice 916 * @since 11 917 */ 918 /** 919 * Called when the Cancel button in the dialog is clicked. 920 * Anonymous Object Rectification. 921 * 922 * @type { ?VoidCallback } 923 * @syscap SystemCapability.ArkUI.ArkUI.Full 924 * @crossplatform 925 * @atomicservice 926 * @since 18 927 */ 928 onCancel?: VoidCallback; 929 930 /** 931 * This event is triggered when a DatePicker date or time is selected in dialog. 932 * 933 * @type { ?function } 934 * @syscap SystemCapability.ArkUI.ArkUI.Full 935 * @since 8 936 * @deprecated since 10 937 * @useinstead datePicker/DatePickerDialogOptions#onDateChange 938 */ 939 onChange?: (value: DatePickerResult) => void; 940 941 /** 942 * Called when the OK button in the dialog is clicked. 943 * 944 * @type { ?function } 945 * @syscap SystemCapability.ArkUI.ArkUI.Full 946 * @crossplatform 947 * @since 10 948 */ 949 /** 950 * Called when the OK button in the dialog is clicked. 951 * 952 * @type { ?function } 953 * @syscap SystemCapability.ArkUI.ArkUI.Full 954 * @crossplatform 955 * @atomicservice 956 * @since 11 957 */ 958 /** 959 * Called when the OK button in the dialog is clicked. 960 * Anonymous Object Rectification. 961 * 962 * @type { ?Callback<Date> } 963 * @syscap SystemCapability.ArkUI.ArkUI.Full 964 * @crossplatform 965 * @atomicservice 966 * @since 18 967 */ 968 onDateAccept?: Callback<Date>; 969 970 /** 971 * This event is triggered when a DatePicker date or time is selected in dialog. 972 * 973 * @type { ?function } 974 * @syscap SystemCapability.ArkUI.ArkUI.Full 975 * @crossplatform 976 * @since 10 977 */ 978 /** 979 * This event is triggered when a DatePicker date or time is selected in dialog. 980 * 981 * @type { ?function } 982 * @syscap SystemCapability.ArkUI.ArkUI.Full 983 * @crossplatform 984 * @atomicservice 985 * @since 11 986 */ 987 /** 988 * This event is triggered when a DatePicker date or time is selected in dialog. 989 * Anonymous Object Rectification. 990 * 991 * @type { ?Callback<Date> } 992 * @syscap SystemCapability.ArkUI.ArkUI.Full 993 * @crossplatform 994 * @atomicservice 995 * @since 18 996 */ 997 onDateChange?: Callback<Date>; 998 999 /** 1000 * Defines the datePickerDialog's background color 1001 * 1002 * @type { ?ResourceColor } 1003 * @default Color.Transparent 1004 * @syscap SystemCapability.ArkUI.ArkUI.Full 1005 * @crossplatform 1006 * @since 11 1007 */ 1008 /** 1009 * Defines the datePickerDialog's background color 1010 * 1011 * @type { ?ResourceColor } 1012 * @default Color.Transparent 1013 * @syscap SystemCapability.ArkUI.ArkUI.Full 1014 * @crossplatform 1015 * @atomicservice 1016 * @since 12 1017 */ 1018 backgroundColor?: ResourceColor; 1019 1020 /** 1021 * Defines the datePickerDialog's background blur Style 1022 * 1023 * @type { ?BlurStyle } 1024 * @default BlurStyle.COMPONENT_ULTRA_THICK 1025 * @syscap SystemCapability.ArkUI.ArkUI.Full 1026 * @crossplatform 1027 * @since 11 1028 */ 1029 /** 1030 * Defines the datePickerDialog's background blur Style 1031 * 1032 * @type { ?BlurStyle } 1033 * @default BlurStyle.COMPONENT_ULTRA_THICK 1034 * @syscap SystemCapability.ArkUI.ArkUI.Full 1035 * @crossplatform 1036 * @atomicservice 1037 * @since 12 1038 */ 1039 backgroundBlurStyle?: BlurStyle; 1040 1041 /** 1042 * Callback function when the dialog appears. 1043 * 1044 * @type { ?function } 1045 * @syscap SystemCapability.ArkUI.ArkUI.Full 1046 * @crossplatform 1047 * @atomicservice 1048 * @since 12 1049 */ 1050 /** 1051 * Callback function when the dialog appears. 1052 * Anonymous Object Rectification. 1053 * 1054 * @type { ?VoidCallback } 1055 * @syscap SystemCapability.ArkUI.ArkUI.Full 1056 * @crossplatform 1057 * @atomicservice 1058 * @since 18 1059 */ 1060 onDidAppear?: VoidCallback; 1061 1062 /** 1063 * Callback function when the dialog disappears. 1064 * 1065 * @type { ?function } 1066 * @syscap SystemCapability.ArkUI.ArkUI.Full 1067 * @crossplatform 1068 * @atomicservice 1069 * @since 12 1070 */ 1071 /** 1072 * Callback function when the dialog disappears. 1073 * Anonymous Object Rectification. 1074 * 1075 * @type { ?VoidCallback } 1076 * @syscap SystemCapability.ArkUI.ArkUI.Full 1077 * @crossplatform 1078 * @atomicservice 1079 * @since 18 1080 */ 1081 onDidDisappear?: VoidCallback; 1082 1083 /** 1084 * Callback function before the dialog openAnimation starts. 1085 * 1086 * @type { ?function } 1087 * @syscap SystemCapability.ArkUI.ArkUI.Full 1088 * @crossplatform 1089 * @atomicservice 1090 * @since 12 1091 */ 1092 /** 1093 * Callback function before the dialog openAnimation starts. 1094 * Anonymous Object Rectification. 1095 * 1096 * @type { ?VoidCallback } 1097 * @syscap SystemCapability.ArkUI.ArkUI.Full 1098 * @crossplatform 1099 * @atomicservice 1100 * @since 18 1101 */ 1102 onWillAppear?: VoidCallback; 1103 1104 /** 1105 * Callback function before the dialog closeAnimation starts. 1106 * 1107 * @type { ?function } 1108 * @syscap SystemCapability.ArkUI.ArkUI.Full 1109 * @crossplatform 1110 * @atomicservice 1111 * @since 12 1112 */ 1113 /** 1114 * Callback function before the dialog closeAnimation starts. 1115 * Anonymous Object Rectification. 1116 * 1117 * @type { ?VoidCallback } 1118 * @syscap SystemCapability.ArkUI.ArkUI.Full 1119 * @crossplatform 1120 * @atomicservice 1121 * @since 18 1122 */ 1123 onWillDisappear?: VoidCallback; 1124 1125 /** 1126 * Defines the dialog's shadow. 1127 * 1128 * @type { ?(ShadowOptions | ShadowStyle) } 1129 * @syscap SystemCapability.ArkUI.ArkUI.Full 1130 * @crossplatform 1131 * @atomicservice 1132 * @since 12 1133 */ 1134 shadow?: ShadowOptions | ShadowStyle; 1135 1136 /** 1137 * Set time format 1138 * 1139 * @type { ?DateTimeOptions } 1140 * @syscap SystemCapability.ArkUI.ArkUI.Full 1141 * @crossplatform 1142 * @atomicservice 1143 * @since 12 1144 */ 1145 dateTimeOptions?: DateTimeOptions; 1146 1147 /** 1148 * Defines whether to respond to the hover mode. 1149 * 1150 * @type { ?boolean } 1151 * @default false 1152 * @syscap SystemCapability.ArkUI.ArkUI.Full 1153 * @crossplatform 1154 * @atomicservice 1155 * @since 14 1156 */ 1157 enableHoverMode?: boolean; 1158 1159 /** 1160 * Defines the dialog's display area in hover mode. 1161 * 1162 * @type { ?HoverModeAreaType } 1163 * @default HoverModeAreaType.BOTTOM_SCREEN 1164 * @syscap SystemCapability.ArkUI.ArkUI.Full 1165 * @crossplatform 1166 * @atomicservice 1167 * @since 14 1168 */ 1169 hoverModeArea?: HoverModeAreaType; 1170 1171 /** 1172 * Enable or disable haptic feedback. 1173 * 1174 * @type { ?boolean } 1175 * @default true 1176 * @syscap SystemCapability.ArkUI.ArkUI.Full 1177 * @atomicservice 1178 * @since 18 1179 */ 1180 enableHapticFeedback?: boolean; 1181} 1182 1183/** 1184 * Defines DatePickerDialog which uses show method to show DatePicker dialog. 1185 * 1186 * @syscap SystemCapability.ArkUI.ArkUI.Full 1187 * @since 8 1188 */ 1189/** 1190 * Defines DatePickerDialog which uses show method to show DatePicker dialog. 1191 * 1192 * @syscap SystemCapability.ArkUI.ArkUI.Full 1193 * @crossplatform 1194 * @since 10 1195 */ 1196/** 1197 * Defines DatePickerDialog which uses show method to show DatePicker dialog. 1198 * 1199 * @syscap SystemCapability.ArkUI.ArkUI.Full 1200 * @crossplatform 1201 * @atomicservice 1202 * @since 11 1203 */ 1204declare class DatePickerDialog { 1205 /** 1206 * Invoking method display. 1207 * 1208 * @param { DatePickerDialogOptions } options 1209 * @syscap SystemCapability.ArkUI.ArkUI.Full 1210 * @since 8 1211 */ 1212 /** 1213 * Invoking method display. 1214 * 1215 * @param { DatePickerDialogOptions } options 1216 * @syscap SystemCapability.ArkUI.ArkUI.Full 1217 * @crossplatform 1218 * @since 10 1219 */ 1220 /** 1221 * Invoking method display. 1222 * 1223 * @param { DatePickerDialogOptions } options 1224 * @syscap SystemCapability.ArkUI.ArkUI.Full 1225 * @crossplatform 1226 * @atomicservice 1227 * @since 11 1228 * @deprecated since 18 1229 * @useinstead ohos.arkui.UIContext.UIContext#showDatePickerDialog 1230 */ 1231 static show(options?: DatePickerDialogOptions); 1232} 1233 1234/** 1235 * Defines DatePicker Component. 1236 * 1237 * @syscap SystemCapability.ArkUI.ArkUI.Full 1238 * @since 8 1239 */ 1240/** 1241 * Defines DatePicker Component. 1242 * 1243 * @syscap SystemCapability.ArkUI.ArkUI.Full 1244 * @crossplatform 1245 * @since 10 1246 */ 1247/** 1248 * Defines DatePicker Component. 1249 * 1250 * @syscap SystemCapability.ArkUI.ArkUI.Full 1251 * @crossplatform 1252 * @atomicservice 1253 * @since 11 1254 */ 1255declare const DatePicker: DatePickerInterface; 1256 1257/** 1258 * Defines DatePicker Component instance. 1259 * 1260 * @syscap SystemCapability.ArkUI.ArkUI.Full 1261 * @since 8 1262 */ 1263/** 1264 * Defines DatePicker Component instance. 1265 * 1266 * @syscap SystemCapability.ArkUI.ArkUI.Full 1267 * @crossplatform 1268 * @since 10 1269 */ 1270/** 1271 * Defines DatePicker Component instance. 1272 * 1273 * @syscap SystemCapability.ArkUI.ArkUI.Full 1274 * @crossplatform 1275 * @atomicservice 1276 * @since 11 1277 */ 1278declare const DatePickerInstance: DatePickerAttribute; 1279 1280 1281