Skip to content

Latest commit

 

History

History
55 lines (37 loc) · 2.34 KB

CHANGELOG.md

File metadata and controls

55 lines (37 loc) · 2.34 KB
Raw

7.1.0

Fix: global types of HOC function. Breaking change: Removes TranslateGlobal type in favour of identical TranslateType

7.0.3

Feat: Type guard for .has function

7.0.2

Fix: smart_count property type

7.0.1

Fix: global translation types in 7.0.0 were wrong

  • Adds tests for global translation types

7.0.0

Breaking changes:

  • You have to create your own I18n Context now with const I18n = React.createContext<I18nContext<Locale>>({ locale: Locale.en }); and then pass the Context as the first argument of useTranslations, useLocale and hoc
  • Compilation target changed from es5 to es2017
  • Adds Locale type safety. Make sure you have tsconfig compilerOption "resolveJsonModule": true to get full benefits
  • Postprocess no longer supports a React.ReactNode return type

6.0.0

Breaking changes:

Adds stricter type checking of translation strings. If using the preprocess option you may need to now use as any or pass the generic useTranslations<Translations>(); in order to pass type checks

5.0.0

  • TypeScript rewrite (includes full typings)
  • Added hooks: useLocale, useTranslations
  • Migrate to React Context
  • Added: reference other translations: %{t:local_tr}, %{g:local_tr}. Especially useful with global translations.
  • Added: transforms, e.g. to capitalize certain words (especially useful in a language like German). Uses %{translation_key | transform} syntax.
  • Added: preprocess, useful for implementing Live Translation.
  • Added: postprocess, e.g. to convert markdown in your translations, as to keep them free of HTML.
  • Removed: LanguageHandler, Subscription, and other legacy React Context hacks.
  • Replaced: node-polyglot with a trimmed, improved version
  • Renamed: translateApi -> tr. Now supports the same options as I18n.Provider.
  • Removed: debug option
  • Removed: setLocale. This is rarely useful; we recommend setting the locale via (sub)domain instead of directory. If necessary this can be re-implemented using another context and setting I18n.Provider's value={{locale:..}}.
  • Changed: onMissingKey -> convertMissingKey, now also takes the translations object as a second parameter.
  • Removed: fallbackLocale. Use convertMissingKey's second parameter.

5.1.0

  • Added: access nested properties by using dot notation. %{user.name} by passing in a user object { user: { name: 'David' }} as the second argument to a translate call