stellar-ui-plus 1.25.0 → 1.25.2

package/components/ste-text/ATTRIBUTES.md

@@ -1,4 +1,6 @@
-#### Props
+## API
+
+### Props
 | 属性名 | 说明  | 类型 | 默认值  | 可选值 | 支持版本 |
 | ----- | ----- | --- | ------- | ------ | -------- |
 | `selectable` | 文本是否可选 默认 false | `boolean` | `false` | - | - |
@@ -7,3 +9,9 @@
 | `lines` | 文本显示的行数，如果设置，超出此行数，将会显示省略号 | `number` | - | - | - |
 
 
+### Slots
+| 插槽名 | 说明  | 参数 | 支持版本 |
+| ----- | ----- | --- | -------- |
+| `default` | 内容 | - | - |
+
+

package/components/ste-text/README.md

@@ -4,9 +4,9 @@
 
 ---$
 
-### 代码演示
+## 代码演示
 
-#### 可选
+## 可选
 
 - 当`selectable`为`true`时，可长按选中文字
 
@@ -16,7 +16,7 @@
 </template>
 ```
 
-#### 解码
+## 解码
 
 - `&nbsp;` 解码为一个不间断空格 (Non-Breaking Space)
 - `&lt;` 解码为小于号 <
@@ -38,7 +38,7 @@
 </template>
 ```
 
-#### 换行省略
+## 换行省略
 
 ```html
 <template>
@@ -50,15 +50,7 @@
 
 ---$
 
-### API
-
 <!-- props -->
 
-#### 组件插槽(Slots)
-
-| 插槽名  | 说明 | 插槽参数 | 支持版本 |
-| ------- | ---- | -------- | -------- |
-| default | 内容 | -        | -        |
-
 ---$
 {{fuyuwei}}

package/components/ste-text/ste-text.easycom.json

@@ -25,6 +25,10 @@
             "name": "lines",
             "description": "文本显示的行数，如果设置，超出此行数，将会显示省略号",
             "type": "number"
+        },
+        {
+            "name": "[slot]default",
+            "description": "内容"
         }
     ]
 }

package/components/ste-toast/ATTRIBUTES.md

@@ -1,4 +1,6 @@
-#### Props
+## API
+
+### Props
 | 属性名 | 说明  | 类型 | 默认值  | 可选值 | 支持版本 |
 | ----- | ----- | --- | ------- | ------ | -------- |
 | `title` | 提示的内容 | `String` | `` | - | - |
@@ -13,3 +15,10 @@
 | `close` | 提示关闭的的回调函数 | `() => void` | - | - | - |
 
 
+### Methods
+| 方法名 | 说明  | 参数 | 返回值 | 支持版本 |
+| ----- | ----- | --- | ------ | -------- |
+| `showToast` | 提示打开函数 | `props`：配置项 | - | - |
+| `hideToast` | 关闭提示函数 | - | - | - |
+
+

package/components/ste-toast/README.md

@@ -4,9 +4,9 @@
 
 ---$
 
-### 使用方法
+## 使用方法
 
-#### 组合函数使用方法
+## 组合函数使用方法
 
 ps：注意 目前 useToast 只能在 setup 作用域下使用  
 父组件引入组件 组合函数调用showToast方法，打开轻提示
@@ -25,7 +25,7 @@ ps：注意 目前 useToast 只能在 setup 作用域下使用
 </template>
 ```
 
-#### Ref用法
+## Ref用法
 
 父组件引入组件 绑定ref 通过ref调用showToast方法，打开轻提示
 
@@ -42,7 +42,7 @@ ps：注意 目前 useToast 只能在 setup 作用域下使用
 </script>
 ```
 
-#### 全局引入
+## 全局引入
 
 配合 [https://github.com/smartXJ/vue3-inset-loader](https://github.com/smartXJ/vue3-inset-loader) 插件， 将 ste-toast 节点置于每个页面中，可以更进一步简化使用
 
@@ -57,7 +57,7 @@ insetLoader: {
 }
 ```
 
-#### 文字提示
+## 文字提示
 
 `title`为提示内容，提示弹窗根据内容自动撑开，最大宽度为260px，超过自动换行，也可手动插入换行符`\n`
 
