{"id":20497145,"url":"https://github.com/alexcambose/polylang","last_synced_at":"2025-06-14T09:06:35.778Z","repository":{"id":95848995,"uuid":"127182891","full_name":"alexcambose/polylang","owner":"alexcambose","description":"Library for handling multi language support using JavaScript","archived":false,"fork":false,"pushed_at":"2018-03-31T05:48:54.000Z","size":36,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-14T09:05:49.278Z","etag":null,"topics":["city","communication","country","dialect","earth","english","human","javascript","javascript-library","language","locale","localization","oral","pronunciation","speech","spoken-language","timezone","vocabulary","word","words"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alexcambose.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2018-03-28T18:37:53.000Z","updated_at":"2019-09-02T08:49:22.000Z","dependencies_parsed_at":"2023-04-27T20:00:59.523Z","dependency_job_id":null,"html_url":"https://github.com/alexcambose/polylang","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/alexcambose/polylang","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexcambose%2Fpolylang","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexcambose%2Fpolylang/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexcambose%2Fpolylang/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexcambose%2Fpolylang/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alexcambose","download_url":"https://codeload.github.com/alexcambose/polylang/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexcambose%2Fpolylang/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259790456,"owners_count":22911547,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["city","communication","country","dialect","earth","english","human","javascript","javascript-library","language","locale","localization","oral","pronunciation","speech","spoken-language","timezone","vocabulary","word","words"],"created_at":"2024-11-15T18:10:11.984Z","updated_at":"2025-06-14T09:06:35.753Z","avatar_url":"https://github.com/alexcambose.png","language":"JavaScript","readme":"# polylang\n\n[![Build Status](https://travis-ci.org/alexcambose/polylang.svg?branch=master)](https://travis-ci.org/alexcambose/polylang)\n\nLibrary for handling multi language support using JavaScript\n\n## Installation\nInstall using [npm](https://www.npmjs.com/package/polylang)\n```\nnpm install --save polylang\n```\n\n## Usage\n```javascript\nconst Polylang = require('polylang'); // or if you are using ES6 imports, import Polylang from 'polylang';\n\nconst polylang = new Polylang(); // create a new instance\npolylang.add('en', {\n    welcome: 'welcome',\n    title: 'Someone is always watching us',\n    errors: {\n        invalid_email: '\u003c\u003cemail\u003e\u003e is not a valid email because \u003c\u003creason\u003e\u003e',\n    }\n});\npolylang.add('ro', {\n    welcome: 'salutare',\n    title: 'Cineva ne urmareste in permanenta',\n    errors: {\n        invalid_email: '\u003c\u003cemail\u003e\u003e nu este un email valid deoarece \u003c\u003cmotiv\u003e\u003e',\n    }\n});\n\npolylang.t('welcome'); // welcome\npolylang.t('errors.invalid_email', { email: 'test@test.com', reason: 'it is too short!' }); // test@test.com is not a valid email because it is too short!\n\npolylang.lang = 'ro';\n\npolylang.t('welcome'); // salutare\npolylang.t('errors.invalid_email', { email: 'test@test.com', motiv: 'este prea scurt!' }); // test@test.com nu este un email valid deoarece este prea scurt!\n```\n\n\n\n\n## API\n\n* [Polylang](#Polylang)\n    * [new Polylang({defaultLang, accessDelimiter, startInterpolationDelimiter, endInterpolationDelimiter})](#new_Polylang_new)\n    * [.add(language, data)](#Polylang+add)\n    * [.remove(language)](#Polylang+remove)\n    * [.t(selector, interpolationValues)](#Polylang+t)\n    * [.translate(selector, language, interpolationValues)](#Polylang+translate)\n\n\u003ca name=\"new_Polylang_new\"\u003e\u003c/a\u003e\n\n### new Polylang({defaultLang, accessDelimiter, startInterpolationDelimiter, endInterpolationDelimiter})\n\n| Param | Type | Description |\n| --- | --- | --- |\n| {defaultLang | \u003ccode\u003estring\u003c/code\u003e | the default language that will be used to translate the text |\n| accessDelimiter | \u003ccode\u003estring\u003c/code\u003e | delimiter used to represent levels in the translation object (ex: 'errors.password.too_short') |\n| startInterpolationDelimiter | \u003ccode\u003estring\u003c/code\u003e | delimiter used to interpolate custom string into the translation at the start of the word |\n| endInterpolationDelimiter} | \u003ccode\u003estring\u003c/code\u003e | delimiter used to interpolate custom string into the translation at the start of the word |\n\n**Example**\n```js\npolylang = new Polylang({\n    defaultLang: 'en'\n    accessDelimiter: '.',\n    startInterpolationDelimiter: '\u003c\u003c',\n    endInterpolationDelimiter: '\u003e\u003e'\n});\n```\n\u003ca name=\"Polylang+add\"\u003e\u003c/a\u003e\n\n### polylang.add(language, data)\nAdd a translation\n\n**Kind**: instance method of [\u003ccode\u003ePolylang\u003c/code\u003e](#Polylang)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| language | \u003ccode\u003estring\u003c/code\u003e | Language |\n| data | \u003ccode\u003eobject\u003c/code\u003e | Translation object |\n\n**Example**\n```js\npolylang.add('en',{\n            errors: {\n                invalid_email: 'The email \"\u003c\u003cemail\u003e\u003e\" is invalid',\n                password: {\n                    too_short: 'The password is too short',\n                    one_digit: 'The passowrd must contain at least one digit'\n                },\n            }\n        });\n```\n\u003ca name=\"Polylang+remove\"\u003e\u003c/a\u003e\n\n### polylang.remove(language)\nRemove a translation\n\n**Kind**: instance method of [\u003ccode\u003ePolylang\u003c/code\u003e](#Polylang)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| language | \u003ccode\u003estring\u003c/code\u003e | Language name that will be removeed |\n\n**Example**\n```js\npolylang.remove('en');\n```\n\u003ca name=\"Polylang+t\"\u003e\u003c/a\u003e\n\n### polylang.t(selector, interpolationValues)\nTranslate\n\n**Kind**: instance method of [\u003ccode\u003ePolylang\u003c/code\u003e](#Polylang)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| selector | \u003ccode\u003estring\u003c/code\u003e | translation path |\n| interpolationValues | \u003ccode\u003estring\u003c/code\u003e \\| \u003ccode\u003eobject\u003c/code\u003e | value/s to be replaced between interpolation delimiters |\n\n**Example**\n```js\npolylang.t('errors.invalid_email', 'test@test.com');\npolylang.t('errors.invalid_email', {email: 'test@test.com', reason: 'it is taken!'}); //if invalid_email string would be 'The email \"\u003c\u003cemail\u003e\u003e\" is invalid because \u003c\u003creason\u003e\u003e'\n```\n\u003ca name=\"Polylang+translate\"\u003e\u003c/a\u003e\n\n### polylang.translate(selector, language, interpolationValues)\nTranslate in a custom language\n\n**Kind**: instance method of [\u003ccode\u003ePolylang\u003c/code\u003e](#Polylang)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| selector | \u003ccode\u003estring\u003c/code\u003e | translation path |\n| language | \u003ccode\u003estring\u003c/code\u003e | translation language |\n| interpolationValues | \u003ccode\u003estring\u003c/code\u003e \\| \u003ccode\u003eobject\u003c/code\u003e | value/s to be replaced between interpolation delimiters |\n\n**Example**\n```js\npolylang.t('errors.invalid_email', 'en', 'test@test.com');\n```\n## Test\n```\nnpm test\n```\n## License\n[MIT](https://github.com/alexcambose/polylang/blob/master/LICENSE)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexcambose%2Fpolylang","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falexcambose%2Fpolylang","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexcambose%2Fpolylang/lists"}