Components

Numeral

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.

import { Numeral } from '@sproutsocial/racine'

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.

Properties

NameTypeDefaultDescriptionRequired?
numbernumber
The number to be formatted
localestring
Locale to format. See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#locales_argument
format
"decimal"
"currency"
"percent"
currencystring
The currency format to use when formatting currency
abbreviate
boolean
number
A boolean determining whether or not the number should be abbreviated, or a number representing the abbreviation threshold
precision
number
"none"
Override the default decimal precision (2 for decimals/currency, 1 for percentages), or "none" allowing unrestricted precision.
qaObject

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.

Percentages

Null values

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