stellar-ui-plus 1.25.1 → 1.25.3

package/components/ste-table/README.md

@@ -4,9 +4,9 @@
 
 ---$
 
-### 代码演示
+## 代码演示
 
-#### 基础使用
+## 基础使用
 
 ```html
 <script lang="ts" setup>
@@ -30,7 +30,7 @@
 </template>
 ```
 
-#### 带边框
+## 带边框
 
 ```html
 <script lang="ts" setup>
@@ -54,7 +54,7 @@
 </template>
 ```
 
-#### 空数据显示
+## 空数据显示
 
 - 通过`table`中的`emptyText`属性来指定单元格中数据为空时显示的值，否则显示`-`
 - 也可以通过插槽来自定义空数据时显示
@@ -85,7 +85,7 @@
 </template>
 ```
 
-#### 列类型
+## 列类型
 
 通过指定某列上的`type`属性
 
@@ -128,7 +128,7 @@
 </template>
 ```
 
-#### 禁用或只读选择项
+## 禁用或只读选择项
 
 传入一个自定义方法来指定某行是否能选择，方法会传入当前行数据(`row`)和下标(`index`)
 只读同理
@@ -162,7 +162,7 @@
 </template>
 ```
 
-#### 显示合计
+## 显示合计
 
 - 通过`showSummary`控制是否显示合计，`sumText`控制合计行第一列的文本
 - `summaryMethod`来指定合计的方法，需要返回一个数组来确定每一列合计显示的内容
@@ -199,7 +199,7 @@
 </template>
 ```
 
-#### 对齐方式
+## 对齐方式
 
 - 通过`align`指定某列的单元格的对齐方式
 - `headerAlign`指定表头的单元格对齐方式， 没设置时跟随`align`值
@@ -216,7 +216,7 @@
 </template>
 ```
 
-#### 表格方法
+## 表格方法
 
 ```html
 <script lang="ts" setup>
@@ -259,7 +259,7 @@
 </template>
 ```
 
-#### 表格滚动
+## 表格滚动
 
 此时需要给表格设置高度`height`，并保证表体高度是大于此高度，此时表格可以滚动，且滚动到底部时触发`scrollToLower`事件
 
@@ -295,7 +295,7 @@
 </template>
 ```
 
-#### 自定义列
+## 自定义列
 
 当需要格式化某列时，可以不设置列的`prop`，但需要设置`customKey`值，然后给表格传入一个`formatter`方法，
 方法中第一个参数是每一行的数据，第二个参数是列的`customKey`，示例如下
@@ -341,7 +341,7 @@
 </template>
 ```
 
-#### 动态设置表头
+## 动态设置表头
 
 当需要动态设置表头，可以不设置列的`label`，但需要设置`customKey`值，然后给表格传入一个`header`方法，
 方法中第一个参数是列的数据，第二个参数是表格的数据`data`，示例如下
@@ -374,7 +374,7 @@
 </template>
 ```
 
-#### 自定义边框样式
+## 自定义边框样式
 
 表格边框样式不满足时，可通过css更改样式
 
@@ -487,7 +487,7 @@
 </style>
 ```
 
-#### 自定义行或单元格样式
+## 自定义行或单元格样式
 
 ```html
 <script lang="ts" setup>
@@ -558,7 +558,7 @@
 </template>
 ```
 
-#### 高亮行
+## 高亮行
 
 `highlight-current-row`为`true`点击某一行时会高亮显示
 `hightlight-selection-row`为`true`时，列类型为`checkbox`时，勾选后会高亮
@@ -576,7 +576,7 @@
 </template>
 ```
 
-#### 配置选择项图标色
+## 配置选择项图标色
 
 需要指定属性`selectionIconColor`，数据结构如下
 
@@ -589,7 +589,7 @@
 }
 ```
 
-#### 单元格超出长按显示气泡
+## 单元格超出长按显示气泡
 
 ```html
 <script lang="ts" setup>
