docs: ✏️ 完善和修复文档中不详细不正确的内容

Moonofweisheng · Sep 2, 2023 · d1b118e · d1b118e
1 parent 8967540
commit d1b118e
Show file tree

Hide file tree

Showing 16 changed files with 48 additions and 47 deletions.
diff --git a/docs/component/calendar.md b/docs/component/calendar.md
@@ -6,9 +6,9 @@
 
 ## 基本使用
 
-`type` 默认为 `date` 类型，设置 `value` 绑定值（13 位时间戳格式），监听 `@confirm` 事件获取选中值。`min-date` 最小日期默认为当前日期往前推 6 个月，`max-date` 最大日期默认为当前日期往后推 6 个月，日历的日期只展示最小日期到最大日期之间的日期。label 可以不传。可以通过 `label-width` 设置标题宽度，默认为 '33%'。
+`type` 默认为 `date` 类型，设置 `v-model` 绑定值（13 位时间戳格式），监听 `@confirm` 事件获取选中值。`min-date` 最小日期默认为当前日期往前推 6 个月，`max-date` 最大日期默认为当前日期往后推 6 个月，日历的日期只展示最小日期到最大日期之间的日期。label 可以不传。可以通过 `label-width` 设置标题宽度，默认为 '33%'。
 
-> 小程序中这两个值尽量不要设置过大，避免大量数据的计算和传递导致页面性能低下。
+> `min-date`和`max-date`这两个值尽量不要设置过大，避免大量数据的计算和传递导致页面性能低下。
 
 ```html
 <wd-calendar v-model="value" label="日期选择" @confirm="handleConfirm" />

diff --git a/docs/component/calendarView.md b/docs/component/calendarView.md
@@ -6,9 +6,9 @@
 
 ## 基本使用
 
-`type` 默认为 `date` 类型，设置 `value` 绑定值（13 位时间戳格式），监听 `@change` 事件获取选中值。`min-date` 最小日期默认为当前日期往前推 6 个月，`max-date` 最大日期默认为当前日期往后推 6 个月，日历面板的日期只展示最小日期到最大日期之间的日期。
+`type` 默认为 `date` 类型，设置 `v-model` 绑定值（13 位时间戳格式），也可以监听 `@change` 事件获取选中值。`min-date` 最小日期默认为当前日期往前推 6 个月，`max-date` 最大日期默认为当前日期往后推 6 个月，日历面板的日期只展示最小日期到最大日期之间的日期。
 
-> 小程序中这两个值尽量不要设置过大，避免大量数据的计算和传递导致页面性能低下。
+> `min-date`和`max-date`这两个值尽量不要设置过大，避免大量数据的计算和传递导致页面性能低下。
 
 ```html
 <wd-calendar-view v-model="value" @change="handleChange" />

diff --git a/docs/component/colPicker.md b/docs/component/colPicker.md
@@ -10,9 +10,9 @@
 
 `columns` 设置数据源，为二维数组，每一列为一个一维数组，每个选项包含 `value`(选项值) 和 `label`(选项名称)。
 
-`value` 设置选中项的值，数据类型为数组；
+`v-model` 设置选中项的值，数据类型为数组；
 
-监听 `change` 事件，获取选中值，`event.detail` 是个对象，包含 `value`(选中值数组)、`selectedItems`（选中项对象数组）两个属性。
+也可以监听 `change` 事件，获取选中值，`event` 是个对象，包含 `value`(选中值数组)、`selectedItems`（选中项对象数组）两个属性。
 
 传入 `column-change` 属性，其类型为 `function`，接收参数 options: object；options 的结构如下：
 

diff --git a/docs/component/datetimePicker.md b/docs/component/datetimePicker.md
@@ -6,7 +6,7 @@
 
 ## 基本用法
 
-`v-model` 设置绑定值，默认为 'datetime' 类型，展示年月日时分，绑定值为 `时间戳` 类型，如果为 'time' 类型，绑定值为字符串。label 可以不传。可以通过 `label-width` 设置标题宽度，默认为 '33%'。
+`v-model` 设置绑定值，默认为 `datetime` 类型，展示年月日时分，绑定值为 `时间戳` 类型，如果为 `time` 类型，绑定值为字符串。label 可以不传。可以通过 `label-width` 设置标题宽度，默认为 `33%`。
 
 ```html
 <wd-datetime-picker v-model="value" label="日期选择" @confirm="handleConfirm" />
@@ -38,7 +38,7 @@ function handleConfirm({ value }) {
 
 ## date 类型
 
-'date' 类型只展示年月日。
+`date` 类型只展示年月日。
 
 ```html
 <wd-datetime-picker type="date" v-model="value" label="年月日" />
