stellar-ui-plus 1.25.1 → 1.25.3

package/components/ste-media-preview/README.md

@@ -4,17 +4,17 @@
 
 ---$
 
--   APP兼容性问题
-    -   APP对于视频预览只支持单个视频预览
-    -   不支持视频图片混合预览
-    -   APP预览多个媒体时，统一当作图片处理
+- APP兼容性问题
+    - APP对于视频预览只支持单个视频预览
+    - 不支持视频图片混合预览
+    - APP预览多个媒体时，统一当作图片处理
 
-### 代码演示
+## 代码演示
 
-#### 基础用法
+## 基础用法
 
--   `show`属性控制是否展示预览弹窗，支持`sync`双向绑定
--   `urls`属性为要预览的媒体URL数组
+- `show`属性控制是否展示预览弹窗，支持`sync`双向绑定
+- `urls`属性为要预览的媒体URL数组
 
 ```html
 <template>
@@ -35,9 +35,9 @@
 </script>
 ```
 
-#### 自动轮播
+## 自动轮播
 
--   `autoplay`属性控制自动轮播间隔时间，单位为毫秒，为`0`时不轮播
+- `autoplay`属性控制自动轮播间隔时间，单位为毫秒，为`0`时不轮播
 
 ```html
 <template>
@@ -59,9 +59,9 @@
 </script>
 ```
 
-#### 前后衔接循环播放
+## 前后衔接循环播放
 
--   `loop`属性可开启前后衔接循环播放
+- `loop`属性可开启前后衔接循环播放
 
 ```html
 <template>
@@ -84,9 +84,9 @@
 </script>
 ```
 
-#### 默认展示下标为2的媒体资源
+## 默认展示下标为2的媒体资源
 
--   `index`属性可控制从第几页开始展示
+- `index`属性可控制从第几页开始展示
 
 ```html
 <template>
@@ -109,9 +109,9 @@
 </script>
 ```
 
-#### 隐藏左下角索引标签
+## 隐藏左下角索引标签
 
--   `showIndex`属性可控制左下角页签显示
+- `showIndex`属性可控制左下角页签显示
 
 ```html
 <template>
@@ -134,9 +134,9 @@
 </script>
 ```
 
-#### 双指缩放
+## 双指缩放
 
--   `scale`属性可开启双指缩放功能
+- `scale`属性可开启双指缩放功能
 
 ```html
 <template>
@@ -159,9 +159,9 @@
 </script>
 ```
 
-#### 长按触发事件
+## 长按触发事件
 
--   事件`longpress`在用户长按时触发
+- 事件`longpress`在用户长按时触发
 
 ```html
 <template>
@@ -190,10 +190,10 @@
 </script>
 ```
 
-#### 关闭前/后事件
+## 关闭前/后事件
 
--   事件`beforeClose`在关闭前被触发
--   事件`close`在关闭后被触发
+- 事件`beforeClose`在关闭前被触发
+- 事件`close`在关闭后被触发
 
 ```html
 <template>
@@ -244,16 +244,7 @@
 
 ---$
 
-### API
-
 <!-- props -->
 
-#### 组件插槽(Slots)
-
-| 插槽名  | 说明         | 插槽参数 | 支持版本 |
-| ------- | ------------ | -------- | -------- |
-| default | 默认插槽：图片底部居中展示 | -        | -        |
-
-
 ---$
 {{xuyajun}}

package/components/ste-media-preview/ste-media-preview.easycom.json

@@ -61,17 +61,26 @@
         {
             "name": "[event]beforeClose",
             "description": "关闭前触发",
-            "type": "() => void"
+            "params": [
+                {
+                    "name": "data",
+                    "description": "() => void"
+                }
+            ]
         },
         {
             "name": "[event]close",
             "description": "关闭后触发",
-            "type": "() => void"
+            "params": [
+                {
+                    "name": "data",
+                    "description": "() => void"
+                }
+            ]
         },
         {
             "name": "[event]change",
             "description": "切换时触发",
-            "type": "(index: number) => void",
             "params": [
                 {
                     "name": "index",
@@ -82,13 +91,16 @@
         {
             "name": "[event]longpress",
             "description": "长按时触发",
-            "type": "(index: number) => void",
             "params": [
                 {
                     "name": "index",
                     "description": "当前下标"
                 }
             ]
+        },
+        {
+            "name": "[slot]default",
+            "description": "默认插槽：图片底部居中展示"
         }
     ]
 }

package/components/ste-message-box/ATTRIBUTES.md

@@ -1,4 +1,6 @@
-#### Props
+## API
+
+### Props
 | 属性名 | 说明  | 类型 | 默认值  | 可选值 | 支持版本 |
 | ----- | ----- | --- | ------- | ------ | -------- |
 | `title` | 提示的标题 | `String` | `` | - | - |

package/components/ste-message-box/README.md

@@ -4,9 +4,9 @@
 
 ---$
 
-### 使用方法
+## 使用方法
 
-#### 组合函数使用方法
+## 组合函数使用方法
 
 ps：注意 目前 useMessageBox 只能在 setup 作用域下使用  
 父组件引入组件 组合函数调用showMsgBox方法，打开轻提示
@@ -25,7 +25,7 @@ ps：注意 目前 useMessageBox 只能在 setup 作用域下使用
 </template>
 ```
 
