Function: useIntl()

function useIntl(): {
  format_24h: boolean;
  formatDate: (date, options?) => string;
  formatDateAndTime: (date) => string;
  formatDateRange: (start, end) => string;
  formatDateTime: (date) => string;
  formatDuration: (seconds) => string;
  formatMoney: (amount, currency) => string;
  formatMonth: (month) => string;
  formatNumber: (value, options?) => string;
  formatPercent: (value, decimals?) => string;
  formatRelativeTime: (date) => string;
  formatTimeSpan: (start, end) => string;
  getCurrencySymbol: (currency) => string;
  getLocalizedText: (de, en) => string;
  getWeekdayName: (dayIndex, format?) => string;
  intl: __module;
  locale: Locale;
};

Defined in: shared/src/hooks/useIntl.ts:18

Main hook for internationalization and formatting. Combines user preferences from the store with Intl utilities.

Returns

Name	Type	Default value	Defined in
format_24h	boolean	-	shared/src/hooks/useIntl.ts:29
formatDate()	(date, options?) => string	-	shared/src/hooks/useIntl.ts:31
formatDateAndTime()	(date) => string	-	shared/src/hooks/useIntl.ts:42
formatDateRange()	(start, end) => string	-	shared/src/hooks/useIntl.ts:45
formatDateTime()	(date) => string	-	shared/src/hooks/useIntl.ts:36
formatDuration()	(seconds) => string	intl.formatDuration	shared/src/hooks/useIntl.ts:55
formatMoney()	(amount, currency) => string	-	shared/src/hooks/useIntl.ts:57
formatMonth()	(month) => string	-	shared/src/hooks/useIntl.ts:34
formatNumber()	(value, options?) => string	-	shared/src/hooks/useIntl.ts:60
formatPercent()	(value, decimals?) => string	-	shared/src/hooks/useIntl.ts:63
formatRelativeTime()	(date) => string	-	shared/src/hooks/useIntl.ts:48
formatTimeSpan()	(start, end) => string	-	shared/src/hooks/useIntl.ts:39
getCurrencySymbol()	(currency) => string	-	shared/src/hooks/useIntl.ts:66
getLocalizedText()	(de, en) => string	-	shared/src/hooks/useIntl.ts:69
getWeekdayName()	(dayIndex, format?) => string	-	shared/src/hooks/useIntl.ts:50
intl	__module	-	shared/src/hooks/useIntl.ts:72
locale	Locale	-	shared/src/hooks/useIntl.ts:28

Example

const { formatMoney, formatDate, locale } = useIntl();
formatMoney(1234.56); // Uses user's default currency and locale
formatDate(new Date()); // Uses user's locale