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