• 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 * Provides a divider component to separate different content blocks/content elements.
18 *
19 * @interface DividerInterface
20 * @syscap SystemCapability.ArkUI.ArkUI.Full
21 * @since 7
22 */
23/**
24 * Provides a divider component to separate different content blocks/content elements.
25 *
26 * @interface DividerInterface
27 * @syscap SystemCapability.ArkUI.ArkUI.Full
28 * @since 9
29 * @form
30 */
31/**
32 * Provides a divider component to separate different content blocks/content elements.
33 *
34 * @interface DividerInterface
35 * @syscap SystemCapability.ArkUI.ArkUI.Full
36 * @crossplatform
37 * @since 10
38 * @form
39 */
40interface DividerInterface {
41  /**
42   * Return Divider.
43   *
44   * @returns { DividerAttribute }
45   * @syscap SystemCapability.ArkUI.ArkUI.Full
46   * @since 7
47   */
48  /**
49   * Return Divider.
50   *
51   * @returns { DividerAttribute }
52   * @syscap SystemCapability.ArkUI.ArkUI.Full
53   * @since 9
54   * @form
55   */
56  /**
57   * Return Divider.
58   *
59   * @returns { DividerAttribute }
60   * @syscap SystemCapability.ArkUI.ArkUI.Full
61   * @crossplatform
62   * @since 10
63   * @form
64   */
65  (): DividerAttribute;
66}
67
68/**
69 * Defines the Divider attribute functions.
70 *
71 * @extends CommonMethod
72 * @syscap SystemCapability.ArkUI.ArkUI.Full
73 * @since 7
74 */
75/**
76 * Defines the Divider attribute functions.
77 *
78 * @extends CommonMethod
79 * @syscap SystemCapability.ArkUI.ArkUI.Full
80 * @since 9
81 * @form
82 */
83/**
84 * Defines the Divider attribute functions.
85 *
86 * @extends CommonMethod
87 * @syscap SystemCapability.ArkUI.ArkUI.Full
88 * @crossplatform
89 * @since 10
90 * @form
91 */
92declare class DividerAttribute extends CommonMethod<DividerAttribute> {
93  /**
94   * Indicates whether to use a horizontal splitter or a vertical splitter.
95   * The options are as follows: false: horizontal splitter; true: vertical splitter.
96   *
97   * @param { boolean } value
98   * @returns { DividerAttribute }
99   * @syscap SystemCapability.ArkUI.ArkUI.Full
100   * @since 7
101   */
102  /**
103   * Indicates whether to use a horizontal splitter or a vertical splitter.
104   * The options are as follows: false: horizontal splitter; true: vertical splitter.
105   *
106   * @param { boolean } value
107   * @returns { DividerAttribute }
108   * @syscap SystemCapability.ArkUI.ArkUI.Full
109   * @since 9
110   * @form
111   */
112  /**
113   * Indicates whether to use a horizontal splitter or a vertical splitter.
114   * The options are as follows: false: horizontal splitter; true: vertical splitter.
115   *
116   * @param { boolean } value
117   * @returns { DividerAttribute }
118   * @syscap SystemCapability.ArkUI.ArkUI.Full
119   * @crossplatform
120   * @since 10
121   * @form
122   */
123  vertical(value: boolean): DividerAttribute;
124
125  /**
126   * Sets the color of the divider line.
127   *
128   * @param { ResourceColor } value
129   * @returns { DividerAttribute }
130   * @syscap SystemCapability.ArkUI.ArkUI.Full
131   * @since 7
132   */
133  /**
134   * Sets the color of the divider line.
135   *
136   * @param { ResourceColor } value
137   * @returns { DividerAttribute }
138   * @syscap SystemCapability.ArkUI.ArkUI.Full
139   * @since 9
140   * @form
141   */
142  /**
143   * Sets the color of the divider line.
144   *
145   * @param { ResourceColor } value
146   * @returns { DividerAttribute }
147   * @syscap SystemCapability.ArkUI.ArkUI.Full
148   * @crossplatform
149   * @since 10
150   * @form
151   */
152  color(value: ResourceColor): DividerAttribute;
153
154  /**
155   * Sets the width of the dividing line.
156   *
157   * @param { number | string } value
158   * @returns { DividerAttribute }
159   * @syscap SystemCapability.ArkUI.ArkUI.Full
160   * @since 7
161   */
162  /**
163   * Sets the width of the dividing line.
164   *
165   * @param { number | string } value
166   * @returns { DividerAttribute }
167   * @syscap SystemCapability.ArkUI.ArkUI.Full
168   * @since 9
169   * @form
170   */
171  /**
172   * Sets the width of the dividing line.
173   *
174   * @param { number | string } value
175   * @returns { DividerAttribute }
176   * @syscap SystemCapability.ArkUI.ArkUI.Full
177   * @crossplatform
178   * @since 10
179   * @form
180   */
181  strokeWidth(value: number | string): DividerAttribute;
182
183  /**
184   * Sets the end style of the split line. The default value is Butt.
185   *
186   * @param { LineCapStyle } value
187   * @returns { DividerAttribute }
188   * @syscap SystemCapability.ArkUI.ArkUI.Full
189   * @since 7
190   */
191  /**
192   * Sets the end style of the split line. The default value is Butt.
193   *
194   * @param { LineCapStyle } value
195   * @returns { DividerAttribute }
196   * @syscap SystemCapability.ArkUI.ArkUI.Full
197   * @since 9
198   * @form
199   */
200  /**
201   * Sets the end style of the split line. The default value is Butt.
202   *
203   * @param { LineCapStyle } value
204   * @returns { DividerAttribute }
205   * @syscap SystemCapability.ArkUI.ArkUI.Full
206   * @crossplatform
207   * @since 10
208   * @form
209   */
210  lineCap(value: LineCapStyle): DividerAttribute;
211}
212
213/**
214 * Defines Divider Component.
215 *
216 * @syscap SystemCapability.ArkUI.ArkUI.Full
217 * @since 7
218 */
219/**
220 * Defines Divider Component.
221 *
222 * @syscap SystemCapability.ArkUI.ArkUI.Full
223 * @since 9
224 * @form
225 */
226/**
227 * Defines Divider Component.
228 *
229 * @syscap SystemCapability.ArkUI.ArkUI.Full
230 * @crossplatform
231 * @since 10
232 * @form
233 */
234declare const Divider: DividerInterface;
235
236/**
237 * Defines Divider Component instance.
238 *
239 * @syscap SystemCapability.ArkUI.ArkUI.Full
240 * @since 7
241 */
242/**
243 * Defines Divider Component instance.
244 *
245 * @syscap SystemCapability.ArkUI.ArkUI.Full
246 * @since 9
247 * @form
248 */
249/**
250 * Defines Divider Component instance.
251 *
252 * @syscap SystemCapability.ArkUI.ArkUI.Full
253 * @crossplatform
254 * @since 10
255 * @form
256 */
257declare const DividerInstance: DividerAttribute;
258