snail.vue 2.0.18 → 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 { 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';
 
@@ -380,27 +380,29 @@ type FooterEvents = {
 /**
  * 滚动视图配置选项
  */
-type ScrollOptions = {
+type ScrollOptions = ScrollbarOptions & {};
+/**
+ * 滚动视图对外暴露方法
+ */
+type ScrollExpose = {
     /**
-     * x轴是否支持滚动
-     * - false（默认值）不支持
-     * - true 支持滚动
+     * 获取滚动状态信息
+     * @returns
      */
-    scrollX?: boolean;
+    getStatus(): ScrollStatus;
     /**
-     * y轴是否支持滚动
-     * - false（默认值）不支持
-     * - true 支持滚动
+     * 进行滚动操作
+     * - 在当前的滚动条位置基础上，滚动指定单位
+     * @param left 水平滚动单位；null、undefined 表示水平不滚动；小于0向左滚动；大于0向右滚动
+     * @param top 垂直滚动单位；null、undefined 表示垂直不滚动；小于0向上滚动；大于0向下滚动
      */
-    scrollY?: boolean;
+    scroll(left?: number, top?: number): void;
     /**
-     * 滚动条尺寸
-     * - normal ：常规，10px
-     * - small ：小尺寸，宽度 6px
-     * - mini ：迷你尺寸，宽度 4px
-     * - none ：无，不显示滚动条，但仍然能够滚动
+     * 滚动到指定位置
+     * @param left 水平滚动条位置；null、undefined 表示水平不滚动
+     * @param top 垂直滚动条位置；null、undefined 表示垂直不滚动
      */
-    barSize?: "normal" | "small" | "mini" | "none";
+    scrollTo(left?: number, top?: number): void;
 };
 /**
  * 滚动视图事件
@@ -433,44 +435,6 @@ type ScrollEvents = {
      */
     bottom: [];
 };
-/**
- * 滚动视图状态
- * - 缓存起来 和下次滚动做比对，触发对应事件
- */
-type ScrollStatus = {
-    /**
-     * 水平滚动条是否显示
-     */
-    xbar: boolean;
-    /**
-     * 垂直滚动条是否显示
-     */
-    ybar: boolean;
-    /**
-     * 滚动到【左侧】了
-     */
-    left: boolean;
-    /**
-     * 滚动到【右侧】了
-     */
-    right: boolean;
-    /**
-     * 滚动到【顶部】了
-     */
-    top: boolean;
-    /**
-     * 滚动到【底部】了
-     */
-    bottom: boolean;
-    /**
-     * 滚动视图宽度
-     */
-    scrollwidth: number;
-    /**
-     * 滚动视图高度
-     */
-    scrollheight: number;
-};
 
 /**
  * 包裹组件 相关实体
@@ -784,7 +748,7 @@ type TreeNodeSlotOptions<Node> = {
 /**
  * Table配置选项
  */
-type TableOptions = ScrollOptions & {
+type TableOptions = Pick<ScrollOptions, "scroll" | "barSize"> & {
     /**
      * 是否启用表格边框
      */
@@ -1241,11 +1205,11 @@ type FlexOptions = {
      * - - start（默认值） 主轴起点对齐
      * - - end 主轴终点对齐
      * - - center 主轴居中对齐
-     * - - space-between 主轴两端对齐，项目之间间隔平均分布
-     * - - space-around 主轴每个项目两侧间隔平均分布
-     * - - space-evenly 主轴每个项目之间间隔平均分布
+     * - - between 主轴两端对齐，项目之间间隔平均分布
+     * - - around 主轴每个项目两侧间隔平均分布
+     * - - evenly 主轴每个项目之间间隔平均分布
      */
-    justifyContent?: "start" | "end" | "center" | "space-between" | "space-around" | "space-evenly";
+    main?: "start" | "end" | "center" | "between" | "around" | "evenly";
     /**
      * 交叉轴对齐方式
      * - css属性：align-items
@@ -1256,7 +1220,7 @@ type FlexOptions = {
      * - - center 交叉轴居中对齐
      * - - baseline 交叉轴第一行文字基线对齐
      */
-    alignItems?: "start" | "end" | "center" | "stretch" | "baseline";
+    cross?: "start" | "end" | "center" | "stretch" | "baseline";
     /**
      * 多行时的交叉轴对齐方式
      * - css属性：align-content
@@ -1265,11 +1229,11 @@ type FlexOptions = {
      * - - start 交叉轴起点对齐
      * - - end 交叉轴终点对齐
      * - - center 交叉轴居中对齐
-     * - - space-between 交叉轴两端对齐，行之间间隔平均分布
-     * - - space-around 交叉轴每行两侧间隔平均分布
-     * - - space-evenly 交叉轴每行之间间隔平均分布
+     * - - between 交叉轴两端对齐，行之间间隔平均分布
+     * - - around 交叉轴每行两侧间隔平均分布
+     * - - evenly 交叉轴每行之间间隔平均分布
      */
-    alignContent?: "start" | "end" | "center" | "stretch" | "space-between" | "space-around" | "space-evenly";
+    content?: "start" | "end" | "center" | "stretch" | "between" | "around" | "evenly";
     /**
      * 启用子项修复
      * - 在`justify-content`启用`space-`相关属性时，子项之间会有间隔，当子项数量较少时，可能出现空间过大的问题，特别时多行的最后一样时
@@ -1302,14 +1266,7 @@ type FlexOptions = {
 /**
  * 弹性容器组件 配置选项
  */
-type ElasticOptions = {
-    /**
-     * 支持滚动的方向
-     * - x ：支持水平方向滚动，内容超出时出横向滚动条
-     * - y ：支持垂直方向滚动，内容超出时出纵向滚动条
-     * - both ：支持水平和垂直方向滚动，内容超出时出横向纵向滚动条
-     */
-    scroll: "x" | "y" | "both";
+type ElasticOptions = ScrollOptions & {
     /**
      * 滚动条弹簧效果
      * - x 仅在x轴方向上启用弹簧效果
@@ -1329,45 +1286,11 @@ type ElasticOptions = {
      * - 满足上拉加载条件后，触发`more`事件，处理完成后调用resolve函数，通知完成加载数据操作
      */
     upMore?: boolean;
-    /**
-     * 滚动条尺寸
-     * - normal ：常规，10px
-     * - small ：小尺寸，宽度 6px
-     * - mini ：迷你尺寸，宽度 4px
-     * - none ：无，不显示滚动条，但仍然能够滚动
-     */
-    barSize?: "normal" | "small" | "mini" | "none";
 };
 /**
  * 弹性容器组件 事件监听
  */
-type ElasticEvents = {
-    /**
-     * 【x轴方向】滚动条变化时
-     * @param show 是否显示。true 滚动条显示；false 滚动条隐藏
-     */
-    xbar: [show: boolean];
-    /**
-     * 【y轴方向】滚动条变化时
-     * @param show 是否显示。true 滚动条显示；false 滚动条隐藏
-     */
-    ybar: [show: boolean];
-    /**
-     * 【y轴方向】滚到【最顶部】了
-     */
-    top: [];
-    /**
-     * 【x轴方向】滚到【最右侧】了
-     */
-    right: [];
-    /**
-     * 【y轴方向】滚到【最底部】了
-     */
-    bottom: [];
-    /**
-     * 【x轴方向】滚到【最左侧】了
-     */
-    left: [];
+type ElasticEvents = ScrollEvents & {
     /**
      * 刷新数据
      * - 配合 `downRefresh`实现下拉刷新功能
@@ -1382,42 +1305,21 @@ type ElasticEvents = {
     more: [resolve: () => void];
 };
 /**
- * 弹性组件的滚动状态信息
- * - 缓存滚动状态 和下次做比对，触发对应事件
+ * 弹性组件 对外暴露属性接口
  */
-type ElasticScrollStatus = {
+type ElasticExpose = {
     /**
-     * 水平滚动条是否显示
+     * 加载刷新数据
+     * - 触发下拉刷新数据
+     * @returns 异步任务对象，外部感知任务执行完成
      */
-    xbar: boolean;
+    loadRefresh(): Promise<void>;
     /**
-     * 垂直滚动条是否显示
+     * 加载更多数据
+     * - 触发上拉加载更多数据
+     * @returns 异步任务对象，外部感知任务执行完成
      */
-    ybar: boolean;
-    /**
-     * 滚动到【左侧】了
-     */
-    left: boolean;
-    /**
-     * 滚动到【右侧】了
-     */
-    right: boolean;
-    /**
-     * 滚动到【顶部】了
-     */
-    top: boolean;
-    /**
-     * 滚动到【底部】了
-     */
-    bottom: boolean;
-    /**
-     * 滚动视图宽度
-     */
-    scrollwidth: number;
-    /**
-     * 滚动视图高度
-     */
-    scrollheight: number;
+    loadMore(): Promise<void>;
 };
 /**
  * 弹性组件的弹簧状态信息
@@ -3060,18 +2962,72 @@ declare const components: {
         };
     });
     Elastic: {
-        new (...args: any[]): vue.CreateComponentPublicInstanceWithMixins<Readonly<ElasticOptions> & Readonly<{}>, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, vue.PublicProps, {}, false, {}, {}, vue.GlobalComponents, vue.GlobalDirectives, string, {}, any, vue.ComponentProvideOptions, {
+        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;
+        }>, {
+            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, {
             P: {};
             B: {};
             D: {};
             C: {};
             M: {};
             Defaults: {};
-        }, Readonly<ElasticOptions> & Readonly<{}>, {}, {}, {}, {}, {}>;
+        }, 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<{}>, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, {}, {}, string, {}, vue.GlobalComponents, vue.GlobalDirectives, string, vue.ComponentProvideOptions> & vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps & (new () => {
+    } & 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;
+    }>, {
+        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 () => {
         $slots: {
             'down-refresh'?: (props: {}) => any;
         } & {
@@ -3176,7 +3132,7 @@ declare const components: {
         $slots: SlotsType<Pick<LayoutOptions, "left" | "right" | "main" | "top" | "bottom">>;
     });
     Scroll: {
-        new (...args: any[]): vue.CreateComponentPublicInstanceWithMixins<Readonly<ScrollOptions> & Readonly<{
+        new (...args: any[]): vue.CreateComponentPublicInstanceWithMixins<Readonly<snail_view.ScrollbarOptions> & Readonly<{
             onLeft?: () => any;
             onRight?: () => any;
             onTop?: () => any;
@@ -3184,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;
@@ -3193,14 +3150,14 @@ declare const components: {
             bottom: () => any;
             xbar: (show: boolean) => any;
             ybar: (show: boolean) => any;
-        }, vue.PublicProps, {}, true, {}, {}, vue.GlobalComponents, vue.GlobalDirectives, string, {}, any, vue.ComponentProvideOptions, {
+        }, vue.PublicProps, {}, false, {}, {}, vue.GlobalComponents, vue.GlobalDirectives, string, {}, any, vue.ComponentProvideOptions, {
             P: {};
             B: {};
             D: {};
             C: {};
             M: {};
             Defaults: {};
-        }, Readonly<ScrollOptions> & Readonly<{
+        }, Readonly<snail_view.ScrollbarOptions> & Readonly<{
             onLeft?: () => any;
             onRight?: () => any;
             onTop?: () => any;
@@ -3208,13 +3165,14 @@ 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;
         __isSuspense?: never;
-    } & vue.ComponentOptionsBase<Readonly<ScrollOptions> & Readonly<{
+    } & vue.ComponentOptionsBase<Readonly<snail_view.ScrollbarOptions> & Readonly<{
         onLeft?: () => any;
         onRight?: () => any;
         onTop?: () => any;
@@ -3222,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;
@@ -3322,7 +3281,7 @@ declare const components: {
         };
     });
     Table: {
-        new (...args: any[]): vue.CreateComponentPublicInstanceWithMixins<Readonly<TableOptions> & Readonly<{}>, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, vue.PublicProps, {}, true, {}, {}, vue.GlobalComponents, vue.GlobalDirectives, string, {}, any, vue.ComponentProvideOptions, {
+        new (...args: any[]): vue.CreateComponentPublicInstanceWithMixins<Readonly<TableOptions> & Readonly<{}>, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, vue.PublicProps, {}, false, {}, {}, vue.GlobalComponents, vue.GlobalDirectives, string, {}, any, vue.ComponentProvideOptions, {
             P: {};
             B: {};
             D: {};
@@ -3548,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 };