@@ -85,7 +85,7 @@ insetLoader: {
 </script>
 ```
 
-### 提示类型
+## 提示类型
 
 `icon`为固定的图标类型，默认为`success`，为`loading`时，弹窗不会自动关闭，需手动关闭弹窗，使用`hideToast`方法
 
@@ -150,7 +150,7 @@ insetLoader: {
 </script>
 ```
 
-### 遮罩层
+## 遮罩层
 
 `mask`为是否显示透明蒙层，防止触摸穿透，默认为`false`
 
@@ -172,7 +172,7 @@ insetLoader: {
 </script>
 ```
 
-### 延迟时间
+## 延迟时间
 
 `duration`为提示的延迟时间，单位ms 值为 0 时，toast 不会自动消失（loading 类型默认为 0）
 
@@ -193,7 +193,7 @@ insetLoader: {
 </script>
 ```
 
-### 回调事件
+## 回调事件
 
 - `success`：提示打开成功的回调函数
 - `fail`：提示打开失败的回调函数
@@ -252,16 +252,7 @@ insetLoader: {
 
 ---$
 
-### API
-
 <!-- props -->
 
-#### Methods
-
-| 方法名      | 说明         | 方法参数    | 支持版本 |
-| ----------- | ------------ | ----------- | -------- |
-| `showToast` | 提示打开函数 | `props`属性 | -        |
-| `hideToast` | 关闭提示函数 | -           | -        |
-
 ---$
 {{qinpengfei}}

package/components/ste-toast/ste-toast.easycom.json

@@ -68,6 +68,20 @@
             "name": "close",
             "description": "提示关闭的的回调函数",
             "type": "() => void"
+        },
+        {
+            "name": "[method]showToast",
+            "description": "提示打开函数",
+            "params": [
+                {
+                    "name": "props",
+                    "description": "配置项"
+                }
+            ]
+        },
+        {
+            "name": "[method]hideToast",
+            "description": "关闭提示函数"
         }
     ]
 }

package/components/ste-touch-swipe/ATTRIBUTES.md

@@ -1,4 +1,6 @@
-#### Props
+## API
+
+### Props
 | 属性名 | 说明  | 类型 | 默认值  | 可选值 | 支持版本 |
 | ----- | ----- | --- | ------- | ------ | -------- |
 | `index` | 当前展示的面板索引 | `number` | `0` | - | - |
@@ -12,7 +14,9 @@
 | `disabledIndexs` | 禁用的面板索引（使用touch-swipe-item作为子元素时直接在touch-swipe-item上定义某个标签禁用即可，不使用touch-swipe-item作为子元素盒子时可传） | `Array<number>` | `[]` | - | - |
 
 
-#### Events
+### Events
 | 事件名 | 说明  | 事件参数 | 支持版本 |
 | ----- | ----- | ------- | -------- |
 | `change` | 切换触发 | `index`：当前展示的面板索引 | - |
+
+

package/components/ste-touch-swipe/README.md

@@ -4,7 +4,7 @@
 
 ---$
 
-#### 水平切换，固定宽度
+## 水平切换，固定宽度
 
 - 外层使用`ste-touch-swipe`父标签包裹
     - `index`属性设置当前激活区域，支持`v-model`双向绑定
@@ -50,7 +50,7 @@
 </template>
 ```
 
-#### 垂直切换，固定高度
+## 垂直切换，固定高度
 
 - 外层使用`ste-touch-swipe`父标签包裹
     - `height`属性设置区域高度，默认`100%`
@@ -97,17 +97,15 @@
 
 ---$
 
-### API
-
 <!-- props -->
 
-### touch-swipe Methods
+## touch-swipe Methods
 
 | 事件名 | 说明                               | 事件参数 |
 | ------ | ---------------------------------- | -------- |
 | `init` | 初始化元素信息，请在渲染完成后调用 | -        |
 
-### touch-swipe-item Props
+## touch-swipe-item Props
 
 | 参数       | 说明                                             | 类型      | 默认值  | 可选值 |
 | ---------- | ------------------------------------------------ | --------- | ------- | ------ |

package/components/ste-touch-swipe/ste-touch-swipe.easycom.json

@@ -71,7 +71,6 @@
         {
             "name": "[event]change",
             "description": "切换触发",
-            "type": "(index:number)=>void",
             "params": [
                 {
                     "name": "index",
@@ -80,4 +79,4 @@
             ]
         }
     ]
-}
+}

package/components/ste-tour/ATTRIBUTES.md

@@ -1,4 +1,6 @@
-#### Props
+## API
+
+### Props
 | 属性名 | 说明  | 类型 | 默认值  | 可选值 | 支持版本 |
 | ----- | ----- | --- | ------- | ------ | -------- |
 | `show` | 是否显示，支持v-model:show双向绑定 | `boolean` | `false` | - | - |
@@ -19,8 +21,10 @@
 | `completeTxt` | 完成按钮文字 | `string` | `完成` | - | - |
 
 
-#### Events
+### Events
 | 事件名 | 说明  | 事件参数 | 支持版本 |
 | ----- | ----- | ------- | -------- |
 | `change` | 步骤切换时触发 | `current`：当前步骤 | - |
-| `close` | 关闭时触发 | - | - |
+| `close` | 关闭时触发 | `data`：()=>void | - |
+
+

package/components/ste-tour/README.md

@@ -15,7 +15,7 @@
 }
 ```
 
