Skip to main content

Interface: DateMetric

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

Date-based metric for displaying dates like expiration or renewal.

Extends​

Properties​

date​

date: string

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

The date value to display.

helpArticleAction()?​

optional helpArticleAction: () => void

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

Optional help article action handler.

Returns​

void

Inherited from​

BaseMetric.helpArticleAction

icon?​

optional icon: IconType

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

Icon to display alongside the metric.

Inherited from​

BaseMetric.icon

isWarning?​

optional isWarning: boolean

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

Whether to show a warning indicator.

label​

label: string

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

Label displayed above the metric value.

Inherited from​

BaseMetric.label

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

Inherited from​

BaseMetric.onClick

remainingDaysMessage?​

optional remainingDaysMessage: string

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

Optional message showing remaining days.

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.

Inherited from​

BaseMetric.tooltip

type​

type: "date"

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