/* * Copyright (c) 2021-2023 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. */ /** * Provides methods for switching components. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 */ /** * Provides methods for switching components. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ declare class SwiperController { /** * constructor. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 */ /** * constructor. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ constructor(); /** * Called when the next child component is displayed. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 */ /** * Called when the next child component is displayed. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ showNext(); /** * Called when the previous subcomponent is displayed. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 */ /** * Called when the previous subcomponent is displayed. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ showPrevious(); /** * Called when need to stop the swiper animation. * * @param { function } callback * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 */ /** * Called when need to stop the swiper animation. * * @param { function } callback * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ finishAnimation(callback?: () => void); } /** * Defines the indicator class. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ declare class Indicator { /** * Set the indicator to the left. * * @param { Length } value - the indicator to the left. * @returns { T } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ left(value: Length): T; /** * Set the indicator to the top. * * @param { Length } value - the indicator to the top. * @returns { T } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ top(value: Length): T; /** * Set the indicator to the right. * * @param { Length } value - the indicator to the right. * @returns { T } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ right(value: Length): T; /** * Set the indicator to the bottom. * * @param { Length } value - the indicator to the bottom. * @returns { T } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ bottom(value: Length): T; /** * DotIndicator class object. * * @returns { DotIndicator } * @static * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ static dot(): DotIndicator; /** * DigitIndicator class object. * * @returns { DigitIndicator } * @static * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ static digit(): DigitIndicator; } /** * Define DotIndicator, the indicator type is dot. * * @extends Indicator * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ declare class DotIndicator extends Indicator { /** * Constructor. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ constructor(); /** * Set the indicator item width. * * @param { Length } value - the indicator item width. * @returns { DotIndicator } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ itemWidth(value: Length): DotIndicator; /** * Set the indicator item height. * * @param { Length } value - the indicator item height. * @returns { DotIndicator } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ itemHeight(value: Length): DotIndicator; /** * Set the indicator item width when selected. * * @param { Length } value - the indicator item width when selected. * @returns { DotIndicator } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ selectedItemWidth(value: Length): DotIndicator; /** * Set the indicator item height when selected. * * @param { Length } value - the indicator item height when selected. * @returns { DotIndicator } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ selectedItemHeight(value: Length): DotIndicator; /** * Setting indicator style mask. * * @param { boolean } value - the indicator item mask. * @returns { DotIndicator } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ mask(value: boolean): DotIndicator; /** * Set the indicator color. * * @param { ResourceColor } value - the indicator item color. * @returns { DotIndicator } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ color(value: ResourceColor): DotIndicator; /** * Set the navigation point color. * * @param { ResourceColor } value - the indicator item when selected. * @returns { DotIndicator } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ selectedColor(value: ResourceColor): DotIndicator; } /** * Set Swiper column count adaptation. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 10 * @form */ declare type SwiperAutoFill = { /** * Set minSize size. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 10 * @form */ minSize: VP; }; /** * Define DigitIndicator, the indicator type is digit. * * @extends Indicator * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ declare class DigitIndicator extends Indicator { /** * Constructor. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ constructor(); /** * Set font color of the digital indicator. * * @param { ResourceColor } value - the indicator font color. * @returns { DigitIndicator } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ fontColor(value: ResourceColor): DigitIndicator; /** * Set font color of the digital indicator when selected. * * @param { ResourceColor } value - the indicator font color when selected. * @returns { DigitIndicator } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ selectedFontColor(value: ResourceColor): DigitIndicator; /** * Set the digital indicator font (just support font size and weight). * * @param { Font } value - the indicator font size and weight. * @returns { DigitIndicator } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ digitFont(value: Font): DigitIndicator; /** * Set the digital indicator font (just support font size and weight). * * @param { Font } value - the indicator font size and weight when selected. * @returns { DigitIndicator } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ selectedDigitFont(value: Font): DigitIndicator; } /** * Arrow object. * * @interface ArrowStyle * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 10 */ declare interface ArrowStyle { /** * Is show the arrow background or not. * * @type { ?boolean } * @default false * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 10 */ showBackground?: boolean; /** * When the indicator show, set the arrow position is side of the indicator or in the middle of content area. * The arrow is displayed on side of the indicator, if the value is false. * * @type { ?boolean } * @default false * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 10 */ isSidebarMiddle?: boolean; /** * The arrow background size. * The size of the arrow is three-quarters of the background size, when the background is displayed. * * @type { ?Length } * @default 24vp * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 10 */ backgroundSize?: Length; /** * The arrow background background color. * * @type { ?ResourceColor } * @default #19182431 * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 10 */ backgroundColor?: ResourceColor; /** * The arrow size. * The arrow size can be set, when the background is not displayed. * The size of the arrow is three-quarters of the background size, when the background is displayed. * * @type { ?Length } * @default 18vp * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 10 */ arrowSize?: Length; /** * The arrow color. * * @type { ?ResourceColor } * @default #182431 * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 10 */ arrowColor?: ResourceColor; } /** * Declare the size of the swiper on the spindle. * * @enum { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 */ /** * Declare the size of the swiper on the spindle. * * @enum { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ declare enum SwiperDisplayMode { /** * Carousel map extension. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 * @deprecated since 10 * @useinstead SwiperDisplayMode#STRETCH * @form */ Stretch, /** * The rotation chart is self linear. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 * @deprecated since 10 * @useinstead SwiperDisplayMode#AUTO_LINEAR * @form */ AutoLinear, /** * Carousel map extension. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ STRETCH, /** * The rotation chart is self linear. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ AUTO_LINEAR, } /** * Provides an interface for sliding containers. * * @interface SwiperInterface * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 */ /** * Provides an interface for sliding containers. * * @interface SwiperInterface * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ interface SwiperInterface { /** * Called when a sliding container is set. * * @param { SwiperController } controller * @returns { SwiperAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 */ /** * Called when a sliding container is set. * * @param { SwiperController } controller * @returns { SwiperAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ (controller?: SwiperController): SwiperAttribute; } /** * Setting indicator style navigation. * * @interface IndicatorStyle * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 8 * @deprecated since 10 */ declare interface IndicatorStyle { /** * Set the indicator to the left. * * @type { ?Length } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 8 * @deprecated since 10 */ left?: Length; /** * Set the indicator to the top. * * @type { ?Length } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 8 * @deprecated since 10 */ top?: Length; /** * Set the indicator to the right. * * @type { ?Length } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 8 * @deprecated since 10 */ right?: Length; /** * Set the indicator to the bottom. * * @type { ?Length } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 8 * @deprecated since 10 */ bottom?: Length; /** * Set the indicator size. * * @type { ?Length } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 8 * @deprecated since 10 */ size?: Length; /** * Setting indicator style mask. * * @type { ?boolean } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 8 * @deprecated since 10 */ mask?: boolean; /** * Set the indicator color. * * @type { ?ResourceColor } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 8 * @deprecated since 10 */ color?: ResourceColor; /** * Set the navigation point color. * * @type { ?ResourceColor } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 8 * @deprecated since 10 */ selectedColor?: ResourceColor; } /** * Provides an interface for swiper animation. * * @interface SwiperAnimationEvent * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 */ declare interface SwiperAnimationEvent { /** * Offset of the current page to the start position of the swiper main axis. The unit is vp. * * @type { number } * @default 0.0 vp * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 10 */ currentOffset: number; /** * Offset of the target page to the start position of the swiper main axis. The unit is vp. * * @type { number } * @default 0.0 vp * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 10 */ targetOffset: number; /** * Start speed of the page-turning animation. The unit is vp/s. * * @type { number } * @default 0.0 vp/s * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 10 */ velocity: number; } /** * Defines the swiper attribute functions. * * @extends CommonMethod * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 */ /** * Defines the swiper attribute functions. * * @extends CommonMethod * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ declare class SwiperAttribute extends CommonMethod { /** * Called when the index value of the displayed subcomponent is set in the container. * * @param { number } value * @returns { SwiperAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 */ /** * Called when the index value of the displayed subcomponent is set in the container. * * @param { number } value * @returns { SwiperAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ index(value: number): SwiperAttribute; /** * Called when setting whether the subcomponent plays automatically. * * @param { boolean } value * @returns { SwiperAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 */ /** * Called when setting whether the subcomponent plays automatically. * * @param { boolean } value * @returns { SwiperAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ autoPlay(value: boolean): SwiperAttribute; /** * Called when the time interval for automatic playback is set. * * @param { number } value * @returns { SwiperAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 */ /** * Called when the time interval for automatic playback is set. * * @param { number } value * @returns { SwiperAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ interval(value: number): SwiperAttribute; /** * Called when you set whether the navigation point indicator is enabled. * * @param { DotIndicator | DigitIndicator | boolean } value - show indicator of the swiper indicator. * @returns { SwiperAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 */ /** * Set indicator is enabled, or set type style. * * @param { DotIndicator | DigitIndicator | boolean } value - the style value or show indicator of the swiper indicator. * @returns { SwiperAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ indicator(value: DotIndicator | DigitIndicator | boolean): SwiperAttribute; /** * Set arrow is enabled, or set the arrow style. * * @param { ArrowStyle | boolean } value - arrow is displayed or set the arrow style. * @param { boolean } isHoverShow - arrow is display when mouse hover in indicator hotspot. * @returns { SwiperAttribute } return the component attribute. * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 10 */ displayArrow(value: ArrowStyle | boolean, isHoverShow?: boolean): SwiperAttribute; /** * Called when setting whether to turn on cyclic sliding. * * @param { boolean } value * @returns { SwiperAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 */ /** * Called when setting whether to turn on cyclic sliding. * * @param { boolean } value * @returns { SwiperAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ loop(value: boolean): SwiperAttribute; /** * Called when the animation duration of the switch is set. * * @param { number } value * @returns { SwiperAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 */ /** * Called when the animation duration of the switch is set. * * @param { number } value * @returns { SwiperAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 */ duration(value: number): SwiperAttribute; /** * Called when setting whether to slide vertically. * * @param { boolean } value * @returns { SwiperAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 */ /** * Called when setting whether to slide vertically. * * @param { boolean } value * @returns { SwiperAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ vertical(value: boolean): SwiperAttribute; /** * Called when the size of the rotation chart is set. * * @param { number | string } value * @returns { SwiperAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 */ /** * Called when the size of the rotation chart is set. * * @param { number | string } value * @returns { SwiperAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ itemSpace(value: number | string): SwiperAttribute; /** * Called when setting the size of the swiper container on the spindle. * * @param { SwiperDisplayMode } value * @returns { SwiperAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 */ /** * Called when setting the size of the swiper container on the spindle. * * @param { SwiperDisplayMode } value * @returns { SwiperAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ displayMode(value: SwiperDisplayMode): SwiperAttribute; /** * Called when setting the cached count of the swiper container one side. * * @param { number } value * @returns { SwiperAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 8 */ /** * Called when setting the cached count of the swiper container one side. * * @param { number } value * @returns { SwiperAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ cachedCount(value: number): SwiperAttribute; /** * This command is invoked when the number of subcomponents is set. * * @param { number | string | SwiperAutoFill } value * @returns { SwiperAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 8 */ /** * This command is invoked when the number of subcomponents is set. * * @param { number | string | SwiperAutoFill } value * @returns { SwiperAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ displayCount(value: number | string | SwiperAutoFill): SwiperAttribute; /** * Invoked when setting the sliding effect * * @param { EdgeEffect } value * @returns { SwiperAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 8 */ /** * Invoked when setting the sliding effect * * @param { EdgeEffect } value * @returns { SwiperAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ effectMode(value: EdgeEffect): SwiperAttribute; /** * Called when sliding is disableSwipe * * @param { boolean } value * @returns { SwiperAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 8 */ /** * Called when sliding is disableSwipe * * @param { boolean } value * @returns { SwiperAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ disableSwipe(value: boolean): SwiperAttribute; /** * Called when sliding is curve * * @param { Curve | string | ICurve } value * @returns { SwiperAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 8 */ /** * Called when sliding is curve * Curve is an enumeration type for common curves * ICurve is a curve object * * @param { Curve | string | ICurve } value * @returns { SwiperAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ curve(value: Curve | string | ICurve): SwiperAttribute; /** * Called when the index value changes. * * @param { function } event * @returns { SwiperAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 */ /** * Called when the index value changes. * * @param { function } event * @returns { SwiperAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ onChange(event: (index: number) => void): SwiperAttribute; /** * Setting indicator style navigation. * * @param { IndicatorStyle } value * @returns { SwiperAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 8 * @deprecated since 10 */ indicatorStyle(value?: IndicatorStyle): SwiperAttribute; /** * The previous margin which can be used to expose a small portion of the previous item. * * @param { Length } value - The length of previous margin. * @returns { SwiperAttribute } The attribute of the swiper. * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 10 */ prevMargin(value: Length): SwiperAttribute; /** * The next margin which can be used to expose a small portion of the latter item. * * @param { Length } value - The length of next margin. * @returns { SwiperAttribute } The attribute of the swiper. * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 10 */ nextMargin(value: Length): SwiperAttribute; /** * Called when the swiper animation start. * * @param { function } event - the index value of the swiper page that when animation start. * @returns { SwiperAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 9 */ /** * Called when the swiper animation start. * * @param { function } event * "index": the index value of the swiper page that when animation start. * "targetIndex": the target index value of the swiper page that when animation start. * "extraInfo": the extra callback info. * @returns { SwiperAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ onAnimationStart(event: (index: number, targetIndex: number, extraInfo: SwiperAnimationEvent) => void): SwiperAttribute; /** * Called when the swiper animation end. * * @param { function } event - the index value of the swiper page that when animation end. * @returns { SwiperAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 9 */ /** * Called when the swiper animation end. * * @param { function } event * "index": the index value of the swiper page that when animation end. * "extraInfo": the extra callback info. * @returns { SwiperAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ onAnimationEnd(event: (index: number, extraInfo: SwiperAnimationEvent) => void): SwiperAttribute; /** * Called when the swiper swipe with the gesture. * * @param { function } event * "index": the index value of the swiper page before gesture swipe. * "extraInfo": the extra callback info. * @returns { SwiperAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 */ onGestureSwipe(event: (index: number, extraInfo: SwiperAnimationEvent) => void): SwiperAttribute; } /** * Defines Swiper Component. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 */ /** * Defines Swiper Component. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ declare const Swiper: SwiperInterface; /** * Defines Swiper Component instance. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 */ /** * Defines Swiper Component instance. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 * @form */ declare const SwiperInstance: SwiperAttribute;