@v-c/virtual-list 0.0.1 → 1.0.0

package/dist/List.d.ts

@@ -1,14 +1,16 @@
-import { Key } from '../../util/src/type';
-import { ExtraRenderInfo } from './interface';
-import { PropType, VNode } from 'vue';
+import { Key } from '@v-c/util/dist/type';
+import { CSSProperties, PropType, VNode } from 'vue';
 import { InnerProps } from './Filler';
+import { ExtraRenderInfo } from './interface';
+import { ScrollBarDirectionType } from './ScrollBar';
 export interface ScrollInfo {
     x: number;
     y: number;
 }
+export type ScrollTo = (arg?: number | ScrollConfig | null) => void;
 export interface ListRef {
     nativeElement?: HTMLDivElement;
-    scrollTo: (arg?: number | ScrollConfig) => void;
+    scrollTo: ScrollTo;
     getScrollInfo: () => ScrollInfo;
 }
 export interface ScrollPos {
@@ -22,18 +24,33 @@ export interface ScrollTarget {
     offset?: number;
 }
 export type ScrollConfig = ScrollTarget | ScrollPos;
-export interface ListProps<T = any> {
+export interface ListProps {
     prefixCls?: string;
-    data?: T[];
+    data?: any[];
     height?: number;
     itemHeight?: number;
     fullHeight?: boolean;
-    itemKey: Key | ((item: T) => Key);
+    itemKey: Key | ((item: any) => Key);
     component?: string;
     virtual?: boolean;
+    direction?: ScrollBarDirectionType;
+    /**
+     * By default `scrollWidth` is same as container.
+     * When set this, it will show the horizontal scrollbar and
+     * `scrollWidth` will be used as the real width instead of container width.
+     * When set, `virtual` will always be enabled.
+     */
+    scrollWidth?: number;
+    styles?: {
+        horizontalScrollBar?: CSSProperties;
+        horizontalScrollBarThumb?: CSSProperties;
+        verticalScrollBar?: CSSProperties;
+        verticalScrollBarThumb?: CSSProperties;
+    };
+    showScrollBar?: boolean | 'optional';
     onScroll?: (e: Event) => void;
     onVirtualScroll?: (info: ScrollInfo) => void;
-    onVisibleChange?: (visibleList: T[], fullList: T[]) => void;
+    onVisibleChange?: (visibleList: any[], fullList: any[]) => void;
     innerProps?: InnerProps;
     extraRender?: (info: ExtraRenderInfo) => VNode;
 }
@@ -59,6 +76,15 @@ declare const _default: import('vue').DefineComponent<import('vue').ExtractPropT
         type: StringConstructor;
         default: string;
     };
+    direction: {
+        type: PropType<ScrollBarDirectionType>;
+    };
+    scrollWidth: NumberConstructor;
+    styles: ObjectConstructor;
+    showScrollBar: {
+        type: PropType<boolean | "optional">;
+        default: string;
+    };
     virtual: {
         type: BooleanConstructor;
         default: boolean;
@@ -90,6 +116,15 @@ declare const _default: import('vue').DefineComponent<import('vue').ExtractPropT
         type: StringConstructor;
         default: string;
     };
+    direction: {
+        type: PropType<ScrollBarDirectionType>;
+    };
+    scrollWidth: NumberConstructor;
+    styles: ObjectConstructor;
+    showScrollBar: {
+        type: PropType<boolean | "optional">;
+        default: string;
+    };
     virtual: {
         type: BooleanConstructor;
         default: boolean;
@@ -101,8 +136,9 @@ declare const _default: import('vue').DefineComponent<import('vue').ExtractPropT
     extraRender: PropType<(info: ExtraRenderInfo) => VNode>;
 }>> & Readonly<{}>, {
     prefixCls: string;
-    component: string;
+    showScrollBar: boolean | "optional";
     fullHeight: boolean;
+    component: string;
     virtual: boolean;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
 export default _default;