mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-16 01:29:11 +08:00
62 lines
2.7 KiB
Markdown
62 lines
2.7 KiB
Markdown
---
|
||
category: Components
|
||
group: Data Display
|
||
title: Statistic
|
||
description: Display statistic number.
|
||
cover: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*YL7PRYNtH-4AAAAAAAAAAAAADrJ8AQ/original
|
||
coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*BPWDRbSYxJ4AAAAAAAAAAAAADrJ8AQ/original
|
||
demo:
|
||
cols: 2
|
||
---
|
||
|
||
## When To Use
|
||
|
||
- When want to highlight some data.
|
||
- When want to display statistic data with description.
|
||
|
||
## Examples
|
||
|
||
<!-- prettier-ignore -->
|
||
<code src="./demo/basic.tsx">Basic</code>
|
||
<code src="./demo/unit.tsx">Unit</code>
|
||
<code src="./demo/animated.tsx">Animated number</code>
|
||
<code src="./demo/card.tsx" background="grey">In Card</code>
|
||
<code src="./demo/countdown.tsx">Countdown</code>
|
||
<code src="./demo/component-token.tsx" debug>Component Token</code>
|
||
|
||
## API
|
||
|
||
Common props ref：[Common props](/docs/react/common-props)
|
||
|
||
#### Statistic
|
||
|
||
| Property | Description | Type | Default | Version |
|
||
| ---------------- | ----------------------------- | -------------------- | ------- | ------- |
|
||
| decimalSeparator | The decimal separator | string | `.` | |
|
||
| formatter | Customize value display logic | (value) => ReactNode | - | |
|
||
| groupSeparator | Group separator | string | `,` | |
|
||
| loading | Loading status of Statistic | boolean | false | 4.8.0 |
|
||
| precision | The precision of input value | number | - | |
|
||
| prefix | The prefix node of value | ReactNode | - | |
|
||
| suffix | The suffix node of value | ReactNode | - | |
|
||
| title | Display title | ReactNode | - | |
|
||
| value | Display value | string \| number | - | |
|
||
| valueStyle | Set value section style | CSSProperties | - | |
|
||
|
||
#### Statistic.Countdown
|
||
|
||
| Property | Description | Type | Default | Version |
|
||
| --- | --- | --- | --- | --- |
|
||
| format | Format as [dayjs](https://day.js.org/) | string | `HH:mm:ss` | |
|
||
| prefix | The prefix node of value | ReactNode | - | |
|
||
| suffix | The suffix node of value | ReactNode | - | |
|
||
| title | Display title | ReactNode | - | |
|
||
| value | Set target countdown time | number | - | |
|
||
| valueStyle | Set value section style | CSSProperties | - | |
|
||
| onFinish | Trigger when time's up | () => void | - | |
|
||
| onChange | Trigger when time's changing | (value: number) => void | - | 4.16.0 |
|
||
|
||
## Design Token
|
||
|
||
<ComponentTokenTable component="Statistic"></ComponentTokenTable>
|