Interface: NumberMetric

Defined in: MetricCard/MetricCard.types.ts:76

Number-based metric for displaying counts.

Extends

• BaseMetric

Properties

current

current: number

Defined in: MetricCard/MetricCard.types.ts:81

Current value.

---

footerText?

optional footerText?: string

Defined in: MetricCard/MetricCard.types.ts:93

Optional footer text below the metric.

---

formatValue?

optional formatValue?: (value) => string

Defined in: MetricCard/MetricCard.types.ts:89

Custom formatter for displaying values.

Parameters

Parameter	Type
value	number

Returns

string

---

helpArticleAction?

optional helpArticleAction?: () => void

Defined in: MetricCard/MetricCard.types.ts:28

Optional help article action handler.

Returns

void

Inherited from

BaseMetric.helpArticleAction

---

icon?

optional icon?: IconType

Defined in: MetricCard/MetricCard.types.ts:20

Icon to display alongside the metric.

Inherited from

BaseMetric.icon

---

label

label: string

Defined in: MetricCard/MetricCard.types.ts:10

Label displayed above the metric value.

Inherited from

BaseMetric.label

---

max

max: number | null

Defined in: MetricCard/MetricCard.types.ts:85

Maximum value. Use null for unlimited.

---

onClick?

optional onClick?: () => void

Defined in: MetricCard/MetricCard.types.ts:24

Optional click handler to make the metric card interactive.

Returns

void

Inherited from

BaseMetric.onClick

---

tooltip?

optional tooltip?: string | (() => void)

Defined in: MetricCard/MetricCard.types.ts:16

Optional tooltip text or action handler for additional context. When a string is provided, it displays a simple tooltip. When a function is provided, it's called when the tooltip icon is clicked.

Inherited from

BaseMetric.tooltip

---

type

type: "number"

Defined in: MetricCard/MetricCard.types.ts:77