city-casereport/miniprogram_npm/tdesign-miniprogram/count-down/README.en-US.md

35 lines
1.2 KiB
Markdown
Raw Normal View History

2023-12-06 14:22:42 +08:00
:: BASE_DOC ::
## API
### CountDown Props
name | type | default | description | required
-- | -- | -- | -- | --
auto-start | Boolean | true | \- | N
content | String / Slot | 'default' | \- | N
format | String | HH:mm:ss | \- | N
millisecond | Boolean | false | \- | N
size | String `v0.5.1` | 'small' | optionssmall/medium/large | N
split-with-unit `v0.5.1` | Boolean | false | \- | N
theme | String `v0.5.1` | 'default' | optionsdefault/round/square | N
time | Number | - | required | Y
### CountDown Events
name | params | description
-- | -- | --
change | `(time: TimeData)` | [see more ts definition](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/count-down/type.ts)。<br/>`interface TimeData { days: number; hours: number; minutes: number; seconds: number; milliseconds: number }`<br/>
finish | \- | \-
### CSS Variables
The component provides the following CSS variables, which can be used to customize styles.
Name | Default Value | Description
-- | -- | --
--td-countdown-bg-color | @error-color-6 | -
--td-countdown-default-color | @font-gray-1 | -
--td-countdown-round-border-radius | @radius-circle | -
--td-countdown-round-color | @font-white-1 | -
--td-countdown-square-border-radius | @radius-small | -