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