• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 * Defines the option in number unit of grid-container child component.
18 *
19 * @interface GridColColumnOption
20 * @syscap SystemCapability.ArkUI.ArkUI.Full
21 * @since 9
22 * @form
23 */
24/**
25 * Defines the option in number unit of grid-container child component.
26 *
27 * @interface GridColColumnOption
28 * @syscap SystemCapability.ArkUI.ArkUI.Full
29 * @crossplatform
30 * @since 10
31 * @form
32 */
33declare interface GridColColumnOption {
34  /**
35   * Grid Col Column Option xs
36   *
37   * @type { ?number }
38   * @syscap SystemCapability.ArkUI.ArkUI.Full
39   * @since 9
40   * @form
41   */
42  /**
43   * Grid Col Column Option xs
44   *
45   * @type { ?number }
46   * @syscap SystemCapability.ArkUI.ArkUI.Full
47   * @crossplatform
48   * @since 10
49   * @form
50   */
51  xs?: number,
52
53  /**
54   * Grid Col Column Option sm
55   *
56   * @type { ?number }
57   * @syscap SystemCapability.ArkUI.ArkUI.Full
58   * @since 9
59   * @form
60   */
61  /**
62   * Grid Col Column Option sm
63   *
64   * @type { ?number }
65   * @syscap SystemCapability.ArkUI.ArkUI.Full
66   * @crossplatform
67   * @since 10
68   * @form
69   */
70  sm?: number,
71
72  /**
73   * Grid Col Column Option md
74   *
75   * @type { ?number }
76   * @syscap SystemCapability.ArkUI.ArkUI.Full
77   * @since 9
78   * @form
79   */
80  /**
81   * Grid Col Column Option md
82   *
83   * @type { ?number }
84   * @syscap SystemCapability.ArkUI.ArkUI.Full
85   * @crossplatform
86   * @since 10
87   * @form
88   */
89  md?: number,
90
91  /**
92   * Grid Col Column Option lg
93   *
94   * @type { ?number }
95   * @syscap SystemCapability.ArkUI.ArkUI.Full
96   * @since 9
97   * @form
98   */
99  /**
100   * Grid Col Column Option lg
101   *
102   * @type { ?number }
103   * @syscap SystemCapability.ArkUI.ArkUI.Full
104   * @crossplatform
105   * @since 10
106   * @form
107   */
108  lg?: number,
109
110  /**
111   * Grid Col Column Option xl
112   *
113   * @type { ?number }
114   * @syscap SystemCapability.ArkUI.ArkUI.Full
115   * @since 9
116   * @form
117   */
118  /**
119   * Grid Col Column Option xl
120   *
121   * @type { ?number }
122   * @syscap SystemCapability.ArkUI.ArkUI.Full
123   * @crossplatform
124   * @since 10
125   * @form
126   */
127  xl?: number,
128
129  /**
130   * Grid Col Column Option xxl
131   *
132   * @type { ?number }
133   * @syscap SystemCapability.ArkUI.ArkUI.Full
134   * @since 9
135   * @form
136   */
137  /**
138   * Grid Col Column Option xxl
139   *
140   * @type { ?number }
141   * @syscap SystemCapability.ArkUI.ArkUI.Full
142   * @crossplatform
143   * @since 10
144   * @form
145   */
146  xxl?: number,
147}
148
149/**
150 * Defines the options of grid-container child component.
151 *
152 * @interface GridColOptions
153 * @syscap SystemCapability.ArkUI.ArkUI.Full
154 * @since 9
155 * @form
156 */
157/**
158 * Defines the options of grid-container child component.
159 *
160 * @interface GridColOptions
161 * @syscap SystemCapability.ArkUI.ArkUI.Full
162 * @crossplatform
163 * @since 10
164 * @form
165 */
166declare interface GridColOptions {
167  /**
168   * Sets the span of current gird-container item.
169   *
170   * @type { ?(number | GridColColumnOption) }
171   * @syscap SystemCapability.ArkUI.ArkUI.Full
172   * @since 9
173   * @form
174   */
175  /**
176   * Sets the span of current gird-container item.
177   *
178   * @type { ?(number | GridColColumnOption) }
179   * @syscap SystemCapability.ArkUI.ArkUI.Full
180   * @crossplatform
181   * @since 10
182   * @form
183   */
184  span?: number | GridColColumnOption;
185
186  /**
187   * Sets the offset of current gird-container item.
188   *
189   * @type { ?(number | GridColColumnOption) }
190   * @syscap SystemCapability.ArkUI.ArkUI.Full
191   * @since 9
192   * @form
193   */
194  /**
195   * Sets the offset of current gird-container item.
196   *
197   * @type { ?(number | GridColColumnOption) }
198   * @syscap SystemCapability.ArkUI.ArkUI.Full
199   * @crossplatform
200   * @since 10
201   * @form
202   */
203  offset?: number | GridColColumnOption;
204
205  /**
206   * Sets the order of current gird-container item.
207   *
208   * @type { ?(number | GridColColumnOption) }
209   * @syscap SystemCapability.ArkUI.ArkUI.Full
210   * @since 9
211   * @form
212   */
213  /**
214   * Sets the order of current gird-container item.
215   *
216   * @type { ?(number | GridColColumnOption) }
217   * @syscap SystemCapability.ArkUI.ArkUI.Full
218   * @crossplatform
219   * @since 10
220   * @form
221   */
222  order?: number | GridColColumnOption;
223}
224
225/**
226 * Defines the the new version of grid-container child component.
227 *
228 * @interface GridColInterface
229 * @syscap SystemCapability.ArkUI.ArkUI.Full
230 * @since 9
231 * @form
232 */
233/**
234 * Defines the the new version of grid-container child component.
235 *
236 * @interface GridColInterface
237 * @syscap SystemCapability.ArkUI.ArkUI.Full
238 * @crossplatform
239 * @since 10
240 * @form
241 */
242interface GridColInterface {
243  /**
244   * Defines the constructor of GridContainer.
245   *
246   * @param { GridColOptions } option
247   * @returns { GridColAttribute }
248   * @syscap SystemCapability.ArkUI.ArkUI.Full
249   * @since 9
250   * @form
251   */
252  /**
253   * Defines the constructor of GridContainer.
254   *
255   * @param { GridColOptions } option
256   * @returns { GridColAttribute }
257   * @syscap SystemCapability.ArkUI.ArkUI.Full
258   * @crossplatform
259   * @since 10
260   * @form
261   */
262  (option?: GridColOptions): GridColAttribute;
263}
264
265declare class GridColAttribute extends CommonMethod<GridColAttribute> {
266  /**
267   * Sets the span of current gird-container item.
268   *
269   * @param { number | GridColColumnOption } value
270   * @returns { GridColAttribute }
271   * @syscap SystemCapability.ArkUI.ArkUI.Full
272   * @since 9
273   * @form
274   */
275  /**
276   * Sets the span of current gird-container item.
277   *
278   * @param { number | GridColColumnOption } value
279   * @returns { GridColAttribute }
280   * @syscap SystemCapability.ArkUI.ArkUI.Full
281   * @crossplatform
282   * @since 10
283   * @form
284   */
285  span(value: number | GridColColumnOption): GridColAttribute;
286
287  /**
288   * Sets the offset of current gird-container item.
289   *
290   * @param { number | GridColColumnOption } value
291   * @returns { GridColAttribute }
292   * @syscap SystemCapability.ArkUI.ArkUI.Full
293   * @since 9
294   * @form
295   */
296  /**
297   * Sets the offset of current gird-container item.
298   *
299   * @param { number | GridColColumnOption } value
300   * @returns { GridColAttribute }
301   * @syscap SystemCapability.ArkUI.ArkUI.Full
302   * @crossplatform
303   * @since 10
304   * @form
305   */
306  gridColOffset(value: number | GridColColumnOption): GridColAttribute;
307
308  /**
309   * Sets the order of current gird-container item.
310   *
311   * @param { number | GridColColumnOption } value
312   * @returns { GridColAttribute }
313   * @syscap SystemCapability.ArkUI.ArkUI.Full
314   * @since 9
315   * @form
316   */
317  /**
318   * Sets the order of current gird-container item.
319   *
320   * @param { number | GridColColumnOption } value
321   * @returns { GridColAttribute }
322   * @syscap SystemCapability.ArkUI.ArkUI.Full
323   * @crossplatform
324   * @since 10
325   * @form
326   */
327  order(value: number | GridColColumnOption): GridColAttribute;
328}
329
330/**
331 * Defines GridCol Component.
332 *
333 * @syscap SystemCapability.ArkUI.ArkUI.Full
334 * @since 9
335 * @form
336 */
337/**
338 * Defines GridCol Component.
339 *
340 * @syscap SystemCapability.ArkUI.ArkUI.Full
341 * @crossplatform
342 * @since 10
343 * @form
344 */
345declare const GridCol: GridColInterface
346
347/**
348 * Defines GridCol Component instance.
349 *
350 * @syscap SystemCapability.ArkUI.ArkUI.Full
351 * @since 9
352 * @form
353 */
354/**
355 * Defines GridCol Component instance.
356 *
357 * @syscap SystemCapability.ArkUI.ArkUI.Full
358 * @crossplatform
359 * @since 10
360 * @form
361 */
362declare const GridColInstance: GridColAttribute;
363