i18n-keyless-react 1.7.3 → 1.7.5

package/dist/I18nKeylessText.d.ts

@@ -1,11 +1,32 @@
 import React from "react";
 import { TranslationOptions } from "i18n-keyless-core";
-interface I18nKeylessTextProps {
+export interface I18nKeylessTextProps {
+    /**
+     * children must be a string
+     * it's the text to translate from your primary language
+     */
     children: string;
+    /**
+     * the keys to replace in the text
+     * it's an object where the key is the placeholder and the value is the replacement
+     * example: { "{{name}}": "John" } will replace all the {{name}} in the text with "John"
+     * RegEx is `key.replace(/[.*+?^${}()|[\]\\]/g, "\\$&"))` so you can use use your own syntax
+     */
     replace?: Record<string, string>;
+    /**
+     * the context of the translation
+     * it's useful for ambiguous translations, like "8 heures" in French could be "8 AM" or "8 hours"
+     */
     context?: string;
+    /**
+     * if true, some helpful logs will be displayed in the console
+     */
     debug?: boolean;
+    /**
+     * if true, the translation will be saved as temporary
+     * it's useful if you want to use the translation in a different context
+     * you can leave it there forever, or remove it once your translation is saved
+     */
     forceTemporary?: TranslationOptions["forceTemporary"];
 }
 export declare const I18nKeylessText: React.FC<I18nKeylessTextProps>;
-export {};

package/dist/index.d.ts

@@ -1,2 +1,3 @@
 export { I18nKeylessText } from "./I18nKeylessText";
 export { init, getTranslation, setCurrentLanguage, useCurrentLanguage, clearI18nKeylessStorage, fetchAllTranslations, } from "./store";
+export type { I18nKeylessTextProps } from "./I18nKeylessText";

package/dist/package.json

@@ -1,7 +1,7 @@
 {
     "name": "i18n-keyless-react",
     "private": false,
-    "version": "1.7.3",
+    "version": "1.7.5",
     "type": "module",
     "main": "./dist/index.js",
     "module": "./dist/index.js",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "i18n-keyless-react",
   "private": false,
-  "version": "1.7.3",
+  "version": "1.7.5",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",