@tolgee/vue

Tolgee for Vue
The Tolgee i18n SDK for Vue

Tolgee is an open-source alternative to Crowdin, Phrase, or Lokalise with its very own revolutionary integrations.

Become part of the family. Join slack channel

What is Tolgee for Vue?

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

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

Currently we support vue v3 only

Quick links

• Tolgee for Vue 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/vue

Initialize tolgee

import { Tolgee, VuePlugin, VueTolgee, FormatSimple } from '@tolgee/vue';

const tolgee = Tolgee()
  .use(VuePlugin())
  .use(FormatSimple())
  .init({
    language: 'en',
    apiUrl: process.env.VUE_APP_TOLGEE_API_URL,
    apiKey: process.env.VUE_APP_TOLGEE_API_KEY,
  });

...

app.use(VueTolgee, { tolgee });

Then use the library in your app:

<template>
  <TolgeeProvider>
    <template v-slot:fallback>
      <div>Loading...</div>
    </template>
    <App />
  </TolgeeProvider>
</template>

T component

<template>
  <T keyName="translation_key" />
</template>

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

or with the default value

<T keyName="translation_key" defaultValue="Default value" />

Composition API for imperative translations

<template>
  <div title="t('translation_key')">Hello</div>
</template>

<script setup>
  import { useTranslate } from '@tolgee/vue';

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

or for language switching

<template>
  <select
    :value="tolgee.getLanguage()"
    v-on:change="changeLanguage"
  >
    <option value="en">en</option>
    <option value="de">de</option>
  </select>
</template>

<script setup>
  import { useTolgee } from '@tolgee/vue';

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

  const changeLanguage = (e) => {
    tolgee.value.changeLanguage(e.target.value);
  };
</script>

Prerequisites

1. You have some Vue-based project
2. You have generated an API key from Tolgee Cloud or a self-hosted Tolgee instance.

Why to use Tolgee?

Because it saves a lot of time, you would spend on localization tasks without it. Because 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:

1. Clone the repository
2. Install the packages in the repository root

pnpm install

1. Run the development script

pnpm develop:vue

This runs the development suite of this monorepo for the vue 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/vue directory.

End-to-end (e2e) testing

To run the e2e tests, simply execute

pnpm run e2e run vue

To open and play with e2e tests, run:

pnpm run e2e open vue

Contributors

Changelog

5.29.5 (2024-10-15)

Bug Fixes

• secret messages right next to each other (#3383) (136426e)