@leenguyen/react-flip-clock-countdown
Advanced tools
Comparing version 1.5.0 to 1.5.1
| { | ||
| "name": "@leenguyen/react-flip-clock-countdown", | ||
| "version": "1.5.0", | ||
| "version": "1.5.1", | ||
| "description": "A 3D animated countdown component for React.", | ||
@@ -5,0 +5,0 @@ "author": "leenguyen", |
@@ -27,17 +27,18 @@ # react-flip-clock-countdown | ||
| | Name | Type | Required | Default | Description | | ||
| | :---------------------------------------- | :---------------------------------------: | :------: | :--------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | [**to**](#to) | <code>Date|string|number</code> | yes | | <code>Date</code> or timestamp in the future. | | ||
| | [~~**containerProps**~~](#containerprops) | <code>object</code> | no | <code>undefined</code> | Props apply to the flip clock container. This prop is deprecated, you should apply directly to the <code>FlipClockCountdown</code> component. | | ||
| | [**onComplete**](#oncomplete) | <code>func</code> | no | | Callback when countdown ends<br/> **Signature**:<br/>`function() => void` | | ||
| | [**onTick**](#ontick) | <code>func</code> | no | | Callback on every interval tick<br /> **Signature**:<br/>`function({ timeDelta, completed }) => void` | | ||
| | **renderMap** | <code>`Array<boolean>`</code> | no | <code>[true, true, true, true]</code> | Each element represents the render state of each section (day, hour, minute, second). If `true` section will be rendered, `false` otherwise. | | ||
| | **labels** | <code>`Array<string>`</code> | no | <code>['Days', 'Hours', 'Minutes', 'Seconds']</code> | Custom array of labels used to represent information for each section (day, hour, minute, second). | | ||
| | **showLabels** | <code>boolean</code> | no | <code>true</code> | Set it to `false` if you don't want to show the labels. | | ||
| | **showSeparators** | <code>boolean</code> | no | <code>true</code> | Set it to `false` if you don't want to show the separators (colon) between time unit. | | ||
| | **labelStyle** | <code>React.CSSProperties</code> | no | <code>undefined</code> | The styles apply to labels `font-size`, `color`, `width`, `height`, etc. | | ||
| | **digitBlockStyle** | <code>React.CSSProperties</code> | no | <code>undefined</code> | The styles apply to digit blocks like `font-size`, `color`, `width`, `height`, etc. | | ||
| | **separatorStyle** | <code>object</code> | no | <code>undefined</code> | The styles apply to separator (colon), includes `size` and `color`. | | ||
| | **dividerStyle** | <code>object</code> | no | <code>undefined</code> | The style will be applied to divider, includes `color` and `height`. | | ||
| | **duration** | <code>number</code> | no | <code>0.7</code> | Duration (in second) when flip card. Valid value in range (0, 1). | | ||
| | Name | Type | Required | Default | Description | | ||
| | :---------------------------------------- | :---------------------------------------: | :------: | :--------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | [**to**](#to) | <code>Date|string|number</code> | yes | | <code>Date</code> or timestamp in the future. | | ||
| | [~~**containerProps**~~](#containerprops) | <code>object</code> | no | <code>undefined</code> | Props apply to the flip clock container. This prop is deprecated, you should apply directly to the <code>FlipClockCountdown</code> component. | | ||
| | [**onComplete**](#oncomplete) | <code>func</code> | no | | Callback when countdown ends<br/> **Signature**:<br/>`function() => void` | | ||
| | [**onTick**](#ontick) | <code>func</code> | no | | Callback on every interval tick<br /> **Signature**:<br/>`function({ timeDelta, completed }) => void` | | ||
| | **renderMap** | <code>`Array<boolean>`</code> | no | <code>[true, true, true, true]</code> | Each element represents the render state of each section (day, hour, minute, second). If `true` section will be rendered, `false` otherwise. | | ||
| | **labels** | <code>`Array<string>`</code> | no | <code>['Days', 'Hours', 'Minutes', 'Seconds']</code> | Custom array of labels used to represent information for each section (day, hour, minute, second). | | ||
| | **showLabels** | <code>boolean</code> | no | <code>true</code> | Set it to `false` if you don't want to show the labels. | | ||
| | **showSeparators** | <code>boolean</code> | no | <code>true</code> | Set it to `false` if you don't want to show the separators (colon) between time unit. | | ||
| | **labelStyle** | <code>React.CSSProperties</code> | no | <code>undefined</code> | The styles apply to labels `font-size`, `color`, `width`, `height`, etc. | | ||
| | **digitBlockStyle** | <code>React.CSSProperties</code> | no | <code>undefined</code> | The styles apply to digit blocks like `font-size`, `color`, `width`, `height`, etc. | | ||
| | **separatorStyle** | <code>object</code> | no | <code>undefined</code> | The styles apply to separator (colon), includes `size` and `color`. | | ||
| | **dividerStyle** | <code>object</code> | no | <code>undefined</code> | The style will be applied to divider, includes `color` and `height`. | | ||
| | **duration** | <code>number</code> | no | <code>0.7</code> | Duration (in second) when flip card. Valid value in range (0, 1). | | ||
| | **hideOnComplete** | <code>boolean</code> | no | <code>true</code> | By befault, the countdown will be hidden when it completed (or show children if provided). This will keep the timer in place and stuck at zeros when the countdown is completed. | | ||
@@ -44,0 +45,0 @@ ### `to` |
Sorry, the diff of this file is not supported yet
No alert changes
Improved metrics
- Total package byte prevSize
- increased by1.43%
61231
- Number of lines in readme file
- increased by0.41%
243
No dependency changes