@@ -618,7 +618,7 @@
 </template>
 ```
 
-#### 合并单元格
+## 合并单元格
 
 当某列的数据为数组类型时，该列会自动触发合并单元格模式，将数组中的每个元素作为一行展示。这在需要展示一对多关系的数据时非常有用。
 
@@ -672,9 +672,9 @@
 
 ---$
 
-### API
+## API
 
-#### Table Props
+## Table Props
 
 | 属性名                  | 说明                                                                                                  | 类型                                       | 默认值     | 可选值 | 支持版本 |
 | ----------------------- | ----------------------------------------------------------------------------------------------------- | ------------------------------------------ | ---------- | ------ | -------- |
@@ -703,7 +703,7 @@
 | `showHeader`            | 是否显示表头                                                                                          | `Boolean`                                  | `true`     | -      | -        |
 | `maxHeight`             | 表格最大高度                                                                                          | `Number/String`                            | -          | -      | -        |
 
-#### Table Events
+## Table Events
 
 | 事件名          | 说明                                         | 事件参数                                                              | 支持版本 |
 | --------------- | -------------------------------------------- | --------------------------------------------------------------------- | -------- |
@@ -716,7 +716,7 @@
 
 <!-- props -->
 
-#### Table Method
+## Table Method
 
 | 方法名               | 说明                               | 方法参数                                                                         | 支持版本 |
 | -------------------- | ---------------------------------- | -------------------------------------------------------------------------------- | -------- |
@@ -725,7 +725,7 @@
 | `toggleAllSelection` | 用于多选表格，切换所有行的选中状态 | -                                                                                | -        |
 | `getSelection`       | 获取当前表格的选中状态的数据       | -                                                                                | -        |
 
-#### TableColumn Props
+## TableColumn Props
 
 | 属性名        | 说明                                             | 类型     | 默认值 | 可选值                                                                                    | 支持版本 |
 | ------------- | ------------------------------------------------ | -------- | ------ | ----------------------------------------------------------------------------------------- | -------- |

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

@@ -79,7 +79,6 @@
             "description": "格式化表头内容的方法，同formatter属性，需要定义customKey属性",
             "type": "function"
         },
-
         {
             "name": "headerRowClassName",
             "description": "表头行的 className 的回调方法，也可以使用字符串为所有表头行设置一个固定的 className",
@@ -166,33 +165,63 @@
         {
             "name": "[event]select",
             "description": "当用户手动勾选数据行的 Checkbox 时触发的事件",
-            "type": "() => void"
+            "params": [
+                {
+                    "name": "data",
+                    "description": "() => void"
+                }
+            ]
         },
         {
             "name": "[event]selectAll",
             "description": "当用户手动勾选全选 Checkbox 时触发的事件",
-            "type": "() => void"
+            "params": [
+                {
+                    "name": "data",
+                    "description": "() => void"
+                }
+            ]
         },
         {
             "name": "[event]cellClick",
             "description": "当某个单元格被点击时会触发该事件",
-            "type": "() => void"
+            "params": [
+                {
+                    "name": "data",
+                    "description": "() => void"
+                }
+            ]
         },
         {
             "name": "[event]rowClick",
             "description": "当某一行被点击时会触发该事件",
-            "type": "() => void"
+            "params": [
+                {
+                    "name": "data",
+                    "description": "() => void"
+                }
+            ]
         },
         {
             "name": "[event]headerClick",
             "description": "当某一列的表头被点击时会触发该事件",
-            "type": "() => void"
+            "params": [
+                {
+                    "name": "data",
+                    "description": "() => void"
+                }
+            ]
         },
         {
             "name": "[event]scrollToLower",
             "description": "表格体滚动到底事件",
-            "type": "() => void",
-            "version": "v1.18.9"
+            "version": "v1.18.9",
+            "params": [
+                {
+                    "name": "data",
+                    "description": "() => void"
+                }
+            ]
         }
     ]
-}
+}

package/components/ste-tabs/ATTRIBUTES.md

@@ -1,4 +1,6 @@
-#### Props
+## API
+
+### Props
 | 属性名 | 说明  | 类型 | 默认值  | 可选值 | 支持版本 |
 | ----- | ----- | --- | ------- | ------ | -------- |
 | `active` | 当前激活的选项支持v-model:active双向绑定（类型为number时绑定index，类型为string时绑定name） | `number / string` | `0` | - | - |
@@ -17,6 +19,7 @@
 | `ellipsis` | 是否省略过长的标题文字 | `boolean` | `false` | - | - |
 | `tabWidth` | tab内容的宽度 | `number / string` | `auto` | - | - |
 | `tabPadding` | 选项内边距，默认24，单位rpx | `number / string` | `24` | - | - |
+| `tabLineGap` | tab到下划线的距离，默认单位rpx | `number / string` | `4` | - | - |
 | `tabSpace` | tab间距rpx | `number / string` | `0` | - | - |
 | `divideNum` | tab等分数量，设置为 0 ，则不等分 | `number / string` | `4` | - | - |
 | `sticky` | 是否使用粘性布局 | `boolean` | `false` | - | - |
@@ -45,8 +48,10 @@
 | `maskZindex` | 下拉蒙层层级 | `number / string` | `1001` | - | - |
 
 
-#### Events
+### Events
 | 事件名 | 说明  | 事件参数 | 支持版本 |
 | ----- | ----- | ------- | -------- |
-| `click-tab` | 点击tab触发 | - | - |
-| `change` | 切换tab触发 | - | - |
+| `click-tab` | 点击tab触发 | `data`：(tab:TabProps)=>void | - |
+| `change` | 切换tab触发 | `data`：(tab:TabProps)=>void | - |
+
+

package/components/ste-tabs/README.md

@@ -4,7 +4,7 @@
 
 ---$
 
-### 代码演示
+## 代码演示
 
 ```html
 <script setup lang="ts">
