Getting started
Components
A label is required when using Meter. Use one of these options:
Use a Meter to communicate an amount of something within a range, like number of emails delivered. Use the valueLabel prop on the MeterLabel component to display the current value being represented by the Meter.
Meter has a default value of 0, a default minimum value of 0, and a default maximum value of 100.
Passing minValue and maxValue to Meter allow you to set a non 0-100 scale. Use minLabel and maxLabel to display minimum and maximum values below the Meter. If using a non 0-100 scale, displaying min and max labels is required.
The Meter label should communicate what the Meter is measuring. Where possible, avoid a label that wraps onto two lines.
A Meter almost always will include a numerical value, the value label. When using the valueLabel prop, consider what type of value would be most useful for a user to see. For example, choose either "50%" or "5,000 of 10,000", not both.
Use Help Text to offer additional information to contextualize or help the user understand the Meter.
Use a Meter when a user needs to understand a measurement within a range (like how much data has been used).
Don't use a Meter to represent a path with a completion point (like uploading a file or filling out a form).
When using a custom value label, use only the format that is the most useful for a user to know.
Don't show multiple formats of the same value when possible.
Help us improve this component by providing feedback, asking questions on Slack, or updating this file on GitHub.