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