react-i18next 11.16.7 → 11.16.10

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+### 11.16.10
+
+- types: translation component types [1509](https://github.com/i18next/react-i18next/pull/1509)
+
+### 11.16.9
+
+- types: fix missing generic type for HTMLAttributes [1499](https://github.com/i18next/react-i18next/pull/1499)
+
+### 11.16.8
+
+- types: fix Trans component to support react 18 types, by introducing allowObjectInHTMLChildren TS option [1492](https://github.com/i18next/react-i18next/pull/1492)
+
 ### 11.16.7
 
 - types: Added objects explicitly to Trans children [1486](https://github.com/i18next/react-i18next/pull/1486)

package/README.md

@@ -3,12 +3,14 @@
 [![CircleCI](https://circleci.com/gh/i18next/react-i18next.svg?style=svg)](https://circleci.com/gh/i18next/react-i18next)
 [![Code Climate](https://codeclimate.com/github/codeclimate/codeclimate/badges/gpa.svg)](https://codeclimate.com/github/i18next/react-i18next)
 [![Coverage Status](https://coveralls.io/repos/github/i18next/react-i18next/badge.svg)](https://coveralls.io/github/i18next/react-i18next)
-[![Quality][quality-badge] ][quality-url]
+[![Quality][quality-badge]][quality-url]
+[![npm][npm-dl-badge]][npm-url]
 
 [npm-icon]: https://nodei.co/npm/react-i18next.png?downloads=true
 [npm-url]: https://npmjs.org/package/react-i18next
-[quality-badge]: http://npm.packagequality.com/shield/react-i18next.svg
-[quality-url]: http://packagequality.com/#?package=react-i18next
+[quality-badge]: https://npm.packagequality.com/shield/react-i18next.svg
+[quality-url]: https://packagequality.com/#?package=react-i18next
+[npm-dl-badge]: https://img.shields.io/npm/dw/react-i18next
 
 ### IMPORTANT:
 
@@ -75,7 +77,7 @@ Head over to the **interactive playground** at [codesandbox](https://codesandbox
 ### Why i18next?
 
 - **Simplicity:** no need to change your webpack configuration or add additional babel transpilers, just use create-react-app and go.
-- **Production ready** we know there are more needs for production than just doing i18n on the clientside, so we offer wider support on [serverside](https://www.i18next.com/supported-frameworks.html) too (nodejs, php, ruby, .net, ...). **Learn once - translate everywhere**.
+- **Production ready** we know there are more needs for production than just doing i18n on the clientside, so we offer wider support on [serverside](https://www.i18next.com/overview/supported-frameworks) too (nodejs, php, ruby, .net, ...). **Learn once - translate everywhere**.
 - **Beyond i18n** comes with [locize](https://locize.com) bridging the gap between developement and translations - covering the whole translation process.
 
 ![ecosystem](https://raw.githubusercontent.com/i18next/i18next/master/assets/i18next-ecosystem.jpg)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-i18next",
-  "version": "11.16.7",
+  "version": "11.16.10",
   "description": "Internationalization for react done right. Using the i18next i18n ecosystem.",
   "main": "dist/commonjs/index.js",
   "types": "./index.d.ts",

package/ts4.1/index.d.ts

@@ -40,6 +40,7 @@ export interface Resources {}
  *     nsSeparator: ':';
  *     keySeparator: '.';
  *     jsonFormat: 'v4';
+ *     allowObjectInHTMLChildren: false;
  *     resources: {
  *       custom: {
  *         foo: 'foo';
@@ -62,6 +63,7 @@ type TypeOptions = MergeBy<
     defaultNS: 'translation';
     jsonFormat: 'v4';
     resources: Resources;
+    allowObjectInHTMLChildren: false;
   },
   CustomTypeOptions
 >;
@@ -97,6 +99,15 @@ declare module 'i18next' {
   }
 }
 
+type ObjectOrNever = TypeOptions['allowObjectInHTMLChildren'] extends true
+  ? Record<string, unknown>
+  : never;
+declare module 'react' {
+  interface HTMLAttributes<T> {
+    children?: ReactNode | ObjectOrNever;
+  }
+}
+
 type PluralSuffix = 'zero' | 'one' | 'two' | 'few' | 'many' | 'other';
 
 type WithOrWithoutPlural<K> = TypeOptions['jsonFormat'] extends 'v4'
@@ -245,13 +256,14 @@ export interface TFunction<N extends Namespace = DefaultNamespace, TKPrefix = un
   ): TFuncReturn<N, TKeys, TDefaultResult, TKPrefix>;
 }
 
+type TransChild = React.ReactNode | Record<string, unknown>;
 export type TransProps<
   K extends TFuncKey<N, TKPrefix> extends infer A ? A : never,
   N extends Namespace = DefaultNamespace,
   TKPrefix = undefined,
   E = React.HTMLProps<HTMLDivElement>
 > = E & {
-  children?: React.ReactNode | Record<string, unknown>;
+  children?: TransChild | TransChild[];
   components?: readonly React.ReactNode[] | { readonly [tagName: string]: React.ReactNode };
   count?: number;
   context?: string;
@@ -314,8 +326,11 @@ export function withSSR(): <Props>(
   getInitialProps: (ctx: unknown) => Promise<any>;
 };
 
-export interface WithTranslation<N extends Namespace = DefaultNamespace> {
-  t: TFunction<N>;
+export interface WithTranslation<
+  N extends Namespace = DefaultNamespace,
+  TKPrefix extends KeyPrefix<N> = undefined
+> {
+  t: TFunction<N, TKPrefix>;
   i18n: i18n;
   tReady: boolean;
 }
@@ -325,10 +340,14 @@ export interface WithTranslationProps {
   useSuspense?: boolean;
 }
 
-export function withTranslation<N extends Namespace = DefaultNamespace>(
+export function withTranslation<
+  N extends Namespace = DefaultNamespace,
+  TKPrefix extends KeyPrefix<N> = undefined
+>(
   ns?: N,
   options?: {
     withRef?: boolean;
+    keyPrefix?: TKPrefix;
   },
 ): <
   C extends React.ComponentType<React.ComponentProps<any> & WithTranslationProps>,
@@ -349,9 +368,9 @@ export interface I18nextProviderProps {
 export const I18nextProvider: React.FunctionComponent<I18nextProviderProps>;
 export const I18nContext: React.Context<{ i18n: i18n }>;
 
-export interface TranslationProps<N extends Namespace = DefaultNamespace> {
+export interface TranslationProps<N extends Namespace = DefaultNamespace, TKPrefix> {
   children: (
-    t: TFunction<N>,
+    t: TFunction<N, TKPrefix>,
     options: {
       i18n: i18n;
       lng: string;
@@ -361,8 +380,10 @@ export interface TranslationProps<N extends Namespace = DefaultNamespace> {
   ns?: N;
   i18n?: i18n;
   useSuspense?: boolean;
+  keyPrefix?: TKPrefix;
 }
 
-export function Translation<N extends Namespace = DefaultNamespace>(
-  props: TranslationProps<N>,
-): any;
+export function Translation<
+  N extends Namespace = DefaultNamespace,
+  TKPrefix extends KeyPrefix<N> = undefined
+>(props: TranslationProps<N, TKPrefix>): any;