@ray-js/smart-ui/dist/@types/index-bar/index.d.ts

轻量、可靠的智能小程序 UI 组件库

/// <reference types="miniprogram-api-typings" />
import { SmartComponent, SmartEventHandler } from '../base';
export interface SmartIndexBarProps {
    /**
     * 索引字符列表
     *
     * @default [A,B,...Z]
     */
    indexList?: string[] | number[];
    /**
     * `z-index`层级
     *
     * @default 1
     */
    zIndex?: number;
    /**
     * 是否开启锚点自动吸顶
     *
     * @default true
     */
    sticky?: boolean;
    /**
     * 锚点自动吸顶时与顶部的距离
     *
     * @default 0
     */
    stickyOffsetTop?: number;
    /**
     * 索引字符高亮颜色
     *
     * @default '#07c160'
     */
    highlightColor?: string;
    /**
     * SideBar 是否可滚动定位
     *
     * @version 2.1.7
     * @default false
     */
    scrollable?: boolean;
}
/**
 * @deprecated
 */
export interface SmartIndexBarSelectEvent extends WechatMiniprogram.BaseEvent {
    /**
     * 索引字符
     */
    detail: string | number;
}
export interface SmartIndexBarEvents {
    /**
     * 选中字符时触发
     */
    onSelect?: SmartEventHandler<string | number>;
}
export type SmartIndexBar = SmartComponent<SmartIndexBarProps, SmartIndexBarEvents>;