Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cjy0208/i18nshell
1.9kb gzipped tiny i18n shell, splitable instances, lazyloadable resources, customizable currency, time or jsx i18n support
https://github.com/cjy0208/i18nshell
i18n lazyload splitable tiny translation
Last synced: about 3 hours ago
JSON representation
1.9kb gzipped tiny i18n shell, splitable instances, lazyloadable resources, customizable currency, time or jsx i18n support
- Host: GitHub
- URL: https://github.com/cjy0208/i18nshell
- Owner: CJY0208
- Created: 2019-12-26T14:14:03.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T05:31:30.000Z (over 1 year ago)
- Last Synced: 2024-11-16T01:50:00.641Z (3 days ago)
- Topics: i18n, lazyload, splitable, tiny, translation
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/i18nshell
- Size: 225 KB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# I18nshell
[](https://github.com/CJY0208/i18nshell)
[](https://github.com/CJY0208/i18nshell)
Tiny i18n shell
English | [中文说明](./README_CN.md)
---
# Install
```bash
yarn add i18nshell
# or
npm install i18nshell --save
```
---
# Basic Usage
```js
import I18n from 'i18nshell'
const i18n = new I18n({
types: {
default: {
resources: {
en: {
greet: 'Hello, {{name}}'
},
zh: {
greet: '你好，{{name}}'
}
}
}
}
})
test()
async function test() {
await I18n.applyLng('en');
i18n.t('greet', {
name: 'CJY'
}) // get string 'Hello, CJY'
await I18n.applyLng('zh');
i18n.t('greet', {
name: 'CJY'
}) // get string '你好，CJY'
}
```
---
# Add customized i18n types such as currency, time, etc.
`i18nshell` has simple text translation built in
Currency, time and other nationalization functions need to be implemented by expanding types
Use `@` to select the type of translation you want to use
```jsx
import I18n from 'i18nshell'
const i18n = new I18n({
types: {
price: {
resource: false, // Not using resources
format: (value) => {
const unit = {
en: '$',
zh: '¥'
}[I18n.lng]
return `${unit}${value}`
}
},
jsx: {
resources: {
en: {
clickHere: 'click {{here}}'
},
zh: {
clickHere: '点击 {{here}}'
}
},
format: (value, data) => (
{I18n.template(value, data, { split: true }).map((item, idx) => (
{item}
))}
)
}
}
})
test()
async function test() {
await I18n.applyLng('en');
i18n.t('1000@price') // get string '$1000'
await I18n.applyLng('zh');
i18n.t('1000@price') // get string '¥1000'
// get jsx content
i18n.t('clickHere@jsx', {
here: (
google
)
})
}
```
---
# Lazyload resources
The following settings work with the `import (...)` syntax, en language packs are only loaded when needed
```js
// en.js
export default {
greet: 'Hello, {{name}}'
}
```
```js
// ./i18n.js
import I18n from 'i18nshell'
new I18n({
types: {
default: {
resources: {
en: I18n.load(() => import('./en.js')),
zh: {
greet: '你好，{{name}}'
}
}
}
}
})
```
---
# Split and inherit other language packs
Implemented using the fallback configuration item
```js
import I18n from 'i18nshell'
const i18n_1 = new I18n({
types: {
default: {
resources: {
zh: {
test1: '测试1'
}
}
}
}
})
const i18n_2 = new I18n({
fallback: [i18n_1],
types: {
default: {
resources: {
zh: {
test2: '测试2'
}
}
}
}
})
const i18n_3 = new I18n({
fallback: [i18n_2],
types: {
default: {
resources: {
zh: {
test3: '测试3'
}
}
}
}
})
test()
async function test() {
await I18n.applyLng('zh')
i18n_3.t('test1') // get string '测试1' fallback i18n_2 -> i18n_1
i18n_3.t('test2') // get string '测试2' fallback i18n_2
i18n_3.t('test3') // get string '测试3'
}
```