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 { IconType } 24 * @syscap SystemCapability.ArkUI.ArkUI.Full 25 * @since 10 26 */ 27 28 29/** 30 * Declare enum IconType 31 * @enum { IconType } 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 * Callback function when operate the icon. 164 * @type { ?() => void }. 165 * @syscap SystemCapability.ArkUI.ArkUI.Full 166 * @since 10 167 */ 168 /** 169 * Callback function when operate the icon. 170 * @type { ?() => void }. 171 * @syscap SystemCapability.ArkUI.ArkUI.Full 172 * @atomicservice 173 * @since 11 174 */ 175 action?: () => void; 176} 177 178/** 179 * Declare type OperateCheck 180 * @syscap SystemCapability.ArkUI.ArkUI.Full 181 * @since 10 182 */ 183/** 184 * Declare type OperateCheck 185 * @syscap SystemCapability.ArkUI.ArkUI.Full 186 * @atomicservice 187 * @since 11 188 */ 189export declare class OperateCheck { 190 /** 191 * Whether is checked on default. 192 * @type { ?boolean }. 193 * @syscap SystemCapability.ArkUI.ArkUI.Full 194 * @since 10 195 */ 196 /** 197 * Whether is checked on default. 198 * @type { ?boolean }. 199 * @syscap SystemCapability.ArkUI.ArkUI.Full 200 * @atomicservice 201 * @since 11 202 */ 203 isCheck?: boolean; 204 205 /** 206 * Callback function when operate the checkbox/switch/radio. 207 * @type { ?() => void }. 208 * @syscap SystemCapability.ArkUI.ArkUI.Full 209 * @since 10 210 */ 211 /** 212 * Callback function when operate the checkbox/switch/radio. 213 * @type { ?() => void }. 214 * @syscap SystemCapability.ArkUI.ArkUI.Full 215 * @atomicservice 216 * @since 11 217 */ 218 onChange?: (value: boolean) => void; 219} 220 221/** 222 * Declare type OperateButton 223 * @syscap SystemCapability.ArkUI.ArkUI.Full 224 * @since 10 225 */ 226/** 227 * Declare type OperateButton 228 * @syscap SystemCapability.ArkUI.ArkUI.Full 229 * @atomicservice 230 * @since 11 231 */ 232export declare class OperateButton { 233 /** 234 * The text on the button. 235 * @type { ?ResourceStr }. 236 * @syscap SystemCapability.ArkUI.ArkUI.Full 237 * @since 10 238 */ 239 /** 240 * The text on the button. 241 * @type { ?ResourceStr }. 242 * @syscap SystemCapability.ArkUI.ArkUI.Full 243 * @atomicservice 244 * @since 11 245 */ 246 text?: ResourceStr; 247} 248 249/** 250 * Declare ContentItem 251 * @syscap SystemCapability.ArkUI.ArkUI.Full 252 * @since 10 253 */ 254/** 255 * Declare ContentItem 256 * @syscap SystemCapability.ArkUI.ArkUI.Full 257 * @atomicservice 258 * @since 11 259 */ 260export declare class ContentItem { 261 /** 262 * The type of icon. 263 * @type { ?IconType } 264 * @syscap SystemCapability.ArkUI.ArkUI.Full 265 * @since 10 266 */ 267 /** 268 * The type of icon. 269 * @type { ?IconType } 270 * @syscap SystemCapability.ArkUI.ArkUI.Full 271 * @atomicservice 272 * @since 11 273 */ 274 iconStyle?: IconType; 275 276 /** 277 * Sets the icon. 278 * @type { ?ResourceStr } 279 * @syscap SystemCapability.ArkUI.ArkUI.Full 280 * @since 10 281 */ 282 /** 283 * Sets the icon. 284 * @type { ?ResourceStr } 285 * @syscap SystemCapability.ArkUI.ArkUI.Full 286 * @atomicservice 287 * @since 11 288 */ 289 icon?: ResourceStr; 290 291 /** 292 * Sets the primaryText. 293 * @type { ?ResourceStr } 294 * @syscap SystemCapability.ArkUI.ArkUI.Full 295 * @since 10 296 */ 297 /** 298 * Sets the primaryText. 299 * @type { ?ResourceStr } 300 * @syscap SystemCapability.ArkUI.ArkUI.Full 301 * @atomicservice 302 * @since 11 303 */ 304 primaryText?: ResourceStr; 305 306 /** 307 * Sets the secondaryText. 308 * @type { ?ResourceStr } 309 * @syscap SystemCapability.ArkUI.ArkUI.Full 310 * @since 10 311 */ 312 /** 313 * Sets the secondaryText. 314 * @type { ?ResourceStr } 315 * @syscap SystemCapability.ArkUI.ArkUI.Full 316 * @atomicservice 317 * @since 11 318 */ 319 secondaryText?: ResourceStr; 320 321 /** 322 * Sets the description. 323 * @type { ?ResourceStr } 324 * @syscap SystemCapability.ArkUI.ArkUI.Full 325 * @since 10 326 */ 327 /** 328 * Sets the description. 329 * @type { ?ResourceStr } 330 * @syscap SystemCapability.ArkUI.ArkUI.Full 331 * @atomicservice 332 * @since 11 333 */ 334 description?: ResourceStr; 335} 336 337/** 338 * Declare OperateItem 339 * @syscap SystemCapability.ArkUI.ArkUI.Full 340 * @since 10 341 */ 342/** 343 * Declare OperateItem 344 * @syscap SystemCapability.ArkUI.ArkUI.Full 345 * @atomicservice 346 * @since 11 347 */ 348export declare class OperateItem { 349 /** 350 * Sets the icon. 351 * @type { ?OperateIcon } 352 * @syscap SystemCapability.ArkUI.ArkUI.Full 353 * @since 10 354 */ 355 /** 356 * Sets the icon. 357 * @type { ?OperateIcon } 358 * @syscap SystemCapability.ArkUI.ArkUI.Full 359 * @atomicservice 360 * @since 11 361 */ 362 icon?: OperateIcon; 363 364 /** 365 * Sets the subIcon. 366 * @type { ?OperateIcon } 367 * @syscap SystemCapability.ArkUI.ArkUI.Full 368 * @since 10 369 */ 370 /** 371 * Sets the subIcon. 372 * @type { ?OperateIcon } 373 * @syscap SystemCapability.ArkUI.ArkUI.Full 374 * @atomicservice 375 * @since 11 376 */ 377 subIcon?: OperateIcon; 378 379 /** 380 * Sets the button. 381 * @type { ?OperateButton } 382 * @syscap SystemCapability.ArkUI.ArkUI.Full 383 * @since 10 384 */ 385 /** 386 * Sets the button. 387 * @type { ?OperateButton } 388 * @syscap SystemCapability.ArkUI.ArkUI.Full 389 * @atomicservice 390 * @since 11 391 */ 392 button?: OperateButton; 393 394 /** 395 * Sets the switch. 396 * @type { ?OperateCheck } 397 * @syscap SystemCapability.ArkUI.ArkUI.Full 398 * @since 10 399 */ 400 /** 401 * Sets the switch. 402 * @type { ?OperateCheck } 403 * @syscap SystemCapability.ArkUI.ArkUI.Full 404 * @atomicservice 405 * @since 11 406 */ 407 switch?: OperateCheck; 408 409 /** 410 * Sets the checkBox. 411 * @type { ?OperateCheck } 412 * @syscap SystemCapability.ArkUI.ArkUI.Full 413 * @since 10 414 */ 415 /** 416 * Sets the checkBox. 417 * @type { ?OperateCheck } 418 * @syscap SystemCapability.ArkUI.ArkUI.Full 419 * @atomicservice 420 * @since 11 421 */ 422 checkbox?: OperateCheck; 423 424 /** 425 * Sets the radio. 426 * @type { ?OperateCheck } 427 * @syscap SystemCapability.ArkUI.ArkUI.Full 428 * @since 10 429 */ 430 /** 431 * Sets the radio. 432 * @type { ?OperateCheck } 433 * @syscap SystemCapability.ArkUI.ArkUI.Full 434 * @atomicservice 435 * @since 11 436 */ 437 radio?: OperateCheck; 438 439 /** 440 * Sets the image. 441 * @type { ?ResourceStr } 442 * @syscap SystemCapability.ArkUI.ArkUI.Full 443 * @since 10 444 */ 445 /** 446 * Sets the image. 447 * @type { ?ResourceStr } 448 * @syscap SystemCapability.ArkUI.ArkUI.Full 449 * @atomicservice 450 * @since 11 451 */ 452 image?: ResourceStr; 453 454 /** 455 * Sets the text. 456 * @type { ?ResourceStr } 457 * @syscap SystemCapability.ArkUI.ArkUI.Full 458 * @since 10 459 */ 460 /** 461 * Sets the text. 462 * @type { ?ResourceStr } 463 * @syscap SystemCapability.ArkUI.ArkUI.Full 464 * @atomicservice 465 * @since 11 466 */ 467 text?: ResourceStr; 468 469 /** 470 * Sets the arrow. 471 * @type { ?ResourceStr } 472 * @syscap SystemCapability.ArkUI.ArkUI.Full 473 * @since 10 474 */ 475 /** 476 * Sets the arrow. 477 * @type { ?ResourceStr } 478 * @syscap SystemCapability.ArkUI.ArkUI.Full 479 * @atomicservice 480 * @since 11 481 */ 482 arrow?: OperateIcon; 483} 484 485/** 486 * Declare ComposeListItem 487 * @syscap SystemCapability.ArkUI.ArkUI.Full 488 * @since 10 489 */ 490/** 491 * Declare ComposeListItem 492 * @syscap SystemCapability.ArkUI.ArkUI.Full 493 * @atomicservice 494 * @since 11 495 */ 496@Component 497export declare struct ComposeListItem { 498 /** 499 * The ContentItem. 500 * @type { ?ContentItem } 501 * @syscap SystemCapability.ArkUI.ArkUI.Full 502 * @since 10 503 */ 504 /** 505 * The ContentItem. 506 * @type { ?ContentItem } 507 * @syscap SystemCapability.ArkUI.ArkUI.Full 508 * @atomicservice 509 * @since 11 510 */ 511 @Prop contentItem?: ContentItem; 512 513 /** 514 * The OperateItem. 515 * @type { ?OperateItem } 516 * @syscap SystemCapability.ArkUI.ArkUI.Full 517 * @since 10 518 */ 519 /** 520 * The OperateItem. 521 * @type { ?OperateItem } 522 * @syscap SystemCapability.ArkUI.ArkUI.Full 523 * @atomicservice 524 * @since 11 525 */ 526 @Prop operateItem?: OperateItem; 527}