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