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