stellar-ui-plus 1.25.1 → 1.25.3

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}}

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

@@ -169,7 +169,6 @@
         {
             "name": "[event]beforeRead",
             "description": "文件读取前触发",
-            "type": "(fileList:Array<UploadFileType>,suspend:()=>void,next()=>void,stop:()=>void)=>void",
             "params": [
                 {
                     "name": "fileList",
@@ -192,7 +191,6 @@
         {
             "name": "[event]read",
             "description": "文件读完成触发",
-            "type": "(fileList:Array<UploadFileType>)=>void",
             "params": [
                 {
                     "name": "fileList",
@@ -203,7 +201,6 @@
         {
             "name": "[event]oversize",
             "description": "文件大小超出限制触发",
-            "type": "(file,fileList:Array<UploadFileType>)=>void",
             "params": [
                 {
                     "name": "file",
@@ -218,7 +215,6 @@
         {
             "name": "[event]beforeDelete",
             "description": "文件删除前触发",
-            "type": "(index:number,suspend:()=>void,next()=>void,stop:()=>void)=>void",
             "params": [
                 {
                     "name": "index",
@@ -241,7 +237,6 @@
         {
             "name": "[event]delete",
             "description": "文件删除后触发",
-            "type": "(index:number,fileList:Array<UploadFileType>)=>void",
             "params": [
                 {
                     "name": "index",
@@ -256,28 +251,60 @@
         {
             "name": "[event]open-preview",
             "description": "打开预览时触发",
-            "type": "()=>void"
+            "params": [
+                {
+                    "name": "data",
+                    "description": "()=>void"
+                }
+            ]
         },
         {
             "name": "[event]preview-change",
             "description": "预览图片变化触发",
-            "type": "(index:number | null)=>void"
+            "params": [
+                {
+                    "name": "data",
+                    "description": "(index:number | null)=>void"
+                }
+            ]
         },
         {
             "name": "[event]close-preview",
             "description": "关闭预览时触发",
-            "type": "()=>void"
+            "params": [
+                {
+                    "name": "data",
+                    "description": "()=>void"
+                }
+            ]
         },
         {
             "name": "[event]click-item",
             "description": "点击文件触发",
-            "type": "(index:number)=>void",
             "params": [
                 {
                     "name": "index",
                     "description": "文件下标"
                 }
             ]
+        },
+        {
+            "name": "[slot]default",
+            "description": "上传按钮"
+        },
+        {
+            "name": "[slot]preview-cover",
+            "description": "每一份文件的预览图层样式",
+            "params": [
+                {
+                    "name": "file",
+                    "description": "当前文件"
+                }
+            ]
+        },
+        {
+            "name": "[slot]media-preview",
+            "description": "图片放大预览（媒体预览组件带默认插槽）"
         }
     ]
 }

package/components/ste-user-info/ATTRIBUTES.md

@@ -1,4 +1,6 @@
-#### Props
+## API
+
+### Props
 | 属性名 | 说明  | 类型 | 默认值  | 可选值 | 支持版本 |
 | ----- | ----- | --- | ------- | ------ | -------- |
 | `avatar` | 头像 | `String` | `` | - | - |
@@ -17,10 +19,18 @@
 | `loginBtnBg` | 登录按钮背景色 | `String` | `主题色` | - | - |
 
 
-#### Events
+### Events
 | 事件名 | 说明  | 事件参数 | 支持版本 |
 | ----- | ----- | ------- | -------- |
-| `userClick` | 用户区域点击 | - | - |
+| `userClick` | 用户区域点击 | `data`：() => void | - |
 | `dataClick` | 数据点击 | `index`：当前点击的数据排序 | - |
-| `codeClick` | 功能码区域点击 | - | - |
-| `loginBtnClick` | 登录按钮点击 | - | - |
+| `codeClick` | 功能码区域点击 | `data`：() => void | - |
+| `loginBtnClick` | 登录按钮点击 | `data`：() => void | - |
+
+
+### Slots
+| 插槽名 | 说明  | 参数 | 支持版本 |
+| ----- | ----- | --- | -------- |
+| `desc` | 用户描述 | - | - |
+
+

package/components/ste-user-info/README.md

@@ -6,7 +6,7 @@
 
 ## 代码演示
 
-### 基本使用
+## 基本使用
 
 - 通过 `avatar`设置头像，默认为``
 - 通过 `nickname`设置昵称，默认为``
@@ -128,7 +128,7 @@
 </style>
 ```
 
-### 用户信息隐藏
+## 用户信息隐藏
 
 - 通过 `showUserInfo`设置是否展示用户相关，默认为`true`
 
@@ -188,7 +188,7 @@
 </style>
 ```
 
-### 核销码隐藏
+## 核销码隐藏
 
 - 通过 `showCode`设置核销码隐藏，默认为`true`
 
@@ -276,7 +276,7 @@
 </style>
 ```
 
-### 用户信息和核销码隐藏
+## 用户信息和核销码隐藏
 
 ```html
 <script lang="ts" setup>
@@ -334,7 +334,7 @@
 </style>
 ```
 
-### 未登录状态
+## 未登录状态
 
 - 通过 `loginStatus`设置登录状态，`0`：未登录，`1`：登录，默认为`1`
 - 通过 `loginSrc`设置未登录头像，默认为``
@@ -399,15 +399,7 @@
 
 ---$
 
-### API
-
 <!-- props -->
 
-#### Slots
-
-| 插槽名 | 说明     | 插槽参数 | 支持版本 |
-| ------ | -------- | -------- | -------- |
-| `desc` | 用户描述 | -        | -        |
-
 ---$
 {{qinpengfei}}

package/components/ste-user-info/ste-user-info.easycom.json

@@ -101,12 +101,16 @@
         {
             "name": "[event]userClick",
             "description": "用户区域点击",
-            "type": "() => void"
+            "params": [
+                {
+                    "name": "data",
+                    "description": "() => void"
+                }
+            ]
         },
         {
             "name": "[event]dataClick",
             "description": "数据点击",
-            "type": "(index : string | number) => void",
             "params": [
                 {
                     "name": "index",
@@ -117,12 +121,26 @@
         {
             "name": "[event]codeClick",
             "description": "功能码区域点击",
-            "type": "() => void"
+            "params": [
+                {
+                    "name": "data",
+                    "description": "() => void"
+                }
+            ]
         },
         {
             "name": "[event]loginBtnClick",
             "description": "登录按钮点击",
-            "type": "() => void"
+            "params": [
+                {
+                    "name": "data",
+                    "description": "() => void"
+                }
+            ]
+        },
+        {
+            "name": "[slot]desc",
+            "description": "用户描述"
         }
     ]
 }

package/components/ste-video/ATTRIBUTES.md

@@ -1,4 +1,6 @@
-#### Props
+## API
+
+### Props
 | 属性名 | 说明  | 类型 | 默认值  | 可选值 | 支持版本 |
 | ----- | ----- | --- | ------- | ------ | -------- |
 | `title` | 视频的标题，全屏时在顶部展示 | `string` | `` | - | - |

package/components/ste-video/README.md

@@ -4,9 +4,9 @@
 
 ---$
 
-### 代码演示
+## 代码演示
 
-#### 基础使用
+## 基础使用
 
 默认视频宽度会根据父容器的宽度撑满
 
@@ -16,7 +16,7 @@
 </template>
 ```
 
-#### 可选择清晰度
+## 可选择清晰度
 
 配置`resolution`后会在全屏时显示清晰度选择选项，数据结构如下
 
@@ -35,15 +35,11 @@
 
 ---$
 
-### API
-
-#### 组件属性(Props)
-
 <!-- props -->
 
 其他属性可参考原生[video](https://zh.uniapp.dcloud.io/component/video.html)
 
-#### 组件事件(Events)
+## 组件事件(Events)
 
 事件可参考原生[video](https://zh.uniapp.dcloud.io/component/video.html)