@opensig/opendesign
Version:
<p align="center"><img src="../docs/public/opendesign-logo-light.png"/></p> <h1 align="center">opendesign</h1> <p align="center">一个 Vue 3 组件库</p> <p align="center"><b>皮肤可定制,使用 TypeScript</b></p>
177 lines (176 loc) • 4.25 kB
TypeScript
import { ComponentPublicInstance, ExtractPropTypes, PropType } from 'vue';
export type ScrollerDirection = 'x' | 'y';
export declare const ScrollerSizeTypes: readonly ["medium", "small"];
export type ScrollerSizeT = (typeof ScrollerSizeTypes)[number];
export declare const baseScrollarProps: {
/**
* 禁用横向滚动
*/
disabledX: {
type: BooleanConstructor;
required: boolean;
};
/**
* 禁用纵向滚动
*/
disabledY: {
type: BooleanConstructor;
};
/**
* 滚动条在停止滚动多长时间后隐藏, ms
*/
duration: {
type: NumberConstructor;
default: number;
};
/**
* 滚动条显示控制
* always:一直显示
* auto: 滚动中、滚动后hover滚动条、拖拽时显示
* hover: 滚动条hover时显示
* never: 不显示滚动条
*/
showType: {
type: PropType<"auto" | "always" | "hover" | "never">;
default: string;
};
/**
* 滚动条尺寸大小
*/
size: {
type: PropType<ScrollerSizeT>;
default: string;
};
/**
* showType=always时,是否根据滚动容器滚动高度变化自动刷新滚动条
*/
autoUpdateOnScrollSize: {
type: BooleanConstructor;
};
/**
* 滚动条尺寸大小
*/
barClass: {
type: StringConstructor;
};
};
export type BaseScrollerPropsT = ExtractPropTypes<typeof baseScrollarProps>;
export declare const scrollerProps: {
/**
* 滚动容器类
*/
wrapClass: {
type: PropType<string | any[] | object>;
};
/**
* 禁用横向滚动
*/
disabledX: {
type: BooleanConstructor;
required: boolean;
};
/**
* 禁用纵向滚动
*/
disabledY: {
type: BooleanConstructor;
};
/**
* 滚动条在停止滚动多长时间后隐藏, ms
*/
duration: {
type: NumberConstructor;
default: number;
};
/**
* 滚动条显示控制
* always:一直显示
* auto: 滚动中、滚动后hover滚动条、拖拽时显示
* hover: 滚动条hover时显示
* never: 不显示滚动条
*/
showType: {
type: PropType<"auto" | "always" | "hover" | "never">;
default: string;
};
/**
* 滚动条尺寸大小
*/
size: {
type: PropType<ScrollerSizeT>;
default: string;
};
/**
* showType=always时,是否根据滚动容器滚动高度变化自动刷新滚动条
*/
autoUpdateOnScrollSize: {
type: BooleanConstructor;
};
/**
* 滚动条尺寸大小
*/
barClass: {
type: StringConstructor;
};
};
export type ScrollerPropsT = ExtractPropTypes<typeof scrollerProps>;
export declare const scrollbarProps: {
/**
* 滚动关联目标容器,支持body、元素ref、HTMLElement
*/
target: {
type: PropType<HTMLElement | ComponentPublicInstance | string | null>;
default: null;
};
/**
* 禁用横向滚动
*/
disabledX: {
type: BooleanConstructor;
required: boolean;
};
/**
* 禁用纵向滚动
*/
disabledY: {
type: BooleanConstructor;
};
/**
* 滚动条在停止滚动多长时间后隐藏, ms
*/
duration: {
type: NumberConstructor;
default: number;
};
/**
* 滚动条显示控制
* always:一直显示
* auto: 滚动中、滚动后hover滚动条、拖拽时显示
* hover: 滚动条hover时显示
* never: 不显示滚动条
*/
showType: {
type: PropType<"auto" | "always" | "hover" | "never">;
default: string;
};
/**
* 滚动条尺寸大小
*/
size: {
type: PropType<ScrollerSizeT>;
default: string;
};
/**
* showType=always时,是否根据滚动容器滚动高度变化自动刷新滚动条
*/
autoUpdateOnScrollSize: {
type: BooleanConstructor;
};
/**
* 滚动条尺寸大小
*/
barClass: {
type: StringConstructor;
};
};
export type ScrollbarPropsT = ExtractPropTypes<typeof scrollbarProps>;