# Install
## Install
::: code-group
```bash [npm]
npm install artplayer
```
```bash [yarn]
yarn add artplayer
```
```bash [pnpm]
pnpm add artplayer
```
```html [script]
```
:::
## `CDN`
::: code-group
```bash [jsdelivr.net]
https://cdn.jsdelivr.net/npm/artplayer/dist/artplayer.js
```
```bash [unpkg.com]
https://unpkg.com/artplayer/dist/artplayer.js
```
:::
## Use
::: code-group
```js [index.js]
import Artplayer from 'artplayer';
const art = new Artplayer({
container: '.artplayer-app',
url: 'path/to/video.mp4',
});
```
```html [index.html]
ArtPlayer Demo
```
:::
::: warning Tip
The size of the player depends on the size of the `container`, so your `container` must have a size
:::
::: tip The following links can see more use examples
[/packages/artplayer-template](https://github.com/zhw2590582/ArtPlayer/tree/master/packages/artplayer-template)
:::
## `Vue.js`
::: code-group
```vue [Artplayer.vue]
```
```vue [app.vue]
```
:::
::: warning Tip
Modifying `option` directly in `Vue.js` will not change the player
:::
## `React.js`
::: code-group
```jsx [Artplayer.jsx]
import { useEffect, useRef } from 'react';
import Artplayer from 'artplayer';
export default function Player({ option, getInstance, ...rest }) {
const artRef = useRef();
useEffect(() => {
const art = new Artplayer({
...option,
container: artRef.current,
});
if (getInstance && typeof getInstance === 'function') {
getInstance(art);
}
return () => {
if (art && art.destroy) {
art.destroy(false);
}
};
}, []);
return ;
}
```
```jsx [app.jsx]
import React from 'react';
import Artplayer from './ArtPlayer.jsx';
function App() {
return (
);
}
export default App;
```
:::
::: warning Tip
Modifying `option` directly in `React.js` will not change the player
:::
## Syntax hint
Sometimes your `js` file will lose the type prompt of `TypeScript`. At this time, you can manually import the type
Variable:
```js
/**
* @type {import("artplayer")}
*/
let art = null;
```
Parameters:
```js
/**
* @param {import("artplayer")} art
*/
function getInstance(art) {
//
}
```
Properties:
```js
export default {
data() {
return {
/**
* @type {import("artplayer")}
*/
art: null,
}
}
}
```