Git Product home page Git Product logo

fiction-reader's Introduction

Fiction Reader (vue3)

This is a basic feature fiction reader designed for easier rendering of text.

Usage

git clone [email protected]:KayneWang/fiction-reader.git

npm install

npm run dev

or

npm install @kaynewang/fiction-reader

Note: Remember import the style.css file in your root js/ts file.

import '@kaynewang/fiction-reader/dist/style.css'

Properties

Name Description Default
mode scroll, pagination scroll
context render text ''
line-break text line break tag \n
font-size-class - built-in class
line-height-class - built-in class
paragraph-gap-class - built-in class

Events

Name Description
page-change callback function for page turning
total-page-change callback function for total page changing

Pagination

<Reader
  ref="readerRef"
  mode="pagination"
  context="test context"
/>
const readerRef = ref()

readerRef.value?.renderNextPageContent() // Next page

readerRef.value?.renderPreviousPageContent() // Previous page

For more usage, please refer to src/App.vue

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.