Перейти к основному содержимому

useMessages()

function useMessages<D>(defaults): (key, values?) => string;

Defined in: platforms/react/i18n/hooks.ts:54

Переводчик пакета: ищет ключ в локали провайдера, а при промахе берёт встроенную английскую таблицу этого пакета. Так пакет говорит по-английски без провайдера и не зависит от того, знает ли локаль его ключи. Тип ключа выводится из таблицы — опечатка в ключе не скомпилируется.

defaults должен быть стабильной ссылкой (импорт JSON-модуля), иначе переводчик будет пересоздаваться на каждый рендер.

Type Parameters​

D​

D extends Readonly<Record<string, string>>

Parameters​

defaults​

D

Встроенная английская таблица пакета.

Returns​

Функция (ключ, значения?) => строка; её идентичность меняется вместе с локалью.

(key, values?): string;

Parameters​

key​

keyof D & string

values?​

Readonly<Record<string, unknown>>

Returns​

string

Example​

import en from './locale/en.json';

const useKitMessages = () => useMessages(en);

function ClearButton() {
  const t = useKitMessages();
  return <button aria-label={t('kit.select.clear')} />;
}