-#### Ref用法
+## Ref用法
 
 父组件引入组件 绑定ref 通过ref调用showMsgBox方法，打开轻提示
 
@@ -46,7 +46,7 @@ ps：注意 目前 useMessageBox 只能在 setup 作用域下使用
 </template>
 ```
 
-#### 全局引入
+## 全局引入
 
 配合 [https://github.com/smartXJ/vue3-inset-loader](https://github.com/smartXJ/vue3-inset-loader) 插件， 将 ste-message-box 节点置于每个页面中，可以更进一步简化使用
 
@@ -61,9 +61,9 @@ insetLoader: {
 }
 ```
 
-### 代码演示
+## 代码演示
 
-#### 基础使用
+## 基础使用
 
 可在标题(`title`)和内容(`content`)中使用`\n`来实现换行
 
@@ -83,7 +83,7 @@ insetLoader: {
 </script>
 ```
 
-#### 带图标
+## 带图标
 
 - 内置三种图标类型：`info`、`success`、`error`
 - 当显示图标时，内容(`content`)会失效，只显示标题(`title`)
@@ -119,7 +119,7 @@ insetLoader: {
 </script>
 ```
 
-#### 自定义按钮
+## 自定义按钮
 
 ```html
 <template>
@@ -163,7 +163,7 @@ insetLoader: {
 </script>
 ```
 
-#### 显示输入框
+## 显示输入框
 
 当显示输入框时，内容(`content`)将不显示
 
@@ -188,7 +188,7 @@ insetLoader: {
 </script>
 ```
 
-#### 插槽
+## 插槽
 
 如果提供的弹框内容不满足需求，可以使用插槽自定义弹框内容。
 可以通过指定唯一标识`selector`的方式，在一个页面中使用多个`ste-message-box`，`useSteMsgBox(selector)`会返回一个指定了selector的组件实例。
@@ -216,7 +216,7 @@ insetLoader: {
 </script>
 ```
 
-#### 回调事件
+## 回调事件
 
 ```html
 <template>
@@ -263,8 +263,6 @@ insetLoader: {
 
 ---$
 
-### API
-
 <!-- props -->
 
 ---$

package/components/ste-navbar/ATTRIBUTES.md

@@ -1,4 +1,6 @@
-#### Props
+## API
+
+### Props
 | 属性名 | 说明  | 类型 | 默认值  | 可选值 | 支持版本 |
 | ----- | ----- | --- | ------- | ------ | -------- |
 | `autoBack` | 是否显示返回按钮 | `Boolean` | `true` | - | - |
@@ -19,7 +21,15 @@
 | `colorType` | 标题对齐方式 | `Number/String` | `left` | `1`：黑色<br/>`2`：白色 | - |
 
 
-#### Events
+### Events
 | 事件名 | 说明  | 事件参数 | 支持版本 |
 | ----- | ----- | ------- | -------- |
-| `backClick` | 返回按钮点击 | - | - |
+| `backClick` | 返回按钮点击 | `data`：()=>void | - |
+
+
+### Slots
+| 插槽名 | 说明  | 参数 | 支持版本 |
+| ----- | ----- | --- | -------- |
+| `default` | 导航栏内容 | - | - |
+
+

package/components/ste-navbar/README.md

@@ -6,7 +6,7 @@
 
 ## 代码演示
 
-### 基本使用
+## 基本使用
 
 通过 `title`设置导航栏标题，插槽`default`设置导航栏内容
 
@@ -16,7 +16,7 @@
 </template>
 ```
 
-### 返回按钮配置
+## 返回按钮配置
 
 - 通过 `autoBack` 属性来设置是否显示返回按钮，默认`true`
 - 通过 `backColor` 属性来设置返回按钮颜色，默认`#000`
@@ -32,7 +32,7 @@
 </template>
 ```
 
-### 标题配置
+## 标题配置
 
 - 通过 `title` 属性来设置标题文本，默认`''`
 - 通过 `titleColor` 属性来设置标题颜色，默认`#181818`
@@ -44,7 +44,7 @@
 </template>
 ```
 
-### 导航栏配置
+## 导航栏配置
 
 - 通过 `fixed` 属性来设置是否固定到顶部，默认`false`
 - 通过 `safeAreaInsetTop` 属性来设置是否开启顶部安全区适配，默认`true`
@@ -58,7 +58,7 @@
 </template>
 ```
 
-### 回调事件
+## 回调事件
 
 通过 `backClick` 获取返回按钮点击事件
 
@@ -82,15 +82,7 @@
 
 ---$
 
-### API
-
 <!-- props -->
 
-#### Slots
-
-| 插槽名    | 说明       | 插槽参数 | 支持版本 |
-| --------- | ---------- | -------- | -------- |
-| `default` | 导航栏内容 | -        | -        |
-
 ---$
 {{qinpengfei}}

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

@@ -123,7 +123,16 @@
         {
             "name": "[event]backClick",
             "description": "返回按钮点击",
-            "type": "()=>void"
+            "params": [
+                {
+                    "name": "data",
+                    "description": "()=>void"
+                }
+            ]
+        },
+        {
+            "name": "[slot]default",
+            "description": "导航栏内容"
         }
     ]
 }