@@ -49,7 +49,7 @@ const value = ref<number>(Date.now())
 ```
 ## year-month 类型
 
-'year-month' 类型只展示年月。
+`year-month` 类型只展示年月。
 
 ```html
 <wd-datetime-picker type="year-month" v-model="value" label="年月" />
@@ -60,7 +60,7 @@ const value = ref<number>(Date.now())
 
 ## time 类型
 
-'time' 类型只展示时分。
+`time` 类型只展示时分。
 
 ```html
 <wd-datetime-picker type="time" v-model="value" label="时分" />
@@ -205,7 +205,7 @@ function handleConfirm({ value }) {
 
 ## 时间范围选择
 
-当 `value` 为 `Array` 类型, 时间范围选择开启。
+当 `v-model` 为 `Array` 类型, 时间范围选择开启。
 
 ```html
 <wd-datetime-picker label="日期选择" v-model="value" @confirm="handleConfirm" />

diff --git a/docs/component/dropMenu.md b/docs/component/dropMenu.md
@@ -10,12 +10,10 @@
 
 `options` 属性是一个一维对象数组，数组项的数据结构为：label（选项文本），value（选项值），tip（选项说明）。
 
-通过绑定 `@change` 事件，获取当前选中项。
-
-因为小程序组件无法监听点击自己以外的地方，为了在点击页面其他地方时，可以自动关闭 dropmenu ，建议引入组件库的 clickOut 函数（会关闭所有 dropmenu、popover、toast、swipeAction），在页面的根元素上监听点击事件的冒泡。
+因为`uni-app`组件无法监听点击自己以外的地方，为了在点击页面其他地方时，可以自动关闭 `dropmenu` ，建议引入组件库的 `clickOut` 函数（会关闭所有 dropmenu、popover、toast、swipeAction），在页面的根元素上监听点击事件的冒泡。
 
 :::warning
-如果存在用户手动点击 dropmenu 以外某个地方如按钮弹出 dropmenu 的场景，则需要在点击的元素（在这里上按钮）加上 @click 阻止事件冒泡到根元素上，避免触发 clickoutside 把要手动打开的 dropmenu 关闭了。
+如果存在用户手动点击 `dropmenu` 以外某个地方如按钮弹出 `dropmenu` 的场景，则需要在点击的元素（在这里上按钮）加上 @click 阻止事件冒泡到根元素上，避免触发 `clickOut` 把要手动打开的 `dropmenu` 关闭了。
 :::
 
 ```html

diff --git a/docs/component/layout.md b/docs/component/layout.md
@@ -99,7 +99,7 @@
 
 | 参数 | 说明 | 类型 | 可选值 | 默认值 | 最低版本 |
 |-----|------|-----|-------|-------|---------|
-| :span | 列元素宽度 | number | - | 24 | - |
+| span | 列元素宽度 | number | - | 24 | - |
 | offset | 列元素偏移距离 | number | - | 0 | - |
 
 ## Row 外部样式类

diff --git a/docs/component/pickerView.md b/docs/component/pickerView.md
@@ -4,7 +4,7 @@
 
 ## 基本用法
 
-单列选择器，给 `columns` 传入一个数值数组，设置 `value` 绑定值。选项可以为字符串，也可以为对象，如果为对象则默认取 `label` 属性为选项内容进行渲染，`value` 获取的值为 `value` 属性的值，如果 `value` 属性不存在，则取 `label` 的值。
+单列选择器，给 `columns` 传入一个数值数组，设置 `v-model` 绑定值。选项可以为字符串，也可以为对象，如果为对象则默认取选项 `label` 属性为选项内容进行渲染，`v-model` 获取的值为选项 `value` 属性的值，如果选项 `value` 属性不存在，则取选项 `label` 的值。
 
 ```html
 <wd-picker-view :columns="columns" v-model="value" @change="onChange" />

diff --git a/docs/component/popover.md b/docs/component/popover.md
@@ -6,12 +6,12 @@
 
 ## 基本用法
 
