snail.vue 1.0.47 → 1.0.49

package/.code-snippets

@@ -39,5 +39,11 @@
 		"scope": "html",
 		"description": "公共类样式：提示文本",
 		"body": "class=\"text-tips\"",
+	},
+	".placeholder":{
+		"prefix": ".placeholder",
+		"scope": "html",
+		"description": "placeholder,针对div、span元素，设置placeholder样式",
+		"body": "placeholder",
 	}
 }

package/dist/snail.vue.d.ts

@@ -416,6 +416,12 @@ interface ITreeBaseContext<T> {
      * @param text 搜索文本
      */
     doSearch(text: string): void;
+    /**
+     * 是否是【已激活】节点
+     * @param node 要判断的节点
+     * @returns true 是已激活节点，false 否
+     */
+    isActived(node: TreeNode<T>): boolean;
     /**
      * 是否是【补丁】节点
      * - 子节点搜索命中时，父级路径上节点没命中，则作父级路径节点作为路径修补节点存在，避免命中子节点展示不出来
@@ -444,6 +450,13 @@ interface ITreeBaseContext<T> {
      * @returns 从【顶级节点】->【指定节点】的全路径数据
      */
     getPath(node: TreeNode<T, TreeNodeExtend>): TreeNode<T, TreeNodeExtend>[];
+    /**
+     * 获取指定【树节点】的唯一Key值
+     * - 相同节点确保唯一，且不变；用于唯一标记此节点
+     * @param node
+     * @returns 返回节点唯一Key值
+     */
+    getKey(node: TreeNode<T>): string;
 }
 /**
  * 树搜索结果
@@ -568,6 +581,13 @@ type TreeNodeModel<T> = TreeNode<T, TreeNodeExtend>;
  * 树节点 渲染配置选项
  */
 type TreeNodeRenderOptions = {
+    /**
+     * 节点展开层级
+     * - 不传入则默认展开所有
+     * - 否则展开传入的层级；从2开始；第一级始终展开；如2则1、2层级展开
+     * -
+     */
+    expandLevel?: number;
     /**
      * 是否禁用【折叠】子节点操作
      * - true 时禁用 折叠操作
@@ -585,8 +605,8 @@ type TreeNodeRenderOptions = {
  */
 type TreeNodeSlotOptions<Node> = {
     /**
-         * 当前节点
-         */
+     * 当前节点
+     */
     node: Node;
     /**
      * 父节点
@@ -764,6 +784,12 @@ type SelectBaseOptions<T> = {
      * - 仅针对【单选模式】生效
      */
     showPath?: boolean;
+    /**
+     * 是否显示【清空已选】按钮
+     * - true：则在弹窗的底部显示【清空已选】按钮，点击时清空所有已选选项
+     * - 若存在多级选项，仅在第一级弹窗中显示
+     */
+    showClear?: boolean;
     /**
      * 选择项 follow弹窗样式
      * - 支持指定弹窗高度，如最大高度，不指定则默认尽可能展示全
@@ -776,7 +802,7 @@ type SelectBaseOptions<T> = {
 type SelectBaseEvents<T> = {
     /**
      * 选中的【选择项】改变时
-     * - @param values 已选的【选择项】：多级单选时，为【选择项】路径（父->子）；其他情况为已选的【选择项】
+     * - @param values 已选的【选择项】：单选时，为【选择项】路径（父->子）；其他情况为已选的【选择项】
      */
     change: [values: SelectItem<T>[]];
 };
@@ -794,7 +820,22 @@ type SelectItem<T> = TreeNode<T, TreeNodeExtend & {
 /**
  * 选项菜单组件 配置选项
  */
-type SelectOptions<T> = ReadonlyOptions & PlaceholderOptions & SelectBaseOptions<T> & {};
+type SelectOptions<T> = ReadonlyOptions & PlaceholderOptions & SelectBaseOptions<T> & {
+    /** 父类<see cref="SelectBaseOptions"/>已有属性：
+     *      items                   【选择项】集合
+     *      search                  启用 【搜索】功能
+     *      searchPlaceholder       搜索框提示语
+     *      multiple                是否【多选模式】
+     *      showPath                显示选项路径
+     *      popupStyle              弹出的选项选择窗体样式
+     */
+    /**
+     * 禁用【值的路径】
+     * - 仅在 multiple 不为 true 时生效
+     * - 为true时，则v-model绑定时为单个值而非数组
+     */
+    valuePathDisabled?: boolean;
+};
 /**
  * 选项菜单 组件 事件
  */
@@ -849,6 +890,20 @@ type SelectPopupOptions<T> = SelectBaseOptions<T> & {
      */
     level: number;
 };
+/**
+ * 【选项菜单】 弹窗组件事件
+ */
+type SelectPopupEvents<T> = {
+    /**
+     * 清空选项
+     */
+    clear: [];
+    /**
+     * 选项点击事件
+     * @param path 选中的【选择项】路径；父->子
+     */
+    click: [path: SelectItem<T>[]];
+};
 /**
  * 【选项菜单】 弹窗组件扩展
  */
@@ -926,6 +981,18 @@ type IconOptions = TitleOptions & {
      * 图标大小：默认24
      */
     size?: number;
+    /**
+     * 轮廓描边颜色
+     * - 配合 strokeWidth 使用，完成图标加粗效果等
+     * @see https://developer.mozilla.org/zh-CN/docs/Web/SVG/Reference/Attribute/stroke
+     */
+    stroke?: string;
+    /**
+     * 轮廓宽度
+     * - 配合 stroke 使用，完成图标加粗效果等
+     * @see https://developer.mozilla.org/zh-CN/docs/Web/SVG/Reference/Attribute/stroke-width
+     */
+    strokeWidth?: number;
     /**
      * 图标绘制路径
      * - 等效 svg-path的d属性
@@ -955,10 +1022,12 @@ type IconOptions = TitleOptions & {
  * - 指向类：
  * - - arrow        向右箭头
  * - 其他类：
+ * - - plus         加号
+ * - - subtract     减号
  * - - grip         紧握图标，垂直方向，一般用于拖动句柄
  * - - custom       自定义图标：此时IconOptions.draw属性传入绘制路径
  */
-type IconType = "success" | "error" | "warn" | "close" | "trash" | "download" | "print" | "edit" | "arrow" | "grip" | "custom";
+type IconType = "success" | "error" | "warn" | "close" | "trash" | "download" | "print" | "edit" | "arrow" | "plus" | "subtract" | "grip" | "custom";
 
 /**
  * 检查选项 数据结构
@@ -1177,9 +1246,10 @@ type SwitchEvents = {
 /**
  * 使用【树上下文】
  * @param nodes 树节点集合
+ * @param activeNodeRef 当前激活的树节点引用；不传入，则无法实现 isActived 判断
  * @returns 上下文对象+作用域
  */
-declare function useTreeContext<T>(nodes: TreeNode<T, TreeNodeExtend>[]): ITreeBaseContext<T> & IScope;
+declare function useTreeContext<T>(nodes: TreeNode<T, TreeNodeExtend>[], activeNodeRef?: ShallowRef<TreeNode<T, TreeNodeExtend>>): ITreeBaseContext<T> & IScope;
 
 /**
  * 使用【响应式管理器】
@@ -1217,11 +1287,11 @@ declare function triggerAppCreated(app: App, type?: AppType): App;
 
 /**
  * 基于类型获取Svg图标绘制路径
- * @param type 图标类型
- * @param color 填充颜色，不传入则使用默认的
+ * @param iconType 图标类型
+ * @param draw 绘制路径；自定义时生效
  * @returns 图标路径
  */
-declare function getSvgDraw(options: IconOptions): string[];
+declare function getSvgDraw(iconType: IconType, draw: string[] | string): string[];
 
 /**
  * 排序组件 配置选项
@@ -1720,8 +1790,9 @@ interface IPopupManager {
      * @param type 提示类型：成功、失败、、、
      * @param message 提示消息
      * @param options 提示框配置选项
+     * @returns 弹窗打开结果，外部可手动关闭弹窗
      */
-    toast(type: IconType, message: string, options?: Omit<ToastOptions, "type" | "message">): void;
+    toast(type: IconType, message: string, options?: Omit<ToastOptions, "type" | "message">): IScope;
 }
 
 /**
@@ -1848,13 +1919,15 @@ declare const components: {
     }>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
     Select: {
         new (...args: any[]): vue.CreateComponentPublicInstanceWithMixins<Readonly<ReadonlyOptions & PlaceholderOptions & SelectBaseOptions<any> & {
-            modelValue?: SelectItem<any>[];
+            valuePathDisabled?: boolean;
+        } & {
+            modelValue?: SelectItem<any>[] | SelectItem<any>;
         }> & Readonly<{
             onChange?: (values: SelectItem<any>[]) => any;
-            "onUpdate:modelValue"?: (value: SelectItem<any>[]) => any;
+            "onUpdate:modelValue"?: (value: SelectItem<any> | SelectItem<any>[]) => any;
         }>, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
             change: (values: SelectItem<any>[]) => any;
-            "update:modelValue": (value: SelectItem<any>[]) => any;
+            "update:modelValue": (value: SelectItem<any> | SelectItem<any>[]) => any;
         }, vue.PublicProps, {}, false, {}, {}, vue.GlobalComponents, vue.GlobalDirectives, string, {}, any, vue.ComponentProvideOptions, {
             P: {};
             B: {};
@@ -1863,22 +1936,26 @@ declare const components: {
             M: {};
             Defaults: {};
         }, Readonly<ReadonlyOptions & PlaceholderOptions & SelectBaseOptions<any> & {
-            modelValue?: SelectItem<any>[];
+            valuePathDisabled?: boolean;
+        } & {
+            modelValue?: SelectItem<any>[] | SelectItem<any>;
         }> & Readonly<{
             onChange?: (values: SelectItem<any>[]) => any;
-            "onUpdate:modelValue"?: (value: SelectItem<any>[]) => any;
+            "onUpdate:modelValue"?: (value: SelectItem<any> | SelectItem<any>[]) => any;
         }>, {}, {}, {}, {}, {}>;
         __isFragment?: never;
         __isTeleport?: never;
         __isSuspense?: never;
     } & vue.ComponentOptionsBase<Readonly<ReadonlyOptions & PlaceholderOptions & SelectBaseOptions<any> & {
-        modelValue?: SelectItem<any>[];
+        valuePathDisabled?: boolean;
+    } & {
+        modelValue?: SelectItem<any>[] | SelectItem<any>;
     }> & Readonly<{
         onChange?: (values: SelectItem<any>[]) => any;
-        "onUpdate:modelValue"?: (value: SelectItem<any>[]) => any;
+        "onUpdate:modelValue"?: (value: SelectItem<any> | SelectItem<any>[]) => any;
     }>, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
         change: (values: SelectItem<any>[]) => any;
-        "update:modelValue": (value: SelectItem<any>[]) => any;
+        "update:modelValue": (value: SelectItem<any> | SelectItem<any>[]) => any;
     }, string, {}, {}, string, {}, vue.GlobalComponents, vue.GlobalDirectives, string, vue.ComponentProvideOptions> & vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps & (new () => {
         $slots: {
             default?: (props: {
@@ -1990,7 +2067,10 @@ declare const components: {
             onTop?: () => any;
             onXbar?: (show: boolean) => any;
             onYbar?: (show: boolean) => any;
-        }>, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
+        }>, {
+            scroll: (left?: number, top?: number) => void;
+            scrollTo: (left?: number, top?: number) => void;
+        }, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
             left: () => any;
             right: () => any;
             bottom: () => any;
@@ -2011,7 +2091,10 @@ declare const components: {
             onTop?: () => any;
             onXbar?: (show: boolean) => any;
             onYbar?: (show: boolean) => any;
-        }>, {}, {}, {}, {}, {}>;
+        }>, {
+            scroll: (left?: number, top?: number) => void;
+            scrollTo: (left?: number, top?: number) => void;
+        }, {}, {}, {}, {}>;
         __isFragment?: never;
         __isTeleport?: never;
         __isSuspense?: never;
@@ -2022,7 +2105,10 @@ declare const components: {
         onTop?: () => any;
         onXbar?: (show: boolean) => any;
         onYbar?: (show: boolean) => any;
-    }>, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
+    }>, {
+        scroll: (left?: number, top?: number) => void;
+        scrollTo: (left?: number, top?: number) => void;
+    }, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
         left: () => any;
         right: () => any;
         bottom: () => any;
@@ -2153,6 +2239,7 @@ declare const components: {
             onSearched?: (text: string) => any;
         }>, {
             context: ITreeBaseContext<any>;
+            onTreeNodeClick: (node: TreeNodeModel<any>, parents?: TreeNodeModel<any>[]) => void;
         }, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
             click: (node: TreeNodeModel<any>, parents?: TreeNodeModel<any>[]) => any;
             searched: (text: string) => any;
@@ -2172,6 +2259,7 @@ declare const components: {
             onSearched?: (text: string) => any;
         }>, {
             context: ITreeBaseContext<any>;
+            onTreeNodeClick: (node: TreeNodeModel<any>, parents?: TreeNodeModel<any>[]) => void;
         }, {}, {}, {}, {}>;
         __isFragment?: never;
         __isTeleport?: never;
@@ -2185,6 +2273,7 @@ declare const components: {
         onSearched?: (text: string) => any;
     }>, {
         context: ITreeBaseContext<any>;
+        onTreeNodeClick: (node: TreeNodeModel<any>, parents?: TreeNodeModel<any>[]) => void;
     }, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
         click: (node: TreeNodeModel<any>, parents?: TreeNodeModel<any>[]) => any;
         searched: (text: string) => any;
@@ -2294,4 +2383,4 @@ declare const components: {
 };
 
 export { components, getSvgDraw, mount, onAppCreated, triggerAppCreated, usePopup, useReactive, useTreeContext };
-export type { ButtonOptions, ChangeEvents, ChooseEvents, ChooseItem, ChooseOptions, ClickEvents, CloseEvents, ComponentBindOptions, ComponentOptions, ConfirmAreaOptions, ConfirmOptions, DeleteEvents, DialogHandle, DialogOptions, DisabledOptions, DragVerifyInfo, DragVerifyOptions, EmptyOptions, EventsType, FoldEvents, FoldOptions, FoldStatus, FollowElectResult, FollowExtend, FollowHandle, FollowOptions, FollowStrategy, FollowStrategyOptions, FooterEvents, FooterOptions, HeaderEvents, HeaderOptions, IPopupManager, IReactiveManager, ISelectContext, ITreeBaseContext, IconOptions, IconType, InputEvents, InputOptions, LayoutOptions, LoadingOptions, MessageOptions, MoveEvents, PlaceholderOptions, PopupDescriptor, PopupHandle, PopupOptions, PopupStatus, PopupStatusOptions, PropsType, ReactiveVar, ReadonlyOptions, ScrollEvents, ScrollOptions, ScrollStatus, SearchEvents, SearchOptions, SelectBaseEvents, SelectBaseOptions, SelectEvents, SelectItem, SelectNodeEvents, SelectNodeOptions, SelectOptions, SelectPopupExtend, SelectPopupOptions, SelectSlotOptions, SortEvents, SortOptions, SwitchEvents, SwitchOptions, TableColOptions, TableOptions, TableRowOptions, TitleOptions, ToastOptions, TreeEvents, TreeNode, TreeNodeEvents, TreeNodeExtend, TreeNodeModel, TreeNodeOptions, TreeNodeRenderOptions, TreeNodeSlotOptions, TreeOptions, TreeSearchResult, WrapperEvents, WrapperOptions };
+export type { ButtonOptions, ChangeEvents, ChooseEvents, ChooseItem, ChooseOptions, ClickEvents, CloseEvents, ComponentBindOptions, ComponentOptions, ConfirmAreaOptions, ConfirmOptions, DeleteEvents, DialogHandle, DialogOptions, DisabledOptions, DragVerifyInfo, DragVerifyOptions, EmptyOptions, EventsType, FoldEvents, FoldOptions, FoldStatus, FollowElectResult, FollowExtend, FollowHandle, FollowOptions, FollowStrategy, FollowStrategyOptions, FooterEvents, FooterOptions, HeaderEvents, HeaderOptions, IPopupManager, IReactiveManager, ISelectContext, ITreeBaseContext, IconOptions, IconType, InputEvents, InputOptions, LayoutOptions, LoadingOptions, MessageOptions, MoveEvents, 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, SortEvents, SortOptions, SwitchEvents, SwitchOptions, TableColOptions, TableOptions, TableRowOptions, TitleOptions, ToastOptions, TreeEvents, TreeNode, TreeNodeEvents, TreeNodeExtend, TreeNodeModel, TreeNodeOptions, TreeNodeRenderOptions, TreeNodeSlotOptions, TreeOptions, TreeSearchResult, WrapperEvents, WrapperOptions };