https://github.com/i18n-pro/svelte
Lightweight, simple, flexible, automatic translation internationalization tool for Svelte（适用于 Svelte 的轻量、简单、灵活、自动翻译的国际化工具）
https://github.com/i18n-pro/svelte
auto-translation automatic-translation i18n i18n-pro machine-translation svelte svelte-i18n translator
Last synced: about 2 months ago
JSON representation
Lightweight, simple, flexible, automatic translation internationalization tool for Svelte（适用于 Svelte 的轻量、简单、灵活、自动翻译的国际化工具）
- Host: GitHub
- URL: https://github.com/i18n-pro/svelte
- Owner: i18n-pro
- License: mit
- Created: 2023-02-11T12:37:32.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-09-06T08:32:27.000Z (2 months ago)
- Last Synced: 2025-09-06T10:05:05.625Z (2 months ago)
- Topics: auto-translation, automatic-translation, i18n, i18n-pro, machine-translation, svelte, svelte-i18n, translator
- Language: TypeScript
- Homepage:
- Size: 864 KB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-svelte - @i18n-pro/svelte - Lightweight, simple, flexible, automatic translation internationalization tool for Svelte. (Utilities / Internationalization)
- trackawesomelist - @i18n-pro/svelte (⭐9) - Lightweight, simple, flexible, automatic translation internationalization tool for Svelte. (Recently Updated / [Oct 27, 2024](/content/2024/10/27/README.md))
README
An out-of-the-box, lightweight i18n auto-translation solution for Svelte
English | [简体中文](https://github.com/i18n-pro/svelte/blob/v2.0.0/README_zh-CN.md)
[](https://www.npmjs.com/package/@i18n-pro/svelte "npm")
[](https://www.npmjs.com/package/@i18n-pro/svelte "npm")
[](https://github.com/i18n-pro/svelte/stargazers "github-stars")
[](https://github.com/i18n-pro/svelte/commits/main "last-commit")
[](https://github.com/i18n-pro/svelte/issues "github-issues")
[](https://codecov.io/gh/i18n-pro/svelte "codecov")
Table of Contents
[Vision](#vision)
[Requirement](#requirement)
[Features](#features)
[Live Demo](#live-demo)
[Principle](#principle)
[Implementation based on `Store` ](#implementation-based-on--store)
[Implementation based on `Context` ](#implementation-based-on--context)
[License](#license)
# Vision
Make internationalization easy and enjoyable 😄💪🏻
# Requirement
* svelte >= **3.0.0**
* i18n-pro >= **3.0.0** < **4.0.0**
# Features
* **lightweight**：[](https://bundlephobia.com/package/i18n-pro "i18n-pro-bundlesize") + [](https://bundlephobia.com/package/@i18n-pro/svelte "bundlesize")
* The following features are inherited from [i18n-pro](https://github.com/i18n-pro/core "i18n-pro")
* **simple**
* **flexible**
* **automatic-translation**
* **keyless**
# Live Demo
* Implementation based on `Store`
* [Open in CodeSandbox](https://codesandbox.io/p/github/i18n-pro/svelte-demo/main?file=README.md)
* [](https://stackblitz.com/github/i18n-pro/svelte-demo?file=README.md)
* Implementation based on `Context`
* [Open in CodeSandbox](https://codesandbox.io/p/github/i18n-pro/svelte-demo/context?file=README.md)
* [](https://stackblitz.com/github/i18n-pro/svelte-demo/tree/context?file=README.md)
# Principle
This library has corresponding implementations for the `Store` and `Context` features based on [i18n-pro](https://github.com/i18n-pro/core "i18n-pro") and `Svelte`
## Implementation based on `Store`
Mainly composed of `4` part
* createI18n
* t
* setI18n
* i18nState
**createI18n**：Initialize internationalization
**t**：Get internationalization text
**setI18n**：Set language or language package
**i18nState**：The current state of internationalization
A simple example is as follows
```typescript
// i18n.ts
import { createI18n } from '@i18n-pro/svelte'
createI18n( {
namespace: 'testNamespace',
locale: "en",
langs: {
zh: {
'hello world': '你好世界',
'custom-key': '你好世界',
},
ja:{
"hello world": "こんにちは世界",
'custom-key': 'こんにちは世界',
},
}
})
// App.svelte
import { t } from '@i18n-pro/svelte'
{/** text-as-key */}
{$t('hello world')}
{/** custom-key */}
{$t.t('custom-key', 'hello world')}
// index.ts
import './i18n'
import App from './App.svelte'
new App({
target: document.getElementById('app'),
})
```
## Implementation based on `Context`
Mainly composed of `2` part
* I18nProvider
* useI18n
**I18nProvider**：Configure container components for internationalization initialization properties
**useI18n**：Hook method for obtaining internationalization API and state
A simple example is as follows
```typescript svelte
// App.svelte
import { useI18n } from '@i18n-pro/svelte/context'
const { t } = useI18n()
{/** text-as-key */}
{$t('hello world')}
{/** custom-key */}
{$t.t('custom-key', 'hello world')}
// Root.svelte
import { I18nProvider } from '@i18n-pro/svelte/context'
import App from './App.svelte'
// index.ts
import App from './Root.svelte'
new App({
target: document.getElementById('app'),
})
```
# Help Document
> To avoid unnecessary duplicate document content, some of the documents in this library are linked to the content in `i18n-pro`
> The `i18n-pro` related link in the current document is based on the `3.0.0` version. If you are using a different version, you need to check the document corresponding to the version you are using to avoid inconsistent usage
* Current Library
* Quick Start
* [Implementation based on `Store` ](https://github.com/i18n-pro/svelte/blob/v2.0.0/docs/dist/USAGE_STORE.md)
* [Implementation based on `Context` ](https://github.com/i18n-pro/svelte/blob/v2.0.0/docs/dist/USAGE_CONTEXT.md)
* API
* [Implementation based on `Store` ](https://github.com/i18n-pro/svelte/blob/v2.0.0/docs/dist/API_STORE.md)
* [Implementation based on `Context` ](https://github.com/i18n-pro/svelte/blob/v2.0.0/docs/dist/API_CONTEXT.md)
* [Changelog](https://github.com/i18n-pro/svelte/blob/v2.0.0/docs/dist/CHANGELOG.md)
* i18n-pro
* [Command Line](https://github.com/i18n-pro/core/blob/v3.0.0/docs/dist/COMMAND_LINE.md)
* [Matching Rules](https://github.com/i18n-pro/core/blob/v3.0.0/docs/dist/MATCH_RULE.md)
* [Q&A](https://github.com/i18n-pro/core/blob/v3.0.0/docs/dist/Q&A.md)
* [Translation Log](https://github.com/i18n-pro/core/blob/v3.0.0/docs/dist/OUTPUT_LOG.md)
# License
[MIT](./LICENSE)
Copyright (c) 2023-present Eyelly Wu