admin/wot-design-uni
1
0
Fork 0
mirror of https://gitee.com/wot-design-uni/wot-design-uni.git synced 2025-12-06 17:18:40 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: ✏️ 文档优化

Browse Source
This commit is contained in:
xuqingkai 2023-08-17 10:52:30 +08:00
parent 95cdf7df98
commit a479f14b63
8 changed files with 30 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/component/datetimePickerView.md
View File

@ -5,12 +5,12 @@
## 基本用法
`v-model` 设置绑定值，默认为 'datetime' 类型，展示年月日时分，绑定值为 `时间戳` 类型，如果为 'time' 类型，绑定值为字符串。
`v-model` 设置绑定值，默认为 `datetime` 类型，展示年月日时分，绑定值为 `时间戳` 类型，如果为 `time` 类型，绑定值为字符串。
```html
<wd-toast />
<wd-datetime-picker-view v-model="value" label="日期选择" bind:change="handleChange" />
<wd-datetime-picker-view v-model="value" label="日期选择" @change="handleChange" />
```
```typescript
import { useToast } from '@/uni_modules/wot-design-uni'
@ -24,7 +24,7 @@ function onChange1({ value }) {
## date 类型
'date' 类型只展示年月日。
`date` 类型只展示年月日。
```html
<wd-datetime-picker-view type="date" v-model="value" label="年月日" />
@ -34,7 +34,7 @@ const value = ref<number>(Date.now())
```
## year-month 类型
'year-month' 类型只展示年月。
`year-month` 类型只展示年月。
```html
<wd-datetime-picker-view type="year-month" v-model="value" label="年月" />
@ -45,13 +45,13 @@ const value = ref<number>(Date.now())
## time 类型
'time' 类型只展示时分。
`time` 类型只展示时分。
```html
<wd-datetime-picker-view type="time" v-model="value" label="时分" />
```
```typescript
const value = ref<number>(Date.now())
const value4 = ref<string>('11:12')
```
## 修改内部格式
@ -126,6 +126,6 @@ const filter = (type, values) => {
| 事件名称 | 说明 | 参数 | 最低版本 |
|--------|------|-----|---------|
| bind:change | 切换选项时触发 | 选中的值 `{ value }`，value 为当前选中日期的时间戳，'time' 类型则为字符串 | - |
| bind:pickstart | 当滚动选择开始时候触发事件 | - | - | - |
| bind:pickend | 当滚动选择结束时候触发事件 | - | - | - |
| change | 切换选项时触发 | 选中的值 `{ value }`，value 为当前选中日期的时间戳，'time' 类型则为字符串 | - |
| pickstart | 当滚动选择开始时候触发事件 | - | - | - |
| pickend | 当滚动选择结束时候触发事件 | - | - | - |

2
docs/component/noticeBar.md
View File

@ -98,7 +98,7 @@
| 事件名称 | 说明 | 参数 | 最低版本 |
| ---------- | -------------- | ---- | -------- |
| bind:close | 关闭按钮点击时 | - | - |
| close | 关闭按钮点击时 | - | - |
## Slot

8
docs/component/rate.md
View File

@ -5,10 +5,10 @@
## 基本用法
设置`value`分数，设置`num`总分数，默认为5分，监听 `change` 事件获取新值。
设置`v-model`分数，设置`num`总分数，默认为5分，监听 `change` 事件获取新值。
```html
<wd-rate v-model="value" bind:change="handleChange" />
<wd-rate v-model="value" @change="handleChange" />
```
```typescript
@ -33,7 +33,7 @@ function changeValue({ value }) {
设置 `disabled` 属性和`disabled-color`
```html
<wd-rate value="{{2}}" disabled />
<wd-rate :modelValue="2" disabled />
```
## 修改颜色
@ -82,7 +82,7 @@ function changeValue({ value }) {
| 事件名称 | 说明 | 参数 | 最低版本 |
|---------|-----|-----|---------|
| bind:change | 点击icon，修改分值事件 | `{ value }` | - |
| change | 点击icon，修改分值事件 | `{ value }` | - |
## 外部样式类

4
docs/component/switch.md
View File

@ -48,7 +48,7 @@ const checked = ref<boolean>(true)
设置 `before-change` 属性，修改前钩子，接收 { value, resolve } 参数，`resolve(true)` 表示修改通过，`resolve(false)` 表示不修改。
```html
<wd-switch v-model="checked" :before-change="beforeChange" bind:change="handleChange" />
<wd-switch v-model="checked" :before-change="beforeChange" @change="handleChange" />
```
```typescript
@ -86,7 +86,7 @@ const beforeChange = ({ value, resolve }) => {
| 事件名称 | 说明 | 参数 | 最低版本 |
|--------|------|-----|---------|
| bind:change | 值修改事件 | `{ value }` | - |
| change | 值修改事件 | `{ value }` | - |
## 外部样式类

6
docs/component/tag.md
View File

@ -168,9 +168,9 @@ function handleClose(order) {
| 事件名称 | 说明 | 参数 | 最低版本 |
| ------------ | -------------------------- | ----------- | -------- |
| bind:click | 标签点击时触发 | event | - |
| bind:close | 点击关闭按钮时触发 | event | - |
| bind:confirm | 新增标签输入内容确定后触发 | `{ value }` | - |
| click | 标签点击时触发 | event | - |
| close | 点击关闭按钮时触发 | event | - |
| confirm | 新增标签输入内容确定后触发 | `{ value }` | - |
## Slots

2
docs/component/toast.md
View File

@ -8,7 +8,7 @@
```html
<wd-toast />
<wd-button bind:click="showToast">toast</wd-button>
<wd-button @click="showToast">toast</wd-button>
```
```typescript

8
docs/component/tooltip.md
View File

@ -28,7 +28,7 @@
```html
<view catchtap="clickoutside">
<wd-tooltip v-model="show" bind:change="handleChange" placement="top" content="top 提示文字">
<wd-tooltip v-model="show" @change="handleChange" placement="top" content="top 提示文字">
<wd-button>top</wd-button>
</wd-tooltip>
</view>
@ -136,9 +136,9 @@ Tooltip 组件通过属性`show-close` 控制是否显示关闭按钮。
| 事件名称 | 说明 | 回调参数 | 最低版本 |
| ----------- | ---------------- | -------- | -------- |
| bind:open | 显示时触发 | - | - |
| bind:close | 隐藏时触发 | - | - |
| bind:change | 显隐值变化时触发 | - | - |
| open | 显示时触发 | - | - |
| close | 隐藏时触发 | - | - |
| change | 显隐值变化时触发 | - | - |
## Methods

12
docs/component/transition.md
View File

@ -85,12 +85,12 @@
| 事件名称 | 说明 | 参数 | 最低版本 |
| ---------------- | ---------- | ---- | -------- |
| bind:beforeenter | 进入前触发 | - | - |
| bind:enter | 进入时触发 | - | - |
| bind:afterenter | 进入后触发 | - | - |
| bind:beforeleave | 离开前触发 | - | - |
| bind:leave | 离开时触发 | - | - |
| bind:afterleave | 离开后触发 | - | - |
| beforeenter | 进入前触发 | - | - |
| enter | 进入时触发 | - | - |
| afterenter | 进入后触发 | - | - |
| beforeleave | 离开前触发 | - | - |
| leave | 离开时触发 | - | - |
| afterleave | 离开后触发 | - | - |
## 外部样式类