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 * Defines the options of Flex. 18 * 19 * @interface FlexOptions 20 * @syscap SystemCapability.ArkUI.ArkUI.Full 21 * @since 7 22 */ 23/** 24 * Defines the options of Flex. 25 * 26 * @interface FlexOptions 27 * @syscap SystemCapability.ArkUI.ArkUI.Full 28 * @since 9 29 * @form 30 */ 31/** 32 * Defines the options of Flex. 33 * 34 * @interface FlexOptions 35 * @syscap SystemCapability.ArkUI.ArkUI.Full 36 * @crossplatform 37 * @since 10 38 * @form 39 */ 40/** 41 * Defines the options of Flex. 42 * 43 * @interface FlexOptions 44 * @syscap SystemCapability.ArkUI.ArkUI.Full 45 * @crossplatform 46 * @atomicservice 47 * @since 11 48 * @form 49 */ 50declare interface FlexOptions { 51 /** 52 * Sets the horizontal layout of elements. 53 * 54 * @type { ?FlexDirection } 55 * @syscap SystemCapability.ArkUI.ArkUI.Full 56 * @since 7 57 */ 58 /** 59 * Sets the horizontal layout of elements. 60 * 61 * @type { ?FlexDirection } 62 * @syscap SystemCapability.ArkUI.ArkUI.Full 63 * @since 9 64 * @form 65 */ 66 /** 67 * Sets the horizontal layout of elements. 68 * 69 * @type { ?FlexDirection } 70 * @syscap SystemCapability.ArkUI.ArkUI.Full 71 * @crossplatform 72 * @since 10 73 * @form 74 */ 75 /** 76 * Sets the horizontal layout of elements. 77 * 78 * @type { ?FlexDirection } 79 * @syscap SystemCapability.ArkUI.ArkUI.Full 80 * @crossplatform 81 * @atomicservice 82 * @since 11 83 * @form 84 */ 85 direction?: FlexDirection; 86 87 /** 88 * Whether the Flex container is a single row/column arrangement or a multi-row/column arrangement. 89 * 90 * @type { ?FlexWrap } 91 * @syscap SystemCapability.ArkUI.ArkUI.Full 92 * @since 7 93 */ 94 /** 95 * Whether the Flex container is a single row/column arrangement or a multi-row/column arrangement. 96 * 97 * @type { ?FlexWrap } 98 * @syscap SystemCapability.ArkUI.ArkUI.Full 99 * @since 9 100 * @form 101 */ 102 /** 103 * Whether the Flex container is a single row/column arrangement or a multi-row/column arrangement. 104 * 105 * @type { ?FlexWrap } 106 * @syscap SystemCapability.ArkUI.ArkUI.Full 107 * @crossplatform 108 * @since 10 109 * @form 110 */ 111 /** 112 * Whether the Flex container is a single row/column arrangement or a multi-row/column arrangement. 113 * 114 * @type { ?FlexWrap } 115 * @syscap SystemCapability.ArkUI.ArkUI.Full 116 * @crossplatform 117 * @atomicservice 118 * @since 11 119 * @form 120 */ 121 wrap?: FlexWrap; 122 123 /** 124 * The alignment format of the subassembly on the Flex container spindle. 125 * 126 * @type { ?FlexAlign } 127 * @syscap SystemCapability.ArkUI.ArkUI.Full 128 * @since 7 129 */ 130 /** 131 * The alignment format of the subassembly on the Flex container spindle. 132 * 133 * @type { ?FlexAlign } 134 * @syscap SystemCapability.ArkUI.ArkUI.Full 135 * @since 9 136 * @form 137 */ 138 /** 139 * The alignment format of the subassembly on the Flex container spindle. 140 * 141 * @type { ?FlexAlign } 142 * @syscap SystemCapability.ArkUI.ArkUI.Full 143 * @crossplatform 144 * @since 10 145 * @form 146 */ 147 /** 148 * The alignment format of the subassembly on the Flex container spindle. 149 * 150 * @type { ?FlexAlign } 151 * @syscap SystemCapability.ArkUI.ArkUI.Full 152 * @crossplatform 153 * @atomicservice 154 * @since 11 155 * @form 156 */ 157 justifyContent?: FlexAlign; 158 159 /** 160 * Alignment Format for Subassembly on Flex Container Cross Axis. 161 * 162 * @type { ?ItemAlign } 163 * @syscap SystemCapability.ArkUI.ArkUI.Full 164 * @since 7 165 */ 166 /** 167 * Alignment Format for Subassembly on Flex Container Cross Axis. 168 * 169 * @type { ?ItemAlign } 170 * @syscap SystemCapability.ArkUI.ArkUI.Full 171 * @since 9 172 * @form 173 */ 174 /** 175 * Alignment Format for Subassembly on Flex Container Cross Axis. 176 * 177 * @type { ?ItemAlign } 178 * @syscap SystemCapability.ArkUI.ArkUI.Full 179 * @crossplatform 180 * @since 10 181 * @form 182 */ 183 /** 184 * Alignment Format for Subassembly on Flex Container Cross Axis. 185 * 186 * @type { ?ItemAlign } 187 * @syscap SystemCapability.ArkUI.ArkUI.Full 188 * @crossplatform 189 * @atomicservice 190 * @since 11 191 * @form 192 */ 193 alignItems?: ItemAlign; 194 195 /** 196 * The alignment of multiple lines of content when there is extra space in the cross axis. 197 * 198 * @type { ?FlexAlign } 199 * @syscap SystemCapability.ArkUI.ArkUI.Full 200 * @since 7 201 */ 202 /** 203 * The alignment of multiple lines of content when there is extra space in the cross axis. 204 * 205 * @type { ?FlexAlign } 206 * @syscap SystemCapability.ArkUI.ArkUI.Full 207 * @since 9 208 * @form 209 */ 210 /** 211 * The alignment of multiple lines of content when there is extra space in the cross axis. 212 * 213 * @type { ?FlexAlign } 214 * @syscap SystemCapability.ArkUI.ArkUI.Full 215 * @crossplatform 216 * @since 10 217 * @form 218 */ 219 /** 220 * The alignment of multiple lines of content when there is extra space in the cross axis. 221 * 222 * @type { ?FlexAlign } 223 * @syscap SystemCapability.ArkUI.ArkUI.Full 224 * @crossplatform 225 * @atomicservice 226 * @since 11 227 * @form 228 */ 229 alignContent?: FlexAlign; 230} 231 232/** 233 * Provides a monthly view component to display information such as date, shift break, and schedule. 234 * 235 * @interface FlexInterface 236 * @syscap SystemCapability.ArkUI.ArkUI.Full 237 * @since 7 238 */ 239/** 240 * Provides a monthly view component to display information such as date, shift break, and schedule. 241 * 242 * @interface FlexInterface 243 * @syscap SystemCapability.ArkUI.ArkUI.Full 244 * @since 9 245 * @form 246 */ 247/** 248 * Provides a monthly view component to display information such as date, shift break, and schedule. 249 * 250 * @interface FlexInterface 251 * @syscap SystemCapability.ArkUI.ArkUI.Full 252 * @crossplatform 253 * @since 10 254 * @form 255 */ 256/** 257 * Provides a monthly view component to display information such as date, shift break, and schedule. 258 * 259 * @interface FlexInterface 260 * @syscap SystemCapability.ArkUI.ArkUI.Full 261 * @crossplatform 262 * @atomicservice 263 * @since 11 264 * @form 265 */ 266interface FlexInterface { 267 /** 268 * Defines the constructor of Flex. 269 * 270 * @param { FlexOptions } value 271 * @returns { FlexAttribute } 272 * @syscap SystemCapability.ArkUI.ArkUI.Full 273 * @since 7 274 */ 275 /** 276 * Defines the constructor of Flex. 277 * 278 * @param { FlexOptions } value 279 * @returns { FlexAttribute } 280 * @syscap SystemCapability.ArkUI.ArkUI.Full 281 * @since 9 282 * @form 283 */ 284 /** 285 * Defines the constructor of Flex. 286 * 287 * @param { FlexOptions } value 288 * @returns { FlexAttribute } 289 * @syscap SystemCapability.ArkUI.ArkUI.Full 290 * @crossplatform 291 * @since 10 292 * @form 293 */ 294 /** 295 * Defines the constructor of Flex. 296 * 297 * @param { FlexOptions } value 298 * @returns { FlexAttribute } 299 * @syscap SystemCapability.ArkUI.ArkUI.Full 300 * @crossplatform 301 * @atomicservice 302 * @since 11 303 * @form 304 */ 305 (value?: FlexOptions): FlexAttribute; 306} 307 308/** 309 * Defines the Flex attribute functions. 310 * 311 * @extends CommonMethod<FlexAttribute> 312 * @syscap SystemCapability.ArkUI.ArkUI.Full 313 * @since 7 314 */ 315/** 316 * Defines the Flex attribute functions. 317 * 318 * @extends CommonMethod<FlexAttribute> 319 * @syscap SystemCapability.ArkUI.ArkUI.Full 320 * @since 9 321 * @form 322 */ 323/** 324 * Defines the Flex attribute functions. 325 * 326 * @extends CommonMethod<FlexAttribute> 327 * @syscap SystemCapability.ArkUI.ArkUI.Full 328 * @crossplatform 329 * @since 10 330 * @form 331 */ 332/** 333 * Defines the Flex attribute functions. 334 * 335 * @extends CommonMethod<FlexAttribute> 336 * @syscap SystemCapability.ArkUI.ArkUI.Full 337 * @crossplatform 338 * @atomicservice 339 * @since 11 340 * @form 341 */ 342declare class FlexAttribute extends CommonMethod<FlexAttribute> { 343 /** 344 * Defines the PointLight 345 * 346 * @param { PointLightStyle } value - The point light style. 347 * @returns { FlexAttribute } The attribute of the flex. 348 * @syscap SystemCapability.ArkUI.ArkUI.Full 349 * @systemapi 350 * @since 11 351 */ 352 pointLight(value: PointLightStyle): FlexAttribute; 353} 354 355/** 356 * Defines Flex Component. 357 * 358 * @syscap SystemCapability.ArkUI.ArkUI.Full 359 * @since 7 360 */ 361/** 362 * Defines Flex Component. 363 * 364 * @syscap SystemCapability.ArkUI.ArkUI.Full 365 * @since 9 366 * @form 367 */ 368/** 369 * Defines Flex Component. 370 * 371 * @syscap SystemCapability.ArkUI.ArkUI.Full 372 * @crossplatform 373 * @since 10 374 * @form 375 */ 376/** 377 * Defines Flex Component. 378 * 379 * @syscap SystemCapability.ArkUI.ArkUI.Full 380 * @crossplatform 381 * @atomicservice 382 * @since 11 383 * @form 384 */ 385declare const Flex: FlexInterface; 386 387/** 388 * Defines Flex Component instance. 389 * 390 * @syscap SystemCapability.ArkUI.ArkUI.Full 391 * @since 7 392 */ 393/** 394 * Defines Flex Component instance. 395 * 396 * @syscap SystemCapability.ArkUI.ArkUI.Full 397 * @since 9 398 * @form 399 */ 400/** 401 * Defines Flex Component instance. 402 * 403 * @syscap SystemCapability.ArkUI.ArkUI.Full 404 * @crossplatform 405 * @since 10 406 * @form 407 */ 408/** 409 * Defines Flex Component instance. 410 * 411 * @syscap SystemCapability.ArkUI.ArkUI.Full 412 * @crossplatform 413 * @atomicservice 414 * @since 11 415 * @form 416 */ 417declare const FlexInstance: FlexAttribute; 418