snail.vue 2.0.19 → 2.0.20

package/dist/snail.vue.d.ts

@@ -1,7 +1,7 @@
 import * as snail_core from 'snail.core';
 import { DateFormat, DateValue, TimeValue, IScope, RunResult, IAsyncScope } from 'snail.core';
 import * as snail_view from 'snail.view';
-import { ScrollbarOptions, BaseStyle, HeightStyle, FlexBoxStyle, WidthStyle, BorderStyle, PaddingStyle, MarginStyle } from 'snail.view';
+import { ScrollbarOptions, ScrollStatus, BaseStyle, HeightStyle, FlexBoxStyle, WidthStyle, BorderStyle, PaddingStyle, MarginStyle } from 'snail.view';
 import * as vue from 'vue';
 import { Component, ShallowRef, Ref, WatchSource, App } from 'vue';
 
@@ -381,6 +381,29 @@ type FooterEvents = {
  * 滚动视图配置选项
  */
 type ScrollOptions = ScrollbarOptions & {};
+/**
+ * 滚动视图对外暴露方法
+ */
+type ScrollExpose = {
+    /**
+     * 获取滚动状态信息
+     * @returns
+     */
+    getStatus(): ScrollStatus;
+    /**
+     * 进行滚动操作
+     * - 在当前的滚动条位置基础上，滚动指定单位
+     * @param left 水平滚动单位；null、undefined 表示水平不滚动；小于0向左滚动；大于0向右滚动
+     * @param top 垂直滚动单位；null、undefined 表示垂直不滚动；小于0向上滚动；大于0向下滚动
+     */
+    scroll(left?: number, top?: number): void;
+    /**
+     * 滚动到指定位置
+     * @param left 水平滚动条位置；null、undefined 表示水平不滚动
+     * @param top 垂直滚动条位置；null、undefined 表示垂直不滚动
+     */
+    scrollTo(left?: number, top?: number): void;
+};
 /**
  * 滚动视图事件
  */
@@ -412,44 +435,6 @@ type ScrollEvents = {
      */
     bottom: [];
 };
-/**
- * 滚动视图状态
- * - 缓存起来 和下次滚动做比对，触发对应事件
- */
-type ScrollStatus = {
-    /**
-     * 水平滚动条是否显示
-     */
-    xbar: boolean;
-    /**
-     * 垂直滚动条是否显示
-     */
-    ybar: boolean;
-    /**
-     * 滚动到【左侧】了
-     */
-    left: boolean;
-    /**
-     * 滚动到【右侧】了
-     */
-    right: boolean;
-    /**
-     * 滚动到【顶部】了
-     */
-    top: boolean;
-    /**
-     * 滚动到【底部】了
-     */
-    bottom: boolean;
-    /**
-     * 滚动视图宽度
-     */
-    scrollwidth: number;
-    /**
-     * 滚动视图高度
-     */
-    scrollheight: number;
-};
 
 /**
  * 包裹组件 相关实体
@@ -1305,7 +1290,7 @@ type ElasticOptions = ScrollOptions & {
 /**
  * 弹性容器组件 事件监听
  */
-type ElasticEvents = {
+type ElasticEvents = ScrollEvents & {
     /**
      * 刷新数据
      * - 配合 `downRefresh`实现下拉刷新功能
@@ -1320,42 +1305,21 @@ type ElasticEvents = {
     more: [resolve: () => void];
 };
 /**
- * 弹性组件的滚动状态信息
- * - 缓存滚动状态 和下次做比对，触发对应事件
+ * 弹性组件 对外暴露属性接口
  */
-type ElasticScrollStatus = {
-    /**
-     * 水平滚动条是否显示
-     */
-    xbar: boolean;
-    /**
-     * 垂直滚动条是否显示
-     */
-    ybar: boolean;
-    /**
-     * 滚动到【左侧】了
-     */
-    left: boolean;
-    /**
-     * 滚动到【右侧】了
-     */
-    right: boolean;
-    /**
-     * 滚动到【顶部】了
-     */
-    top: boolean;
-    /**
-     * 滚动到【底部】了
-     */
-    bottom: boolean;
+type ElasticExpose = {
     /**
-     * 滚动视图宽度
+     * 加载刷新数据
+     * - 触发下拉刷新数据
+     * @returns 异步任务对象，外部感知任务执行完成
      */
-    scrollwidth: number;
+    loadRefresh(): Promise<void>;
     /**
-     * 滚动视图高度
+     * 加载更多数据
+     * - 触发上拉加载更多数据
+     * @returns 异步任务对象，外部感知任务执行完成
      */
-    scrollheight: number;
+    loadMore(): Promise<void>;
 };
 /**
  * 弹性组件的弹簧状态信息
@@ -2999,9 +2963,24 @@ declare const components: {
     });
     Elastic: {
         new (...args: any[]): vue.CreateComponentPublicInstanceWithMixins<Readonly<ElasticOptions> & Readonly<{
+            onLeft?: () => any;
+            onRight?: () => any;
+            onTop?: () => any;
+            onBottom?: () => any;
+            onXbar?: (show: boolean) => any;
+            onYbar?: (show: boolean) => any;
             onRefresh?: (resolve: () => void) => any;
             onMore?: (resolve: () => void) => any;
-        }>, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
+        }>, {
+            loadRefresh(): Promise<void>;
+            loadMore(): Promise<void>;
+        }, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
+            left: () => any;
+            right: () => any;
+            top: () => any;
+            bottom: () => any;
+            xbar: (show: boolean) => any;
+            ybar: (show: boolean) => any;
             refresh: (resolve: () => void) => any;
             more: (resolve: () => void) => any;
         }, vue.PublicProps, {}, false, {}, {}, vue.GlobalComponents, vue.GlobalDirectives, string, {}, any, vue.ComponentProvideOptions, {
@@ -3012,16 +2991,40 @@ declare const components: {
             M: {};
             Defaults: {};
         }, Readonly<ElasticOptions> & Readonly<{
+            onLeft?: () => any;
+            onRight?: () => any;
+            onTop?: () => any;
+            onBottom?: () => any;
+            onXbar?: (show: boolean) => any;
+            onYbar?: (show: boolean) => any;
             onRefresh?: (resolve: () => void) => any;
             onMore?: (resolve: () => void) => any;
-        }>, {}, {}, {}, {}, {}>;
+        }>, {
+            loadRefresh(): Promise<void>;
+            loadMore(): Promise<void>;
+        }, {}, {}, {}, {}>;
         __isFragment?: never;
         __isTeleport?: never;
         __isSuspense?: never;
     } & vue.ComponentOptionsBase<Readonly<ElasticOptions> & Readonly<{
+        onLeft?: () => any;
+        onRight?: () => any;
+        onTop?: () => any;
+        onBottom?: () => any;
+        onXbar?: (show: boolean) => any;
+        onYbar?: (show: boolean) => any;
         onRefresh?: (resolve: () => void) => any;
         onMore?: (resolve: () => void) => any;
-    }>, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
+    }>, {
+        loadRefresh(): Promise<void>;
+        loadMore(): Promise<void>;
+    }, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
+        left: () => any;
+        right: () => any;
+        top: () => any;
+        bottom: () => any;
+        xbar: (show: boolean) => any;
+        ybar: (show: boolean) => any;
         refresh: (resolve: () => void) => any;
         more: (resolve: () => void) => any;
     }, string, {}, {}, string, {}, vue.GlobalComponents, vue.GlobalDirectives, string, vue.ComponentProvideOptions> & vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps & (new () => {
@@ -3137,8 +3140,9 @@ declare const components: {
             onXbar?: (show: boolean) => any;
             onYbar?: (show: boolean) => any;
         }>, {
-            scroll: (left?: number, top?: number) => void;
-            scrollTo: (left?: number, top?: number) => void;
+            getStatus(): snail_view.ScrollStatus;
+            scroll(left?: number, top?: number): void;
+            scrollTo(left?: number, top?: number): void;
         }, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
             left: () => any;
             right: () => any;
@@ -3161,8 +3165,9 @@ declare const components: {
             onXbar?: (show: boolean) => any;
             onYbar?: (show: boolean) => any;
         }>, {
-            scroll: (left?: number, top?: number) => void;
-            scrollTo: (left?: number, top?: number) => void;
+            getStatus(): snail_view.ScrollStatus;
+            scroll(left?: number, top?: number): void;
+            scrollTo(left?: number, top?: number): void;
         }, {}, {}, {}, {}>;
         __isFragment?: never;
         __isTeleport?: never;
@@ -3175,8 +3180,9 @@ declare const components: {
         onXbar?: (show: boolean) => any;
         onYbar?: (show: boolean) => any;
     }>, {
-        scroll: (left?: number, top?: number) => void;
-        scrollTo: (left?: number, top?: number) => void;
+        getStatus(): snail_view.ScrollStatus;
+        scroll(left?: number, top?: number): void;
+        scrollTo(left?: number, top?: number): void;
     }, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
         left: () => any;
         right: () => any;
@@ -3501,4 +3507,4 @@ declare const components: {
 };
 
 export { MOTION, components, getBuiltinIcon, mount, onAppCreated, triggerAppCreated, usePicker, usePopup, useReactive, useTreeContext };
-export type { ButtonOptions, ChangeEvents, ChooseEvents, ChooseItem, ChooseOptions, ClickEvents, CloseEvents, ComponentBindOptions, ComponentOptions, ConfirmAreaOptions, ConfirmOptions, DatePickerDayItem, DatePickerMonthItem, DatePickerOptions, DatePickerYearItem, DatetimeDisabledOptions, DatetimePickerEvents, DeleteEvents, DialogHandle, DialogOptions, DisabledOptions, DragVerifyInfo, DragVerifyOptions, ElasticEvents, ElasticOptions, ElasticScrollStatus, ElasticSpringStatus, EmitterType, EmptyOptions, EventsType, FlexOptions, FoldEvents, FoldOptions, FoldStatus, FollowElectResult, FollowExtend, FollowHandle, FollowOptions, FollowPositionOptions, FollowStrategy, FollowStrategyOptions, FooterEvents, FooterOptions, HeaderEvents, HeaderOptions, INumberFormatter, IPickerManager, IPopupManager, IReactiveManager, ISelectContext, ITreeBaseContext, IconOptions, IconType, InputEvents, InputOptions, LayoutAraeOptions, LayoutAreaItem, LayoutOptions, LoadingOptions, MessageOptions, MotionEffectOptions, MotionOptions, MoveEvents, NumberBaseOptions, NumberEvents, NumberFormatResult, NumberOptions, PickerExtend, PickerPopupOptions, PlaceholderOptions, PopupDescriptor, PopupHandle, PopupOptions, PopupStatus, PopupStatusOptions, PropsType, ReactiveVar, ReadonlyOptions, ScrollEvents, ScrollOptions, ScrollStatus, SearchEvents, SearchOptions, SelectBaseEvents, SelectBaseOptions, SelectEvents, SelectItem, SelectNodeEvents, SelectNodeOptions, SelectOptions, SelectPopupEvents, SelectPopupExtend, SelectPopupOptions, SelectSlotOptions, SlotsType, SortEvent, SortEvents, SortGroupHook, SortGroupOptions, SortOptions, SwitchEvents, SwitchOptions, TableColOptions, TableOptions, TableRowOptions, TextareaEvents, TextareaOptions, TimePickerHourItem, TimePickerMinuteItem, TimePickerOptions, TimePickerSecondItem, TitleOptions, ToastOptions, TreeEvents, TreeNode, TreeNodeEvents, TreeNodeExtend, TreeNodeModel, TreeNodeOptions, TreeNodeRenderOptions, TreeNodeSlotOptions, TreeOptions, TreeSearchResult, ValueOptions, WrapperEvents, WrapperOptions };
+export type { ButtonOptions, ChangeEvents, ChooseEvents, ChooseItem, ChooseOptions, ClickEvents, CloseEvents, ComponentBindOptions, ComponentOptions, ConfirmAreaOptions, ConfirmOptions, DatePickerDayItem, DatePickerMonthItem, DatePickerOptions, DatePickerYearItem, DatetimeDisabledOptions, DatetimePickerEvents, DeleteEvents, DialogHandle, DialogOptions, DisabledOptions, DragVerifyInfo, DragVerifyOptions, ElasticEvents, ElasticExpose, ElasticOptions, ElasticSpringStatus, EmitterType, EmptyOptions, EventsType, FlexOptions, FoldEvents, FoldOptions, FoldStatus, FollowElectResult, FollowExtend, FollowHandle, FollowOptions, FollowPositionOptions, FollowStrategy, FollowStrategyOptions, FooterEvents, FooterOptions, HeaderEvents, HeaderOptions, INumberFormatter, IPickerManager, IPopupManager, IReactiveManager, ISelectContext, ITreeBaseContext, IconOptions, IconType, InputEvents, InputOptions, LayoutAraeOptions, LayoutAreaItem, LayoutOptions, LoadingOptions, MessageOptions, MotionEffectOptions, MotionOptions, MoveEvents, NumberBaseOptions, NumberEvents, NumberFormatResult, NumberOptions, PickerExtend, PickerPopupOptions, PlaceholderOptions, PopupDescriptor, PopupHandle, PopupOptions, PopupStatus, PopupStatusOptions, PropsType, ReactiveVar, ReadonlyOptions, ScrollEvents, ScrollExpose, ScrollOptions, SearchEvents, SearchOptions, SelectBaseEvents, SelectBaseOptions, SelectEvents, SelectItem, SelectNodeEvents, SelectNodeOptions, SelectOptions, SelectPopupEvents, SelectPopupExtend, SelectPopupOptions, SelectSlotOptions, SlotsType, SortEvent, SortEvents, SortGroupHook, SortGroupOptions, SortOptions, SwitchEvents, SwitchOptions, TableColOptions, TableOptions, TableRowOptions, TextareaEvents, TextareaOptions, TimePickerHourItem, TimePickerMinuteItem, TimePickerOptions, TimePickerSecondItem, TitleOptions, ToastOptions, TreeEvents, TreeNode, TreeNodeEvents, TreeNodeExtend, TreeNodeModel, TreeNodeOptions, TreeNodeRenderOptions, TreeNodeSlotOptions, TreeOptions, TreeSearchResult, ValueOptions, WrapperEvents, WrapperOptions };