package/components/ste-notice-bar/ATTRIBUTES.md

@@ -1,4 +1,6 @@
-#### Props
+## API
+
+### Props
 | 属性名 | 说明  | 类型 | 默认值  | 可选值 | 支持版本 |
 | ----- | ----- | --- | ------- | ------ | -------- |
 | `list` | 滚动数据列表 | `Array` | `[]` | - | - |
@@ -14,9 +16,18 @@
 | `scrollable` | 是否可以滚动 | `Boolean` | `true` | - | - |
 
 
-#### Events
+### Events
 | 事件名 | 说明  | 事件参数 | 支持版本 |
 | ----- | ----- | ------- | -------- |
-| `click` | 外层点击事件回调 | - | - |
-| `close` | 关闭通知栏时触发 | - | - |
-| `end` | 滚动结束时触发 | - | - |
+| `click` | 外层点击事件回调 | `data`：() => void | - |
+| `close` | 关闭通知栏时触发 | `data`：() => void | - |
+| `end` | 滚动结束时触发 | `data`：() => void | - |
+
+
+### Slots
+| 插槽名 | 说明  | 参数 | 支持版本 |
+| ----- | ----- | --- | -------- |
+| `leftIcon` | 左边图标的插槽 | - | - |
+| `rightIcon` | 右边图标的插槽 | - | - |
+
+

package/components/ste-notice-bar/README.md

@@ -4,9 +4,9 @@
 
 ---$
 
-### 代码演示
+## 代码演示
 
-#### 基础用法
+## 基础用法
 
 通过`list`数组参数设置需要滚动的内容,水平滚动。
 
@@ -20,7 +20,7 @@
 </template>
 ```
 
-#### 自定义样式
+## 自定义样式
 
 - 通过 `color` 属性设置文字颜色，默认为 `#000000`。
 - 通过 `background` 属性设置背景，默认为 `#ffffff`。
