@tolgee/svelte

Tolgee for Svelte
The Tolgee i18n SDK for Svelte

Tolgee is an open-source alternative to Crowdin, Phrase, or Lokalise

What is Tolgee for Svelte?

Svelte integration library of Tolgee. With this package, it's super simple to add i18n to your Svelte app! For more information about using Tolgee with Svelte, visit the docs 📖.

Localize (translate) your Svelte or SvelteKit projects to multiple languages with Tolgee. Integration of Tolgee is extremely simple! 🇯🇵 🇰🇷 🇩🇪 🇨🇳 🇺🇸 🇫🇷 🇪🇸 🇮🇹 🇷🇺 🇬🇧

Quick links

• Tolgee for Angular docs
• Tolgee JS SDK docs
• Tolgee Website
  • Product (Learn more about the great features)
    • Dev tools
    • Translation assistance
    • Collaboration
• Tolgee platform docs

Installation

npm install @tolgee/svelte

Then use the library in your app:

<script lang="ts">
  import { TolgeeProvider, Tolgee, SveltePlugin, FormatSimple } from '@tolgee/svelte';

  const tolgee = Tolgee()
    .use(SveltePlugin())
    .use(FormatSimple())
    .init({
      apiUrl: import.meta.env.VITE_TOLGEE_API_URL,
      apiKey: import.meta.env.VITE_TOLGEE_API_KEY,
      language: 'en'
    });
</script>

<TolgeeProvider {tolgee}>
  <div slot="fallback">Loading...</div>
  <slot />
</TolgeeProvider>

Usage

To translate texts using Tolgee Svelte integration, you can use T component or getTranslate function.

T component

<script>
  import { T } from '@tolgee/svelte';
</script>

<T keyName="key" defaultValue="This is default" />

getTranslate function

The getTranslate function returns a store containing the function, which translates your key.

<script>
  import { getTranslate } from '@tolgee/svelte';

  const { t } = getTranslate();
</script>

{$t('this_is_a_key', { key: 'value', key2: 'value2' })}

Changing the language

To change the current language, use getTolgee method. For example, you can bind it to a select value.

<script lang="ts">
  import { getTolgee } from '@tolgee/svelte';

  const tolgee = getTolgee(['language']);

  function handleLanguageChange(e) {
    $tolgee.changeLanguage(e.currentTarget.value);
  }
</script>

<select value={$tolgee.getLanguage()} on:change={handleLanguageChange}> ... </select>

Prerequisites

• You have some Svelte-based project
• You have generated an API key from Tolgee Cloud or a self-hosted Tolgee instance.

Why to use Tolgee?

Tolgee saves a lot of time you would spend on localization tasks otherwise. It enables you to provide perfectly translated software.

Features

• All-in-one localization solution for your JS application 🙌
• Out-of-box in-context localization 🎉
• Automated screenshot generation 📷
• Translation management platform 🎈
• Open-source 🔥

Read more on the Tolgee website

Development

We welcome your PRs.

To develop the package locally:

• Clone the repository
• Install the packages in the repository root

pnpm install

• Run the development script

pnpm develop:svelte

This runs the development suite of this monorepo for the svelte integration. The changes in each dependency package are automatically built and propagated to the test application, which you can open and play within the browser.

Testing

To run Jest tests of this package, execute

npm run test

In the /packages/svelte directory.

End-to-end (e2e) testing

To run the e2e tests, simply execute

pnpm run e2e run svelte

To open and play with e2e tests, run:

pnpm run e2e open svelte

Contributors