vue-reader

VueReader
69,162 47
Install
npm install vue-reader
Latest Version:1.3.9
Vue:3
Older releases:2
License:Apache
Last Updated:Oct 20, 2026
Links: GitHub  ·  npm
Maintainer: jinhuan

English

介绍

轻松地将 EPUB 阅读器嵌入你的 Web 应用。

安装

从 v1.3.x 开始,vue-reader 不再支持 Vue 2。如需在 Vue 2 中使用,请安装 v1.2.x。

npm i vue-reader
pnpm add vue-reader

基本用法

<template>
  <div style="height: 100vh">
    <vue-reader url="/files/啼笑因缘.epub" />
  </div>
</template>
<script setup>
import { VueReader } from 'vue-reader'
</script>
<template>
  <div style="height: 100vh">
    <vue-reader url="/files/啼笑因缘.epub" />
  </div>
</template>
<script>
import { VueReader } from 'vue-reader'
export default {
  components: { VueReader },
}
</script>

VueReader API

VueReader 属性

名称 说明 类型 默认值
url 图书 URL 或 ArrayBuffer string/ArrayBuffer —
title 图书标题 string —
showToc 是否显示目录 boolean true
EpubView 属性 可使用全部 EpubView 属性。 -

VueReader 插槽

名称 说明
title 图书标题
EpubView 插槽 可使用全部 EpubView 插槽。

VueReader 暴露的方法

名称 说明
EpubView 暴露的方法 可使用 EpubView 暴露的全部方法。

EpubView API

EpubView 属性

名称 说明 类型 默认值
url 图书路径或 ArrayBuffer string/ArrayBuffer —
location 设置或更新 EPUB 阅读位置 string/number —
tocChanged 阅读器解析图书后,通过此回调接收章节数组 function(toc) —
epubInitOptions 传递给 EPUB 初始化函数的自定义属性,参见 epub.js object —
epubOptions 传递给 EPUB 渲染器的自定义属性,参见 epub.js 的 book.renderTo 函数 object —
getRendition epub.js 渲染 EPUB 文件后,通过此回调获取 rendition 对象 function(rendition) —

EpubView 事件

名称 说明 类型
update:location 接收当前阅读位置。页面变化以及首次渲染时都会触发。 function(location)
select 选中文本时触发 function(cfirange,contents)
keyPress 按下按键时触发 function(keyboardEvent)

EpubView 插槽

名称 说明
loadingView EPUB 加载时显示的内容
errorView EPUB 加载失败时显示的内容

EpubView 暴露的方法

名称 说明 类型
nextPage 显示下一页 function
prevPage 显示上一页 function
setLocation 跳转到指定位置 function(href)

相关项目

Star 历史

Related Packages

@dullar/mercury

Advanced and highly reusable Mobile UI Components built on Vue2 & You can define...

8,553 6
@halobear/vue-upload

vue上传组件

460 1
@libraz/mejiro-vue

Vue components and composables for mejiro — vertical text rendering, EPUB reader...

2,089 1
vite-plugin-vue2

Vite plugin for Vue2

1,474,659 618
vue-jstree

a tree plugin for vue2

137,015 630

Version History

Version Released License
1.3.9 Apache
1.3.8 Apache
1.3.7 Apache
1.3.6 Apache
1.3.5 Apache