🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more

react-epub-search

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

react-epub-search

An epub-reader for React integrated with search powered by ePubJS

1.0.1
latest
Version published
Weekly downloads
0
Maintainers
1
Weekly downloads
 
Created

An ePub-reader for react intergrated with search powered by EpubJS #react #epubjs #webpack #babel #standardjs

Inspiration

React wrapper for EpubJS

React Reader is a react-wrapper for epub.js.

About

epub.js is a great library and this is a wrapper for it intergated with search. This wrapper makes it easy to use in a React-app.

This package publish 4 named exports:

  • EpubReader - Most used, a basic epub-reader to embed into your webapp
  • EpubView - Underlaying epub-canvas (wrapper for epub.js iframe)

Basic usage

npm install react-epub-search --save

import React, { useState } from 'react'
import { EpubReader } from 'react-epub-search'

const App = () => {
  // And your own state logic to persist state
  const [location, setLocation] = useState(null)
  const locationChanged = epubcifi => {
    // epubcifi is a internal string used by epubjs to point to a location in an epub. It looks like this: epubcfi(/6/6[titlepage]!/4/2/12[pgepubid00003]/3:0)
    setLocation(epubcifi)
  }
  return (
    <div style={{ height: '100vh' }}>
      <EpubReader
        location={location}
        locationChanged={locationChanged}
        url="https://react-reader.metabits.no/files/alice.epub"
      />
    </div>
  )
}

export default App

Handling Search Results

const App = () => {
  // And your own state logic to persist state
  const [location, setLocation] = useState(null)
  const locationChanged = epubcifi => {
    setLocation(epubcifi)
  }
  const onChangeSearchResults = (result) => console.log(results);

  return (
    <div style={{ height: '100vh' }}>
      <EpubReader
        location={location}
        locationChanged={locationChanged}
        onChangeSearchResults={onChangeSearchResults}
        url="https://react-reader.metabits.no/files/alice.epub"
      />
    </div>
  )
}

Other Functionalities:

  • Theme (Light/Dark)
  • Theme Change (Color and Font Size)
  • Reset Reader (Used for toggle theme) (Bug of EpubJS)
  • navigationChangehandler (Used for right-left arrow keys)
  • Image Click

FAQs

Package last updated on 09 May 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts