flipbook-vue is a Vue component that displays images in 3D page flip effect.
Demo page is here.
Install as a module:
npm i -S flipbook-vue
or
yarn add flipbook-vue
or
pnpm add flipbook-vue
Or include in html:
<script src="https://unpkg.com/flipbook-vue"></script>BREAKING CHANGE: This form now provides Vue 3 version. If you are using Vue 2.x, use
"https://unpkg.com/flipbook-vue/dist/vue2/flipbook.min.js"(preferred) or"https://unpkg.com/flipbook-vue@0".
<template>
<flipbook class="flipbook" :pages="['array', 'of', 'image', 'URLs']"></flipbook>
</template>
<style>
.flipbook {
width: 90vw;
height: 90vh;
}
</style>If installed as a module, with Vue 3.x,
<script>
import Flipbook from 'flipbook-vue'
export default {
components: { Flipbook }
}
</script>To use with Vue 2.x,
import Flipbook from 'flipbook-vue/vue2'Array of image URLs. Required. All images should have the same aspect ratio.
If the first element is null, the next element is displayed alone (as the cover page).
All other props are optional.
Array of high resolution versions of image URLs. They are used when zoomed.
Duration of page flipping animation in milliseconds. Defaults to 1000.
Duration of zoom in/out animation in milliseconds. Defaults to 500.
Array of possible magnifications.
null is equivalent to [1] (no zoom).
Defaults to [1, 2, 4]. NOTE : Do NOT pass an empty array.
Intensity of ambient light in 0 to 1. Smaller value gives more shades. Defaults to 0.4.
Intensity of specular light in 0 to 1. Higher value gives more gloss. Defaults to 0.6.
Z-axis distance in pixels between the screen and the viewer. Higher value gives less effect. Defaults to 2400.
How many rectangles a single page is horizontally split into. Higher value gives higher quality rendering in exchange for performance. Defaults to 10.
Force single page mode regardless of viewport size. Defaults to false.
Reading direction.
If your document is right-to-left, set this "left".
Default is "right".
Enable centering of the cover pages.
Default is true.
Page number (>= 1) to open.
Default is null.
URL of an image that is displayed while page is loading. By default internal animated SVG is used.
Zoom in or out on click or tap. Default is true.
Flip page by dragging/swiping. Default is true.
When set to 'zoom', mouse wheel events zoom in/out the page.
Default is 'scroll', wheel events and touch pad scroll gestures scroll the zoomed page.
Fired when flip to left animation starts. Argument is page number before flip.
Fired when flip to left animation ends. Argument is page number after flip.
Fired when flip to right animation starts. Argument is page number before flip.
Fired when flip to right animation ends. Argument is page number after flip.
Fired when zoom-in/out animation starts. Argument is magnification after zoom.
Fired when zoom-in/out animation ends. Argument is magnification after zoom.
This component exposes some properties and methods as slot properties. Example usage:
<flipbook :pages="pages" v-slot="flipbook">
<button @click="flipbook.flipLeft">Previous Page</button>
<button @click="flipbook.flipRight">Next Page</button>
</flipbook>For more practical usage, refer to src/App.vue (the demo page source).
These properties and methods can also be referred through $refs to the flipbook component.
True if it can flip to previous page. NOTE: Can return false if currently being animated.
True if it can flip to next page. NOTE: Can return false if currently being animated.
True if it can zoom in.
True if it can zoom out.
Current page number (1 to numPages).
Total number of pages.
Method to flip to previous page.
Method to flip to next page.
Method to zoom in.
Method to zoom out.
You may need to specify the size of view port in your style sheet, directly to
<flipbook> element, or to .viewport sub-element of flipbook.
If the size is horizontally long and singlePage prop is false (default), it displays two pages spread, suitable for desktop browsers.
If it's vertically long, it displays single pages, suitable for smartphones.
There are some internal classes.
A <div> element that contains everything but <slot>.
<slot> is placed above .viewport.
Approximate bounding box of the displayed images.
Suitable to give box-shadow.
Supports modern browsers and IE 11.
To start development server with demo pages:
cd examples/demo
pnpm i
pnpm serve
To package for npm:
pnpm dist
- vivekKodira: README correction
- siderisng:
dragToFlip - MaikoTan: TypeScript support
MIT
Copyright © 2019-2023 Takeshi Sone.
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent