Skip to content

Commit

Permalink
experimental support for hooks
Browse files Browse the repository at this point in the history
  • Loading branch information
jamuhl committed Oct 26, 2018
1 parent 69d6822 commit 897576d
Show file tree
Hide file tree
Showing 27 changed files with 2,869 additions and 22 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
### 8.2.0

- comes with support for hooks that are experimental in react v16.7.0-alpha [learn more](https://react.i18next.com/experimental/using-with-hooks)

### 8.1.2

- publish changes to typescript definitions [567](https://github.com/i18next/react-i18next/pull/567)
Expand Down
39 changes: 18 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,10 @@
[npm-url]: https://npmjs.org/package/react-i18next
[travis-ci-image]: https://travis-ci.org/i18next/react-i18next.svg?branch=master
[travis-ci-url]: https://travis-ci.org/i18next/react-i18next

[dependencies-image]: https://david-dm.org/i18next/react-i18next.png
[dependencies-url]: https://david-dm.org/i18next/react-i18next
[devdependencies-image]: https://david-dm.org/i18next/react-i18next/dev-status.png
[devdependencies-url]: https://david-dm.org/i18next/react-i18next#info=devDependencies

[quality-badge]: http://npm.packagequality.com/shield/react-i18next.svg
[quality-url]: http://packagequality.com/#?package=react-i18next

Expand Down Expand Up @@ -79,37 +77,35 @@ Want to learn more about how seamless your internationalization and translation

### Installation

Source can be loaded via [npm](https://www.npmjs.com/package/react-i18next), bower or [downloaded](https://github.com/i18next/react-i18next/blob/master/react-i18next.min.js) from this repo.
Source can be loaded via [npm](https://www.npmjs.com/package/react-i18next) or [downloaded](https://github.com/i18next/react-i18next/blob/master/react-i18next.min.js) from this repo.

```
# npm package
$ npm install react-i18next
# bower
$ bower install react-i18next
```

- If you don't use a module loader it will be added to `window.reactI18next`

### Examples

* [Example react](https://github.com/i18next/react-i18next/tree/master/example/react)
* [Example preact](https://github.com/i18next/react-i18next/tree/master/example/preact)
* [Example react-native](https://github.com/i18next/react-i18next/tree/master/example/reactnative-expo)
* [Example expo.io](https://github.com/i18next/react-i18next/tree/master/example/reactnative-expo)
* [Example next.js](https://github.com/i18next/react-i18next/tree/master/example/nextjs)
* [Example razzle](https://github.com/i18next/react-i18next/tree/master/example/razzle-ssr)
* [Example hashbase / beaker browser](https://github.com/i18next/react-i18next/tree/master/example/dat)
* [Example storybook](https://github.com/i18next/react-i18next/tree/master/example/storybook)
* [Example locize.com](https://github.com/i18next/react-i18next/tree/master/example/locize-example)
* [Example test with jest](https://github.com/i18next/react-i18next/tree/master/example/test-jest)
- [Example react](https://github.com/i18next/react-i18next/tree/master/example/react)
- [Example react using hocs (react 16.7.0-alpha)](https://github.com/i18next/react-i18next/tree/master/example/react-hooks)
- [Example preact](https://github.com/i18next/react-i18next/tree/master/example/preact)
- [Example react-native](https://github.com/i18next/react-i18next/tree/master/example/reactnative-expo)
- [Example expo.io](https://github.com/i18next/react-i18next/tree/master/example/reactnative-expo)
- [Example next.js](https://github.com/i18next/react-i18next/tree/master/example/nextjs)
- [Example razzle](https://github.com/i18next/react-i18next/tree/master/example/razzle-ssr)
- [Example hashbase / beaker browser](https://github.com/i18next/react-i18next/tree/master/example/dat)
- [Example storybook](https://github.com/i18next/react-i18next/tree/master/example/storybook)
- [Example locize.com](https://github.com/i18next/react-i18next/tree/master/example/locize-example)
- [Example test with jest](https://github.com/i18next/react-i18next/tree/master/example/test-jest)

### Requirements

- react >= __0.14.0__ (in case of < v16 or preact you will need to define parent in [Trans component](https://react.i18next.com/components/trans-component.html#props) or globally in [i18next.react options](https://react.i18next.com/components/trans-component.html#additional-options-on-i18nextinit))
- i18next >= __2.0.0__
- react >= **0.14.0** (in case of < v16 or preact you will need to define parent in [Trans component](https://react.i18next.com/components/trans-component.html#props) or globally in [i18next.react options](https://react.i18next.com/components/trans-component.html#additional-options-on-i18nextinit))
- i18next >= **2.0.0**

--------------
---

<h3 align="center">Gold Sponsors</h3>

Expand All @@ -119,7 +115,8 @@ $ bower install react-i18next
</a>
</p>

--------------
---

**localization as a service - locize.com**

Needing a translation management? Want to edit your translations with an InContext Editor? Use the orginal provided to you by the maintainers of i18next!
Expand All @@ -128,4 +125,4 @@ Needing a translation management? Want to edit your translations with an InConte

With using [locize](http://locize.com/?utm_source=react_i18next_readme&utm_medium=github) you directly support the future of i18next and react-i18next.

--------------
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"extendedComponentReportingItsNamespace": "extendedComponentReportingItsNamespace"
}
1 change: 1 addition & 0 deletions example/react-hooks/.env
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
SKIP_PREFLIGHT_CHECK=true
21 changes: 21 additions & 0 deletions example/react-hooks/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# See https://help.github.com/ignore-files/ for more about ignoring files.

# dependencies
/node_modules

# testing
/coverage

# production
/build

# misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
Loading

0 comments on commit 897576d

Please sign in to comment.