Files
ArtPlayer/packages/artplayer-document/docs/zh-cn/Overview.md
T
2021-11-24 18:16:29 +08:00

94 lines
1.7 KiB
Markdown

---
title: 快速上手
sidebar_position: 1
slug: /zh-cn
---
## 安装
### 通过 `npm` 安装:
```bash
$ npm install artplayer
```
### 通过 `yarn` 安装:
```bash
$ yarn add artplayer
```
然后加载 `artplayer` 模块:
```js
// ES6
import Artplayer from 'artplayer';
// CommonJS
const Artplayer = require('artplayer');
```
### 通过 `script` 安装:
```html
<!-- locally -->
<script src="path/to/artplayer.js"></script>
<!-- jsdelivr -->
<script src="https://cdn.jsdelivr.net/npm/artplayer/dist/artplayer.js"></script>
<!-- unpkg -->
<script src="https://unpkg.com/artplayer/dist/artplayer.js"></script>
```
然后你可以通过 `window.Artplayer` 访问到构造函数
## 使用
`Artplayer` 是一个构造函数,通过 `new` 关键字进行实例化
```html
<!DOCTYPE html>
<html>
<head>
<title>ArtPlayer Demo</title>
<meta charset="UTF-8" />
</head>
<body>
<div class="artplayer-app" style="width:400px;height:300px"></div>
<script src="path/to/artplayer.js"></script>
<script>
var art = new Artplayer({
container: '.artplayer-app',
url: '/assets/sample/video.mp4',
});
</script>
</body>
</html>
```
:::danger 提示
播放器的尺寸依赖于容器 `container` 的尺寸,所以你的容器 `container` 必须是有尺寸的
:::
## 演示
:::tip 提示
本文档里,通过点击代码块前的 `Run Code` 按钮,可以马上进入演示
:::
----------------------------------------------
<div className="run-code">▶ Run Code</div>
```js
var art = new Artplayer({
container: '.artplayer-app',
url: '/assets/sample/video.mp4',
});
```