mirror of
https://github.com/zhw2590582/ArtPlayer.git
synced 2026-10-25 08:01:20 -08:00
Harvey Zhao
92f09a4290
- Updated descriptions and terminology across various component documentation files for improved clarity. - Changed headings and section titles for better readability and consistency. - Enhanced the language and structure of the documentation to provide clearer guidance on usage and configuration. - Removed the `fix-docs.js` script as its functionality has been integrated into the translation process. - Improved the translation script to handle Markdown code block issues and added retry logic for API calls.
102 lines
2.3 KiB
Markdown
102 lines
2.3 KiB
Markdown
# Language Settings
|
|
|
|
::: danger
|
|
|
|
Due to the increasing number of bundled multilingual resources, starting from version `5.1.0`, the core `artplayer.js` code will no longer bundle any languages other than `Simplified Chinese` and `English`. You will need to manually import any other languages you require.
|
|
|
|
:::
|
|
|
|
:::warning
|
|
|
|
When a language cannot be matched, English will be displayed by default. For i18n syntax reference, see: [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`. No manual import is required.
|
|
|
|
```js{4}
|
|
var art = new Artplayer({
|
|
container: '.artplayer-app',
|
|
url: '/assets/sample/video.mp4',
|
|
lang: 'zh-cn', // or 'en'
|
|
});
|
|
```
|
|
|
|
## Importing Languages
|
|
|
|
Language files before bundling are located at: `artplayer/src/i18n/*.js`. Contributions for new languages are welcome.
|
|
|
|
Bundled 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',
|
|
});
|
|
```
|
|
|
|
:::
|
|
|
|
## Adding a New 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'
|
|
},
|
|
},
|
|
});
|
|
```
|
|
|
|
## Modifying a 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'
|
|
},
|
|
},
|
|
});
|
|
``` |