@ray-js/smart-ui-typings
Version:
@ray-js/smart-ui 智能小程序 UI 框架的类型声明文件
37 lines (36 loc) • 900 B
TypeScript
import { VantComponent, VantEventHandler } from '../base';
export interface VantStickyProps {
/**
* 吸顶时与顶部的距离,单位`px`
*
* @default 0
*/
offsetTop?: number;
/**
* 吸顶时的`zIndex`
*
* @default 99
*/
zIndex?: number;
/**
* 一个函数,返回容器对应的 `NodesRef` 节点
*/
container?: Function;
/**
* 当前滚动区域的滚动位置,非 `null` 时会禁用页面滚动事件的监听
*/
scrollTop?: number;
}
export interface VantStickyScrollEventDetail {
/** 距离顶部位置 */
scrollTop: number;
/** 是否吸顶 */
isFixed: boolean;
}
export interface VantStickyEvents {
/**
* 滚动时触发
*/
onScroll?: VantEventHandler<VantStickyScrollEventDetail>;
}
export type VantSticky = VantComponent<VantStickyProps, VantStickyEvents>;