Skip to main content

Interface: BaseMetric

Defined in: packages/components/src/components/MetricCard/MetricCard.types.ts:6

Base metric properties shared by all metric types.

Extended by​

Properties​

helpArticleAction()?​

optional helpArticleAction: () => void

Defined in: packages/components/src/components/MetricCard/MetricCard.types.ts:28

Optional help article action handler.

Returns​

void

icon?​

optional icon: IconType

Defined in: packages/components/src/components/MetricCard/MetricCard.types.ts:20

Icon to display alongside the metric.

label​

label: string

Defined in: packages/components/src/components/MetricCard/MetricCard.types.ts:10

Label displayed above the metric value.

onClick()?​

optional onClick: () => void

Defined in: packages/components/src/components/MetricCard/MetricCard.types.ts:24

Optional click handler to make the metric card interactive.

Returns​

void

tooltip?​

optional tooltip: string | () => void

Defined in: packages/components/src/components/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.