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 { CommonMethod, Bindable } from './common' 23/*** endif */ 24 25/** 26 * Defines the grid item style. 27 * 28 * @enum { number } 29 * @syscap SystemCapability.ArkUI.ArkUI.Full 30 * @crossplatform 31 * @since 11 32 */ 33/** 34 * Defines the grid item style. 35 * 36 * @enum { number } 37 * @syscap SystemCapability.ArkUI.ArkUI.Full 38 * @crossplatform 39 * @atomicservice 40 * @since arkts {'1.1':'12','1.2':'20'} 41 * @arkts 1.1&1.2 42 */ 43declare enum GridItemStyle { 44 /** 45 * Show none style. 46 * 47 * @syscap SystemCapability.ArkUI.ArkUI.Full 48 * @crossplatform 49 * @since 11 50 */ 51 /** 52 * Show none style. 53 * 54 * @syscap SystemCapability.ArkUI.ArkUI.Full 55 * @crossplatform 56 * @atomicservice 57 * @since arkts {'1.1':'12','1.2':'20'} 58 * @arkts 1.1&1.2 59 */ 60 NONE = 0, 61 62 /** 63 * Show plain style. 64 * 65 * @syscap SystemCapability.ArkUI.ArkUI.Full 66 * @crossplatform 67 * @since 11 68 */ 69 /** 70 * Show plain style. 71 * 72 * @syscap SystemCapability.ArkUI.ArkUI.Full 73 * @crossplatform 74 * @atomicservice 75 * @since arkts {'1.1':'12','1.2':'20'} 76 * @arkts 1.1&1.2 77 */ 78 PLAIN = 1, 79} 80 81/** 82 * Defines the grid item options. 83 * 84 * @interface GridItemOptions 85 * @syscap SystemCapability.ArkUI.ArkUI.Full 86 * @crossplatform 87 * @since 11 88 */ 89/** 90 * Defines the grid item options. 91 * 92 * @interface GridItemOptions 93 * @syscap SystemCapability.ArkUI.ArkUI.Full 94 * @crossplatform 95 * @atomicservice 96 * @since arkts {'1.1':'12','1.2':'20'} 97 * @arkts 1.1&1.2 98 */ 99declare interface GridItemOptions { 100 /** 101 * Describes the GridItem style. 102 * 103 * @type { ?GridItemStyle } 104 * @syscap SystemCapability.ArkUI.ArkUI.Full 105 * @crossplatform 106 * @since 11 107 */ 108 /** 109 * Describes the GridItem style. 110 * 111 * @type { ?GridItemStyle } 112 * @syscap SystemCapability.ArkUI.ArkUI.Full 113 * @crossplatform 114 * @atomicservice 115 * @since arkts {'1.1':'12','1.2':'20'} 116 * @arkts 1.1&1.2 117 */ 118 style?: GridItemStyle; 119} 120 121/** 122 * Mesh container for static fixed-size layout scenarios. 123 * 124 * @interface GridItemInterface 125 * @syscap SystemCapability.ArkUI.ArkUI.Full 126 * @since 7 127 */ 128/** 129 * Mesh container for static fixed-size layout scenarios. 130 * 131 * @interface GridItemInterface 132 * @syscap SystemCapability.ArkUI.ArkUI.Full 133 * @crossplatform 134 * @since 10 135 */ 136/** 137 * Mesh container for static fixed-size layout scenarios. 138 * 139 * @interface GridItemInterface 140 * @syscap SystemCapability.ArkUI.ArkUI.Full 141 * @crossplatform 142 * @atomicservice 143 * @since arkts {'1.1':'11','1.2':'20'} 144 * @arkts 1.1&1.2 145 */ 146interface GridItemInterface { 147 /** 148 * Return to get GridItem. 149 * 150 * @returns { GridItemAttribute } 151 * @syscap SystemCapability.ArkUI.ArkUI.Full 152 * @since 7 153 */ 154 /** 155 * Return to get GridItem. 156 * 157 * @returns { GridItemAttribute } 158 * @syscap SystemCapability.ArkUI.ArkUI.Full 159 * @crossplatform 160 * @since 10 161 */ 162 /** 163 * Return to get GridItem. 164 * 165 * @param { GridItemOptions } value - Defines the grid item options. 166 * @returns { GridItemAttribute } 167 * @syscap SystemCapability.ArkUI.ArkUI.Full 168 * @crossplatform 169 * @atomicservice 170 * @since arkts {'1.1':'11','1.2':'20'} 171 * @arkts 1.1&1.2 172 */ 173 (value?: GridItemOptions): GridItemAttribute; 174} 175 176/** 177 * @extends CommonMethod<GridItemAttribute> 178 * @syscap SystemCapability.ArkUI.ArkUI.Full 179 * @since 7 180 */ 181/** 182 * @extends CommonMethod<GridItemAttribute> 183 * @syscap SystemCapability.ArkUI.ArkUI.Full 184 * @crossplatform 185 * @since 10 186 */ 187/** 188 * @extends CommonMethod<GridItemAttribute> 189 * @syscap SystemCapability.ArkUI.ArkUI.Full 190 * @crossplatform 191 * @atomicservice 192 * @since arkts {'1.1':'11','1.2':'20'} 193 * @arkts 1.1&1.2 194 */ 195declare class GridItemAttribute extends CommonMethod<GridItemAttribute> { 196 /** 197 * This parameter specifies the start line number of the current element. 198 * 199 * @param { number } value 200 * @returns { GridItemAttribute } 201 * @syscap SystemCapability.ArkUI.ArkUI.Full 202 * @since 7 203 */ 204 /** 205 * This parameter specifies the start line number of the current element. 206 * 207 * @param { number } value 208 * @returns { GridItemAttribute } 209 * @syscap SystemCapability.ArkUI.ArkUI.Full 210 * @crossplatform 211 * @since 10 212 */ 213 /** 214 * This parameter specifies the start line number of the current element. 215 * 216 * @param { number } value 217 * @returns { GridItemAttribute } 218 * @syscap SystemCapability.ArkUI.ArkUI.Full 219 * @crossplatform 220 * @atomicservice 221 * @since arkts {'1.1':'11','1.2':'20'} 222 * @arkts 1.1&1.2 223 */ 224 rowStart(value: number): GridItemAttribute; 225 226 /** 227 * Specifies the end line number of the current element. 228 * 229 * @param { number } value 230 * @returns { GridItemAttribute } 231 * @syscap SystemCapability.ArkUI.ArkUI.Full 232 * @since 7 233 */ 234 /** 235 * Specifies the end line number of the current element. 236 * 237 * @param { number } value 238 * @returns { GridItemAttribute } 239 * @syscap SystemCapability.ArkUI.ArkUI.Full 240 * @crossplatform 241 * @since 10 242 */ 243 /** 244 * Specifies the end line number of the current element. 245 * 246 * @param { number } value 247 * @returns { GridItemAttribute } 248 * @syscap SystemCapability.ArkUI.ArkUI.Full 249 * @crossplatform 250 * @atomicservice 251 * @since arkts {'1.1':'11','1.2':'20'} 252 * @arkts 1.1&1.2 253 */ 254 rowEnd(value: number): GridItemAttribute; 255 256 /** 257 * This parameter specifies the start column number of the current element. 258 * 259 * @param { number } value 260 * @returns { GridItemAttribute } 261 * @syscap SystemCapability.ArkUI.ArkUI.Full 262 * @since 7 263 */ 264 /** 265 * This parameter specifies the start column number of the current element. 266 * 267 * @param { number } value 268 * @returns { GridItemAttribute } 269 * @syscap SystemCapability.ArkUI.ArkUI.Full 270 * @crossplatform 271 * @since 10 272 */ 273 /** 274 * This parameter specifies the start column number of the current element. 275 * 276 * @param { number } value 277 * @returns { GridItemAttribute } 278 * @syscap SystemCapability.ArkUI.ArkUI.Full 279 * @crossplatform 280 * @atomicservice 281 * @since arkts {'1.1':'11','1.2':'20'} 282 * @arkts 1.1&1.2 283 */ 284 columnStart(value: number): GridItemAttribute; 285 286 /** 287 * This parameter specifies the end column number of the current element. 288 * 289 * @param { number } value 290 * @returns { GridItemAttribute } 291 * @syscap SystemCapability.ArkUI.ArkUI.Full 292 * @since 7 293 */ 294 /** 295 * This parameter specifies the end column number of the current element. 296 * 297 * @param { number } value 298 * @returns { GridItemAttribute } 299 * @syscap SystemCapability.ArkUI.ArkUI.Full 300 * @crossplatform 301 * @since 10 302 */ 303 /** 304 * This parameter specifies the end column number of the current element. 305 * 306 * @param { number } value 307 * @returns { GridItemAttribute } 308 * @syscap SystemCapability.ArkUI.ArkUI.Full 309 * @crossplatform 310 * @atomicservice 311 * @since arkts {'1.1':'11','1.2':'20'} 312 * @arkts 1.1&1.2 313 */ 314 columnEnd(value: number): GridItemAttribute; 315 316 /** 317 * This parameter specifies whether to recreate the node when the component build is triggered. 318 * 319 * @param { boolean } value 320 * @returns { GridItemAttribute } 321 * @syscap SystemCapability.ArkUI.ArkUI.Full 322 * @since 7 323 * @deprecated since 9 324 */ 325 forceRebuild(value: boolean): GridItemAttribute; 326 327 /** 328 * Called when judging whether it is selectable. 329 * 330 * @param { boolean } value 331 * @returns { GridItemAttribute } 332 * @syscap SystemCapability.ArkUI.ArkUI.Full 333 * @since 8 334 */ 335 /** 336 * Called when judging whether it is selectable. 337 * 338 * @param { boolean } value 339 * @returns { GridItemAttribute } 340 * @syscap SystemCapability.ArkUI.ArkUI.Full 341 * @crossplatform 342 * @since 10 343 */ 344 /** 345 * Called when judging whether it is selectable. 346 * 347 * @param { boolean } value 348 * @returns { GridItemAttribute } 349 * @syscap SystemCapability.ArkUI.ArkUI.Full 350 * @crossplatform 351 * @atomicservice 352 * @since arkts {'1.1':'11','1.2':'20'} 353 * @arkts 1.1&1.2 354 */ 355 selectable(value: boolean): GridItemAttribute; 356 357 /** 358 * Called when judging whether it is selected. 359 * This parameter supports $$ for two-way binding of variables. 360 * 361 * @param { boolean } value - if the gridItem is selected. 362 * @returns { GridItemAttribute } the attribute of the gridItem. 363 * @syscap SystemCapability.ArkUI.ArkUI.Full 364 * @crossplatform 365 * @since 10 366 */ 367 /** 368 * Called when judging whether it is selected. 369 * This parameter supports $$ for two-way binding of variables. 370 * 371 * @param { boolean } value - if the gridItem is selected. 372 * @returns { GridItemAttribute } the attribute of the gridItem. 373 * @syscap SystemCapability.ArkUI.ArkUI.Full 374 * @crossplatform 375 * @atomicservice 376 * @since 11 377 */ 378 selected(value: boolean): GridItemAttribute; 379 380 /** 381 * Called when judging whether it is selected. 382 * This parameter supports $$ for two-way binding of variables. 383 * 384 * @param { boolean | Bindable<boolean> } value 385 * @returns { GridItemAttribute } the attribute of the gridItem. 386 * @syscap SystemCapability.ArkUI.ArkUI.Full 387 * @crossplatform 388 * @atomicservice 389 * @since 20 390 * @arkts 1.2 391 */ 392 selected(value: boolean | Bindable<boolean>): GridItemAttribute; 393 394 /** 395 * Called when the gridItem is selected. 396 * 397 * @param { function } event 398 * @returns { GridItemAttribute } 399 * @syscap SystemCapability.ArkUI.ArkUI.Full 400 * @since 8 401 */ 402 /** 403 * Called when the gridItem is selected. 404 * 405 * @param { function } event 406 * @returns { GridItemAttribute } 407 * @syscap SystemCapability.ArkUI.ArkUI.Full 408 * @crossplatform 409 * @since 10 410 */ 411 /** 412 * Called when the gridItem is selected. 413 * 414 * @param { function } event 415 * @returns { GridItemAttribute } 416 * @syscap SystemCapability.ArkUI.ArkUI.Full 417 * @crossplatform 418 * @atomicservice 419 * @since arkts {'1.1':'11','1.2':'20'} 420 * @arkts 1.1&1.2 421 */ 422 onSelect(event: (isSelected: boolean) => void): GridItemAttribute; 423} 424 425/** 426 * Defines GridItem Component. 427 * 428 * @syscap SystemCapability.ArkUI.ArkUI.Full 429 * @since 7 430 */ 431/** 432 * Defines GridItem Component. 433 * 434 * @syscap SystemCapability.ArkUI.ArkUI.Full 435 * @crossplatform 436 * @since 10 437 */ 438/** 439 * Defines GridItem Component. 440 * 441 * @syscap SystemCapability.ArkUI.ArkUI.Full 442 * @crossplatform 443 * @atomicservice 444 * @since 11 445 */ 446declare const GridItem: GridItemInterface 447 448/** 449 * Defines GridItem Component instance. 450 * 451 * @syscap SystemCapability.ArkUI.ArkUI.Full 452 * @since 7 453 */ 454/** 455 * Defines GridItem Component instance. 456 * 457 * @syscap SystemCapability.ArkUI.ArkUI.Full 458 * @crossplatform 459 * @since 10 460 */ 461/** 462 * Defines GridItem Component instance. 463 * 464 * @syscap SystemCapability.ArkUI.ArkUI.Full 465 * @crossplatform 466 * @atomicservice 467 * @since 11 468 */ 469declare const GridItemInstance: GridItemAttribute; 470