npm package: @mi18n/vue
Description: Vue implementation for Mi18n localization framework
Author: JanCizmar
Latest version: 5.16.4

<!-- This file was generated using pnpm generate-readmes script 
        
        Don't edit this file. Edit the README.md.njk. Macros can be found in readmeMacros/macros.njk
        
        -->

<h1 align="center" style="border-bottom: none">
    <b>
        <a href="https://mi18n.io">Mi18n for Vue</a><br>
    </b>
    The Mi18n i18n SDK for Vue
    <br>
</h1>

<div align="center">

[![Logo](https://user-images.githubusercontent.com/18496315/188628892-33fcc282-26f1-4035-8105-95952bd93de9.svg)](https://mi18n.io)

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

![test workflow](https://github.com/mi18n/mi18n-js/actions/workflows/test.yml/badge.svg)

![@mi18n/vue version](https://img.shields.io/npm/v/@mi18n/vue?label=@mi18n/vue)

![types typescript](https://img.shields.io/badge/Types-Typescript-blue)
![typescript](https://img.shields.io/github/languages/top/mi18n/mi18n-js)
![licence](https://img.shields.io/github/license/mi18n/mi18n-js)
[![github stars](https://img.shields.io/github/stars/mi18n/mi18n-js?style=social&label=Mi18n%20JS)](https://github.com/mi18n/mi18n-js)
[![github stars](https://img.shields.io/github/stars/mi18n/server?style=social&label=Mi18n%20Server)](https://github.com/mi18n/server)
[![Github discussions](https://img.shields.io/github/discussions/mi18n/mi18n-platform)](https://github.com/mi18n/mi18n-platform/discussions)
</div>

<div align="center">

[<img src="https://img.shields.io/badge/-Facebook-424549?style=social&logo=facebook" height=25 />](https://www.facebook.com/Mi18n.i18n)
[<img src="https://img.shields.io/badge/-Twitter-424549?style=social&logo=twitter" height=25 />](https://twitter.com/Mi18n_i18n)
[<img src="https://img.shields.io/badge/-Linkedin-424549?style=social&logo=linkedin" height=25 />](https://www.linkedin.com/company/mi18n)

**Become part of the family. Join [slack channel <img src="https://img.shields.io/badge/-Mi18n Comunity-424549?style=social&logo=slack" height=25 />](https://join.slack.com/t/mi18ncommunity/shared_invite/zt-195isb5u8-_RcSRgVJfvgsPpOBIok~IQ)**

</div>




# What is Mi18n for Vue?
Vue integration library of Mi18n. With this package, it's super simple to add i18n to your Vue app!
For more information about using Mi18n with Vue, visit the [docs 📖](https://mi18n.io/integrations/svelte).

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

> Currently we support vue v3 only


## Quick links
- [Mi18n for Vue docs](https://mi18n.io/js-sdk/5.0.0-alpha.1/integrations/vue/installation)
- [Mi18n JS SDK docs](https://mi18n.io/js-sdk)
- [Mi18n Website](https://mi18n.io)
    - Product (Learn more about the great features)
        - [Dev tools](https://mi18n.io/features/dev-tools)
        - [Translation assistance](https://mi18n.io/features/translation-assistance)
        - [Collaboration](https://mi18n.io/features/collaboration)
- [Mi18n platform docs](https://mi18n.io/platform)
  


## Installation

```
npm install @mi18n/vue
```


Initialize mi18n

```ts
import { Mi18n, VuePlugin, VueMi18n, FormatSimple } from '@mi18n/vue';

const mi18n = Mi18n()
  .use(VuePlugin())
  .use(FormatSimple())
  .init({
    language: 'en',
    apiUrl: process.env.VUE_APP_MI18N_API_URL,
    apiKey: process.env.VUE_APP_MI18N_API_KEY,
  });

...

app.use(VueMi18n, { mi18n });
```

Then use the library in your app:

```html
<template>
  <Mi18nProvider>
    <template v-slot:fallback>
      <div>Loading...</div>
    </template>
    <App />
  </Mi18nProvider>
</template>
```



### T component

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

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

or with the default value

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

## Composition API for imperative translations

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

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

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

or for language switching

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

<script setup>
  import { useMi18n } from '@mi18n/vue';

  const mi18n = useMi18n(['language']);

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


## Prerequisites

1. You have some Vue-based project
2. You have generated an API key from [Mi18n Cloud](https://admin.midasbuy.com/i18n/api) or a self-hosted Mi18n instance.
   


## Why to use Mi18n?
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 🔥

![Frame 47](https://user-images.githubusercontent.com/18496315/188637819-ac4eb02d-7859-4ca8-9807-27818a52782d.png)
Read more on the [Mi18n website](https://mi18n.io)


## Development

We welcome your PRs.

To develop the package locally:
1. Clone [the repository](https://github.com/mi18n/mi18n-js)
1. 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

<a href="https://github.com/mi18n/mi18n-platform/graphs/contributors">
  <img alt="contributors" src="https://contrib.rocks/image?repo=mi18n/mi18n-js"/>
</a>