lark-cms/dist/packages/components/YhwCarousel.rn.d.ts

Multi terminal CMS component library

import React from "react";
interface ComponentProps {
    /**
     * 是否启用手势，默认true，如果为false，旋转木马将不会对任何手势做出响应
     */
    enabled?: boolean;
    /**
     * 如果为true，则垂直翻滚，否则水平翻滚（默认false）
     */
    vertical?: boolean;
    /**
     * 轮播切换时自动播放，默认true
     */
    autoPlay?: boolean;
    /**
     * 轮播是否循环，默认true
     */
    autoplayLoop?: boolean;
    /**
     * 是否启用分页，默认true
     */
    pagingEnabled?: boolean;
    /**
     * 如果启用，释放触摸将滚动到最近的项目(当pagingEnabled=false时有效)，默认true
     */
    snapEnabled?: boolean;
    /**
     * 轮播宽度，默认430
     */
    width?: number;
    /**
     * 轮播高度，默认258
     */
    height?: number;
    /**
     * 自动播放的时间间隔，默认3500毫秒
     */
    time?: number;
    /**
     * 可以响应平移手势事件的最大项目数（来控制渲染当前元素的项数），0表示所有项目都将响应平移手势活动。默认0 全部渲染
     */
    windowSize?: number;
    /**
     * 是否显示分页标记，默认true
     */
    showPagination?: boolean;
    /**
     * 轮播数据源
     * 支持多种格式：[{img: ''}, {source: ''}] 或者 ['', '', '']
     */
    dataList: any[];
    /**
     * 轮播图模式，默认parallax（视差（左右有小部分上下页展示））、horizontal-stack （默认横向翻滚）、vertical-stack
     */
    mode?: "parallax" | "horizontal-stack" | "vertical-stack";
    /**
     * 自定义轮播图渲染项 （itemRender: (index: number; item: any) => <View />）
     * 如果不传入，则使用默认的轮播图渲染项
     * @param {number} index - 当前轮播图的索引
     * @param {any} item - 当前轮播图的数据项
     * @returns {JSX.Element} - 返回一个React元素
     */
    onItemRender?: any;
    /**
     * 点击每个轮播项时触发的事件回调 (index) => void
     * @param {number} index - 当前轮播图的索引
     */
    onItemClick?: any;
}
/**
 * 焦点图组件（Support for both iOS & Android & Web）
 */
declare const YhwCarouselRN: ({ enabled, vertical, autoPlay, autoplayLoop, pagingEnabled, snapEnabled, width, height, time, windowSize, showPagination, dataList, mode, onItemRender, onItemClick }: ComponentProps) => React.JSX.Element;
export default YhwCarouselRN;