• 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 * Mesh container for static fixed-size layout scenarios.
18 *
19 * @interface GridItemInterface
20 * @syscap SystemCapability.ArkUI.ArkUI.Full
21 * @since 7
22 */
23/**
24 * Mesh container for static fixed-size layout scenarios.
25 *
26 * @interface GridItemInterface
27 * @syscap SystemCapability.ArkUI.ArkUI.Full
28 * @crossplatform
29 * @since 10
30 */
31interface GridItemInterface {
32  /**
33   * Return to get GridItem.
34   *
35   * @returns { GridItemAttribute }
36   * @syscap SystemCapability.ArkUI.ArkUI.Full
37   * @since 7
38   */
39  /**
40   * Return to get GridItem.
41   *
42   * @returns { GridItemAttribute }
43   * @syscap SystemCapability.ArkUI.ArkUI.Full
44   * @crossplatform
45   * @since 10
46   */
47  (): GridItemAttribute;
48}
49
50/**
51 * @extends CommonMethod
52 * @syscap SystemCapability.ArkUI.ArkUI.Full
53 * @since 7
54 */
55/**
56 * @extends CommonMethod
57 * @syscap SystemCapability.ArkUI.ArkUI.Full
58 * @crossplatform
59 * @since 10
60 */
61declare class GridItemAttribute extends CommonMethod<GridItemAttribute> {
62  /**
63   * This parameter specifies the start line number of the current element.
64   *
65   * @param { number } value
66   * @returns { GridItemAttribute }
67   * @syscap SystemCapability.ArkUI.ArkUI.Full
68   * @since 7
69   */
70  /**
71   * This parameter specifies the start line number of the current element.
72   *
73   * @param { number } value
74   * @returns { GridItemAttribute }
75   * @syscap SystemCapability.ArkUI.ArkUI.Full
76   * @crossplatform
77   * @since 10
78   */
79  rowStart(value: number): GridItemAttribute;
80
81  /**
82   * Specifies the end line number of the current element.
83   *
84   * @param { number } value
85   * @returns { GridItemAttribute }
86   * @syscap SystemCapability.ArkUI.ArkUI.Full
87   * @since 7
88   */
89  /**
90   * Specifies the end line number of the current element.
91   *
92   * @param { number } value
93   * @returns { GridItemAttribute }
94   * @syscap SystemCapability.ArkUI.ArkUI.Full
95   * @crossplatform
96   * @since 10
97   */
98  rowEnd(value: number): GridItemAttribute;
99
100  /**
101   * This parameter specifies the start column number of the current element.
102   *
103   * @param { number } value
104   * @returns { GridItemAttribute }
105   * @syscap SystemCapability.ArkUI.ArkUI.Full
106   * @since 7
107   */
108  /**
109   * This parameter specifies the start column number of the current element.
110   *
111   * @param { number } value
112   * @returns { GridItemAttribute }
113   * @syscap SystemCapability.ArkUI.ArkUI.Full
114   * @crossplatform
115   * @since 10
116   */
117  columnStart(value: number): GridItemAttribute;
118
119  /**
120   * This parameter specifies the end column number of the current element.
121   *
122   * @param { number } value
123   * @returns { GridItemAttribute }
124   * @syscap SystemCapability.ArkUI.ArkUI.Full
125   * @since 7
126   */
127  /**
128   * This parameter specifies the end column number of the current element.
129   *
130   * @param { number } value
131   * @returns { GridItemAttribute }
132   * @syscap SystemCapability.ArkUI.ArkUI.Full
133   * @crossplatform
134   * @since 10
135   */
136  columnEnd(value: number): GridItemAttribute;
137
138  /**
139   * This parameter specifies whether to recreate the node when the component build is triggered.
140   *
141   * @param { boolean } value
142   * @returns { GridItemAttribute }
143   * @syscap SystemCapability.ArkUI.ArkUI.Full
144   * @since 7
145   * @deprecated since 9
146   */
147  forceRebuild(value: boolean): GridItemAttribute;
148
149  /**
150   * Called when judging whether it is selectable.
151   *
152   * @param { boolean } value
153   * @returns { GridItemAttribute }
154   * @syscap SystemCapability.ArkUI.ArkUI.Full
155   * @since 8
156   */
157  /**
158   * Called when judging whether it is selectable.
159   *
160   * @param { boolean } value
161   * @returns { GridItemAttribute }
162   * @syscap SystemCapability.ArkUI.ArkUI.Full
163   * @crossplatform
164   * @since 10
165   */
166  selectable(value: boolean): GridItemAttribute;
167
168  /**
169   * Called when judging whether it is selected.
170   * This parameter supports $$ for two-way binding of variables.
171   *
172   * @param { boolean } value - if the gridItem is selected.
173   * @returns { GridItemAttribute } the attribute of the gridItem.
174   * @syscap SystemCapability.ArkUI.ArkUI.Full
175   * @crossplatform
176   * @since 10
177   */
178  selected(value: boolean): GridItemAttribute;
179
180  /**
181   * Called when the gridItem is selected.
182   *
183   * @param { function } event
184   * @returns { GridItemAttribute }
185   * @syscap SystemCapability.ArkUI.ArkUI.Full
186   * @since 8
187   */
188  /**
189   * Called when the gridItem is selected.
190   *
191   * @param { function } event
192   * @returns { GridItemAttribute }
193   * @syscap SystemCapability.ArkUI.ArkUI.Full
194   * @crossplatform
195   * @since 10
196   */
197  onSelect(event: (isSelected: boolean) => void): GridItemAttribute;
198}
199
200/**
201 * Defines GridItem Component.
202 *
203 * @syscap SystemCapability.ArkUI.ArkUI.Full
204 * @since 7
205 */
206/**
207 * Defines GridItem Component.
208 *
209 * @syscap SystemCapability.ArkUI.ArkUI.Full
210 * @crossplatform
211 * @since 10
212 */
213declare const GridItem: GridItemInterface
214
215/**
216 * Defines GridItem Component instance.
217 *
218 * @syscap SystemCapability.ArkUI.ArkUI.Full
219 * @since 7
220 */
221/**
222 * Defines GridItem Component instance.
223 *
224 * @syscap SystemCapability.ArkUI.ArkUI.Full
225 * @crossplatform
226 * @since 10
227 */
228declare const GridItemInstance: GridItemAttribute;
229