mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-12 15:19:58 +08:00
e027cbec1c
* chore: add prettier-ignore in markdown demo * docs: format markdown api table * docs: format markdown api table
54 lines
2.2 KiB
Markdown
54 lines
2.2 KiB
Markdown
---
|
|
category: Components
|
|
group: Data Display
|
|
title: Statistic
|
|
cover: https://gw.alipayobjects.com/zos/antfincdn/rcBNhLBrKbE/Statistic.svg
|
|
demo:
|
|
cols: 2
|
|
---
|
|
|
|
Display statistic number.
|
|
|
|
## 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/card.tsx">In Card</code>
|
|
<code src="./demo/countdown.tsx">Countdown</code>
|
|
|
|
## API
|
|
|
|
#### 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 \| dayjs | - | |
|
|
| 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 |
|