{"_id":"@kaliber/i18n","_rev":"47-cecb58859522b4251a68de5c84035474","name":"@kaliber/i18n","dist-tags":{"latest":"1.1.0"},"versions":{"1.0.0":{"name":"@kaliber/i18n","version":"1.0.0","keywords":["react","hooks","hook","i18n"],"license":"MIT","_id":"@kaliber/i18n@1.0.0","maintainers":[{"name":"joostkiens","email":"me@joostkiens.com"},{"name":"pkuepers","email":"pkuepers@kaliber.net"},{"name":"daveykropf","email":"davey@kaliber.net"},{"name":"eecolor","email":"eecolor@gmail.com"}],"dist":{"shasum":"36751847cea48a0006ec1b04d20c217db4ec2d57","tarball":"https://registry.npmjs.org/@kaliber/i18n/-/i18n-1.0.0.tgz","fileCount":5,"integrity":"sha512-gkb9J80+YSkAiE/oIeP+7eFD8A+/2eGnJULBhlIACAAGaPsQv+maunLp/xByqKKDrBm8bE7wWOPm5oy5U0oe3A==","signatures":[{"sig":"MEUCIQD5hvoc1XwjB83CHQad80PheZmbdHZPcti9elabZHeXTwIgP027F8Ut1LPYsj5ya+RDSXRtuXqnCc5zlyZaGuBFCoI=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":8608,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJes7byCRA9TVsSAnZWagAAGYkQAI8hew9hsHxzUcouDvvq\n+iUovJda7VKO0iES33ES0ScyDlaAYPT5SHszywC27fSVaHCJDbeYCe3nBVWH\noZ9y81DSVoL/XmYe6i/IrLNBvlSqlIYD2ZJO9eVVz3+Pr+uqZ2tsJzQlkpK1\nNczKOz7/u4fLvXOASixlZ6893uFY2s5/558UfGGWjsHtQIDARDBgz0diAdiv\nBPBDia9g78NdjzXKItfDdhaV++DqcbZwsuCIusRbKUD/KnuLmKOEfUZy750v\nnWEFNXg365cYPJTfqulFv4dBAMt0R/1gONRyvzLnbhsUk0SRhAxFJKO+7qPD\nKEuORBdEOuVgqc85wM/LqP7q7ryyEuqcbnW47jqdwrcdUJxTyhSOzTFISg+t\nQTLYyw8h8upp6MrbKGMJ6OWGbSmnwOtCN3otDLtUihWFSzLq9jRyqtG1/Ieg\nSbWv8ENce5QtncJcsPak0Xteh6IZyuITYnGFQ55uNlgkX9bPvgOGr21Bs1f2\naYB48N6NTN/OTx48rjSJ3HXPnxxzuWLK+5eDczQf7n00YBs9p3ZYWbykS+P6\ngSQWm6t04FoDKkrjprBLB9on9FN7Hhwh0Rb1oth9amTgUPNt8Lp13044Bn2n\nc7VrhIgMlEUw1CIZBE8zSKMz3Vn8LQrsH7OMGY0kAPw3GCuCTJQSIcMg+EGh\nTTQ0\r\n=Qf71\r\n-----END PGP SIGNATURE-----\r\n"},"main":"index.js","private":false,"_npmUser":{"name":"pkuepers","email":"pkuepers@kaliber.net"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.","repository":{"url":"https://github.com/kaliberjs/i18n.git","type":"git"},"description":"Internationalize your React application","directories":{},"licenseText":"MIT License\n\nCopyright (c) 2019 kaliber.js\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","sideEffects":false,"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/i18n_1.0.0_1588836082237_0.46196768069421634","host":"s3://npm-registry-packages"}},"1.0.1":{"name":"@kaliber/i18n","version":"1.0.1","keywords":["react","hooks","hook","i18n"],"license":"MIT","_id":"@kaliber/i18n@1.0.1","maintainers":[{"name":"daveykropf","email":"davey@kaliber.net"},{"name":"eecolor","email":"eecolor@gmail.com"},{"name":"joostkiens","email":"me@joostkiens.com"},{"name":"pkuepers","email":"pkuepers@kaliber.net"}],"dist":{"shasum":"865a72dbe65724a3923b66faf0cfdf080cea3673","tarball":"https://registry.npmjs.org/@kaliber/i18n/-/i18n-1.0.1.tgz","fileCount":5,"integrity":"sha512-G4bmse4f7YJJ52X6LksNr2/W6G34wjH9M+eLlfp46Kx8FNFrr+uf9d86sApV53GISfTMTF4avcbikRujCl0klQ==","signatures":[{"sig":"MEUCIQCbynpUPk+Ra1T6uUSTfsDsHx//WrY61co+0RS+8vc0jgIgdZes4yKVfd2jvWRAApmugHUooiNGv4JwGhMJ3FEP7zc=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":9099,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJes85LCRA9TVsSAnZWagAALEcP/26HUGMvwtEIaNFuJT42\nlcDGuz3VkeqXe18iaC6Ur00DC0JtzmLwtErER/rKGXmSL1B6NVYwtMlOqEHs\nHVl2ht96pQ16E1hglAdV/srocDxP+EcOtPx49b+txe1nOPP9p5T3O8tz1rKM\nuWk2JXC1CnAxcqwDP3iBT5jrSayEP9XcGk7pNnqYM5iZKWGUfsSu7kdCEtXD\nH2eIvC2gc6Ck/PRmIjqzT4MsrG18meJbFb/dIbDCRrYg2HAYUdpz3OqrRioy\nEbAuUqwfr44v+ZrzQzVR1Pny+9ZA+y8wxcTQoRK+mK78da7Nrt19CVsfWbUo\nvI8bJUoNbBLV+e1M7FjR4crGfQ3IAFy5us1orO6BhKtFhWyNy83YaA87AWQ1\nmGAkHTu7cQ+1gjhpzAwmTIPZS7veR6+P0PEnqVk7PvHg9VjpP3cg64MerZwE\nj0rlVu5N6xoKtS9UR4qoRw67YnVMyO2OOiLAdRTKmingokMM1I13pqVskSDs\niQdZ/KewXLjb1d0aXoquct8MQx/aza72BeRlHopLr09I1ZuJf5HVgDpaX9EP\nChG1NQqKbfOaCv/Acpb0xbV8aRa01RPPg1bpTu1BG52ZRpHpSqWxaATL5A7g\n+/8RxRGO5vUovmLjkc9KDYNI0NsBqQZMBGyxyI/5miFb3SdMTURzdKzY+YIg\nkMBR\r\n=1wdb\r\n-----END PGP SIGNATURE-----\r\n"},"main":"index.js","private":false,"_npmUser":{"name":"pkuepers","email":"pkuepers@kaliber.net"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.","repository":{"url":"https://github.com/kaliberjs/i18n.git","type":"git"},"description":"Internationalize your React application","directories":{},"licenseText":"MIT License\n\nCopyright (c) 2019 kaliber.js\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","sideEffects":false,"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/i18n_1.0.1_1588842058918_0.860161823803133","host":"s3://npm-registry-packages"}},"1.1.0":{"name":"@kaliber/i18n","version":"1.1.0","keywords":["react","hooks","hook","i18n"],"license":"MIT","_id":"@kaliber/i18n@1.1.0","maintainers":[{"name":"kaliber-owner","email":"development@kaliber.net"},{"name":"daveykropf","email":"davey@kaliber.net"},{"name":"eecolor","email":"eecolor@gmail.com"},{"name":"pkuepers","email":"pkuepers@kaliber.net"},{"name":"larsvankleef","email":"spamlabtap@gmail.com"}],"dist":{"shasum":"89d0a513357d18ebf0aed28c6df43c3e390187e0","tarball":"https://registry.npmjs.org/@kaliber/i18n/-/i18n-1.1.0.tgz","fileCount":5,"integrity":"sha512-yhXV9cr0PvwlVx2oE8HnqQeyyNW+EsR8Ou1fw3stJmarlQxITis5ZZZzmIwPtIwdCGksdg4+ulo+CWX0y9Cr6g==","signatures":[{"sig":"MEQCIEojL1aq95SRi7P94oxNEAWyaaZ2htKuu1+8i+BMsZepAiBtdWYI6ZYmZ65Thsancd9wnZP5/8wdKtEoQtk+V9IJPg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":9592,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh95cGCRA9TVsSAnZWagAAl1QP/Rcjr9bI8Uq7cgtFceKb\niTXdJkla/+hFfuLo9bKf7MKFh80Sx0TWXGbuDN64LNX8PwOi4lJ+H7NM5jdp\nMq5VbPLLI57wWe5CtAZyKumqIDkxKyN28WCI0x9uuyUzuNIQZUV+wYbnibTp\n9/4PAnUORyQy+6qHh/oA/P013DZ1PByxcUJL6xZg41hFSl1JYSYxPegeofRz\nJ6JensCni5RzNW/Qb1kLIHBm4av3aWYjlYYJniZaiwHHyUYNS+qgVaINEJqy\n6K3fnIg9NdR6xtmKmynXhQAdnH4nRO39SSgm57K7KnpmM1bbNlwRkIuYX5Cr\ntgBEtco3Vk11bIfeaPLsV2AhpHt/YgMxBkwSqp4GDwjIp/CKe9qPoKqC02U+\n78g0cu4YvQNSOkbuZkMu7iwE0QnJdT5OikKzNvy/SnnWI1M04GF4mS4EmUNx\nGiV8Eg19ZsU9JOeDMs6eolI9rbIExisTpQI9topiwWVmRL+7BCGifS2c2xbK\nEettTNF0djlZayPr/nBAPCDGwgGHL4m8xQm8NSrM2lpIElxKjQ39MGsJ8Vmr\ni7qQW08miu2OUC0nzB2Qu/ev36O9i//1gcqRuz/oYqGlsMeeVjwPCeQon46Z\nzLd3mXMLH03CFFEEqXnyhOKSFVxZNDJfB0o1BUVrpXTaTHo3iiMt4nNNa74f\neziJ\r\n=ucu9\r\n-----END PGP SIGNATURE-----\r\n"},"main":"index.js","private":false,"_npmUser":{"name":"pkuepers","email":"pkuepers@kaliber.net"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.","repository":{"url":"https://github.com/kaliberjs/i18n.git","type":"git"},"description":"Internationalize your React application","directories":{},"licenseText":"MIT License\n\nCopyright (c) 2019 kaliber.js\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","sideEffects":false,"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/i18n_1.1.0_1643616006572_0.12273188183113248","host":"s3://npm-registry-packages"}}},"time":{"created":"2020-05-07T07:21:22.021Z","modified":"2026-09-09T12:43:14.145Z","1.0.0":"2020-05-07T07:21:22.351Z","1.0.1":"2020-05-07T09:00:59.013Z","1.1.0":"2022-01-31T08:00:06.744Z"},"license":"MIT","keywords":["react","hooks","hook","i18n"],"repository":{"url":"https://github.com/kaliberjs/i18n.git","type":"git"},"description":"Internationalize your React application","maintainers":[{"email":"davey@kaliber.net","name":"daveykropf"},{"email":"ewestra@kaliber.net","name":"eecolor"},{"email":"jduijm@kaliber.net","name":"jerryduijm"},{"email":"development@kaliber.net","name":"kaliber-owner"},{"email":"nhoenderop@kaliber.net","name":"nhoenderop"},{"email":"jbrunemann@kaliber.net","name":"janbru"},{"email":"asmit@kaliber.net","name":"albertkaliber"},{"email":"mvanbrakel@kaliber.net","name":"mvanbrakel"},{"email":"Rvanschaik@kaliber.net","name":"r0h-oh"},{"email":"claan@kaliber.net","name":"1cln"},{"email":"mreimus@kaliber.net","name":"maart-22"},{"email":"ldavidsondescelles@kaliber.net","name":"yoreljenkins"},{"email":"mdevalk@kaliber.net","name":"mdevalk1983"},{"email":"guido.evertzen@gmail.com","name":"guido.evertzen"},{"email":"svroom@kaliber.net","name":"svroom-kaliber"},{"email":"tomharms93@proton.me","name":"tomharms"},{"email":"rinus.vh@hotmail.com","name":"rinus.vh"},{"email":"pgoddijn@gmail.com","name":"pgoddijn"},{"email":"jvankralingen@kaliber.net","name":"jvankralingen"}],"readme":"# i18n\n\nInternationalize your React application.\n\n## Motivation\ni18n, a.k.a. internationalization. Often you want to make your application available in multiple languages. @kaliber/i18n helps translating the static strings in your application.\n\n## Installation\n\n```\nyarn add @kaliber/i18n\n```\n\n## Usage\n\n[Skip to reference](#reference)\n\n```jsx\nimport { I18nProvider, useI18n, useI18nLanguage } from '@kaliber/i18n'\nimport { i18n } from './config/i18n.js'\n\nfunction App() {\n  return (\n    <I18nProvider value={i18n} language='en'>\n      <Page />\n    </I18nProvider>\n  )\n}\n\nfunction Page() {\n  const i18n = useI18n()\n  const language = useI18nLanguage()\n\n  return (\n    <div>\n      <header>\n        <Navigation links={i18n('navigation')} />\n      </header>\n      <main>\n        <PageMain i18nPath='home' />\n      </main>\n      <aside>\n        {/* Missing translations yield a warning in your console, when not in production mode */}\n        {i18n('missing.aMissingTranslation')}\n      </aside>\n      <footer>\n        {i18n('footer').copyright()} - {language.toUpperCase()}\n      </footer>\n    </div>\n  )\n}\n\n// Please note that the i18nPath prop is not an actual part of this library,\n// it's just a variable containing a path string ('home').\n\nfunction PageMain({ i18nPath }) {\n  const i18n = useI18n()\n\n  return (\n    <article>\n      <header>\n        {/* Prefix 'title' with the i18nPath */}\n        <h1>{i18n(i18nPath, 'title')}</h1>\n\n        {/* Access a translation in 'global' */}\n        <em>{i18n('global.writtenBy')}: Kaliber</em>\n\n        {/* Pass down the internationalized items as props */}\n        <Tags tags={i18n(i18nPath, 'meta.tags')} />\n      </header>\n\n      {/* Or pass down the i18nPath and handle translations lower in the tree */}\n      <PageContent {...{ i18nPath }} />\n    </article>\n  )\n}\n```\n\nExample i18n object:\n```js\nconst i18n = {\n  navigation: [\n    {\n      label: 'Home',\n      link: '#'\n    },\n    {\n      label: {\n        nl: 'Neem contact op',\n        en: 'Contact us'\n      },\n      link: '#contact'\n    }\n  ],\n  home: {\n    title: {\n      nl: 'Welkom!',\n      en: 'Welcome!'\n    },\n    meta: {\n      tags: [\n        {\n          nl: 'dummy tekst',\n          en: 'dummy text'\n        },\n        {\n          nl: 'pagina',\n          en: 'page'\n        }\n      ]\n    },\n    content: {\n      title: {\n        nl: 'Een klein beetje typesetting tekst',\n        en: 'A bit of typesetting text'\n      },\n      body: <p>Lorem ipsum dolor sit amet <strong>consectetur adipisicing elit</strong>. Facere esse unde aut officiis repudiandae vero placeat totam voluptas. Doloribus iste quae maiores officia praesentium magni, perspiciatis quibusdam necessitatibus sequi nemo.</p>,\n    },\n  },\n  footer: {\n    copyright: () => `Copyright ${(new Date()).getFullYear()}`\n  },\n  global: {\n    writtenBy: {\n      nl: 'geschreven door',\n      en: 'written by'\n    },\n    tags: 'tags'\n  }\n}\n```\n\n![](https://media.giphy.com/media/OBP5KeYczcxxK/giphy.gif)\n\n## Reference\n\n### `I18nProvider`\n\n```jsx\n<I18nProvider value={i18n} language='en'>\n  {children}\n</I18nProvider>\n```\n\n| Props          |                                                                               |\n|----------------|-------------------------------------------------------------------------------|\n| `value`        | The i18n object to use. |\n| `language`     | _Optional._ <br />When a language is given, normalization will be attempted at the leave nodes. E.g.: given the language `en` this means a leafnode with the shape `{ en: 'countries', nl: 'landen' }` will be normalized to just `'countries'`. |\n| `logMissingTranslation`     | _Optional._ (default: `console.warn`)<br />If you want to change how missing translations are logged, you can provide your own `logMissingTranslation` function. This function is called with an object of the shape: `{ language, path }`. |\n\nThe provided i18n object may be a deeply nested object, optionally containing arrays. Values don't have to be strings, you can also provide numbers, functions or React elements (see the example i18n object under [usage](#usage))\n\n### `useI18n`\n\nReturns (a subsection of) the i18n object.\n\n```js\nconst i18n = useI18n(i18nPath) \nconst translatedString = i18n('path')\n```\n\n| Input          |                                                                               |\n|----------------|-------------------------------------------------------------------------------|\n| `i18nPath`         | _Optional._ <br />When given, the returned `i18n` function looks up its translations in a subset of the i18n object indicated by `i18nPath`. |\n\n| Output         |                                                                               |\n|----------------|-------------------------------------------------------------------------------|\n| `i18n`         | A `function` which accepts one or multiple `i18nPath` segments as arguments, which will be joined by dots. The value at this resulting path (prefixed with the `i18nPath`) will be normalized, then returned. When no value is found a warning will be logged (unless you're running production mode). |\n\n**Examples**\n```js\nconst i18n = useI18n()\nconst translatedString = i18n('global.cta')\n```\n```js\nconst i18n = useI18n('global')\nconst translatedString = i18n('cta')\n```\n```js\nfunction Component({ i18nPath }) {\n  const i18n = useI18n()\n  const translatedString = i18n(i18nPath, 'content.title')\n  const anotherTranslatedString = i18n('global.cta')\n\n  // ...\n}\n```\n\n### `useI18nLanguage`\n\nReturns the language that is being used.\n\n```js\nconst language = useI18nLanguage() \n```\n\n## Disclaimer\nThis library is intended for internal use, we provide __no__ support, use at your own risk. It does not import React, but expects it to be provided, which [@kaliber/build](https://kaliberjs.github.io/build/) can handle for you.\n\nThis library is not transpiled.","readmeFilename":"readme.md"}