Skip to content


API docs for the Toolpad Studio Metric component.

The Metric component can be used to display a single numerical value. it supports multiple numerical formats such as bytes, currency, percentage... It also supports conditional formatting to adapt the color based on the numerical value.


Name Type Default Description
label string "label" The label to be displayed.
value number 0 The value to be displayed.
numberFormat object The number format for the value.
caption string "" The caption to be displayed.
conditionalFormat object The color of the number, dependent on the value.
fullWidth boolean Whether the button should occupy all available horizontal space.