1/* 2* Copyright (C) 2023-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 * Declare enum IconType 23 * @enum { number } 24 * @syscap SystemCapability.ArkUI.ArkUI.Full 25 * @since 10 26 */ 27 28 29/** 30 * Declare enum IconType 31 * @enum { number } 32 * @syscap SystemCapability.ArkUI.ArkUI.Full 33 * @atomicservice 34 * @since 11 35 */ 36export declare enum IconType { 37 /** 38 * Badge type. 39 * @syscap SystemCapability.ArkUI.ArkUI.Full 40 * @since 10 41 */ 42 /** 43 * Badge type. 44 * @syscap SystemCapability.ArkUI.ArkUI.Full 45 * @atomicservice 46 * @since 11 47 */ 48 BADGE = 1, 49 /** 50 * Normal icon type. 51 * @syscap SystemCapability.ArkUI.ArkUI.Full 52 * @since 10 53 */ 54 /** 55 * Normal icon type. 56 * @syscap SystemCapability.ArkUI.ArkUI.Full 57 * @atomicservice 58 * @since 11 59 */ 60 NORMAL_ICON = 2, 61 /** 62 * System icon type. 63 * @syscap SystemCapability.ArkUI.ArkUI.Full 64 * @since 10 65 */ 66 /** 67 * System icon type. 68 * @syscap SystemCapability.ArkUI.ArkUI.Full 69 * @atomicservice 70 * @since 11 71 */ 72 SYSTEM_ICON = 3, 73 /** 74 * HeadSculpture type. 75 * @syscap SystemCapability.ArkUI.ArkUI.Full 76 * @since 10 77 */ 78 /** 79 * HeadSculpture type. 80 * @syscap SystemCapability.ArkUI.ArkUI.Full 81 * @atomicservice 82 * @since 11 83 */ 84 HEAD_SCULPTURE = 4, 85 /** 86 * App icon type. 87 * @syscap SystemCapability.ArkUI.ArkUI.Full 88 * @since 10 89 */ 90 /** 91 * App icon type. 92 * @syscap SystemCapability.ArkUI.ArkUI.Full 93 * @atomicservice 94 * @since 11 95 */ 96 APP_ICON = 5, 97 /** 98 * Preview type. 99 * @syscap SystemCapability.ArkUI.ArkUI.Full 100 * @since 10 101 */ 102 /** 103 * Preview type. 104 * @syscap SystemCapability.ArkUI.ArkUI.Full 105 * @atomicservice 106 * @since 11 107 */ 108 PREVIEW = 6, 109 /** 110 * Longitudinal type. 111 * @syscap SystemCapability.ArkUI.ArkUI.Full 112 * @since 10 113 */ 114 /** 115 * Longitudinal type. 116 * @syscap SystemCapability.ArkUI.ArkUI.Full 117 * @atomicservice 118 * @since 11 119 */ 120 LONGITUDINAL = 7, 121 /** 122 * Vertical type. 123 * @syscap SystemCapability.ArkUI.ArkUI.Full 124 * @since 10 125 */ 126 /** 127 * Vertical type. 128 * @syscap SystemCapability.ArkUI.ArkUI.Full 129 * @atomicservice 130 * @since 11 131 */ 132 VERTICAL = 8 133} 134 135/** 136 * Declare type OperateIcon 137 * @syscap SystemCapability.ArkUI.ArkUI.Full 138 * @since 10 139 */ 140/** 141 * Declare type OperateIcon 142 * @syscap SystemCapability.ArkUI.ArkUI.Full 143 * @atomicservice 144 * @since 11 145 */ 146export declare class OperateIcon { 147 /** 148 * The content of text or the address of icon. 149 * @type { ResourceStr }. 150 * @syscap SystemCapability.ArkUI.ArkUI.Full 151 * @since 10 152 */ 153 /** 154 * The content of text or the address of icon. 155 * @type { ResourceStr }. 156 * @syscap SystemCapability.ArkUI.ArkUI.Full 157 * @atomicservice 158 * @since 11 159 */ 160 value: ResourceStr; 161 162 /** 163 * The content of text or the address of symbol. 164 * @type { ?SymbolGlyphModifier }. 165 * @syscap SystemCapability.ArkUI.ArkUI.Full 166 * @atomicservice 167 * @since 18 168 */ 169 symbolStyle?: SymbolGlyphModifier; 170 171 /** 172 * Callback function when operate the icon. 173 * @type { ?function } 174 * @syscap SystemCapability.ArkUI.ArkUI.Full 175 * @since 10 176 */ 177 /** 178 * Callback function when operate the icon. 179 * @type { ?function } 180 * @syscap SystemCapability.ArkUI.ArkUI.Full 181 * @atomicservice 182 * @since 11 183 */ 184 action?: () => void; 185 186 /** 187 * The accessibilityText of the icon. 188 * 189 * @type { ?ResourceStr } 190 * @syscap SystemCapability.ArkUI.ArkUI.Full 191 * @atomicservice 192 * @since 18 193 */ 194 accessibilityText?: ResourceStr; 195 196 /** 197 * The accessibilityDescription of the icon. 198 * 199 * @type { ?ResourceStr } 200 * @syscap SystemCapability.ArkUI.ArkUI.Full 201 * @atomicservice 202 * @since 18 203 */ 204 accessibilityDescription?: ResourceStr; 205 206 /** 207 * The accessibilityLevel of the icon. 208 * 209 * @type { ?string } 210 * @default "auto" 211 * @syscap SystemCapability.ArkUI.ArkUI.Full 212 * @atomicservice 213 * @since 18 214 */ 215 accessibilityLevel?: string; 216} 217 218/** 219 * Declare type OperateCheck 220 * @syscap SystemCapability.ArkUI.ArkUI.Full 221 * @since 10 222 */ 223/** 224 * Declare type OperateCheck 225 * @syscap SystemCapability.ArkUI.ArkUI.Full 226 * @atomicservice 227 * @since 11 228 */ 229export declare class OperateCheck { 230 /** 231 * Whether is checked on default. 232 * @type { ?boolean }. 233 * @syscap SystemCapability.ArkUI.ArkUI.Full 234 * @since 10 235 */ 236 /** 237 * Whether is checked on default. 238 * @type { ?boolean }. 239 * @syscap SystemCapability.ArkUI.ArkUI.Full 240 * @atomicservice 241 * @since 11 242 */ 243 isCheck?: boolean; 244 245 /** 246 * Callback function when operate the checkbox/switch/radio. 247 * @type { ?function } 248 * @syscap SystemCapability.ArkUI.ArkUI.Full 249 * @since 10 250 */ 251 /** 252 * Callback function when operate the checkbox/switch/radio. 253 * @type { ?function } 254 * @syscap SystemCapability.ArkUI.ArkUI.Full 255 * @atomicservice 256 * @since 11 257 */ 258 onChange?: (value: boolean) => void; 259 260 /** 261 * The accessibilityText of the checkbox/switch/radio. 262 * 263 * @type { ?ResourceStr } 264 * @syscap SystemCapability.ArkUI.ArkUI.Full 265 * @atomicservice 266 * @since 18 267 */ 268 accessibilityText?: ResourceStr; 269 270 /** 271 * The accessibilityDescription of the checkbox/switch/radio. 272 * 273 * @type { ?ResourceStr } 274 * @syscap SystemCapability.ArkUI.ArkUI.Full 275 * @atomicservice 276 * @since 18 277 */ 278 accessibilityDescription?: ResourceStr; 279 280 /** 281 * The accessibilityLevel of the checkbox/switch/radio. 282 * 283 * @type { ?string } 284 * @default "auto" 285 * @syscap SystemCapability.ArkUI.ArkUI.Full 286 * @atomicservice 287 * @since 18 288 */ 289 accessibilityLevel?: string; 290} 291 292/** 293 * Declare type OperateButton 294 * @syscap SystemCapability.ArkUI.ArkUI.Full 295 * @since 10 296 */ 297/** 298 * Declare type OperateButton 299 * @syscap SystemCapability.ArkUI.ArkUI.Full 300 * @atomicservice 301 * @since 11 302 */ 303export declare class OperateButton { 304 /** 305 * The text on the button. 306 * @type { ?ResourceStr }. 307 * @syscap SystemCapability.ArkUI.ArkUI.Full 308 * @since 10 309 */ 310 /** 311 * The text on the button. 312 * @type { ?ResourceStr }. 313 * @syscap SystemCapability.ArkUI.ArkUI.Full 314 * @atomicservice 315 * @since 11 316 */ 317 text?: ResourceStr; 318 319 /** 320 * The accessibilityText of the button. 321 * 322 * @type { ?ResourceStr } 323 * @syscap SystemCapability.ArkUI.ArkUI.Full 324 * @atomicservice 325 * @since 18 326 */ 327 accessibilityText?: ResourceStr; 328 329 /** 330 * The accessibilityDescription of the button. 331 * 332 * @type { ?ResourceStr } 333 * @syscap SystemCapability.ArkUI.ArkUI.Full 334 * @atomicservice 335 * @since 18 336 */ 337 accessibilityDescription?: ResourceStr; 338 339 /** 340 * The accessibilityLevel of the button. 341 * 342 * @type { ?string } 343 * @default "auto" 344 * @syscap SystemCapability.ArkUI.ArkUI.Full 345 * @atomicservice 346 * @since 18 347 */ 348 accessibilityLevel?: string; 349} 350 351/** 352 * Declare ContentItem 353 * @syscap SystemCapability.ArkUI.ArkUI.Full 354 * @since 10 355 */ 356/** 357 * Declare ContentItem 358 * @syscap SystemCapability.ArkUI.ArkUI.Full 359 * @atomicservice 360 * @since 11 361 */ 362export declare class ContentItem { 363 /** 364 * The type of icon. 365 * @type { ?IconType } 366 * @syscap SystemCapability.ArkUI.ArkUI.Full 367 * @since 10 368 */ 369 /** 370 * The type of icon. 371 * @type { ?IconType } 372 * @syscap SystemCapability.ArkUI.ArkUI.Full 373 * @atomicservice 374 * @since 11 375 */ 376 iconStyle?: IconType; 377 378 /** 379 * Sets the icon. 380 * @type { ?ResourceStr } 381 * @syscap SystemCapability.ArkUI.ArkUI.Full 382 * @since 10 383 */ 384 /** 385 * Sets the icon. 386 * @type { ?ResourceStr } 387 * @syscap SystemCapability.ArkUI.ArkUI.Full 388 * @atomicservice 389 * @since 11 390 */ 391 icon?: ResourceStr; 392 393 /** 394 * Sets the symbol. 395 * @type { ?SymbolGlyphModifier } 396 * @syscap SystemCapability.ArkUI.ArkUI.Full 397 * @atomicservice 398 * @since 18 399 */ 400 symbolStyle?: SymbolGlyphModifier; 401 402 /** 403 * Sets the primaryText. 404 * @type { ?ResourceStr } 405 * @syscap SystemCapability.ArkUI.ArkUI.Full 406 * @since 10 407 */ 408 /** 409 * Sets the primaryText. 410 * @type { ?ResourceStr } 411 * @syscap SystemCapability.ArkUI.ArkUI.Full 412 * @atomicservice 413 * @since 11 414 */ 415 primaryText?: ResourceStr; 416 417 /** 418 * Sets the secondaryText. 419 * @type { ?ResourceStr } 420 * @syscap SystemCapability.ArkUI.ArkUI.Full 421 * @since 10 422 */ 423 /** 424 * Sets the secondaryText. 425 * @type { ?ResourceStr } 426 * @syscap SystemCapability.ArkUI.ArkUI.Full 427 * @atomicservice 428 * @since 11 429 */ 430 secondaryText?: ResourceStr; 431 432 /** 433 * Sets the description. 434 * @type { ?ResourceStr } 435 * @syscap SystemCapability.ArkUI.ArkUI.Full 436 * @since 10 437 */ 438 /** 439 * Sets the description. 440 * @type { ?ResourceStr } 441 * @syscap SystemCapability.ArkUI.ArkUI.Full 442 * @atomicservice 443 * @since 11 444 */ 445 description?: ResourceStr; 446} 447 448/** 449 * Declare OperateItem 450 * @syscap SystemCapability.ArkUI.ArkUI.Full 451 * @since 10 452 */ 453/** 454 * Declare OperateItem 455 * @syscap SystemCapability.ArkUI.ArkUI.Full 456 * @atomicservice 457 * @since 11 458 */ 459export declare class OperateItem { 460 /** 461 * Sets the icon. 462 * @type { ?OperateIcon } 463 * @syscap SystemCapability.ArkUI.ArkUI.Full 464 * @since 10 465 */ 466 /** 467 * Sets the icon. 468 * @type { ?OperateIcon } 469 * @syscap SystemCapability.ArkUI.ArkUI.Full 470 * @atomicservice 471 * @since 11 472 */ 473 icon?: OperateIcon; 474 475 /** 476 * Sets the subIcon. 477 * @type { ?OperateIcon } 478 * @syscap SystemCapability.ArkUI.ArkUI.Full 479 * @since 10 480 */ 481 /** 482 * Sets the subIcon. 483 * @type { ?OperateIcon } 484 * @syscap SystemCapability.ArkUI.ArkUI.Full 485 * @atomicservice 486 * @since 11 487 */ 488 subIcon?: OperateIcon; 489 490 /** 491 * Sets the button. 492 * @type { ?OperateButton } 493 * @syscap SystemCapability.ArkUI.ArkUI.Full 494 * @since 10 495 */ 496 /** 497 * Sets the button. 498 * @type { ?OperateButton } 499 * @syscap SystemCapability.ArkUI.ArkUI.Full 500 * @atomicservice 501 * @since 11 502 */ 503 button?: OperateButton; 504 505 /** 506 * Sets the switch. 507 * @type { ?OperateCheck } 508 * @syscap SystemCapability.ArkUI.ArkUI.Full 509 * @since 10 510 */ 511 /** 512 * Sets the switch. 513 * @type { ?OperateCheck } 514 * @syscap SystemCapability.ArkUI.ArkUI.Full 515 * @atomicservice 516 * @since 11 517 */ 518 switch?: OperateCheck; 519 520 /** 521 * Sets the checkBox. 522 * @type { ?OperateCheck } 523 * @syscap SystemCapability.ArkUI.ArkUI.Full 524 * @since 10 525 */ 526 /** 527 * Sets the checkBox. 528 * @type { ?OperateCheck } 529 * @syscap SystemCapability.ArkUI.ArkUI.Full 530 * @atomicservice 531 * @since 11 532 */ 533 checkbox?: OperateCheck; 534 535 /** 536 * Sets the radio. 537 * @type { ?OperateCheck } 538 * @syscap SystemCapability.ArkUI.ArkUI.Full 539 * @since 10 540 */ 541 /** 542 * Sets the radio. 543 * @type { ?OperateCheck } 544 * @syscap SystemCapability.ArkUI.ArkUI.Full 545 * @atomicservice 546 * @since 11 547 */ 548 radio?: OperateCheck; 549 550 /** 551 * Sets the image. 552 * @type { ?ResourceStr } 553 * @syscap SystemCapability.ArkUI.ArkUI.Full 554 * @since 10 555 */ 556 /** 557 * Sets the image. 558 * @type { ?ResourceStr } 559 * @syscap SystemCapability.ArkUI.ArkUI.Full 560 * @atomicservice 561 * @since 11 562 */ 563 image?: ResourceStr; 564 565 /** 566 * Sets the symbolStyle. 567 * @type { ?SymbolGlyphModifier } 568 * @syscap SystemCapability.ArkUI.ArkUI.Full 569 * @atomicservice 570 * @since 18 571 */ 572 symbolStyle?: SymbolGlyphModifier; 573 574 /** 575 * Sets the text. 576 * @type { ?ResourceStr } 577 * @syscap SystemCapability.ArkUI.ArkUI.Full 578 * @since 10 579 */ 580 /** 581 * Sets the text. 582 * @type { ?ResourceStr } 583 * @syscap SystemCapability.ArkUI.ArkUI.Full 584 * @atomicservice 585 * @since 11 586 */ 587 text?: ResourceStr; 588 589 /** 590 * Sets the arrow. 591 * @type { ?OperateIcon } 592 * @syscap SystemCapability.ArkUI.ArkUI.Full 593 * @since 10 594 */ 595 /** 596 * Sets the arrow. 597 * @type { ?OperateIcon } 598 * @syscap SystemCapability.ArkUI.ArkUI.Full 599 * @atomicservice 600 * @since 11 601 */ 602 arrow?: OperateIcon; 603} 604 605/** 606 * Declare ComposeListItem 607 * 608 * @struct { ComposeListItem } 609 * @syscap SystemCapability.ArkUI.ArkUI.Full 610 * @since 10 611 */ 612/** 613 * Declare ComposeListItem 614 * 615 * @struct { ComposeListItem } 616 * @syscap SystemCapability.ArkUI.ArkUI.Full 617 * @atomicservice 618 * @since 11 619 */ 620@Component 621export declare struct ComposeListItem { 622 /** 623 * The ContentItem. 624 * @type { ?ContentItem } 625 * @syscap SystemCapability.ArkUI.ArkUI.Full 626 * @since 10 627 */ 628 /** 629 * The ContentItem. 630 * @type { ?ContentItem } 631 * @syscap SystemCapability.ArkUI.ArkUI.Full 632 * @atomicservice 633 * @since 11 634 */ 635 @Prop contentItem?: ContentItem; 636 637 /** 638 * The OperateItem. 639 * @type { ?OperateItem } 640 * @syscap SystemCapability.ArkUI.ArkUI.Full 641 * @since 10 642 */ 643 /** 644 * The OperateItem. 645 * @type { ?OperateItem } 646 * @syscap SystemCapability.ArkUI.ArkUI.Full 647 * @atomicservice 648 * @since 11 649 */ 650 @Prop operateItem?: OperateItem; 651}