1/* 2 * Copyright (c) 2022-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 option in number unit of grid-container child component. 23 * 24 * @interface GridColColumnOption 25 * @syscap SystemCapability.ArkUI.ArkUI.Full 26 * @form 27 * @since 9 28 */ 29/** 30 * Defines the option in number unit of grid-container child component. 31 * 32 * @interface GridColColumnOption 33 * @syscap SystemCapability.ArkUI.ArkUI.Full 34 * @crossplatform 35 * @form 36 * @since 10 37 */ 38/** 39 * Defines the option in number unit of grid-container child component. 40 * 41 * @interface GridColColumnOption 42 * @syscap SystemCapability.ArkUI.ArkUI.Full 43 * @crossplatform 44 * @form 45 * @atomicservice 46 * @since 11 47 */ 48declare interface GridColColumnOption { 49 /** 50 * Grid Col Column Option xs 51 * 52 * @type { ?number } 53 * @syscap SystemCapability.ArkUI.ArkUI.Full 54 * @form 55 * @since 9 56 */ 57 /** 58 * Grid Col Column Option xs 59 * 60 * @type { ?number } 61 * @syscap SystemCapability.ArkUI.ArkUI.Full 62 * @crossplatform 63 * @form 64 * @since 10 65 */ 66 /** 67 * Grid Col Column Option xs 68 * 69 * @type { ?number } 70 * @syscap SystemCapability.ArkUI.ArkUI.Full 71 * @crossplatform 72 * @form 73 * @atomicservice 74 * @since 11 75 */ 76 xs?: number, 77 78 /** 79 * Grid Col Column Option sm 80 * 81 * @type { ?number } 82 * @syscap SystemCapability.ArkUI.ArkUI.Full 83 * @form 84 * @since 9 85 */ 86 /** 87 * Grid Col Column Option sm 88 * 89 * @type { ?number } 90 * @syscap SystemCapability.ArkUI.ArkUI.Full 91 * @crossplatform 92 * @form 93 * @since 10 94 */ 95 /** 96 * Grid Col Column Option sm 97 * 98 * @type { ?number } 99 * @syscap SystemCapability.ArkUI.ArkUI.Full 100 * @crossplatform 101 * @form 102 * @atomicservice 103 * @since 11 104 */ 105 sm?: number, 106 107 /** 108 * Grid Col Column Option md 109 * 110 * @type { ?number } 111 * @syscap SystemCapability.ArkUI.ArkUI.Full 112 * @form 113 * @since 9 114 */ 115 /** 116 * Grid Col Column Option md 117 * 118 * @type { ?number } 119 * @syscap SystemCapability.ArkUI.ArkUI.Full 120 * @crossplatform 121 * @form 122 * @since 10 123 */ 124 /** 125 * Grid Col Column Option md 126 * 127 * @type { ?number } 128 * @syscap SystemCapability.ArkUI.ArkUI.Full 129 * @crossplatform 130 * @form 131 * @atomicservice 132 * @since 11 133 */ 134 md?: number, 135 136 /** 137 * Grid Col Column Option lg 138 * 139 * @type { ?number } 140 * @syscap SystemCapability.ArkUI.ArkUI.Full 141 * @form 142 * @since 9 143 */ 144 /** 145 * Grid Col Column Option lg 146 * 147 * @type { ?number } 148 * @syscap SystemCapability.ArkUI.ArkUI.Full 149 * @crossplatform 150 * @form 151 * @since 10 152 */ 153 /** 154 * Grid Col Column Option lg 155 * 156 * @type { ?number } 157 * @syscap SystemCapability.ArkUI.ArkUI.Full 158 * @crossplatform 159 * @form 160 * @atomicservice 161 * @since 11 162 */ 163 lg?: number, 164 165 /** 166 * Grid Col Column Option xl 167 * 168 * @type { ?number } 169 * @syscap SystemCapability.ArkUI.ArkUI.Full 170 * @form 171 * @since 9 172 */ 173 /** 174 * Grid Col Column Option xl 175 * 176 * @type { ?number } 177 * @syscap SystemCapability.ArkUI.ArkUI.Full 178 * @crossplatform 179 * @form 180 * @since 10 181 */ 182 /** 183 * Grid Col Column Option xl 184 * 185 * @type { ?number } 186 * @syscap SystemCapability.ArkUI.ArkUI.Full 187 * @crossplatform 188 * @form 189 * @atomicservice 190 * @since 11 191 */ 192 xl?: number, 193 194 /** 195 * Grid Col Column Option xxl 196 * 197 * @type { ?number } 198 * @syscap SystemCapability.ArkUI.ArkUI.Full 199 * @form 200 * @since 9 201 */ 202 /** 203 * Grid Col Column Option xxl 204 * 205 * @type { ?number } 206 * @syscap SystemCapability.ArkUI.ArkUI.Full 207 * @crossplatform 208 * @form 209 * @since 10 210 */ 211 /** 212 * Grid Col Column Option xxl 213 * 214 * @type { ?number } 215 * @syscap SystemCapability.ArkUI.ArkUI.Full 216 * @crossplatform 217 * @form 218 * @atomicservice 219 * @since 11 220 */ 221 xxl?: number, 222} 223 224/** 225 * Defines the options of grid-container child component. 226 * 227 * @interface GridColOptions 228 * @syscap SystemCapability.ArkUI.ArkUI.Full 229 * @form 230 * @since 9 231 */ 232/** 233 * Defines the options of grid-container child component. 234 * 235 * @interface GridColOptions 236 * @syscap SystemCapability.ArkUI.ArkUI.Full 237 * @crossplatform 238 * @form 239 * @since 10 240 */ 241/** 242 * Defines the options of grid-container child component. 243 * 244 * @interface GridColOptions 245 * @syscap SystemCapability.ArkUI.ArkUI.Full 246 * @crossplatform 247 * @form 248 * @atomicservice 249 * @since 11 250 */ 251declare interface GridColOptions { 252 /** 253 * Sets the span of current gird-container item. 254 * 255 * @type { ?(number | GridColColumnOption) } 256 * @syscap SystemCapability.ArkUI.ArkUI.Full 257 * @form 258 * @since 9 259 */ 260 /** 261 * Sets the span of current gird-container item. 262 * 263 * @type { ?(number | GridColColumnOption) } 264 * @syscap SystemCapability.ArkUI.ArkUI.Full 265 * @crossplatform 266 * @form 267 * @since 10 268 */ 269 /** 270 * Sets the span of current gird-container item. 271 * 272 * @type { ?(number | GridColColumnOption) } 273 * @syscap SystemCapability.ArkUI.ArkUI.Full 274 * @crossplatform 275 * @form 276 * @atomicservice 277 * @since 11 278 */ 279 span?: number | GridColColumnOption; 280 281 /** 282 * Sets the offset of current gird-container item. 283 * 284 * @type { ?(number | GridColColumnOption) } 285 * @syscap SystemCapability.ArkUI.ArkUI.Full 286 * @form 287 * @since 9 288 */ 289 /** 290 * Sets the offset of current gird-container item. 291 * 292 * @type { ?(number | GridColColumnOption) } 293 * @syscap SystemCapability.ArkUI.ArkUI.Full 294 * @crossplatform 295 * @form 296 * @since 10 297 */ 298 /** 299 * Sets the offset of current gird-container item. 300 * 301 * @type { ?(number | GridColColumnOption) } 302 * @syscap SystemCapability.ArkUI.ArkUI.Full 303 * @crossplatform 304 * @form 305 * @atomicservice 306 * @since 11 307 */ 308 offset?: number | GridColColumnOption; 309 310 /** 311 * Sets the order of current gird-container item. 312 * 313 * @type { ?(number | GridColColumnOption) } 314 * @syscap SystemCapability.ArkUI.ArkUI.Full 315 * @form 316 * @since 9 317 */ 318 /** 319 * Sets the order of current gird-container item. 320 * 321 * @type { ?(number | GridColColumnOption) } 322 * @syscap SystemCapability.ArkUI.ArkUI.Full 323 * @crossplatform 324 * @form 325 * @since 10 326 */ 327 /** 328 * Sets the order of current gird-container item. 329 * 330 * @type { ?(number | GridColColumnOption) } 331 * @syscap SystemCapability.ArkUI.ArkUI.Full 332 * @crossplatform 333 * @form 334 * @atomicservice 335 * @since 11 336 */ 337 order?: number | GridColColumnOption; 338} 339 340/** 341 * Defines the the new version of grid-container child component. 342 * 343 * @interface GridColInterface 344 * @syscap SystemCapability.ArkUI.ArkUI.Full 345 * @form 346 * @since 9 347 */ 348/** 349 * Defines the the new version of grid-container child component. 350 * 351 * @interface GridColInterface 352 * @syscap SystemCapability.ArkUI.ArkUI.Full 353 * @crossplatform 354 * @form 355 * @since 10 356 */ 357/** 358 * Defines the the new version of grid-container child component. 359 * 360 * @interface GridColInterface 361 * @syscap SystemCapability.ArkUI.ArkUI.Full 362 * @crossplatform 363 * @form 364 * @atomicservice 365 * @since 11 366 */ 367interface GridColInterface { 368 /** 369 * Defines the constructor of GridContainer. 370 * 371 * @param { GridColOptions } option 372 * @returns { GridColAttribute } 373 * @syscap SystemCapability.ArkUI.ArkUI.Full 374 * @form 375 * @since 9 376 */ 377 /** 378 * Defines the constructor of GridContainer. 379 * 380 * @param { GridColOptions } option 381 * @returns { GridColAttribute } 382 * @syscap SystemCapability.ArkUI.ArkUI.Full 383 * @crossplatform 384 * @form 385 * @since 10 386 */ 387 /** 388 * Defines the constructor of GridContainer. 389 * 390 * @param { GridColOptions } option 391 * @returns { GridColAttribute } 392 * @syscap SystemCapability.ArkUI.ArkUI.Full 393 * @crossplatform 394 * @form 395 * @atomicservice 396 * @since 11 397 */ 398 (option?: GridColOptions): GridColAttribute; 399} 400 401/** 402 * Defines the GridContainer attribute functions. 403 * 404 * @extends CommonMethod<GridColAttribute> 405 * @syscap SystemCapability.ArkUI.ArkUI.Full 406 * @form 407 * @since 9 408 */ 409/** 410 * Defines the GridContainer attribute functions. 411 * 412 * @extends CommonMethod<GridColAttribute> 413 * @syscap SystemCapability.ArkUI.ArkUI.Full 414 * @crossplatform 415 * @form 416 * @since 10 417 */ 418/** 419 * Defines the GridContainer attribute functions. 420 * 421 * @extends CommonMethod<GridColAttribute> 422 * @syscap SystemCapability.ArkUI.ArkUI.Full 423 * @crossplatform 424 * @form 425 * @atomicservice 426 * @since 11 427 */ 428declare class GridColAttribute extends CommonMethod<GridColAttribute> { 429 /** 430 * Sets the span of current gird-container item. 431 * 432 * @param { number | GridColColumnOption } value 433 * @returns { GridColAttribute } 434 * @syscap SystemCapability.ArkUI.ArkUI.Full 435 * @form 436 * @since 9 437 */ 438 /** 439 * Sets the span of current gird-container item. 440 * 441 * @param { number | GridColColumnOption } value 442 * @returns { GridColAttribute } 443 * @syscap SystemCapability.ArkUI.ArkUI.Full 444 * @crossplatform 445 * @form 446 * @since 10 447 */ 448 /** 449 * Sets the span of current gird-container item. 450 * 451 * @param { number | GridColColumnOption } value 452 * @returns { GridColAttribute } 453 * @syscap SystemCapability.ArkUI.ArkUI.Full 454 * @crossplatform 455 * @form 456 * @atomicservice 457 * @since 11 458 */ 459 span(value: number | GridColColumnOption): GridColAttribute; 460 461 /** 462 * Sets the offset of current gird-container item. 463 * 464 * @param { number | GridColColumnOption } value 465 * @returns { GridColAttribute } 466 * @syscap SystemCapability.ArkUI.ArkUI.Full 467 * @form 468 * @since 9 469 */ 470 /** 471 * Sets the offset of current gird-container item. 472 * 473 * @param { number | GridColColumnOption } value 474 * @returns { GridColAttribute } 475 * @syscap SystemCapability.ArkUI.ArkUI.Full 476 * @crossplatform 477 * @form 478 * @since 10 479 */ 480 /** 481 * Sets the offset of current gird-container item. 482 * 483 * @param { number | GridColColumnOption } value 484 * @returns { GridColAttribute } 485 * @syscap SystemCapability.ArkUI.ArkUI.Full 486 * @crossplatform 487 * @form 488 * @atomicservice 489 * @since 11 490 */ 491 gridColOffset(value: number | GridColColumnOption): GridColAttribute; 492 493 /** 494 * Sets the order of current gird-container item. 495 * 496 * @param { number | GridColColumnOption } value 497 * @returns { GridColAttribute } 498 * @syscap SystemCapability.ArkUI.ArkUI.Full 499 * @form 500 * @since 9 501 */ 502 /** 503 * Sets the order of current gird-container item. 504 * 505 * @param { number | GridColColumnOption } value 506 * @returns { GridColAttribute } 507 * @syscap SystemCapability.ArkUI.ArkUI.Full 508 * @crossplatform 509 * @form 510 * @since 10 511 */ 512 /** 513 * Sets the order of current gird-container item. 514 * 515 * @param { number | GridColColumnOption } value 516 * @returns { GridColAttribute } 517 * @syscap SystemCapability.ArkUI.ArkUI.Full 518 * @crossplatform 519 * @form 520 * @atomicservice 521 * @since 11 522 */ 523 order(value: number | GridColColumnOption): GridColAttribute; 524} 525 526/** 527 * Defines GridCol Component. 528 * 529 * @syscap SystemCapability.ArkUI.ArkUI.Full 530 * @form 531 * @since 9 532 */ 533/** 534 * Defines GridCol Component. 535 * 536 * @syscap SystemCapability.ArkUI.ArkUI.Full 537 * @crossplatform 538 * @form 539 * @since 10 540 */ 541/** 542 * Defines GridCol Component. 543 * 544 * @syscap SystemCapability.ArkUI.ArkUI.Full 545 * @crossplatform 546 * @form 547 * @atomicservice 548 * @since 11 549 */ 550declare const GridCol: GridColInterface 551 552/** 553 * Defines GridCol Component instance. 554 * 555 * @syscap SystemCapability.ArkUI.ArkUI.Full 556 * @form 557 * @since 9 558 */ 559/** 560 * Defines GridCol Component instance. 561 * 562 * @syscap SystemCapability.ArkUI.ArkUI.Full 563 * @crossplatform 564 * @form 565 * @since 10 566 */ 567/** 568 * Defines GridCol Component instance. 569 * 570 * @syscap SystemCapability.ArkUI.ArkUI.Full 571 * @crossplatform 572 * @form 573 * @atomicservice 574 * @since 11 575 */ 576declare const GridColInstance: GridColAttribute; 577