npm - locizify - Versions diffs - 5.0.5 → 5.2.0 - Mend

locizify 5.0.5 → 5.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (13) hide show

package/CHANGELOG.md CHANGED Viewed

@@ -1,3 +1,15 @@
+### v5.2.0
+- update i18next dependencies
+### v5.1.0
+- update locize dependecy and expose editor functions turnOn/Off
+### v5.0.6
+- update locize dependencies
 ### v5.0.5
 - update locize dependencies
@@ -120,7 +132,6 @@
 - update deps using `locize.app` instead of `locize.io`
 - remove bower
 ### v2.15.1
 - update deps

package/README.md CHANGED Viewed

@@ -16,7 +16,7 @@ Just drop the following line to your header to deliver your content in any langu
   apikey="[API_KEY]"
   referencelng="[LNG]"
   fallbacklng="[LNG]"
-  src="https://unpkg.com/locizify@^5.0.3"
+  src="https://unpkg.com/locizify@^5.0.5"
 ></script>
 ```
@@ -36,7 +36,6 @@ Did you wait 5-10 seconds before refreshing the locize UI? It may take a couple
 Per default only `localhost` is allowed to send missing keys ([or update missing keys](https://www.i18next.com/overview/configuration-options#missing-keys)) (to avoid using this feature accidentally [in production](https://docs.locize.com/guides-tips-and-tricks/going-production)). If you're not using `localhost` during development you will have to set the `allowedAddOrUpdateHosts: ['your.domain.tld']`.
 ## Find more information
 locizify wraps some other modules from locize and i18next so there are additional valuable resources to read to get details on all the provided options:
@@ -61,7 +60,7 @@ Add the script to your page:
       apikey="[API_KEY]"
       referencelng="[LNG]"
       fallbacklng="[LNG]"
-      src="https://unpkg.com/locizify@^5.0.3"
+      src="https://unpkg.com/locizify@^5.0.5"
     ></script>
   </head>
   ...
@@ -93,7 +92,7 @@ Add the script to your page:
       apikey="[API_KEY]"
       referencelng="[LNG]"
       fallbacklng="[LNG]"
-      src="https://unpkg.com/locizify@^5.0.3"
+      src="https://unpkg.com/locizify@^5.0.5"
       // optional
       version="[VERSION]"
@@ -117,7 +116,7 @@ Add the script to your page:
 <!DOCTYPE html>
 <html>
   <head>
-    <script src="https://unpkg.com/locizify@^5.0.3"></script>
+    <script src="https://unpkg.com/locizify@^5.0.5"></script>
     <script>
       locizify.init({
         // required
@@ -214,10 +213,10 @@ locizify.getLanguages(function(err, lngs) {
 ```js
 const translation = locizify.init({
-  autorun: false
+  autorun: false,
 });
-setTimeout(function() {
+setTimeout(function () {
   translation.start();
 }, 1000);
 ```
@@ -298,7 +297,7 @@ Just add needed items to the specific array:
 locizify.init({
   ignoreTags: ['SCRIPT'], // need to be uppercased
   ignoreIds: ['ignoreMeId'],
-  ignoreClasses: ['ignoreMeClass']
+  ignoreClasses: ['ignoreMeClass'],
 });
 ```
@@ -345,7 +344,7 @@ Default would be translation.
 ```js
 locizify.init({
-  namespace: 'myNamespace'
+  namespace: 'myNamespace',
 });
 ```
@@ -353,7 +352,7 @@ locizify.init({
 ```js
 locizify.init({
-  namespaceFromPath: true
+  namespaceFromPath: true,
 });
 ```
@@ -415,7 +414,8 @@ Per default the virtualdom implementation will use the extracted content as keys
 }
 ```
-In some situations you like to define an explicit key for that segment:
+In some situations you like to define an explicit key for that segment.
+The default key attribute is `i18next-key`, so just add that attribute to the html element to be used as own translation key and the html element value will be used as default value:
 ```js
 // <div i18next-key="myKey">This is my text.</div>
@@ -427,6 +427,8 @@ In some situations you like to define an explicit key for that segment:
 }
 ```
+\*Do NOT replace your html content with a custom key. This will technically work, but your server side representation will be negatively influenced (SEO), because there will not be any nice content fallback. Search engines like google search will then show your custom i18n keys instead of your website content. **So better use the `i18next-key` attribute to achieve this!\***
 There are two init options to configure this further:
 ```js
@@ -434,7 +436,7 @@ locizify.init({
   // ...
   keyAttr: 'i18next-key', // node attribute to use as key
-  ignoreWithoutKey: false // set to true to only extract/translate nodes having a key
+  ignoreWithoutKey: false, // set to true to only extract/translate nodes having a key
   // ...
 });
@@ -467,3 +469,14 @@ You will have to enforce flat JSON in your locize project (settings -> publish f
 ```js
 locizify.forceRerender();
 ```
+## access to locize script (locize InContext editor)
+https://github.com/locize/locize
+```js
+let isOff;
+isOff = locizify.editor.turnOff(); // -> true
+isOff = locizify.editor.turnOn(); // -> false
+```

package/dist/commonjs/index.js CHANGED Viewed

@@ -120,7 +120,12 @@ _i18nextify["default"].getOptions = function (callback) {
     i18next.on('initialized', ready);
   }
-};
+}; // add editor functions
+_i18nextify["default"].editor = {
+  turnOn: _locize.turnOn,
+  turnOff: _locize.turnOff
+};
 var _default = _i18nextify["default"];
 exports["default"] = _default;

package/dist/es/index.js CHANGED Viewed

@@ -7,7 +7,7 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 import i18nextify from 'i18nextify';
 import LocizeBackend from 'i18next-locize-backend';
-import { locizePlugin } from 'locize';
+import { locizePlugin, turnOn, turnOff } from 'locize';
 var i18next = i18nextify.i18next;
 var enforce = {
   saveMissingTo: 'all'
@@ -107,6 +107,11 @@ i18nextify.getOptions = function (callback) {
     i18next.on('initialized', ready);
   }
-};
+}; // add editor functions
+i18nextify.editor = {
+  turnOn: turnOn,
+  turnOff: turnOff
+};
 export default i18nextify;