Currency
Referencia de API del componente <Currency>
Descripción general
El componente <Currency> muestra un valor numérico como importe monetario.
El número se formatea según la locale actual y los parámetros opcionales que se especifiquen.
Este componente solo se encarga del formato y no realiza ningún cálculo de tipo de cambio.
<Currency>{100}</Currency>
// Salida: $100.00Todo el formateo se realiza localmente con la biblioteca Intl.NumberFormat.
Referencias
Props
Prop
Type
Descripción
| Prop | Descripción |
|---|---|
children | El contenido que se renderiza dentro del componente. Por lo general, un número que representa el valor a formatear como moneda. Si se proporciona, tiene prioridad sobre la prop value. |
name | name opcional para el campo de moneda, usado con fines de metadatos. |
value | El valor predeterminado de la moneda. Hará contenido de respaldo predeterminado a children si no se proporciona. Puede ser una cadena o un número. Las cadenas se convertirán a números antes del formateo. |
currency | El tipo de moneda, como "USD" o "EUR". Esto determina el símbolo y el formato utilizados para la moneda. |
options | options de formateo opcionales para la moneda, conforme a la especificación Intl.NumberFormatOptions. Úsalo para definir estilos como el número máximo de dígitos fraccionarios, la agrupación, etc. |
locales | locales opcionales para especificar el locale de formateo. Si no se proporciona, se usa el locale predeterminado del usuario. Lee más sobre cómo especificar locales aquí. |
Devuelve
JSX.Element que contiene la moneda con formato como cadena.
Ejemplos
Ejemplo básico
El componente <Currency> se puede utilizar para mostrar importes de moneda con formato local.
import { Currency } from 'gt-react';
export default function PriceDisplay(item) {
return (
<Currency> {item.price} </Currency>
);
}Especificar la moneda
Aquí mostramos el precio en euros.
import { Currency } from 'gt-react';
export default function PriceDisplay(item) {
return (
<Currency currency="EUR"> {item.price} </Currency>
);
}Traducción de componentes <Currency>
Supongamos que quieres mostrar la divisa dentro de una oración que también se traduce.
Puedes envolver el componente <Currency> dentro de un componente <T>.
import { T, Currency } from 'gt-react';
export default function PriceDisplay(item) {
return (
<T id="itemPrice"> // [!code highlight]
El precio es <Currency> {item.price} </Currency>.
</T>
);
}Formato personalizado
Aquí mostramos el precio en GBP con un número exacto de decimales y el símbolo angosto de la moneda (es decir, "$100" en lugar de "US$100"). Consulta más información sobre las Intl.NumberFormatOptions para ver más opciones.
import { Currency } from 'gt-react';
export default function PriceDisplay(item) {
return (
<Currency
currency="GBP"
options={{
currencyDisplay: 'narrowSymbol',
minimumFractionDigits: 2,
maximumFractionDigits: 2,
}}
>
{item.price}
</Currency>
);
}Notas
- El componente
<Currency>se utiliza para formatear importes monetarios según el locale actual y cualquier parámetro opcional proporcionado. - Este componente únicamente se encarga del formateo; no realiza cálculos de tipos de cambio.
- El contenido del componente
<Currency>no se enviará a la API para su traducción. Todo el formateo se realiza localmente utilizando la bibliotecaIntl.NumberFormat.
Próximos pasos
- Para más detalles y ejemplos de uso del componente
<Currency>y de otros componentes de variables como<Num>,<DateTime>y<Var>,
¿Qué te ha parecido esta guía?