Skip to main content

<CurrencyField>

Displays a currency value, formatted according to the user's locale using Intl.NumberFormat. It's a specialization of the <NumberField> and accepts the same props, except that the style option of the options prop is always set to currency.

Usage​

<CurrencyField source="price" currency="USD" />

By default, the CurrencyField uses the locale from the application context. You can override it with the locales prop:

<CurrencyField source="price" currency="USD" locales="en-US" />

You can also use the options prop to customize the formatting, just like for the <NumberField>:

<CurrencyField source="price" currency="USD" options={{ minimumFractionDigits: 2 }} />

Props​

PropTypeDefaultDescription