-### 基础用法
+## 基础用法
 
 - 属性`show`用于控制显示隐藏
 - 属性`steps`用于设置步骤内容，数组形式，数组中每个元素是一个对象，对象包含以下属性
@@ -41,7 +41,7 @@
 </template>
 ```
 
-### 位置偏移量
+## 位置偏移量
 
 - 属性`offset`用于设置位置偏移量，数组形式，数组中两个元素分别表示横纵方向上的偏移量
 
@@ -59,7 +59,7 @@
 </template>
 ```
 
-### 插槽
+## 插槽
 
 - 默认插槽可以自定义描述内容，插槽参数`item`为当前步骤信息
 - 属性`messageBg`可以将默认背景改为透明，然后通过插槽自定义背景样式，实现自定义描述内容。
@@ -81,7 +81,7 @@
 </template>
 ```
 
-### 多步骤，显示标题栏
+## 多步骤，显示标题栏
 
 - 属性`offset`用于设置位置偏移量，数组形式，数组中两个元素分别表示横纵方向上的偏移量
 
@@ -106,7 +106,7 @@
 </template>
 ```
 
-### 不显示背景蒙层
+## 不显示背景蒙层
 
 - 属性`mask`用于设置是否显示背景蒙层，默认显示
 
@@ -126,8 +126,6 @@
 
 ---$
 
-### API
-
 <!-- props -->
 
 ---$

package/components/ste-tour/ste-tour.easycom.json

@@ -26,7 +26,10 @@
             "name": "offset",
             "description": "位置偏移量，格式为：[x, y]",
             "type": "[number, number]",
