• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 */
40declare interface FlexOptions {
41  /**
42   * Sets the horizontal layout of elements.
43   *
44   * @type { ?FlexDirection }
45   * @syscap SystemCapability.ArkUI.ArkUI.Full
46   * @since 7
47   */
48  /**
49   * Sets the horizontal layout of elements.
50   *
51   * @type { ?FlexDirection }
52   * @syscap SystemCapability.ArkUI.ArkUI.Full
53   * @since 9
54   * @form
55   */
56  /**
57   * Sets the horizontal layout of elements.
58   *
59   * @type { ?FlexDirection }
60   * @syscap SystemCapability.ArkUI.ArkUI.Full
61   * @crossplatform
62   * @since 10
63   * @form
64   */
65  direction?: FlexDirection;
66
67  /**
68   * Whether the Flex container is a single row/column arrangement or a multi-row/column arrangement.
69   *
70   * @type { ?FlexWrap }
71   * @syscap SystemCapability.ArkUI.ArkUI.Full
72   * @since 7
73   */
74  /**
75   * Whether the Flex container is a single row/column arrangement or a multi-row/column arrangement.
76   *
77   * @type { ?FlexWrap }
78   * @syscap SystemCapability.ArkUI.ArkUI.Full
79   * @since 9
80   * @form
81   */
82  /**
83   * Whether the Flex container is a single row/column arrangement or a multi-row/column arrangement.
84   *
85   * @type { ?FlexWrap }
86   * @syscap SystemCapability.ArkUI.ArkUI.Full
87   * @crossplatform
88   * @since 10
89   * @form
90   */
91  wrap?: FlexWrap;
92
93  /**
94   * The alignment format of the subassembly on the Flex container spindle.
95   *
96   * @type { ?FlexAlign }
97   * @syscap SystemCapability.ArkUI.ArkUI.Full
98   * @since 7
99   */
100  /**
101   * The alignment format of the subassembly on the Flex container spindle.
102   *
103   * @type { ?FlexAlign }
104   * @syscap SystemCapability.ArkUI.ArkUI.Full
105   * @since 9
106   * @form
107   */
108  /**
109   * The alignment format of the subassembly on the Flex container spindle.
110   *
111   * @type { ?FlexAlign }
112   * @syscap SystemCapability.ArkUI.ArkUI.Full
113   * @crossplatform
114   * @since 10
115   * @form
116   */
117  justifyContent?: FlexAlign;
118
119  /**
120   * Alignment Format for Subassembly on Flex Container Cross Axis.
121   *
122   * @type { ?ItemAlign }
123   * @syscap SystemCapability.ArkUI.ArkUI.Full
124   * @since 7
125   */
126  /**
127   * Alignment Format for Subassembly on Flex Container Cross Axis.
128   *
129   * @type { ?ItemAlign }
130   * @syscap SystemCapability.ArkUI.ArkUI.Full
131   * @since 9
132   * @form
133   */
134  /**
135   * Alignment Format for Subassembly on Flex Container Cross Axis.
136   *
137   * @type { ?ItemAlign }
138   * @syscap SystemCapability.ArkUI.ArkUI.Full
139   * @crossplatform
140   * @since 10
141   * @form
142   */
143  alignItems?: ItemAlign;
144
145  /**
146   * The alignment of multiple lines of content when there is extra space in the cross axis.
147   *
148   * @type { ?FlexAlign }
149   * @syscap SystemCapability.ArkUI.ArkUI.Full
150   * @since 7
151   */
152  /**
153   * The alignment of multiple lines of content when there is extra space in the cross axis.
154   *
155   * @type { ?FlexAlign }
156   * @syscap SystemCapability.ArkUI.ArkUI.Full
157   * @since 9
158   * @form
159   */
160  /**
161   * The alignment of multiple lines of content when there is extra space in the cross axis.
162   *
163   * @type { ?FlexAlign }
164   * @syscap SystemCapability.ArkUI.ArkUI.Full
165   * @crossplatform
166   * @since 10
167   * @form
168   */
169  alignContent?: FlexAlign;
170}
171
172/**
173 * Provides a monthly view component to display information such as date, shift break, and schedule.
174 *
175 * @interface FlexInterface
176 * @syscap SystemCapability.ArkUI.ArkUI.Full
177 * @since 7
178 */
179/**
180 * Provides a monthly view component to display information such as date, shift break, and schedule.
181 *
182 * @interface FlexInterface
183 * @syscap SystemCapability.ArkUI.ArkUI.Full
184 * @since 9
185 * @form
186 */
187/**
188 * Provides a monthly view component to display information such as date, shift break, and schedule.
189 *
190 * @interface FlexInterface
191 * @syscap SystemCapability.ArkUI.ArkUI.Full
192 * @crossplatform
193 * @since 10
194 * @form
195 */
196interface FlexInterface {
197  /**
198   * Defines the constructor of Flex.
199   *
200   * @param { FlexOptions } value
201   * @returns { FlexAttribute }
202   * @syscap SystemCapability.ArkUI.ArkUI.Full
203   * @since 7
204   */
205  /**
206   * Defines the constructor of Flex.
207   *
208   * @param { FlexOptions } value
209   * @returns { FlexAttribute }
210   * @syscap SystemCapability.ArkUI.ArkUI.Full
211   * @since 9
212   * @form
213   */
214  /**
215   * Defines the constructor of Flex.
216   *
217   * @param { FlexOptions } value
218   * @returns { FlexAttribute }
219   * @syscap SystemCapability.ArkUI.ArkUI.Full
220   * @crossplatform
221   * @since 10
222   * @form
223   */
224  (value?: FlexOptions): FlexAttribute;
225}
226
227/**
228 * Defines the Flex attribute functions.
229 *
230 * @extends CommonMethod
231 * @syscap SystemCapability.ArkUI.ArkUI.Full
232 * @since 7
233 */
234/**
235 * Defines the Flex attribute functions.
236 *
237 * @extends CommonMethod
238 * @syscap SystemCapability.ArkUI.ArkUI.Full
239 * @since 9
240 * @form
241 */
242/**
243 * Defines the Flex attribute functions.
244 *
245 * @extends CommonMethod
246 * @syscap SystemCapability.ArkUI.ArkUI.Full
247 * @crossplatform
248 * @since 10
249 * @form
250 */
251declare class FlexAttribute extends CommonMethod<FlexAttribute> {}
252
253/**
254 * Defines Flex Component.
255 *
256 * @syscap SystemCapability.ArkUI.ArkUI.Full
257 * @since 7
258 */
259/**
260 * Defines Flex Component.
261 *
262 * @syscap SystemCapability.ArkUI.ArkUI.Full
263 * @since 9
264 * @form
265 */
266/**
267 * Defines Flex Component.
268 *
269 * @syscap SystemCapability.ArkUI.ArkUI.Full
270 * @crossplatform
271 * @since 10
272 * @form
273 */
274declare const Flex: FlexInterface;
275
276/**
277 * Defines Flex Component instance.
278 *
279 * @syscap SystemCapability.ArkUI.ArkUI.Full
280 * @since 7
281 */
282/**
283 * Defines Flex Component instance.
284 *
285 * @syscap SystemCapability.ArkUI.ArkUI.Full
286 * @since 9
287 * @form
288 */
289/**
290 * Defines Flex Component instance.
291 *
292 * @syscap SystemCapability.ArkUI.ArkUI.Full
293 * @crossplatform
294 * @since 10
295 * @form
296 */
297declare const FlexInstance: FlexAttribute;
298