snail.vue 2.0.15 → 2.0.17

package/dist/snail.vue.d.ts

@@ -1204,6 +1204,232 @@ type FoldEvents = {
     change: [status: FoldStatus];
 };
 
+/**
+ * 弹性布局组件配置选项
+ */
+type FlexOptions = {
+    /**
+     * 主轴方向
+     * - css属性：flex-direction
+     * - 取值范围：
+     * - - row（默认值） 水平主轴，起点在左端
+     * - - row-reverse 水平主轴，起点在右端
+     * - - column 垂直主轴，起点在上沿
+     * - - column-reverse 垂直主轴，起点在下沿
+     */
+    direction?: "row" | "column" | "row-reverse" | "column-reverse";
+    /**
+     * 是否换行
+     * - css属性：flex-wrap
+     * - 取值范围：
+     * - - nowrap（默认值） 不换行，所有 flex 项都排在一行
+     * - - wrap 换行，第一行在上方
+     * - - wrap-reverse 换行，第一行在下方
+     */
+    wrap?: "nowrap" | "wrap" | "wrap-reverse";
+    /**
+     * 行与列之间的间隙（网格间距）
+     * - css属性：gap
+     * - row-gap、column-gap的缩写
+     * - 举例：gap: "10px 20px" 表示行间距为10px，列间距为20px；gap: "10px" 表示行间距和列间距都为10px
+     */
+    gap?: string;
+    /**
+     * 主轴对齐方式
+     * - css属性：justify-content
+     * - 取值范围：
+     * - - start（默认值） 主轴起点对齐
+     * - - end 主轴终点对齐
+     * - - center 主轴居中对齐
+     * - - space-between 主轴两端对齐，项目之间间隔平均分布
+     * - - space-around 主轴每个项目两侧间隔平均分布
+     * - - space-evenly 主轴每个项目之间间隔平均分布
+     */
+    justifyContent?: "start" | "end" | "center" | "space-between" | "space-around" | "space-evenly";
+    /**
+     * 交叉轴对齐方式
+     * - css属性：align-items
+     * - 取值范围：
+     * - - stretch（默认值） 交叉轴拉伸对齐（如果项目未设置高度或设为 auto，将占满整个交叉轴）
+     * - - start 交叉轴起点对齐
+     * - - end 交叉轴终点对齐
+     * - - center 交叉轴居中对齐
+     * - - baseline 交叉轴第一行文字基线对齐
+     */
+    alignItems?: "start" | "end" | "center" | "stretch" | "baseline";
+    /**
+     * 多行时的交叉轴对齐方式
+     * - css属性：align-content
+     * - 取值范围：
+     * - - stretch（默认值） 交叉轴拉伸对齐（如果项目未设置高度或设为 auto，将占满整个交叉轴）
+     * - - start 交叉轴起点对齐
+     * - - end 交叉轴终点对齐
+     * - - center 交叉轴居中对齐
+     * - - space-between 交叉轴两端对齐，行之间间隔平均分布
+     * - - space-around 交叉轴每行两侧间隔平均分布
+     * - - space-evenly 交叉轴每行之间间隔平均分布
+     */
+    alignContent?: "start" | "end" | "center" | "stretch" | "space-between" | "space-around" | "space-evenly";
+    /**
+     * 启用子项修复
+     * - 在`justify-content`启用`space-`相关属性时，子项之间会有间隔，当子项数量较少时，可能出现空间过大的问题，特别时多行的最后一样时
+     * - 启动后，会基于子项数量补全最后一行缺失的子项数量，来修复空间过大的问题
+     * - 推荐仅在所有子项主轴方向尺寸一样时，否则修复可能不准确
+     */
+    repairItem?: boolean;
+    /**
+     * flex容器的子项数量
+     * - 配合 `repairSpace` 构建修复空间的子项数量
+     * - 当 `repairSpace` 启用时，自动监听子项数量变化来动态调整修复空间的子项数量；不启用时忽略
+     */
+    itemCount?: number;
+    /**
+     * flex容器的子项标签名
+     * - 配合 `repairSpace` 构建修复空间的子项元素标签名
+     * - 默认值为`div`，即子项元素为`<div>`标签
+     * - 可配置为其他标签名，如`span`，则子项元素为`<span>`标签
+     */
+    itemTag?: string;
+    /**
+     * flex容器的子项类样式名
+     * - 配合 `repairSpace` 构建修复空间的子项元素类样式名
+     * - 推荐设置为一个固定值的类样式名，如`flex-item`，来方便用户通过该类样式名来设置子项元素的样式
+     * - 构建的子项，会自动追加一个 "repair-item”的类样式名，来方便用户通过该类样式名来设置修复空间子项元素的样式
+     */
+    itemClass?: string;
+};
+
+/**
+ * 弹性容器组件 配置选项
+ */
+type ElasticOptions = {
+    /**
+     * 支持滚动的方向
+     * - x ：支持水平方向滚动，内容超出时出横向滚动条
+     * - y ：支持垂直方向滚动，内容超出时出纵向滚动条
+     * - both ：支持水平和垂直方向滚动，内容超出时出横向纵向滚动条
+     */
+    scroll: "x" | "y" | "both";
+    /**
+     * 滚动条弹簧效果
+     * - x 仅在x轴方向上启用弹簧效果
+     * - y 仅在y轴方向上启用弹簧效果
+     * - both ：同时启用x轴和y轴的弹簧效果
+     */
+    spring?: "x" | "y" | "both";
+    /**
+     * 是否启用【下拉刷新】功能
+     * - `spring` 为 `y/both`时生效
+     * - 满足下拉刷新条件后，触发`refresh`事件，处理完成后调用resolve函数，通知完成刷新数据操作
+     */
+    downRefresh?: boolean;
+    /**
+     * 是否启用【上拉加载】功能
+     * - `spring` 为 `y/both`时生效
+     * - 满足上拉加载条件后，触发`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: [];
+    /**
+     * 刷新数据
+     * - 配合 `downRefresh`实现下拉刷新功能
+     * @param resolve 处理完成后调用resolve函数，通知完成刷新数据操作
+     */
+    refresh: [resolve: () => void];
+    /**
+     * 加载更多
+     * - 配合 `upMore`实现上拉加载功能
+     * @param resolve 处理完成后调用resolve函数，通知完成加载数据操作
+     */
+    more: [resolve: () => void];
+};
+/**
+ * 弹性组件的滚动状态信息
+ * - 缓存滚动状态 和下次做比对，触发对应事件
+ */
+type ElasticScrollStatus = {
+    /**
+     * 水平滚动条是否显示
+     */
+    xbar: boolean;
+    /**
+     * 垂直滚动条是否显示
+     */
+    ybar: boolean;
+    /**
+     * 滚动到【左侧】了
+     */
+    left: boolean;
+    /**
+     * 滚动到【右侧】了
+     */
+    right: boolean;
+    /**
+     * 滚动到【顶部】了
+     */
+    top: boolean;
+    /**
+     * 滚动到【底部】了
+     */
+    bottom: boolean;
+    /**
+     * 滚动视图宽度
+     */
+    scrollwidth: number;
+    /**
+     * 滚动视图高度
+     */
+    scrollheight: number;
+};
+/**
+ * 弹性组件的弹簧状态信息
+ */
+type ElasticSpringStatus = {
+    x: number | undefined;
+    /**
+     * y轴方向的橡皮筋效果偏移量
+     */
+    y: number | undefined;
+};
+
 /**
  * 选项菜单 基础配置选项
  */
