Num
Справка по API компонента <Num>
Обзор
Компонент <Num> выводит число в формате локали пользователя и поддерживает настройку параметрами форматирования.
<Num>{100}</Num>
// Вывод: 100Все преобразования формата выполняются локально с использованием библиотеки Intl.NumberFormat.
Справочные материалы
Свойства
Prop
Type
Описание
| Prop | Описание |
|---|---|
children | Содержимое, рендерящееся внутри компонента. Обычно это число, которое будет отформатировано в соответствии с текущей локалью и параметрами. Если указано, имеет приоритет над пропом value. |
name | Необязательное имя числового поля, используется для метаданных. |
value | Значение числа по умолчанию. Может быть строкой или числом. Строки будут преобразованы в числа перед форматированием. |
options | Необязательные параметры форматирования числа согласно спецификации Intl.NumberFormatOptions. Используйте их для задания стилей, таких как валюта, точность десятичных знаков и т. д. |
locales | Необязательный список локалей, определяющий локаль форматирования. Если не указан, используется локаль пользователя по умолчанию. Подробнее о задании локали читайте здесь. |
Возвращает
JSX.Element, содержащий форматированное число в виде строки.
Примеры
Базовый пример
В этом примере item.quantity будет отформатирован в соответствии с локалью пользователя.
import { Num } from 'gt-react';
export default function Inventory(item) {
return (
<Num> {item.quantity} </Num>
);
}Указание локалей
По умолчанию локали определяются настройками браузера пользователя,
но вы можете явно задать локаль для компонента <Num>.
import { Num } from 'gt-react';
export default function CountDisplay(item) {
return (
<Num locales={['fr-FR']}> {item.count} </Num>
);
}Перевод компонентов <Num>
Предположим, вы хотите, чтобы число было частью более длинного переводимого предложения.
Просто оберните содержимое в компоненты <T>.
import { T, Num } from 'gt-react';
export default function DynamicPriceDisplay(item) {
return (
<T id="price">
Доступно <Num> {item.count} </Num> ед. // [!code highlight]
</T>
);
}Индивидуальное форматирование
<Num> использует библиотеку Intl.NumberFormat для форматирования чисел.
import { Num } from 'gt-react';
export default function CustomFormat(number) {
return (
<Num
options={{ style: "decimal", maximumFractionDigits: 2 }}
>
{number}
</Num>
);
}Примечания
- Компонент
<Num>используется для форматирования чисел в соответствии с локалью пользователя. - Внутри компонента
<T>обязательно оборачивайте все динамические числа в компонент<Num>.
Дальнейшие шаги
- Подробнее о компоненте
<Num>и других компонентах для переменных —<Currency>,<DateTime>и<Var>— а также примеры их использования,
Насколько полезно это руководство?