mirror of
https://github.com/zhw2590582/ArtPlayer.git
synced 2026-10-19 19:51:20 -08:00
update docs
This commit is contained in:
1 parent
0ad47e4cf1
commit
7dd21df106
85 files changed
+1906
-1712
No files matched your search
@@ -234,13 +234,38 @@ Modifying `option` directly in `React.js` will not change the player
|
||||
|
||||
:::
|
||||
|
||||
## Syntax hint
|
||||
## TypeScript
|
||||
|
||||
The `artplayer.d.ts` that is automatically imported when importing `Artplayer`, but you can also import the type of options individually
|
||||
|
||||
```ts{2}
|
||||
import Artplayer from 'artplayer';
|
||||
import { type Option } from 'artplayer/types/option';
|
||||
|
||||
const option: Option = {
|
||||
container: '.artplayer-app',
|
||||
url: './assets/sample/video.mp4',
|
||||
};
|
||||
|
||||
option.volume = 0.5;
|
||||
|
||||
const art = new Artplayer(option);
|
||||
```
|
||||
|
||||
::: tip All TypeScript definitions
|
||||
|
||||
[packages/artplayer/types](https://github.com/zhw2590582/ArtPlayer/tree/master/packages/artplayer/types)
|
||||
|
||||
:::
|
||||
|
||||
|
||||
## JavaScript
|
||||
|
||||
Sometimes your `js` file will lose the type prompt of `TypeScript`. At this time, you can manually import the type
|
||||
|
||||
Variable:
|
||||
|
||||
```js
|
||||
```js{1-3}
|
||||
/**
|
||||
* @type {import("artplayer")}
|
||||
*/
|
||||
@@ -249,7 +274,7 @@ let art = null;
|
||||
|
||||
Parameters:
|
||||
|
||||
```js
|
||||
```js{1-3}
|
||||
/**
|
||||
* @param {import("artplayer")} art
|
||||
*/
|
||||
@@ -260,7 +285,7 @@ function getInstance(art) {
|
||||
|
||||
Properties:
|
||||
|
||||
```js
|
||||
```js{4-6}
|
||||
export default {
|
||||
data() {
|
||||
return {
|
||||
@@ -273,6 +298,23 @@ export default {
|
||||
}
|
||||
```
|
||||
|
||||
Option:
|
||||
|
||||
```js{1-3}
|
||||
/**
|
||||
* @type {import("artplayer/types/option").Option}
|
||||
*/
|
||||
|
||||
const option = {
|
||||
container: '.artplayer-app',
|
||||
url: './assets/sample/video.mp4',
|
||||
};
|
||||
|
||||
option.volume = 0.5;
|
||||
|
||||
const art8 = new Artplayer(option);
|
||||
```
|
||||
|
||||
## Old browsers
|
||||
|
||||
Production builds of `artplayer.js` are only compatible with the last major version of `Chrome`: `last 1 Chrome version`
|
||||
@@ -295,8 +337,11 @@ https://unpkg.com/artplayer/dist/artplayer.legacy.js
|
||||
|
||||
:::
|
||||
|
||||
If you want to be compatible with older browsers, please modify the following configuration and build it yourself:
|
||||
::: tip If you want to be compatible with older browsers, please modify the following configuration and build it yourself:
|
||||
|
||||
Build configuration: [/scripts/build.js](https://github.com/zhw2590582/ArtPlayer/blob/master/scripts/build.js#L29)
|
||||
|
||||
Reference documents: [browserslist](https://github.com/browserslist/browserslist#full-list)
|
||||
Reference documents: [browserslist](https://github.com/browserslist/browserslist#full-list)
|
||||
|
||||
:::
|
||||
|
||||
@@ -230,13 +230,37 @@ export default App;
|
||||
|
||||
:::
|
||||
|
||||
## 语法提示
|
||||
## TypeScript
|
||||
|
||||
导入 `Artplayer` 时会自动导入的 `artplayer.d.ts`,但你也可以单独导入选项的类型
|
||||
|
||||
```ts{2}
|
||||
import Artplayer from 'artplayer';
|
||||
import { type Option } from 'artplayer/types/option';
|
||||
|
||||
const option: Option = {
|
||||
container: '.artplayer-app',
|
||||
url: './assets/sample/video.mp4',
|
||||
};
|
||||
|
||||
option.volume = 0.5;
|
||||
|
||||
const art = new Artplayer(option);
|
||||
```
|
||||
|
||||
::: tip 全部 TypeScript 定义
|
||||
|
||||
[packages/artplayer/types](https://github.com/zhw2590582/ArtPlayer/tree/master/packages/artplayer/types)
|
||||
|
||||
:::
|
||||
|
||||
## JavaScript
|
||||
|
||||
有时你的 `js` 文件会丢失 `TypeScript` 的类型提示,这时候你可以手动导入类型
|
||||
|
||||
变量:
|
||||
|
||||
```js
|
||||
```js{1-3}
|
||||
/**
|
||||
* @type {import("artplayer")}
|
||||
*/
|
||||
@@ -245,7 +269,7 @@ let art = null;
|
||||
|
||||
参数:
|
||||
|
||||
```js
|
||||
```js{1-3}
|
||||
/**
|
||||
* @param {import("artplayer")} art
|
||||
*/
|
||||
@@ -256,7 +280,7 @@ function getInstance(art) {
|
||||
|
||||
属性:
|
||||
|
||||
```js
|
||||
```js{4-6}
|
||||
export default {
|
||||
data() {
|
||||
return {
|
||||
@@ -269,6 +293,23 @@ export default {
|
||||
}
|
||||
```
|
||||
|
||||
选项:
|
||||
|
||||
```js{1-3}
|
||||
/**
|
||||
* @type {import("artplayer/types/option").Option}
|
||||
*/
|
||||
|
||||
const option = {
|
||||
container: '.artplayer-app',
|
||||
url: './assets/sample/video.mp4',
|
||||
};
|
||||
|
||||
option.volume = 0.5;
|
||||
|
||||
const art8 = new Artplayer(option);
|
||||
```
|
||||
|
||||
## 古老的浏览器
|
||||
|
||||
生产构建的 `artplayer.js` 只兼容最新一个主版本的 `Chrome`:`last 1 Chrome version`
|
||||
@@ -291,8 +332,11 @@ https://unpkg.com/artplayer/dist/artplayer.legacy.js
|
||||
|
||||
:::
|
||||
|
||||
假如你要兼容更古老的浏览器时,请修改以下配置然后自行构建:
|
||||
::: tip 假如你要兼容更古老的浏览器时,请修改以下配置然后自行构建:
|
||||
|
||||
构建配置:[scripts/build.js](https://github.com/zhw2590582/ArtPlayer/blob/master/scripts/build.js#L29)
|
||||
|
||||
参考文档:[browserslist](https://github.com/browserslist/browserslist#full-list)
|
||||
参考文档:[browserslist](https://github.com/browserslist/browserslist#full-list)
|
||||
|
||||
:::
|
||||
|
||||
@@ -24,4 +24,4 @@
|
||||
"dependencies": {
|
||||
"option-validator": "^2.0.6"
|
||||
}
|
||||
}
|
||||
}
|
||||
+1
-1
@@ -63,7 +63,7 @@ export type ComponentOption = {
|
||||
/**
|
||||
* Html string or html element of component
|
||||
*/
|
||||
html: string | HTMLElement;
|
||||
html?: string | HTMLElement;
|
||||
|
||||
/**
|
||||
* Whether to disable component
|
||||
|
||||
Reference in new issue
Block a user