vue3-danmaku
Version:
基于 Vue3 的弹幕交互组件
190 lines (130 loc) • 7.7 kB
Markdown
[](https://www.npmjs.com/package/vue3-danmaku)
[](https://www.npmjs.com/package/vue3-danmaku)
[]()
[](https://trackgit.com)
> 基于 Vue3 的弹幕交互组件
[](https://github.com/hellodigua/vue-danmaku/tree/master)
> [!WARNING]
> vue3-danmaku 不再维护，请安装 [vue-danmaku](https://www.npmjs.com/package/vue-danmaku) 以替代vue3-danmaku
```bash
$ npm install vue3-danmaku --save
```
```vue
<template>
<vue-danmaku v-model:danmus="danmus" loop style="height:100px; width:300px;"></vue-danmaku>
</template>
<script setup>
import vueDanmaku from 'vue3-danmaku'
const danmus = ref(['danmu1', 'danmu2', 'danmu3', '...'])
</script>
```
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
| :------------ | :--------------------------------------------------- | :------ | :----------- | :----- |
| danmus | 弹幕元素列表，支持纯文本或者自定义对象(支持 v-model) | Array | 字符串或对象 | [] |
| channels | 轨道数量 | Number | | 0 |
| autoplay | 是否自动播放 | Boolean | | true |
| useSlot | 是否开启弹幕插槽 | Boolean | | false |
| loop | 是否开启弹幕循环 | Boolean | | false |
| fontSize | 弹幕字号（slot 模式下不可用） | Number | | 18 |
| extraStyle | 额外样式（slot 模式下不可用） | String | | |
| speeds | 弹幕速度（每秒移动的像素数） | Number | | 200 |
| debounce | 弹幕刷新频率(ms) | Number | | 100 |
| randomChannel | 随机选择轨道插入 | Boolean | | false |
| isSuspend | 是否开启弹幕悬浮暂停（试验型功能） | Boolean | | false |
| top | 弹幕垂直间距(px) | Number | | 4 |
| right | 弹幕水平间距(px) | Number | | 0 |
- 注 0：1.0.0 版本起，danmus 参数写法变为双向绑定 v-model:danmus
- 注 1：channels 为 0，则轨道数为容器可容纳最高轨道数
- 注 2：danmus 初始化后如果为空，则 autoplay 失效。因此对于异步加载的弹幕数据，需要手动调用 `refName.value.play()` 进行播放
- 注 3：弹幕刷新频率为每隔多长时间插入一条弹幕
通过以下方式调用：
```js
<vue-danmaku ref="danmakuRef"></vue-danmaku>
setup() {
const danmakuRef = ref(null)
danmakuRef.value.play()
}
```
| 方法名 | 说明 | 参数 |
| :----------- | :------------------------------------------- | :----------------------------- |
| play | 开始/继续播放 | - |
| pause | 暂停弹幕播放 | - |
| stop | 停止播放并清空弹幕 | - |
| show | 弹幕显示 | - |
| hide | 弹幕隐藏 | - |
| reset | 重置配置 | - |
| resize | 容器尺寸改变时重新计算滚动距离（需手动调用） | - |
| push | 发送弹幕（插入到弹幕列表末尾，排队显示） | danmu 数据，可以是字符串或对象 |
| add | 发送弹幕（插入到当前播放位置，实时显示） | danmu 数据，可以是字符串或对象 |
| insert | 绘制弹幕（实时插入，不进行数据绑定） | danmu 数据，可以是字符串或对象 |
| getPlayState | 获得当前播放状态 | |
- 注 1：push 和 add 的返回值为插入后的下标，可通过判断下标的方式对当前插入弹幕进行样式定制
- 注 2：insert 跟 push/add 的区别在于，insert 不进行数据绑定，而是直接插入 DOM，适用于直播等场景
| 事件名 | 说明 | 返回值 |
| :------- | :----------------------------- | :-------------------------- |
| list-end | 所有弹幕插入完毕 | - |
| play-end | 所有弹幕播放完成（已滚出屏幕） | index（最后一个弹幕的下标） |
| dm-over | 开启弹幕悬浮暂停时，当进入弹幕，暂停时触发 | 触发的弹幕对象元素 |
| dm-out | 开启弹幕悬浮暂停时，当离开弹幕，恢复滚动时触发 | 触发的弹幕对象元素 |
如果你有自定义弹幕结构与样式的需求，你可以传入任意结构的对象并自己写内部样式。
```vue
<template>
<vue-danmaku ref="danmaku" v-model:danmus="danmus" useSlot loop :channels="5">
<template v-slot:dm="{ index, danmu }">
<span>{{ index }}{{ danmu.name }}：{{ danmu.text }}</span>
</template>
</vue-danmaku>
</template>
<script>
import vueDanmaku from 'vue3-danmaku'
export default {
setup(props) {
const danmus = ref([{ avatar: 'http://a.com/a.jpg', name: 'a', text: 'aaa' }, { avatar: 'http://a.com/b.jpg', name: 'b', text: 'bbb' }, ...])
return { danmus }
},
}
</script>
```
这个 [QA文档](https://github.com/hellodigua/vue-danmaku/blob/vue3/QA.md) 收集了一些常见问题，可以做阅读参考
也可以给本项目 [提交 issue](https://github.com/hellodigua/vue-danmaku/issues)
如果vue-danmaku帮助到了你，欢迎 [star](https://github.com/hellodigua/vue-danmaku/)，你的 star 是我改 BUG 的动力 ヾ(*ゝω・*)ノ
- fix: 修复定时器类型错误
- feat: 新增弹幕悬浮暂停相关事件
- feat: 初始化时获取不到容器宽高时抛出异常
- chore: 压缩打包体积
- fix: 修复部分场景下弹幕显示重叠的问题
- fix: 修复弹幕过长时后续弹幕不连贯的问题
- 更新了文档
- 优化 resize 逻辑
- fix: 修复 iOS15 下部分机型的 APP 内置 webview 在弹幕初始化时可能会闪屏的 BUG
- feat: 暴露 insert 方法，允许直接外部绘制弹幕
- 修复大量遗留 BUG
- 同步 Vue2 版本变更
- 支持 danmus 双向绑定
- speed 参数改为 speeds 参数，含义同样发生变化(主要是为了保证不同屏幕下弹幕移动速度相同)
- speed: 弹幕经过屏幕的总时长
- speeds: 弹幕每秒走过的像素距离
- 支持 vue3