-Popover 的属性与 [Tooltip](/#/components/tooltip) 很类似，因此对于重复属性，请参考 [Tooltip](/#/components/tooltip) 的文档，在此文档中不做详尽解释。
+Popover 的属性与 [Tooltip](/component/tooltip.html) 很类似，因此对于重复属性，请参考 [Tooltip](/component/tooltip.html) 的文档，在此文档中不做详尽解释。
 
-因为小程序组件无法监听点击自己以外的地方，为了在点击页面其他地方时，可以自动关闭 popover ，建议引入组件库的 clickOut 函数（会关闭所有 dropmenu、popover、toast、swipeAction），在页面的根元素上监听点击事件的冒泡。
+因为`uni-app`组件无法监听点击自己以外的地方，为了在点击页面其他地方时，可以自动关闭 `popover` ，建议引入组件库的 `clickOut` 函数（会关闭所有 dropmenu、popover、toast、swipeAction），在页面的根元素上监听点击事件的冒泡。
 
 :::warning
-如果存在用户手动点击 popover 以外某个地方如按钮弹出 popover 的场景，则需要在点击的元素（在这里上按钮）加上 click 阻止事件冒泡到根元素上，避免触发 clickoutside 把要手动打开的 popover 关闭了。
+如果存在用户手动点击 `popover` 以外某个地方如按钮弹出 `popover` 的场景，则需要在点击的元素（在这里上按钮）加上 click 阻止事件冒泡到根元素上，避免触发 `clickOut` 把要手动打开的 `popover` 关闭了。
 :::
 
 ```html

diff --git a/docs/component/radio.md b/docs/component/radio.md
@@ -5,12 +5,11 @@
 
 ## 基本用法
 
-`value` 为绑定值，即选中的 `wd-radio` 的 `value` 值。
-点击radio会触发`change`事件，同时可以通过修改`value`来调整选中的radio。
+`v-model` 为绑定值，即选中的 `wd-radio` 的 `value` 值。
 
 ```html
 <demo-block title="基本用法">
-  <wd-radio-group v-model="value" @change="change">
+  <wd-radio-group v-model="value">
     <wd-radio :value="1">单选框1</wd-radio>
     <wd-radio :value="2">单选框2</wd-radio>
   </wd-radio-group>
@@ -19,10 +18,6 @@
 ```
 ```typescript
 const value = ref<number>(1)
-
-function change(e) {
-  console.log(e)
-}
 ```
 
 ## 修改图标形状

diff --git a/docs/component/rate.md b/docs/component/rate.md
@@ -1,11 +1,20 @@
+<!--
+ * @Author: weisheng
+ * @Date: 2023-08-27 18:05:52
+ * @LastEditTime: 2023-09-02 16:12:14
+ * @LastEditors: weisheng
+ * @Description: 
+ * @FilePath: \wot-design-uni\docs\component\rate.md
+ * 记得注释
+-->
 <frame/>
 
 #  Rate 评分
 
 
 ## 基本用法
 
-设置`v-model`分数，设置`num`总分数，默认为5分，监听 `change` 事件获取新值。
+设置`v-model`分数，设置`num`总分数，默认为5分。
 
 ```html
 <wd-rate v-model="value" @change="handleChange" />

diff --git a/docs/component/swipeAction.md b/docs/component/swipeAction.md
@@ -10,12 +10,12 @@
 
 ## 基本用法
 
-`wd-swipe-action`分为三部分：'自定义左按钮内容'、'自定义内容'、'自定义右按钮内容'。自定义按钮内容需要设置`slot`开启，自定义内容为默认插槽，无需手动开启。
+`wd-swipe-action`分为三部分：`自定义左按钮内容`、`自定义内容`、`自定义右按钮内容`。自定义按钮内容需要设置`slot`开启，自定义内容为默认插槽，无需手动开启。
 
-因为小程序组件无法监听点击自己以外的地方，为了在点击页面其他地方时，可以自动关闭 swipeAction ，建议引入组件库的 clickOut 函数（会关闭所有 dropmenu、popover、toast、swipeAction），在页面的根元素上监听点击事件的冒泡。
+因为`uni-app`组件无法监听点击自己以外的地方，为了在点击页面其他地方时，可以自动关闭 `swipeAction` ，建议引入组件库的 `clickOut` 函数（会关闭所有 dropmenu、popover、toast、swipeAction），在页面的根元素上监听点击事件的冒泡。
 
 :::warning
-如果存在用户手动点击 swipeAction 以外某个地方如按钮滑出 swipeAction 的场景，则需要在点击的元素（在这里上按钮）加上 @click 阻止事件冒泡到根元素上，避免触发 clickoutside 把要手动打开的 swipeAction 关闭了。
+如果存在用户手动点击 `swipeAction` 以外某个地方如按钮滑出 `swipeAction` 的场景，则需要在点击的元素（在这里上按钮）加上 @click 阻止事件冒泡到根元素上，避免触发 `clickOut` 把要手动打开的 `swipeAction` 关闭了。
 :::
 
 ```html

diff --git a/docs/component/switch.md b/docs/component/switch.md
@@ -5,7 +5,7 @@
 
 ## 基本用法
 
-`v-model` 值，为绑定值，默认为 boolean 类型。
+`v-model` 为绑定值，默认为 boolean 类型。
 
 ```html
 <wd-switch v-model="checked" />

diff --git a/docs/component/tabs.md b/docs/component/tabs.md
@@ -5,9 +5,9 @@
 
 ## 基本用法
 
-`value` 为绑定值，可以为 number 类型（选中的tab的下标）和 string 类型（标签名）。
+`v-model` 为绑定值，可以为 number 类型（选中的tab的下标）和 string 类型（标签名）。
 
-> 当`value`为`number`类型时，`wd-tab`可以不必设置`name`。同时如果value超出了tab数量，会用0自动兜底
+> 当`v-model`为`number`类型时，`wd-tab`可以不必设置`name`。同时如果value超出了tab数量，会用0自动兜底。
 
 ```html
 <wd-tabs v-model="tab">
@@ -85,16 +85,6 @@ const tab = ref<number>(0)
   </block>
 </wd-tabs>
 ```
-```typescript
-Page({
-  data: {
-    tab: 0
-  },
-  handleClick ({ detail: { index } }) {
-    console.log(`点击了标签${index}`)
-  }
-})
-```
 
 ## 手势滑动
 

diff --git a/docs/component/tooltip.md b/docs/component/tooltip.md
@@ -20,10 +20,10 @@
 
 如 `placement="left-end"`，则提示信息出现在目标元素的左侧，且提示信息的底部与目标元素的底部对齐。
 
-因为小程序组件无法监听点击自己以外的地方，为了在点击页面其他地方时，可以自动关闭 tooltip ，建议引入组件库的 clickOut 函数（会关闭所有 dropmenu、popover、toast、swipeAction），在页面的根元素上监听点击事件的冒泡。
+因为`uni-app`组件无法监听点击自己以外的地方，为了在点击页面其他地方时，可以自动关闭 `tooltip` ，建议引入组件库的 `clickOut` 函数（会关闭所有 dropmenu、popover、toast、swipeAction），在页面的根元素上监听点击事件的冒泡。
 
 :::warning
-如果存在用户手动点击 tooltip 以外某个地方如按钮滑出 tooltip 的场景，则需要在点击的元素（在这里上按钮）加上 catchtap 阻止事件冒泡到根元素上，避免触发 clickoutside 把要手动打开的 tooltip 关闭了。
+如果存在用户手动点击 `tooltip` 以外某个地方如按钮滑出 `tooltip` 的场景，则需要在点击的元素（在这里上按钮）加上 click 阻止事件冒泡到根元素上，避免触发 `clickOut` 把要手动打开的 `tooltip` 关闭了。
 :::
 
 ```html

diff --git a/docs/guide/commonProblems.md b/docs/guide/commonProblems.md
@@ -2,6 +2,15 @@
 
 本节介绍在开发过程当中遇到的部分 **常见问题** 以及 **解决办法**
 
+## 目前支持哪些平台？
+
+目前支持`APP-vue`、`微信小程序`和`h5`，在`1.0.0`版本之前都是支持这三个平台。当我们升级到`1.0.0`版本时会新增支持`支付宝小程序`和`钉钉小程序`，虽然当前目前基本也是支持这两个平台的，但是有部分组件存在样式差异，这一点因为时间问题还没有修复，所以这里也是不推荐在`支付宝小程序`和`钉钉小程序`中使用`Wot Design Uni`组件库。
+
+
+## 如何开启暗黑模式？
+
+`Wot Design Uni`支持深色模式、主题定制等能力，详见[ConfigProvider 全局配置](/component/configProvider.html)组件。
+
 
 ## 小程序样式隔离
 

diff --git a/docs/guide/introduction.md b/docs/guide/introduction.md
@@ -4,7 +4,7 @@
 
 ## 快速上手
 
-请查看[快速上手](#/components/quickUse)文档。
+请查看[快速上手](/guide/quickUse.html)文档。
 
 ## 扫码体验