Numeral is a primitive component used to format numbers according to our number formatting guidelines.

Please refer to our number formatting guidelines for more detailed information on how we format numbers.

<Box display='flex' justifyContent='center'>
  <Numeral number={123456.789} />
</Box>

By default, Numeral will abbreviate numbers (when necessary). When numbers are abbreviated, a tooltip will be added to show the full number. If you’d like to turn this off, set the abbreviate prop to false.

<Box display='flex' justifyContent='center'>
  <Numeral number={123456.789} abbreviate={false} />
</Box>

Properties

Note: This component uses the Text component under the hood, and accepts all of the props of that component in addition to those listed above.

Recipes

Currencies

When format is set to currency, you can provide a currency code to the currency prop to get the proper formatting. This only works when abbreviation is turned off.

<Box display='flex' justifyContent='space-around'>
  <Numeral number={123456.789} format='currency' abbreviate={false} />
  <Numeral number={123456.789} format='currency' currency='EUR' locale='de-DE' abbreviate={false} />
  <Numeral number={123456.789} format='currency' currency='JPY' locale='ja' abbreviate={false} />
</Box>

Percentages

<Box display='flex' justifyContent='center'>
  <Numeral number={12.34} format='percent' />
</Box>

Null values

When a number is not provided to the component, it will automatically render a hyphen to represent a null value.

<Box display='flex' justifyContent='center'>
  <Numeral number={null} />
</Box>