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