-            "default": [0, 0]
+            "default": [
+                0,
+                0
+            ]
         },
         {
             "name": "showTitleBar",
@@ -103,7 +106,6 @@
         {
             "name": "[event]change",
             "description": "步骤切换时触发",
-            "type": "(current:number)=>void",
             "params": [
                 {
                     "name": "current",
@@ -114,7 +116,12 @@
         {
             "name": "[event]close",
             "description": "关闭时触发",
-            "type": "()=>void"
+            "params": [
+                {
+                    "name": "data",
+                    "description": "()=>void"
+                }
+            ]
         }
     ]
-}
+}

package/components/ste-tree/ATTRIBUTES.md

@@ -1,4 +1,6 @@
-#### Props
+## API
+
+### Props
 | 属性名 | 说明  | 类型 | 默认值  | 可选值 | 支持版本 |
 | ----- | ----- | --- | ------- | ------ | -------- |
 | `options` | 树形结构数组（Node结构见基础用法详情 ），若组件渲染完成后修此属性，请手动调用init方法 | `Array<TreeNode>` | `[]` | - | - |
@@ -10,10 +12,21 @@
 | `openNodes` | 默认展开的节点数组 | `Array<number / string>` | `[]` | - | - |
 
 
-#### Events
+### Events
 | 事件名 | 说明  | 事件参数 | 支持版本 |
 | ----- | ----- | ------- | -------- |
 | `click` | 点击节点时触发 | `node`：当前点击的节点 | - |
 | `open` | 打开节点时出发 | `node`：当前打开的节点 | - |
 | `close` | 关闭节点时出发 | `node`：当前关闭的节点 | - |
 | `beforeOpen` | 打开节点前触发 | `node`：当前即将打开的节点<br/>`suspend`：调用该函数等待后续操作<br/>`next`：调用该函数继续执行后续代码，可接收一个对象数组，该数组会替换当前节点的children<br/>`stop`：调用该函数阻止后续代码执行 | - |
+
+
+### Methods
+| 方法名 | 说明  | 参数 | 返回值 | 支持版本 |
+| ----- | ----- | --- | ------ | -------- |
+| `init` | 初始化方法，若`options`改变时页面没有更新，可调用此方法重现渲染 | - | - | - |
+| `open` | 打开指定节点 | - | - | - |
+| `close` | 关闭指定节点 | - | - | - |
+| `search` | 节点搜索 | - | - | - |
+
+

package/components/ste-tree/README.md

@@ -6,7 +6,7 @@
 
 ## 使用示例
 
-### 基础用法
+## 基础用法
 
 - 属性`options`用于设置折叠面板的选项，类型为树形结构
 
@@ -70,7 +70,7 @@
 </template>
 ```
 
-### 默认展开节点，打开/关闭指定节点
+## 默认展开节点，打开/关闭指定节点
 
 - 属性`openNodes`用于设置默认展开的节点，默认展开的节点数组（数组内容为节点value值，请在组件加载前设置，加载后若要展开请调用open方法）
 - 方法`open`用于打开指定节点
@@ -132,7 +132,7 @@
 </template>
 ```
 
-### 节点搜索
+## 节点搜索
 
 - 属性`searchTitle`用于搜索节点
 - 也可以使用方法`search(keyword)`进行搜索
@@ -181,7 +181,7 @@
 </template>
 ```
 
-### 非手风琴模式(展开时不关闭兄弟节点)
+## 非手风琴模式(展开时不关闭兄弟节点)
 
 - 属性`accordion`用于设置是否为手风琴模式，默认为`true`
 
@@ -227,7 +227,7 @@
 </template>
 ```
 
-### 懒加载
+## 懒加载
 
 - `options`中对象没有子集`children`时，将属性`hasChildren`设置为`true`可展示`open`按钮
 - 事件`beforeOpen`用于监听用户点击`open`时，打开指定节点前触发
@@ -297,7 +297,7 @@
 </template>
 ```
 
-### 自定义内容
+## 自定义内容
 
 - 插槽`default`用于自定义节点标题
 - 插槽`open`用于自定义节点展开按钮图标，大小不得超过30rpx
@@ -358,18 +358,7 @@
 
 ---$
 
-### API
-
 <!-- props -->
 
-#### Method
-
-| 方法名   | 说明                                                            | 方法参数 | 支持版本 |
-| -------- | --------------------------------------------------------------- | -------- | -------- |
-| `init`   | 初始化方法，若`options`改变时页面没有更新，可调用此方法重现渲染 | -        | -        |
-| `open`   | 打开指定节点                                                    | `value`  | -        |
-| `close`  | 关闭指定节点                                                    | `value`  | -        |
-| `search` | 节点搜索                                                        | `title`  | -        |
-
 ---$
 {{xuyajun}}

package/components/ste-tree/ste-tree.easycom.json

@@ -49,7 +49,6 @@
         {
             "name": "[event]click",
             "description": "点击节点时触发",
-            "type": "(node:TreeNode)=>void",
             "params": [
                 {
                     "name": "node",
@@ -60,7 +59,6 @@
         {
             "name": "[event]open",
             "description": "打开节点时出发",
-            "type": "(node:TreeNode)=>void",
             "params": [
                 {
                     "name": "node",
@@ -71,7 +69,6 @@
         {
             "name": "[event]close",
             "description": "关闭节点时出发",
-            "type": "(node:TreeNode)=>void",
             "params": [
                 {
                     "name": "node",
@@ -82,7 +79,6 @@
         {
             "name": "[event]beforeOpen",
             "description": "打开节点前触发",
-            "type": "(node:TreeNode,suspend:()=>void,next:(tree:TreeNode[])=>void,stop:()=>void)=>void",
             "params": [
                 {
                     "name": "node",
@@ -101,6 +97,22 @@
                     "description": "调用该函数阻止后续代码执行"
                 }
             ]
+        },
+        {
+            "name": "[method]init",
+            "description": "初始化方法，若`options`改变时页面没有更新，可调用此方法重现渲染"
+        },
+        {
+            "name": "[method]open",
+            "description": "打开指定节点"
+        },
+        {
+            "name": "[method]close",
+            "description": "关闭指定节点"
+        },
+        {
+            "name": "[method]search",
+            "description": "节点搜索"
         }
     ]
 }

package/components/ste-upload/ATTRIBUTES.md

@@ -1,4 +1,6 @@
-#### Props
+## API
+
+### Props
 | 属性名 | 说明  | 类型 | 默认值  | 可选值 | 支持版本 |
 | ----- | ----- | --- | ------- | ------ | -------- |
 | `modelValue` | 文件列表 | `Array<UploadFileType>` | `[]` | - | - |
@@ -23,7 +25,7 @@
 | `flexWrap` | 子元素是否换行 | `string` | `wrap` | `wrap`：换行<br/>`nowrap`：不换行 | - |
 
 
-#### Events
+### Events
 | 事件名 | 说明  | 事件参数 | 支持版本 |
 | ----- | ----- | ------- | -------- |
 | `beforeRead` | 文件读取前触发 | `fileList`：即将选择的文件列表<br/>`suspend`：等待<br/>`next`：继续<br/>`stop`：停止 | - |
@@ -31,7 +33,17 @@
 | `oversize` | 文件大小超出限制触发 | `file`：超出限制的第一个文件<br/>`fileList`：选择的文件列表 | - |
 | `beforeDelete` | 文件删除前触发 | `index`：正在删除的文件下标<br/>`suspend`：等待<br/>`next`：继续<br/>`stop`：停止 | - |
 | `delete` | 文件删除后触发 | `index`：删除的文件下标<br/>`fileList`：删除后的文件列表 | - |
-| `open-preview` | 打开预览时触发 | - | - |
-| `preview-change` | 预览图片变化触发 | - | - |
-| `close-preview` | 关闭预览时触发 | - | - |
+| `open-preview` | 打开预览时触发 | `data`：()=>void | - |
+| `preview-change` | 预览图片变化触发 | `data`：(index:number / null)=>void | - |
+| `close-preview` | 关闭预览时触发 | `data`：()=>void | - |
 | `click-item` | 点击文件触发 | `index`：文件下标 | - |
+
+
+### Slots
+| 插槽名 | 说明  | 参数 | 支持版本 |
+| ----- | ----- | --- | -------- |
+| `default` | 上传按钮 | - | - |
+| `preview-cover` | 每一份文件的预览图层样式 | `file`：当前文件 | - |
+| `media-preview` | 图片放大预览（媒体预览组件带默认插槽） | - | - |
+
+

package/components/ste-upload/README.md

@@ -4,7 +4,7 @@
 
 ---$
 
-#### 基础用法
+## 基础用法
 
 - `v-model`双向绑定接收一个对象数组，对象包含以下属性
     - `url`：文件路径（与path二选一必须）
@@ -49,7 +49,7 @@
 </script>
 ```
 
-#### 文件类型，多选
+## 文件类型，多选
 
 - `accept`属性可以设置选择文件类型：可选值有
     - `image`：图片类型（默认）
@@ -76,7 +76,7 @@
 </script>
 ```
 
-#### 限制上传数量
+## 限制上传数量
 
 - `maxCount`属性可以设置最大上传数量，超出数量后，无法继续选择文件
 
@@ -98,7 +98,7 @@
 </script>
 ```
 
-#### 限制文件大小
+## 限制文件大小
 
 - `maxSize`属性可以设置可上传文件的大小，超出大小无法选择
 
@@ -108,7 +108,7 @@
 </template>
 ```
 
-#### 自定义上传样式
+## 自定义上传样式
 
 - 默认插槽可自定义上传按钮样式
 
@@ -120,7 +120,7 @@
 </template>
 ```
 
-#### 自定义预览图层
+## 自定义预览图层
 
 - 具名插槽`preview-cover`可自定义每一份文件的预览图层样式
 
@@ -146,7 +146,7 @@
 </style>
 ```
 
-#### 读取文件前置处理
+## 读取文件前置处理
 
 - 事件`beforeRead`在文件选择前触发，参数如下：
     - 第一个参数为正在读取的`fileList`
@@ -175,7 +175,7 @@
 </script>
 ```
 
-#### 删除前置处理
+## 删除前置处理
 
 - 事件`beforeDelete`在文件选择前触发，参数如下：
     - 第一个参数为正在删除的`index`
@@ -214,7 +214,7 @@
 </script>
 ```
 
-#### 媒体预览插槽
+## 媒体预览插槽
 
 - 事件`previewChange`监听媒体预览区域切换，参数为当前预览的索引或者`null`；
 - 插槽`media-preview`可自定义媒体预览区域底部内容
@@ -244,18 +244,7 @@
 
 ---$
 
-### API
-
 <!-- props -->
 
-#### 组件插槽(Slots)
-
-| 插槽名  | 说明         | 插槽参数 | 支持版本 |
-| ------- | ------------ | -------- | -------- |
-| default | 上传按钮 | -        | -        |
-| preview-cover | 每一份文件的预览图层样式 | 当前文件        | -        |
-| media-preview | 图片放大预览（媒体预览组件带默认插槽） | -        | -        |
-
-
 ---$
 {{xuyajun}}