AFFiNE/packages/i18n
2023-06-01 19:11:12 +08:00
..
src chore: update page group naming () 2023-05-31 16:41:25 +00:00
.gitignore build: perform TypeCheck for all packages () 2023-05-31 12:49:56 +00:00
package.json v0.7.0-canary.7 2023-06-01 19:11:12 +08:00
README.md feat(i18n): static type on i18n () 2023-05-04 05:35:09 +00:00
tsconfig.json build: perform TypeCheck for all packages () 2023-05-31 12:49:56 +00:00
tsconfig.resources.json build: perform TypeCheck for all packages () 2023-05-31 12:49:56 +00:00

i18n

Usages

  • Update missing translations into the base resources, a.k.a the src/resources/en.json
  • Replace literal text with translation keys
import { useAFFiNEI18N } from '@affine/i18n/hooks';

// src/resources/en.json
// {
//     'Text': 'some text',
//     'Switch to language': 'Switch to {{language}}', // <- you can interpolation by curly brackets
// };

const App = () => {
  const t = useAFFiNEI18N();

  const changeLanguage = (language: string) => {
    i18n.changeLanguage(language);
  };

  return (
    <div>
      <div>{t('Text')}</div>

      <button onClick={() => changeLanguage('en')}>{t('Switch to language', { language: 'en' })}</button>
      <button onClick={() => changeLanguage('zh-Hans')}>{t('Switch to language', { language: 'zh-Hans' })}</button>
    </div>
  );
};

How the i18n workflow works?

  • When the src/resources/en.json(base language) updated and merged to the develop branch, will trigger the languages-sync action.
  • The languages-sync action will check the base language and add missing translations to the Tolgee platform.
  • This way, partners from the community can update the translations.

How to sync translations manually

  • Set token as environment variable
export TOLGEE_API_KEY=tgpak_XXXXXXX
  • Run the sync-languages:check to check all languages
  • Run the sync-languages script to add new keys to the Tolgee platform
  • Run the download-resources script to download the latest full-translation translation resources from the Tolgee platform

References