{"id":21325525,"url":"https://github.com/lhz516/react-simple-i18n","last_synced_at":"2025-07-12T06:32:36.605Z","repository":{"id":32788410,"uuid":"142534448","full_name":"lhz516/react-simple-i18n","owner":"lhz516","description":"React i18n solution with context API","archived":false,"fork":false,"pushed_at":"2023-07-19T12:05:57.000Z","size":722,"stargazers_count":8,"open_issues_count":3,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-11-04T16:54:32.345Z","etag":null,"topics":["i18n","language","react"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/lhz516.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-07-27T06:01:54.000Z","updated_at":"2022-10-28T17:57:29.000Z","dependencies_parsed_at":"2022-08-07T18:01:41.227Z","dependency_job_id":null,"html_url":"https://github.com/lhz516/react-simple-i18n","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lhz516%2Freact-simple-i18n","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lhz516%2Freact-simple-i18n/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lhz516%2Freact-simple-i18n/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lhz516%2Freact-simple-i18n/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lhz516","download_url":"https://codeload.github.com/lhz516/react-simple-i18n/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225802704,"owners_count":17526452,"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":["i18n","language","react"],"created_at":"2024-11-21T21:06:32.852Z","updated_at":"2025-07-12T06:32:36.600Z","avatar_url":"https://github.com/lhz516.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# React Simple I18n\r\n\r\n\u003cdiv\u003e\r\n  \u003ca href=\"https://www.npmjs.com/package/react-simple-i18n\" title=\"MIT License\"\u003e\r\n    \u003cimg src=\"https://img.shields.io/npm/l/react-simple-i18n.svg?color=brightgreen\" alt=\"MIT License\"\u003e\r\n  \u003c/a\u003e\r\n  \u003ca href=\"https://www.npmjs.com/package/react-simple-i18n\" title=\"Monthly download\"\u003e\r\n    \u003cimg src=\"https://img.shields.io/npm/dm/react-simple-i18n.svg?color=green\" alt=\"Monthly download\"\u003e\r\n  \u003c/a\u003e\r\n  \u003ca href=\"https://www.npmjs.com/package/react-simple-i18n\" title=\"Latest version\"\u003e\r\n    \u003cimg src=\"https://img.shields.io/npm/v/react-simple-i18n.svg\" alt=\"Latest version\"\u003e\r\n  \u003c/a\u003e\r\n\u003c/div\u003e\r\n\r\n- React i18n solution with context API, support React 18 and 19+\r\n- Written in TypeScript\r\n- Lightweight, simple usage, easy to configure\r\n    - Lib size: 13.02KB\r\n    - Minified: 6.48KB (with [compression-webpack-plugin](https://github.com/webpack-contrib/compression-webpack-plugin))\r\n    - Gzipped: 2.13KB\r\n- 100% test coverage, reliable\r\n\r\n## Usage\r\n\r\nDefine languages data first\r\n```jsx\r\nconst langData = {\r\n  enUS: {\r\n    projects: 'Projects',\r\n    cars: 'This car is %s%, that car is %s%',\r\n    nav: {\r\n      home: 'Home',\r\n    },\r\n  },\r\n  zhCN: {\r\n    projects: '项目',\r\n    cars: '这辆车是%s%，那辆车是%s%',\r\n    nav: {\r\n      home: '首页',\r\n    },\r\n  },\r\n}\r\n```\r\n\r\nUse React hook\r\n```jsx\r\nimport React, { Component } from 'react'\r\nimport { createI18n, I18nProvider, useI18n } from 'react-simple-i18n'\r\n\r\nconst Demo = () =\u003e {\r\n  const { t, i18n } = useI18n()\r\n\r\n  return (\r\n    \u003cdiv\u003e\r\n      \u003cp\u003e{t('projects')}\u003c/p\u003e\r\n      \u003cp\u003e{t('cars', 'BMW', 'TOYOTA')}\u003c/p\u003e\r\n      \u003cp\u003e{t('nav.home')}\u003c/p\u003e\r\n      \u003cbutton onClick={() =\u003e i18n.setLang('enUS')}\u003eEnglish\u003c/button\u003e\r\n      \u003cbutton onClick={() =\u003e i18n.setLang('zhCN')}\u003e中文\u003c/button\u003e\r\n    \u003c/div\u003e\r\n  )\r\n}\r\n\r\nconst App = () =\u003e (\r\n  \u003cI18nProvider i18n={createI18n(langData, { lang: 'enUS' })}\u003e\r\n    \u003cDemo /\u003e\r\n  \u003c/I18nProvider\u003e\r\n)\r\n```\r\n\r\n## Top Level API\r\n\r\n### createI18n(data, options)\r\n\r\nCreates an `i18n` object for `I18nProvider`\r\n\r\n#### Arguments\r\n\r\n- `data` Language data object, see usage above\r\n- `options`\r\n  - `lang` Initial language to use\r\n  - `defaultText` Function that returns default text if i18n doesn't exist. It takes a single argument which is the i18n key string.\r\n\r\n#### Return\r\n\r\n- `i18n`\r\n  - `t(key, ...args)` Get translation by language name\r\n    - @param `key` {string} key of a translation field\r\n    - @param `args` {[string]} strings to replace `%s%` in the field\r\n  - `getLang()` Get current language\r\n    - @return {string} current language name, such as `enUS`\r\n  - `setLang(lang)` Set language by language name\r\n    - @param `lang` {string} language name, such as `enUS`\r\n  - `addLangData(langData)` Async add language data, allow adding multiple languages once\r\n    - @param `langData` {object} Language object `{ enUS: { key: 'value' } }`\r\n  - `listen(handler)` Add listener to language change\r\n    - @param `handler` {func()} function which will be called when language change\r\n  - `unlisten(handler)` Unbind a listener of language change\r\n    - @param `handler` {func()} function which will be called when language change\r\n\r\n### \\\u003cI18nProvider i18n\\\u003e\r\n\r\nMakes `i18n` available to `withI18n` HOC and `useI18n` hook\r\n\r\n#### Props\r\n\r\n- `i18n` I18n object created by `createI18n`\r\n\r\n### useI18n()\r\n\r\nA React hook that returns an object with `t` and `i18n`.\r\n\r\n# License\r\n\r\nMIT\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flhz516%2Freact-simple-i18n","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flhz516%2Freact-simple-i18n","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flhz516%2Freact-simple-i18n/lists"}