blackteay/vant
1
0
Fork 0
mirror of https://gitee.com/vant-contrib/vant.git synced 2025-04-06 03:57:59 +08:00
Code Issues Projects Releases Wiki Activity

[Doc] CountDown: en document (#3820)

Browse Source
This commit is contained in:
neverland 2019-07-11 15:50:33 +08:00 committed by GitHub
parent c78524264f
commit 734c3259d8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 36 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
src/count-down/README.md
View File

@ -111,4 +111,40 @@ export default {
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|------|
| time | Total time | `Number` | - |
| format | Time format，DD-day，HH-hour，mm-minute，ss-second，SSS-millisecond | `String` | `HH:mm:ss` |
| auto-start | Whether to auto start count down | `Boolean` | `true` |
| millisecond | Whether to enable millisecond render | `Boolean` | `false` |
### Events
| Event | Description | Arguments |
|------|------|------|
| finish | Triggered when count down finished | - |
### Slots
| Name | Description | slot-scope |
|------|------|------|
| default | Custom Content | timeData |
### timeData Structure
| Name | Description | Type |
|------|------|------|
| days | Remain days | `number` |
| hours | Remain hours | `number` |
| minutes | Remain minutes | `number` |
| seconds | Remain seconds | `number` |
| milliseconds | Remain milliseconds | `number` |
### Methods
Use ref to get CountDown instance and call instance methods
| Name | Attribute | Return value | Description |
|------|------|------|------|
| start | - | - | Start count down |
| pause | - | - | Pause count down |
| reset | - | - | Reset count down |