@@ -36,7 +36,7 @@
 </template>
 ```
 
-#### 垂直滚动
+## 垂直滚动
 
 通过`direction`设置滚动的方向，`across`：水平，`vertical`：垂直 水平滚动、默认`across`。
 
@@ -50,7 +50,7 @@
 </template>
 ```
 
-#### 滚动速率
+## 滚动速率
 
 通过`acrossSpeed`设置水平方向的滚动速率 `(px/s)`。
 
@@ -64,7 +64,7 @@
 </template>
 ```
 
-#### 滚动的速度
+## 滚动的速度
 
 通过`verticalSpeed`设置垂直方向的滚动的速度`（ms）`。
 
@@ -78,7 +78,7 @@
 </template>
 ```
 
-#### 延时滚动
+## 延时滚动
 
 通过`delay`设置延时`（ms）`。
 
@@ -94,7 +94,7 @@
 </template>
 ```
 
-#### 停留时间
+## 停留时间
 
 通过`standTime`设置每次滚动前停留多少毫秒(竖向滚动时有效)`（ms）`。
 
@@ -108,7 +108,7 @@
 </template>
 ```
 
-#### 是否可以滚动
+## 是否可以滚动
 
 通过`scrollable`设置公共栏是否可以滚动，默认`true`。
 
@@ -124,7 +124,7 @@
 </template>
 ```
 
-#### 取消按钮
+## 取消按钮
 
 通过`closeMode`设置是否启用关闭模式，默认`false`。
 
@@ -138,7 +138,7 @@
 </template>
 ```
 
-#### 插槽
+## 插槽
 
 通过`leftIcon`设置左边图标的插槽。
 通过`rightIcon`设置右边图标的插槽。
@@ -162,16 +162,7 @@
 
 ---$
 
-### API
-
 <!-- props -->
 
-#### 组件插槽(Slots)
-
-| 插槽名      | 说明           | 插槽参数 | 支持版本 |
-| ----------- | -------------- | -------- | -------- |
-| `leftIcon`  | 左边图标的插槽 | -        |          |
-| `rightIcon` | 右边图标的插槽 | -        |          |
-
 ---$
 {{qinpengfei}}

package/components/ste-notice-bar/ste-notice-bar.easycom.json

@@ -93,17 +93,40 @@
         {
             "name": "[event]click",
             "description": "外层点击事件回调",
-            "type": "() => void"
+            "params": [
+                {
+                    "name": "data",
+                    "description": "() => void"
+                }
+            ]
         },
         {
             "name": "[event]close",
             "description": "关闭通知栏时触发",
-            "type": "() => void"
+            "params": [
+                {
+                    "name": "data",
+                    "description": "() => void"
+                }
+            ]
         },
         {
             "name": "[event]end",
             "description": "滚动结束时触发",
-            "type": "() => void"
+            "params": [
+                {
+                    "name": "data",
+                    "description": "() => void"
+                }
+            ]
+        },
+        {
+            "name": "[slot]leftIcon",
+            "description": "左边图标的插槽"
+        },
+        {
+            "name": "[slot]rightIcon",
+            "description": "右边图标的插槽"
         }
     ]
 }

package/components/ste-number-keyboard/ATTRIBUTES.md

@@ -1,4 +1,6 @@
-#### Props
+## API
+
+### Props
 | 属性名 | 说明  | 类型 | 默认值  | 可选值 | 支持版本 |
 | ----- | ----- | --- | ------- | ------ | -------- |
 | `mode` | 键盘模式 | `string` | `popup` | `popup`：弹出式<br/>`page`：页面式 | - |
@@ -18,17 +20,25 @@
 | `backspaceSize` | 回退按钮图标大小 | `number / string` | `48` | - | - |
 | `confirmBg` | 确定按钮背景颜色 | `string` | `#0090FF` | - | - |
 | `confirmColor` | 确定按钮文字颜色 | `string` | `#ffffff` | - | - |
-| `undefined` | - | `undefined` | - | - | - |
 
 
-#### Events
+### Events
 | 事件名 | 说明  | 事件参数 | 支持版本 |
 | ----- | ----- | ------- | -------- |
 | `change` | 输入值value改变时触发 | `value`：输入值 | - |
