Skip to content

Latest commit

 

History

History
481 lines (267 loc) · 13.9 KB

CHANGELOG.md

File metadata and controls

481 lines (267 loc) · 13.9 KB
Raw

8.0.6

  • fix SSR cases

8.0.5

  • fix issue with context not applied when merging i18n options

8.0.4

  • add prop-types to peer deps as long we use the ponyfill create-react-context

8.0.3

  • remove prop-types in tests

8.0.2

  • remove proptypes dependency - not needed anylonger as we do not define old context
  • move out ssr stuff to utils
  • move reportNS to the NamespacesConsumer

8.0.1

  • use @babel/plugin-transform-runtime

8.0.0

  • translate HOC was renamed to "withNamespaces" as it controls which namespaces should be loaded

  • I18n render prop was renamed to "NamespacesConsumer" as it controls which namespaces should be "consumed"

  • there is a new context.consuming HOC "withI18n" adds i18n, t to component props (without the extra options of withNamespaces)

  • there is a simplification for interpolation in translations

'Hello <1><0>{{name}}</0></1>, you have <3>{{count}}</3> message. Open <5>hear</5>.'

can be written as:

'Hello <1>{{name}}</1>, you have {{count}} message. Open <5>hear</5>.'

=> there is no need to add <0>...</0> around interpolated values anylonger => your old files having those extra pseudo tags will still work without needing to change them

  • there is a new I18nContext -> I18nContext.provider, I18next.consumer using new react context api

Using react's new context api

should be non breaking in most cases, with following exceptions:

  • using preact you will have to use preact.createContext plugin (or eventual hope the provided polyfill works for preact too)
  • you used the translate.getWrappedInstance function -> you will need to use instance.getWrappedInstance().getWrappedInstance() now as the translate hoc is now wrapped in an additional I18nContext.Consumer

still we prefer to increase this to a major version as beside the described egde cases there might be other effects we not have covered with our tests

7.13.0

  • Load missing namespaces when updating ns prop on I18n component 523

7.12.0

  • pass down lng via props in I18n and translate HOC - for use cases like 508

7.11.1

  • fix related to issue #504: also report default Namespace with translate() 506

7.11.0

  • Added reportNS function to I18NextProvider to report used namespaces 500

7.10.1

  • fix small issue in icu.macro introduced on refactoring

7.10.0

  • Adds import { Trans, Plural, Select } from react-i18next/icu.macro a babel macro to allow nicer components used with ICU format (which as default would result in invalid JSX). discussion

7.9.1

  • Skip custom html tags in Trans component translation PR482

7.9.0

  • Support defaultNS from I18nextProvider props PR478
  • Don't polyfill Object.entries globally 476

7.8.1

  • i18n in context is optional as it can be passed via props too 474

7.8.0

  • avoid rerenders triggered by bound i18next events while I18n or translate hoc are not ready yet (omitBoundRerender: true --- is default) 456

7.7.0

  • Allow Trans component to be used with props only for icu use case (next step babel makro) 439

7.6.1

  • Allow to pass a function as parent for component PR424

7.6.0

  • adds tOptions to Trans component to support ICU
  • removes componentWillMount lifecycle method from I18n.js render props as it will get deprecated on react 16.3 404

7.5.1

  • Fix reference to props in constructor PR411

7.5.0

  • passes down tReady from translate hoc for cases you prefer showing a placeholder instead of default return null in case of wait: true and not yet loaded translations PR400
  • I18n render prop calls with ready as third param

7.4.0

  • enables setting prop ns on Trans component to override namespace passed by render prop or hoc
  • allows trans component with no children just returning the string getting from translations

7.3.6

  • reorder selection of i18n in I18n render prop

7.3.5

  • reorder selection of i18n in I18n render prop

7.3.4

  • more save access to options in general

7.3.3

  • more save access to options.react

7.3.2

  • replace Interpolate PureComponent with Component to assert it gets rerendered on lng change

7.3.1

  • remove react-dom from peer dependencies as module is used in react-native too

7.3.0

  • Allow translate HOC to take a function for getting namespaces 372

7.2.0

  • Add usePureComponent option PR357
  • Render empty string on empty string as Trans child PR364

7.1.1

  • fixes: bring back Trans component t fc from context

7.1.0

  • optional take i18n.t in Trans component if non t function passed in via props or context

7.0.2

  • fixes rendering in Trans component in case of no parent

7.0.1

  • working Trans component without the need of setting options.react

7.0.0

  • [BREAKING] As with react 16 you can return multiple elements from render - based on that we do not need to return a wrapper any longer from Trans component.

Starting with v7.0.0 Trans component per default won't add a parent div around content passed as children. It will just return it's children.

You still got the option to set a parent if you prefer content being wrapped.

If you prefer wrapping for all your Trans components (or for backwards compatibility) you can set option react.defaultTransParent to an element on i18next init.

6.2.0

  • adds hashTransKey function for custom key generation in case of not passing a key to Trans component and not like having the source value as key

6.1.0

  • pre-check namespaces to avoid unnecessary initial null render PR336

6.0.6

  • remove PureComponent from Trans

6.0.5

  • fixes support passing i18n and t to Trans as props PR315

6.0.4

  • fixes translate hoc build

6.0.3

  • stop using PureComponent and use Component again...seems we get an issue with react-router v4 if using PureComponents
  • recreate t function on i18next updates so PureComponents relying on t get an update triggered

6.0.2

  • rebuild needed cause of uppercasing for components name was not reflected in last build

6.0.1

  • remove react from dependencies - not sure how that came into the package.json

