Introduction

vue-book-reader is a vue wrapper for foliate-js - library for rendering e-books in the browser. Supports EPUB, MOBI, KF8 (AZW3), FB2, CBZ, PDF (experimental; requires PDF.js), or add support for other formats yourself by implementing the book interface

Basic usage

npm install vue-book-reader --save

And in your vue-component...

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

VueReader API

VueReader Attributes

| Name | Description | Type | Default | | -------- | --------------------------------- | ------------------------------------- | ----------- | | url | book url or File | string/File | — | | location | set / update location of the book | string/number | — | | title | the title of the book | string | — | | showToc | whether to show the toc | boolean | true | | BookView Attributes | BookView attributes all can be used. | - |

VueReader Slots

| Name | Description | | --------------------------------- | --------------------------------- | | title | book title | | BookView slots | BookView slots all can be used. |

VueReader Exposes

| Name | Description | | ------------------------------------- | ----------------------------------- | | BookView Exposes | BookView exposes all can be used. |

BookView API

BookView Attributes

| Name | Description | Type | Default | | ---------- | --------------------------------- | ----------------------- | ---------------- | | url | book url or File | string/File | | tocChanged | get an array representing the table of contents of the book | function(href) |

BookView Slots

| Name | Description | | ----------- | ------------------------ | | loadingView | BookView loadingView | | errorView | BookView errorView |

BookView Exposes

| Name | Description | Type | | ----------- | ---------------------- | ---------------- | | nextPage | display next page | function | | prevPage | display previous page | function | | setLocation | Set the page | function(href) |