Meter
Meters are visual representations of a quantity or an achievement. Their progress is determined by user actions, rather than system actions.
| install | yarn add @react-spectrum/meter |
|---|---|
| version | 3.0.0-rc.2 |
| usage | import {Meter} from '@react-spectrum/meter' |
Example#
<Meter label="Storage space" variant="positive" value=35 />Value#
Meters are controlled with the value prop.
In this default case, the value props can be thought of as representing current percentage of progress as the minimum and maxiumum values default to 0 and 100, respectively.
<Meter label="Storage space" value=25 variant="positive" />Alternatively, a different scale can be used by setting the minValue and maxValue.
<Meter label="Widgets Used" minValue=50 maxValue=150 value=100 variant="positive" />Values are formatted as a percentage by default, but can be modified by using the formatOptions for different formats.
formatOptions is compatible with the option parameter of Intl.NumberFormat and is applied to the current locale.
<Meter label="Currency" formatOptions={style: 'currency' currency: 'JPY'} value=60 variant="positive" />Accessibility#
Depending on the visualization being used (i.e. depending on the showValueLabel prop), a label, aria-label, or aria-labelledby attribute are required.
<div>
<Meter aria-labelledby="pc-label" showValueLabel=false value=10 variant="positive" />
<label id="pc-label" style={display: 'block'}>Meter</label>
</div>Internationalization#
To internationalize a Meter, a localized string should be passed to the label prop, aria-label prop, or value of the associated aria-labelledby element.
For languages that are read right to left (e.g. Hebrew and Arabic), the layout of the bar loader is mirrored.
If the prop formatOptions is used, Meter will utilize current locale to format the value string.
Props#
| Name | Type | Default | Description |
variant | 'positive' | 'warning' | 'critical' | — | The visual style of the Meter. |
size | 'S' | 'L' | "L" | How thick the ProgressBar should be. |
labelPosition | LabelPosition | "top" | The label's overall position relative to the element it is labeling. |
label | ReactNode | — | The content to display as the label. |
showValueLabel | boolean | — | Whether the value's label is displayed |
formatOptions | | — | The display format of the value label. |
valueLabel | ReactNode | — | The content to display as the value's label. |
value | number | "0" | The current value (controlled). |
minValue | number | "0" | The smallest value allowed for the input. |
maxValue | number | "100" | The largest value allowed for the input. |
UNSAFE_className | string | — | |
UNSAFE_style | CSSProperties | — |
Layout
| Name | Type | Default | Description |
flex | string | number | boolean | — | |
flexGrow | number | — | |
flexShrink | number | — | |
flexBasis | number | string | — | |
alignSelf | 'auto'
| 'normal'
| 'start'
| 'end'
| 'flex-start'
| 'flex-end'
| 'self-start'
| 'self-end'
| 'center'
| 'stretch' | — | |
justifySelf | 'auto'
| 'normal'
| 'start'
| 'end'
| 'flex-start'
| 'flex-end'
| 'self-start'
| 'self-end'
| 'center'
| 'left'
| 'right'
| 'stretch' | — | |
flexOrder | number | — | |
gridArea | string | — | |
gridColumn | string | — | |
gridRow | string | — | |
gridColumnStart | string | — | |
gridColumnEnd | string | — | |
gridRowStart | string | — | |
gridRowEnd | string | — |
Spacing
| Name | Type | Default | Description |
margin | DimensionValue | — | |
marginTop | DimensionValue | — | |
marginLeft | DimensionValue | — | |
marginRight | DimensionValue | — | |
marginBottom | DimensionValue | — | |
marginStart | DimensionValue | — | |
marginEnd | DimensionValue | — | |
marginX | DimensionValue | — | |
marginY | DimensionValue | — |
Sizing
| Name | Type | Default | Description |
width | DimensionValue | — | |
minWidth | DimensionValue | — | |
maxWidth | DimensionValue | — | |
height | DimensionValue | — | |
minHeight | DimensionValue | — | |
maxHeight | DimensionValue | — |
Positioning
| Name | Type | Default | Description |
position | 'static'
| 'relative'
| 'absolute'
| 'fixed'
| 'sticky' | — | |
top | DimensionValue | — | |
bottom | DimensionValue | — | |
left | DimensionValue | — | |
right | DimensionValue | — | |
start | DimensionValue | — | |
end | DimensionValue | — | |
zIndex | number | — | |
isHidden | boolean | — |
Accessibility
| Name | Type | Default | Description |
role | string | — | |
id | string | — | |
tabIndex | number | — | |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-controls | string | — | Identifies the element (or elements) whose contents or presence are controlled by the current element. |
aria-owns | string | — | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. |
aria-hidden | boolean | 'false' | 'true' | — | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. |
Visual options#
Labels#
Value labels are shown by default on top, but they can also be moved to the side or hidden as needed. The label should be in sentence case.
<Flex flexDirection="column" maxWidth="275px">
<Meter label="Label" marginBottom="25px" value=25 variant="warning" />
<Meter label="Label" marginBottom="25px" labelPosition="side" value=25 variant="warning" />
<Meter label="Label" showValueLabel=false value=25 variant="warning" />
</Flex>The value label can be updated via the valueLabel prop in cases where showing a different scale makes sense.
<Meter label="Progress" marginBottom="25px" value=25 valueLabel="1 of 4" variant="warning" />Size#
<Flex flexDirection="column">
<Meter label="Meter" marginBottom="25px" size="S" value=90 variant="critical" />
<Meter label="Meter" size="L" value=90 variant="critical" />
</Flex>Variants#
<Flex flexDirection="column">
<Meter label="Label" marginBottom="25px" value=25 variant="positive" />
<Meter label="Label" marginBottom="25px" value=25 variant="critical" />
<Meter label="Label" value=25 variant="warning" />
</Flex>