@@ -133,17 +133,15 @@
 
 ---$
 
-### API
-
 <!-- props -->
 
-#### Tabs Slot
+## Tabs Slot
 
 | 插槽名    | 说明                              | 插槽参数 | 支持版本 |
 | --------- | --------------------------------- | -------- | -------- |
 | `default` | 默认插槽，请传入`ste-tab`标签列表 | -        | -        |
 
-#### Tab Props
+## Tab Props
 
 | 属性名          | 说明                                                                 | 类型              | 默认值  | 可选值 | 支持版本 |
 | --------------- | -------------------------------------------------------------------- | ----------------- | ------- | ------ | -------- |
@@ -157,7 +155,7 @@
 | `badge`         | 右上角徽标的内容                                                     | `String`/`Number` | `0`     | -      | -        |
 | `showZeroBadge` | 当 badge 为数字 0 时，是否展示徽标                                   | `Boolean`         | `false` | -      | -        |
 
-#### Tab Slot
+## Tab Slot
 
 | 插槽名          | 说明                                         | 插槽参数 | 支持版本   |
 | --------------- | -------------------------------------------- | -------- | ---------- |

package/components/ste-tabs/props.ts

@@ -17,6 +17,7 @@ export interface SteTabsProps {
   ellipsis: boolean
   tabWidth: number | string
   tabPadding: number | string
+  tabLineGap: number | string
   tabSpace: number | string
   divideNum: number
   sticky: boolean
@@ -78,6 +79,8 @@ export default {
   tabWidth: { type: [String, Number], default: () => 'auto' },
   // 选项内边距，默认24，单位rpx
   tabPadding: { type: [Number, String], default: () => 24 },
+  // tab到下划线的距离，默认单位rpx
+  tabLineGap: { type: [Number, String], default: () => 4 },
   // tab间距rpx
   tabSpace: { type: [Number, String], default: () => 0 },
   // tab等分数量，设置为 0 ，则不等分

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

@@ -108,6 +108,12 @@
             "type": "number | string",
             "default": 24
         },
+        {
+            "name": "tabLineGap",
+            "description": "tab到下划线的距离，默认单位rpx",
+            "type": "number | string",
+            "default": 4
+        },
         {
             "name": "tabSpace",
             "description": "tab间距rpx",
@@ -267,12 +273,22 @@
         {
             "name": "[event]click-tab",
             "description": "点击tab触发",
-            "type": "(tab:TabProps)=>void"
+            "params": [
+                {
+                    "name": "data",
+                    "description": "(tab:TabProps)=>void"
+                }
+            ]
         },
         {
             "name": "[event]change",
             "description": "切换tab触发",
-            "type": "(tab:TabProps)=>void"
+            "params": [
+                {
+                    "name": "data",
+                    "description": "(tab:TabProps)=>void"
+                }
+            ]
         }
     ]
 }

package/components/ste-tabs/useData.ts

@@ -136,7 +136,7 @@ export default function useData({
       '--tabs-line-height': utils.formatPx(props.lineHeight),
       '--tabs-tab-width': tabWidth,
       '--tabs-tab-padding': utils.formatPx(props.tabPadding),
-      '--tabs-tab-padding-bottom': cmpShowLine.value ? utils.formatPx(4) : utils.formatPx(props.tabPadding),
+      '--tabs-tab-padding-bottom': cmpShowLine.value ? utils.formatPx(props.tabLineGap) : utils.formatPx(props.tabPadding),
       '--tabs-transition-duration': props.duration ? `${props.duration}s` : 'inherit',
       '--tabs-tab-space': tabSpace,
       '--tabs-tab-space-line': tabSpaceLine,

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 @@
             ]
         }
     ]
-}
+}