• 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 * ItemState
18 *
19 * @enum { number }
20 * @syscap SystemCapability.ArkUI.ArkUI.Full
21 * @since 8
22 */
23/**
24 * ItemState
25 *
26 * @enum { number }
27 * @syscap SystemCapability.ArkUI.ArkUI.Full
28 * @crossplatform
29 * @since 10
30 */
31declare enum ItemState {
32  /**
33   * Default State
34   *
35   * @syscap SystemCapability.ArkUI.ArkUI.Full
36   * @since 8
37   */
38  /**
39   * Default State
40   *
41   * @syscap SystemCapability.ArkUI.ArkUI.Full
42   * @crossplatform
43   * @since 10
44   */
45  Normal,
46
47  /**
48   * Disabled State
49   *
50   * @syscap SystemCapability.ArkUI.ArkUI.Full
51   * @since 8
52   */
53  /**
54   * Disabled State
55   *
56   * @syscap SystemCapability.ArkUI.ArkUI.Full
57   * @crossplatform
58   * @since 10
59   */
60  Disabled,
61
62  /**
63   * Waiting State
64   *
65   * @syscap SystemCapability.ArkUI.ArkUI.Full
66   * @since 8
67   */
68  /**
69   * Waiting State
70   *
71   * @syscap SystemCapability.ArkUI.ArkUI.Full
72   * @crossplatform
73   * @since 10
74   */
75  Waiting,
76
77  /**
78   * Skip State
79   *
80   * @syscap SystemCapability.ArkUI.ArkUI.Full
81   * @since 8
82   */
83  /**
84   * Skip State
85   *
86   * @syscap SystemCapability.ArkUI.ArkUI.Full
87   * @crossplatform
88   * @since 10
89   */
90  Skip,
91}
92
93/**
94 * Provides an interface for switching the stepperItem view on stepper container.
95 *
96 * @interface StepperItemInterface
97 * @syscap SystemCapability.ArkUI.ArkUI.Full
98 * @since 8
99 */
100/**
101 * Provides an interface for switching the stepperItem view on stepper container.
102 *
103 * @interface StepperItemInterface
104 * @syscap SystemCapability.ArkUI.ArkUI.Full
105 * @crossplatform
106 * @since 10
107 */
108interface StepperItemInterface {
109  /**
110   * Called when the stepperItem component is used.
111   *
112   * @returns { StepperItemAttribute }
113   * @syscap SystemCapability.ArkUI.ArkUI.Full
114   * @since 8
115   */
116  /**
117   * Called when the stepperItem component is used.
118   *
119   * @returns { StepperItemAttribute }
120   * @syscap SystemCapability.ArkUI.ArkUI.Full
121   * @crossplatform
122   * @since 10
123   */
124  (): StepperItemAttribute;
125}
126
127/**
128 * Defines the stepper item attribute functions.
129 *
130 * @extends CommonMethod
131 * @syscap SystemCapability.ArkUI.ArkUI.Full
132 * @since 8
133 */
134/**
135 * Defines the stepper item attribute functions.
136 *
137 * @extends CommonMethod
138 * @syscap SystemCapability.ArkUI.ArkUI.Full
139 * @crossplatform
140 * @since 10
141 */
142declare class StepperItemAttribute extends CommonMethod<StepperItemAttribute> {
143  /**
144   * Called when the value of stepperItem prevLabel is set
145   *
146   * @param { string } value
147   * @returns { StepperItemAttribute }
148   * @syscap SystemCapability.ArkUI.ArkUI.Full
149   * @since 8
150   */
151  /**
152   * Called when the value of stepperItem prevLabel is set
153   *
154   * @param { string } value
155   * @returns { StepperItemAttribute }
156   * @syscap SystemCapability.ArkUI.ArkUI.Full
157   * @crossplatform
158   * @since 10
159   */
160  prevLabel(value: string): StepperItemAttribute;
161
162  /**
163   * Called when the value of stepperItem nextLabel is set
164   *
165   * @param { string } value
166   * @returns { StepperItemAttribute }
167   * @syscap SystemCapability.ArkUI.ArkUI.Full
168   * @since 8
169   */
170  /**
171   * Called when the value of stepperItem nextLabel is set
172   *
173   * @param { string } value
174   * @returns { StepperItemAttribute }
175   * @syscap SystemCapability.ArkUI.ArkUI.Full
176   * @crossplatform
177   * @since 10
178   */
179  nextLabel(value: string): StepperItemAttribute;
180
181  /**
182   * Called when the value of stepperItem status is set
183   *
184   * @param { ItemState } value
185   * @returns { StepperItemAttribute }
186   * @syscap SystemCapability.ArkUI.ArkUI.Full
187   * @since 8
188   */
189  /**
190   * Called when the value of stepperItem status is set
191   *
192   * @param { ItemState } value
193   * @returns { StepperItemAttribute }
194   * @syscap SystemCapability.ArkUI.ArkUI.Full
195   * @crossplatform
196   * @since 10
197   */
198  status(value?: ItemState): StepperItemAttribute;
199}
200
201/**
202 * Defines StepperItem Component instance.
203 *
204 * @syscap SystemCapability.ArkUI.ArkUI.Full
205 * @since 8
206 */
207/**
208 * Defines StepperItem Component instance.
209 *
210 * @syscap SystemCapability.ArkUI.ArkUI.Full
211 * @crossplatform
212 * @since 10
213 */
214declare const StepperItemInstance: StepperItemAttribute;
215
216/**
217 * Defines StepperItem Component.
218 *
219 * @syscap SystemCapability.ArkUI.ArkUI.Full
220 * @since 8
221 */
222/**
223 * Defines StepperItem Component.
224 *
225 * @syscap SystemCapability.ArkUI.ArkUI.Full
226 * @crossplatform
227 * @since 10
228 */
229declare const StepperItem: StepperItemInterface;
230