• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2 * Copyright (c) 2024 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 * Defines the arc scroll bar options.
23 *
24 * @interface ArcScrollBarOptions
25 * @syscap SystemCapability.ArkUI.ArkUI.Circle
26 * @crossplatform
27 * @atomicservice
28 * @since 18
29 */
30declare interface ArcScrollBarOptions {
31  /**
32   * Describes the controller for scrollable container.
33   *
34   * @type { ?Scroller }
35   * @syscap SystemCapability.ArkUI.ArkUI.Circle
36   * @crossplatform
37   * @atomicservice
38   * @since 18
39   */
40  scroller: Scroller;
41
42  /**
43   * Sets the state of scroll bar.
44   *
45   * @type { ?BarState }
46   * @syscap SystemCapability.ArkUI.ArkUI.Circle
47   * @crossplatform
48   * @atomicservice
49   * @since 18
50   */
51  state?: BarState;
52}
53
54/**
55 * Defines the arc scroll bar component.
56 *
57 * @interface ArcScrollBarInterface
58 * @syscap SystemCapability.ArkUI.ArkUI.Circle
59 * @crossplatform
60 * @atomicservice
61 * @since 18
62 */
63export interface ArcScrollBarInterface {
64  /**
65   * Creates the arc scroll bar component.
66   *
67   * @param { ArcScrollBarOptions } options
68   * @returns { ArcScrollBarAttribute }
69   * @syscap SystemCapability.ArkUI.ArkUI.Circle
70   * @crossplatform
71   * @atomicservice
72   * @since 18
73   */
74  (options: ArcScrollBarOptions): ArcScrollBarAttribute;
75}
76
77/**
78 * Defines the arc scroll bar attribute functions.
79 *
80 * @extends CommonMethod<ArcScrollBarAttribute>
81 * @syscap SystemCapability.ArkUI.ArkUI.Circle
82 * @crossplatform
83 * @atomicservice
84 * @since 18
85 */
86export declare class ArcScrollBarAttribute extends CommonMethod<ArcScrollBarAttribute> {
87}
88
89/**
90 * Defines ArcScrollBar Component instance.
91 *
92 * @syscap SystemCapability.ArkUI.ArkUI.Circle
93 * @crossplatform
94 * @atomicservice
95 * @since 18
96 */
97export declare const ArcScrollBarInstance: ArcScrollBarAttribute;
98
99/**
100 * Defines ArcScrollBar Component.
101 *
102 * @syscap SystemCapability.ArkUI.ArkUI.Circle
103 * @crossplatform
104 * @atomicservice
105 * @uicomponent
106 * @since 18
107 */
108export declare const ArcScrollBar: ArcScrollBarInterface;
109