6.0.0

  • [BREAKING] removes options to set translateFuncName in translate hoc (was not supported in Trans and Interpolate component anyway)
  • setting i18n instance and defaults can now be done by i18next.use(reactI18nextModule) making I18nextProvider obsolete
  • As an alternative to the translate hoc you now can use the I18n component supporting a render props (for details about render props https://www.youtube.com/watch?v=BcVAq3YFiuc)

5.4.1

  • fixes AST implementation for preact

5.4.0

  • replaces regex used to parse nodes from string to an ast implementation solving #298

5.3.0

  • Pass extra parameters to Trans parent component

5.2.0

  • adds module export in package.json pointing to es dist files.

5.1.0

  • you now can set i18n instance on translate hoc once using setI18n:
import translate from 'react-i18next';
import i18n from './i18n';

translate.setI18n(i18n);

5.0.0

  • [BREAKING] we no longer accept wait to be specified on i18next init options like { wait: true } -> all overrides for the translate hoc now have to be in child react like { react: { wait: true } }
  • you now can override all the default options for translate hoc by setting them on i18next.init (excluding translateFuncName as we need that upfront to define childContextTypes)
i18next.init({
  // ... other options
  react: {
    wait: false,
    withRef: false,
    bindI18n: 'languageChanged loaded',
    bindStore: 'added removed',
    nsMode: 'default'
  }
});
  • you now can override all defaults for translate hoc options (including translateFuncName) by using:
import translate from 'react-i18next';

translate.setDefaults({
  wait: false,
  withRef: false,
  bindI18n: 'languageChanged loaded',
  bindStore: 'added removed',
  nsMode: 'default',
  translateFuncName: 't'
});

4.8.0

  • make trans component work with preact and preact-compat
  • add preact example

4.7.0

  • Trans component parent element configurable PR278

4.6.4

  • optimize generated defaultValue for components not having children

4.6.3

  • move react, prop-types, ... to peerDependency again

4.6.2

  • optimize trans component output

4.6.1

  • fixes issue in changeLanguage on set via translate hoc ssr

4.6.0

  • allow passing initialI18nStore and initialLanguage to I18nextProvider via props to support simpler ssr
  • adds a serverside rendering sample based on razzle

4.5.0

  • pass i18n instance to context inside translate hoc to simplify usage in nextjs
  • options.react.exposeNamespace will expose namespace on data-i18next-options for consuming in editors

4.4.0

  • introduces Trans component which enables you to translate nested components incl. interpolation by resulting in one translatable string. learn more

4.3.0

  • allow passing down initialI18nStore and initialLanguage to translate hoc to support ssr scenario better see example/nextjs

4.2.0

  • allow passing i18next instance in translate hoc options makes integration in nextjs easier

4.1.2

  • Remove workaround to set ready if there was no initialized signal PR263

4.1.1

  • Fix react-i18next to work with TypeScript PR261

4.1.0

  • eslint cleanup
  • a lot more tests
  • flag nsMode: 'fallback' -> uses namespaces passed to translate hoc as fallbacks #254

4.0.0

  • deploys 3.1.1 as possible breaking: fixes issue in fixing t function - pass only first namespace not an array of namespaces (access other namespaces like: this.props.t('namespace:key'))

3.1.2

  • reverts last change

3.1.1

  • fixes issue in fixing t function - pass only first namespace not an array of namespaces

3.1.0

  • fixes wrong warning of missing prop on interpolate with format
  • the wait flag on translate hoc can now be set globally on i18next options i18next.init({ wait: true })

3.0.0

  • [BREAKING] assert you install prop-types as a peerDependency based on changes in react >= 15.5.x
  • update react to 15.5.x use prop-types module to remove react warnings PR248
  • update all dependencies
  • move react, prop-types to peerDependencies

2.2.3

  • try not access store if undefined for hmr

2.2.1

  • fixes validation for missing prop in interpolate component

2.2.0

  • support formatting inside interpolate component

2.1.0

  • tanslate hoc: expose the i18n instance via props

2.0.0

  • translate hoc wait option asserts now that i18next is initialized before rendering (waits for lng detection)
  • [BREAKING] needs i18next >= 4.2.0

1.11.0

  • pass style prop to interpolate component
  • define i18next as a peerDependency

1.10.1

  • Suppresses required context type warning if passing i18n as a prop PR205

1.10.0

  • allow passing i18next instance via props to translate hoc PR203

1.9.0

  • adds options bindI18n, bindStore can be set to false or string of events to bind for triggering updates

1.8.0

  • allows to set a className on interpolate component
  • update all dependencies and devDependencies

1.7.0

  • add option to change t function name to something else PR196
  • Added an option of using the with a raw HTML PR195

1.6.3

  • only trigger loaded namespaces if mounted

1.6.2

  • update for react 15.2, eliminates Unknown Prop Warning

1.6.1

  • Added conditional warning on unmatched variable during interpolation [PR 160](i18next#160

1.6.0

1.5.3

  • Handle i18next added and removed resource events [PR 150](i18next#150

1.5.2

  • move ns loading to did mount

1.5.1

  • possible fix for HRM issues

1.5.0

  • adds wait option, which delays initial rendering until translations are loaded

1.4.2

  • possible fix for HRM issues

1.4.1

  • change global name

1.4.0

  • adds getWrappedInstance() to translate wrapper

1.3.0

  • Support for universal apps / server-side rendering PR 52

1.2.2

  • fixes bower json - bower publish only

1.2.0

  • change build to rollup

1.1.0

  • added WrappedComponent property to translate wrapper PR 15

1.0.1

  • fixing export of index

1.0.0

  • change package.json main to /lib/index.js
  • move build from gulp to npm run script