@@ -1677,52 +1903,52 @@ type NumberEvents = ChangeEvents<number> & {
  */
 type IconOptions = TitleOptions & {
     /**
-     * 图标类型
+     * 是否为自定义图标
+     * - 为true时，外部通过插槽自己绘制图标
+     * - 为false时，使用`type`值绘制对应的内置图标
+     * - 默认false
      */
-    type: IconType;
+    custom?: boolean;
     /**
-     * 图形伸展
-     * - svg.viewBox 属性
-     * - 为空则默认“0 0 1024 1024”
+     * 内置的图标类型
+     * - `custom`为false时生效
      */
-    viewBox?: string;
-    /**
-     * 图标颜色
-     */
-    color?: string;
-    /**
-     * 鼠标移入时的图标颜色
-     */
-    hoverColor?: string;
+    type?: IconType;
     /**
-     * 图标大小：默认24
+     * 是否是按钮图标
+     * - true时，鼠标移入时 cursor:pointer;
      */
-    size?: number;
+    button?: boolean;
     /**
-     * 轮廓描边颜色
-     * - 配合 strokeWidth 使用，完成图标加粗效果等
-     * @see https://developer.mozilla.org/zh-CN/docs/Web/SVG/Reference/Attribute/stroke
+     * 图标大小
+     * - 可指定对象，如 { width: 24, height: 24 }，则图标大小为 24 * 24
+     * - 可指定数字，如 24，则图标大小为 24 * 24
+     * - 默认 24
      */
-    stroke?: string;
+    size?: number | {
+        width?: number;
+        height?: number;
+    };
     /**
-     * 轮廓宽度
-     * - 配合 stroke 使用，完成图标加粗效果等
-     * @see https://developer.mozilla.org/zh-CN/docs/Web/SVG/Reference/Attribute/stroke-width
+     * 图标颜色
      */
-    strokeWidth?: number;
+    color?: string;
     /**
-     * 图标绘制路径
-     * - 等效 svg-path的d属性
-     * - 仅在type为 custom 时生效
-     * - 若为数组，则表示多条绘制路径
+     * 鼠标移入时的图标颜色
      */
-    draw?: string | string[];
+    hoverColor?: string;
     /**
      * 旋转角度
      * - 默认0
      * - 通过：transform: rotate(1.06); 实现
      */
     rotate?: number;
+    /**
+     * 图形伸展
+     * - svg.viewBox 属性
+     * - 为空则默认“0 0 1024 1024”
+     */
+    viewBox?: string;
 };
 /**
  * 图标类型
@@ -1744,9 +1970,8 @@ type IconOptions = TitleOptions & {
  * - - plus         加号
  * - - subtract     减号
  * - - grip         紧握图标，垂直方向，一般用于拖动句柄
- * - - custom       自定义图标：此时IconOptions.draw属性传入绘制路径
  */
-type IconType = "success" | "error" | "warn" | "close" | "trash" | "download" | "print" | "edit" | "arrow" | "datepicker" | "timepicker" | "plus" | "subtract" | "grip" | "custom";
+type IconType = "success" | "error" | "warn" | "close" | "trash" | "download" | "print" | "edit" | "arrow" | "datepicker" | "timepicker" | "plus" | "subtract" | "grip";
 
 /**
  * 检查选项 数据结构
@@ -2042,12 +2267,11 @@ declare function triggerAppCreated(app: App, type?: AppType): App;
  */
 
 /**
- * 基于类型获取Svg图标绘制路径
+ * 获取内置图标绘制路径
  * @param iconType 图标类型
- * @param draw 绘制路径；自定义时生效
  * @returns 图标路径
  */
-declare function getSvgDraw(iconType: IconType, draw: string[] | string): string[];
+declare function getBuiltinIcon(iconType: IconType): string[];
 
 /**
  * 动态加载组件 组件配置选项
@@ -2682,7 +2906,23 @@ declare const components: {
             default?: (props: {}) => any;
         };
     });
-    Icon: vue.DefineComponent<IconOptions, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<IconOptions> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, false, {}, any>;
+    Icon: {
+        new (...args: any[]): vue.CreateComponentPublicInstanceWithMixins<Readonly<IconOptions> & Readonly<{}>, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, vue.PublicProps, {}, true, {}, {}, vue.GlobalComponents, vue.GlobalDirectives, string, {}, any, vue.ComponentProvideOptions, {
+            P: {};
+            B: {};
+            D: {};
+            C: {};
+            M: {};
+            Defaults: {};
+        }, Readonly<IconOptions> & Readonly<{}>, {}, {}, {}, {}, {}>;
+        __isFragment?: never;
+        __isTeleport?: never;
+        __isSuspense?: never;
+    } & vue.ComponentOptionsBase<Readonly<IconOptions> & Readonly<{}>, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, {}, {}, string, {}, vue.GlobalComponents, vue.GlobalDirectives, string, vue.ComponentProvideOptions> & vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps & (new () => {
+        $slots: {
+            default?: (props: {}) => any;
+        };
+    });
     Input: vue.DefineComponent<ReadonlyOptions & PlaceholderOptions & TitleOptions & {
         type?: "text" | "number" | "password";
         required?: boolean;
@@ -2819,6 +3059,44 @@ declare const components: {
             [x: number]: (props: any) => any;
         };
     });
+    Elastic: {
+        new (...args: any[]): vue.CreateComponentPublicInstanceWithMixins<Readonly<ElasticOptions> & Readonly<{}>, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, vue.PublicProps, {}, false, {}, {}, vue.GlobalComponents, vue.GlobalDirectives, string, {}, any, vue.ComponentProvideOptions, {
+            P: {};
+            B: {};
+            D: {};
+            C: {};
+            M: {};
+            Defaults: {};
+        }, Readonly<ElasticOptions> & Readonly<{}>, {}, {}, {}, {}, {}>;
+        __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 () => {
+        $slots: {
+            'down-refresh'?: (props: {}) => any;
+        } & {
+            default?: (props: {}) => any;
+        } & {
+            'up-more'?: (props: {}) => any;
+        };
+    });
+    Flex: {
+        new (...args: any[]): vue.CreateComponentPublicInstanceWithMixins<Readonly<FlexOptions> & Readonly<{}>, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, vue.PublicProps, {}, true, {}, {}, vue.GlobalComponents, vue.GlobalDirectives, string, {}, any, vue.ComponentProvideOptions, {
+            P: {};
+            B: {};
+            D: {};
+            C: {};
+            M: {};
+            Defaults: {};
+        }, Readonly<FlexOptions> & Readonly<{}>, {}, {}, {}, {}, {}>;
+        __isFragment?: never;
+        __isTeleport?: never;
+        __isSuspense?: never;
+    } & vue.ComponentOptionsBase<Readonly<FlexOptions> & Readonly<{}>, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, {}, {}, string, {}, vue.GlobalComponents, vue.GlobalDirectives, string, vue.ComponentProvideOptions> & vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps & (new () => {
+        $slots: {
+            default?: (props: {}) => any;
+        };
+    });
     Fold: {
         new (...args: any[]): vue.CreateComponentPublicInstanceWithMixins<Readonly<DisabledOptions & TitleOptions & {
             subtitle?: string;
@@ -3189,6 +3467,11 @@ declare const components: {
             default?: (props: {}) => any;
         };
     });
+    FlashNumber: vue.DefineComponent<{
+        value?: string | number;
+    }, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<{
+        value?: string | number;
+    }> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
     DatePicker: vue.DefineComponent<ReadonlyOptions & {
         value?: string;
         format?: snail_core.DateFormat;
@@ -3264,5 +3547,5 @@ declare const components: {
     });
 };
 
-export { MOTION, components, getSvgDraw, 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, EmitterType, EmptyOptions, EventsType, 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 { 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 };