mirror of
https://github.com/zhw2590582/ArtPlayer.git
synced 2026-10-29 02:51:20 -08:00
Harvey Zack
5b1cebb334
- Created a new documentation file for the danmuku plugin with code examples. - Added comprehensive i18n setup instructions, including default language settings, language imports, and examples for adding and modifying languages. - Updated the structure and content of the i18n documentation to enhance clarity and usability.
101 lines
2.2 KiB
Markdown
101 lines
2.2 KiB
Markdown
# Language Settings
|
|
|
|
::: danger
|
|
|
|
Given the increasing number of bundled multilingual packs, starting from version `5.1.0`, the core code of `artplayer.js` will no longer include other languages besides `Simplified Chinese` and `English`. You need to import the required languages on your own.
|
|
|
|
:::
|
|
|
|
:::warning
|
|
|
|
When a language cannot be matched, English will be displayed by default. For i18n usage, refer to: [artplayer/types/i18n.d.ts](https://github.com/zhw2590582/ArtPlayer/blob/master/packages/artplayer/types/i18n.d.ts)
|
|
|
|
:::
|
|
|
|
## Default Languages
|
|
|
|
The default languages are: `en`, `zh-cn`, which do not require manual import.
|
|
|
|
```js{4}
|
|
var art = new Artplayer({
|
|
container: '.artplayer-app',
|
|
url: '/assets/sample/video.mp4',
|
|
lang: 'zh-cn', // or 'en'
|
|
});
|
|
```
|
|
|
|
## Importing Languages
|
|
|
|
Language files before packaging are located in: `artplayer/src/i18n/*.js`.
|
|
|
|
Packaged language files are located at: `artplayer/dist/i18n/*.js`.
|
|
|
|
::: code-group
|
|
|
|
```js [import]
|
|
import id from 'artplayer/i18n/id';
|
|
import zhTw from 'artplayer/i18n/zh-tw';
|
|
|
|
var art = new Artplayer({
|
|
container: '.artplayer-app',
|
|
url: '/assets/sample/video.mp4',
|
|
i18n: {
|
|
id: id,
|
|
'zh-tw': zhTw,
|
|
},
|
|
lang: 'zh-tw',
|
|
});
|
|
```
|
|
|
|
```js [script]
|
|
<script src="artplayer/dist/i18n/id.js"></script>
|
|
<script src="artplayer/dist/i18n/zh-tw.js"></script>
|
|
|
|
var art = new Artplayer({
|
|
container: '.artplayer-app',
|
|
url: '/assets/sample/video.mp4',
|
|
i18n: {
|
|
id: window['artplayer-i18n-id'],
|
|
'zh-tw': window['artplayer-i18n-zh-tw'],
|
|
},
|
|
lang: 'zh-tw',
|
|
});
|
|
```
|
|
|
|
:::
|
|
## Add Language
|
|
|
|
```js{4-9}
|
|
var art = new Artplayer({
|
|
container: '.artplayer-app',
|
|
url: '/assets/sample/video.mp4',
|
|
lang: 'your-lang',
|
|
i18n: {
|
|
'your-lang': {
|
|
Play: 'Your Play'
|
|
},
|
|
},
|
|
});
|
|
```
|
|
|
|
## Modify Language
|
|
|
|
```js
|
|
import zhTw from 'artplayer/i18n/zh-tw';
|
|
|
|
var art = new Artplayer({
|
|
container: '.artplayer-app',
|
|
url: '/assets/sample/video.mp4',
|
|
i18n: {
|
|
// Change the default language
|
|
'zh-cn': {
|
|
Play: 'Your Play'
|
|
},
|
|
// Change the imported language
|
|
'zh-tw': {
|
|
...zhTw,
|
|
Play: 'Your Play'
|
|
},
|
|
},
|
|
});
|
|
``` |