Distributed under LGPL-3.0-or-later license
Book component for Vue 3. It provides easy, flexible API and great customizability.
- You can make your book interactive
- Or create interactive journal
- Or you just need to do something fast and easy way
// main.ts
import {createApp} from 'vue';
import BananaVue3BookPlugin from '@bananajs/vue3-book-component';
import '@bananajs/vue3-book-component/BananaVue3Book.css';
import App from './App.vue';
createApp(App).use(BananaVue3BookPlugin).mount('#app');
// App.vue
<template>
<banana-vue3-book :options="options" :list="list">
<template #first>
</template>
<!-- item of slot data is the same object in list prop -->
<template #faceFront="{ item }">
</template>
<template #faceBack="{ item }">
</template>
<template #last>
</template>
</banana-vue3-book>
</template>
<script>
setup() {
const options = {
duration: 1500,
perspective: 1500,
delay: 1000,
autoplay: true,
loop: false,
};
const list = [/* your data to show */];
return { options, list };
},
</script>
Name | Type | Purpose |
---|---|---|
options |
Object | Different options for book |
list |
Array | Your pages to show |
How fast will work auto flip.
Default: 1500
Default: 1500
Delay between page turn
Default: 1000
Turn on/off auto play
Default: false
Turn on/off loop
Default: false
Name | Data | Purpose |
---|---|---|
first |
None | First item in book |
faceFront |
{ item } |
Face of the page |
faceBack |
{ item } |
Back of the page |
last |
None | Last item in book |
- Fork it (https://github.com/bananajs-is-already-taken/vue3-book-component/fork)
- Create your feature branch (
git checkout -b feature/fooBar
) - Commit your changes using a semantic commit message.
- Push to the branch (
git push origin feature/fooBar
) - Create a new Pull Request
Icons made by Freepik from www.flaticon.com