-| `clear` | 清空按钮点击事件 | - | - |
-| `backspace` | 删除按钮点击事件 | - | - |
+| `clear` | 清空按钮点击事件 | `data`：() => void | - |
+| `backspace` | 删除按钮点击事件 | `data`：() => void | - |
 | `confirm` | 确认按钮点击事件 | `value`：输入值 | - |
 | `click` | 点击功能键(确认/删除/清除)之外的键盘触发 | `key`：当前点击的按钮 | - |
 | `beforeinput` | 输入之前触发，功能键之外的键盘点击时为输入 | `key`：当前点击的按钮<br/>`suspend`：开启等待的回调函数<br/>`next`：执行后续操作的回调函数<br/>`stop`：阻止后续执行的回调函数 | - |
-| `open` | 打开弹窗键盘触发 | - | - |
-| `close` | 关闭弹窗键盘触发 | - | - |
+| `open` | 打开弹窗键盘触发 | `data`：() => void | - |
+| `close` | 关闭弹窗键盘触发 | `data`：() => void | - |
+
+
+### Slots
+| 插槽名 | 说明  | 参数 | 支持版本 |
+| ----- | ----- | --- | -------- |
+| `default` | 弹窗标题插槽 | - | - |
+| `header` | 在键盘上方显示的内容 | - | - |
+
+

package/components/ste-number-keyboard/README.md

@@ -4,9 +4,9 @@
 
 ---$
 
-### 代码演示
+## 代码演示
 
-#### 基础用法
+## 基础用法
 
 - 属性`value`: 输入的值，支持`v-model`双向绑定
 - 属性`show`: 是否显示键盘，支持`sync`双向绑定
@@ -38,7 +38,7 @@
 </style>
 ```
 
-#### 隐藏右侧功能键
+## 隐藏右侧功能键
 
 - 属性`rightKeys`: 是否显示右侧功能键，默认显示
 
@@ -69,7 +69,7 @@
 </style>
 ```
 
-#### 隐藏清除按钮,value最大长度
+## 隐藏清除按钮,value最大长度
 
 - 属性`showClear`: 是否显示清除按钮，默认显示
 - 属性`maxlength`: 最大`value`长度，默认不限制
@@ -102,7 +102,7 @@
 </style>
 ```
 
-#### 自定义按键
+## 自定义按键
 
 - 属性`customKeys`: 自定义按键列表，建议不超过两个
 
@@ -134,7 +134,7 @@
 </style>
 ```
 
-#### 自定义颜色/字体大小/确定文本
+## 自定义颜色/字体大小/确定文本
 
 - 属性`textColor`: 按键文字颜色，默认#333333
 - 属性`textSize`: 按键文字大小，默认48，单位rpx
@@ -170,7 +170,7 @@
 </style>
 ```
 
-#### 输入前事件（自定义功能）
+## 输入前事件（自定义功能）
 
 - 属性`customKeys`中自定义一些按钮，如"返回"
     - 需要自定义该按钮功能，可使用`beforeinput`阻止该按钮的默认功能
@@ -224,7 +224,7 @@
 </style>
 ```
 
-#### 在文档流中展示
+## 在文档流中展示
 
 - 属性`mode`: 键盘模式，
     - 可选值:`popup`在弹窗中展示(默认)
@@ -271,7 +271,7 @@
 </style>
 ```
 
-#### 绑定多个输入框
+## 绑定多个输入框
 
 - 当有一个键盘绑定多个输入框的需求时，可去掉键盘组件的`v-model`，使用如下数据格式
 - 在输入框绑定点击事件来指定当前输入
@@ -315,16 +315,7 @@
 
 ---$
 
-### API
-
 <!-- props -->
 
-#### 组件插槽(Slot)
-
-| 插槽名  | 说明                 | 插槽参数 | 支持版本 |
-| ------- | -------------------- | -------- | -------- |
-| default | 弹窗标题插槽         | -        | -        |
-| header  | 在键盘上方显示的内容 | -        | -        |
-
 ---$
 {{xuyajun}}