!11230 提供单独导航点组件

Merge pull request !11230 from jiangzhijun8/master
This commit is contained in:
openharmony_ci 2024-09-30 07:01:28 +00:00 committed by Gitee
commit 8f720e0026
No known key found for this signature in database
GPG Key ID: 173E9B9CA92EEF8F
3 changed files with 231 additions and 0 deletions

View File

@ -112,6 +112,7 @@
/// <reference path="./stepper.d.ts" />
/// <reference path="./stepper_item.d.ts" />
/// <reference path="./swiper.d.ts" />
/// <reference path="./indicatorcomponent.d.ts" />
/// <reference path="./symbolglyph.d.ts" />
/// <reference path="./symbol_span.d.ts" />
/// <reference path="./tabs.d.ts" />

View File

@ -0,0 +1,217 @@
/*
* Copyright (c) 2024 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Provides methods for switching components.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 13
*/
declare class IndicatorComponentController {
/**
* constructor.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 13
*/
constructor();
/**
* Called when the next child component is displayed.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 13
*/
showNext():void;
/**
* Called when the previous subcomponent is displayed.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 13
*/
showPrevious():void;
/**
* Controlling IndicatorComponent to change to the specified subcomponent.
*
* @param { number } index - The index of item to be redirected.
* @param { boolean } [useAnimation] - If true, swipe to index item with animation. If false, swipe to index item without animation.
* The default value is false.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 13
*/
changeIndex(index: number, useAnimation?: boolean):void;
}
/**
* Provides an interface for indicator.
*
* @interface IndicatorComponentInterface
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 13
*/
interface IndicatorComponentInterface {
/**
* Called when a indicator is set.
*
* @param { IndicatorComponentController } controller - indicator component controller.
* @returns { IndicatorComponentAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 13
*/
(controller?: IndicatorComponentController): IndicatorComponentAttribute;
}
/**
* Defines the IndicatorComponent attribute functions.
*
* @extends CommonMethod<IndicatorComponentAttribute>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 13
*/
declare class IndicatorComponentAttribute extends CommonMethod<IndicatorComponentAttribute> {
/**
* Called when the index value of the displayed subcomponent is set in the container.
*
* @param { number } index
* @returns { IndicatorComponentAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 13
*/
initialIndex(index: number): IndicatorComponentAttribute;
/**
* Sets the total number of indicator.
*
* @param { number } totalCount
* @returns { IndicatorComponentAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 13
*/
count(totalCount: number): IndicatorComponentAttribute;
/**
* Sets the indicator style.
*
* @param { DotIndicator | DigitIndicator } indicatorStyle - the style value
* @returns { IndicatorComponentAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 13
*/
style(indicatorStyle: DotIndicator | DigitIndicator): IndicatorComponentAttribute;
/**
* Called when setting whether to turn on cyclic sliding.
*
* @param { boolean } isLoop
* @returns { IndicatorComponentAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 13
*/
loop(isLoop: boolean): IndicatorComponentAttribute;
/**
* Called when setting whether to slide vertically.
*
* @param { boolean } isVertical
* @returns { IndicatorComponentAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 13
*/
vertical(isVertical: boolean): IndicatorComponentAttribute;
/**
* Called when the index value changes.
*
* @param { Callback<number> } event
* @returns { IndicatorComponentAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 13
*/
onChange(event: Callback<number>): IndicatorComponentAttribute;
}
/**
* Defines IndicatorComponent.
*
* @constant
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 13
*/
declare const IndicatorComponent: IndicatorComponentInterface;
/**
* Defines IndicatorComponent instance.
*
* @constant
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 13
*/
declare const IndicatorComponentInstance: IndicatorComponentAttribute;

View File

@ -1368,6 +1368,19 @@ declare class SwiperAttribute extends CommonMethod<SwiperAttribute> {
* @since 11
*/
indicator(value: DotIndicator | DigitIndicator | boolean): SwiperAttribute;
/**
* Use indicator component controller.
*
* @param { IndicatorComponentController } controller - indicator component controller.
* @returns { SwiperAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 13
*/
indicator(controller: IndicatorComponentController): SwiperAttribute;
/**
* Set arrow is enabled, or set the arrow style.