react-localization 1.0.13 → 1.0.17

package/README.md

@@ -13,7 +13,7 @@ The library uses the current interface language, then it loads and displays the
 
 It's possible to force a language different from the interface one.
 
-##Installation
+## Installation
 
 `npm install --save react-localization`
 
@@ -22,7 +22,7 @@ It's possible to force a language different from the interface one.
 In the React class that you want to localize require the library and define the strings object passing to the constructor a simple object containing a language key (i.e. en, it, fr..) and then a list of key-value pairs with the needed localized strings.
 
  ```js
-\\ES6 module syntax
+// ES6 module syntax
 import LocalizedStrings from 'react-localization';
 
 let strings = new LocalizedStrings({
@@ -73,7 +73,7 @@ strings.setContent({
 * setLanguage(languageCode) - to force manually a particular language
 * getLanguage() - to get the current displayed language
 * getInterfaceLanguage() - to get the current device interface language
-* formatString() - to format the passed string replacing its placeholders with the other arguments strings
+* formatString() - formats the input string and returns a new string, replacing its placeholders with the other arguments strings
 ```js
   en:{
     bread:"bread",
@@ -103,6 +103,17 @@ strings.setContent({
     year: 2018
   })
 ```
+
+Typical usage is to render it in a JSX with `formatString` calls inlined:
+
+```jsx
+<div>
+ <SomeComponent food={strings.formatString(strings.question, strings.bread, "jam")} />
+ <p>Usage with an object parameter: {
+  strings.formatString(strings.currentDate, { month: "February", day: 13, year: 2050 })
+ }></p>
+</div>
+```
 **Beware: do not define a string key as formatString!**
 
 * setContent(props) - to dynamically load another set of strings

package/lib/LocalizedStrings.d.ts

@@ -9,7 +9,7 @@ declare module 'react-localization' {
     export interface LocalizedStringsMethods {
         /**
          * Can be used from ouside the class to force a particular language
-         * indipendently from the interface one
+         * independently from the interface one
          * @param language 
          */
         setLanguage(language: string): void;
@@ -43,7 +43,7 @@ declare module 'react-localization' {
          * @param key 
          * @param language 
          */
-        getString(key: string, language: string): string;
+        getString(key: string, language?: string, omitWarning?: boolean): string;
 
         /**
          * Replace the NamedLocalization object without reinstantiating the object
@@ -54,8 +54,17 @@ declare module 'react-localization' {
 
     export type LocalizedStrings<T> = LocalizedStringsMethods & T;
 
+    type GetInterfaceLanguageCallback = () => string;
+
+    interface Options {
+        customLanguageInterface?: GetInterfaceLanguageCallback;
+        logsEnabled?: boolean;
+        pseudo?: boolean;
+        pseudoMultipleLanguages?: boolean;
+    }
+
     interface LocalizedStringsFactory {
-        new <T>(props: GlobalStrings<T>): LocalizedStrings<T>;
+        new <T>(props: GlobalStrings<T>, options?: Options): LocalizedStrings<T>;
     }
 
     var LocalizedStrings: LocalizedStringsFactory;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-localization",
-  "version": "1.0.13",
+  "version": "1.0.17",
   "description": "Simple module to localize the React interface using the same syntax used in the ReactNativeLocalization module, use 'npm run build' before publishing",
   "scripts": {
     "babel-version": "babel --version",
@@ -34,10 +34,13 @@
     "babel-preset-es2015": "^6.24.1",
     "babel-preset-react": "^6.24.1",
     "babel-preset-stage-2": "^6.24.1",
-    "jasmine": "^2.7.0"
+    "jasmine": "^2.7.0",
+    "react": "^16.0.0"
   },
   "dependencies": {
-    "localized-strings": "^0.2.00",
-    "react": "^16.0.0"
+    "localized-strings": "^0.2.0"
+  },
+  "peerDependencies": {
+    "react": "^17.0.0 || ^16.0.0 || ^15.6.0"
   }
 }