GitHub - internetarchive/bookreader: The Internet Archive BookReader · GitHub
Skip to content You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert Branches Tags Open more actions menu Latest commit History 3,419 Commits 3,419 Commits Folders and files Name Name Last commit message Last commit date .github .github BookReaderDemo BookReaderDemo scripts scripts src src tests tests .eslintrc.cjs .eslintrc.cjs .gitattributes .gitattributes .gitignore .gitignore .npmrc .npmrc .testcaferc.cjs .testcaferc.cjs AGENTS.md AGENTS.md CHANGELOG.md CHANGELOG.md CONTRIBUTING.md CONTRIBUTING.md LICENSE LICENSE README.md README.md babel.config.cjs babel.config.cjs codecov.yml codecov.yml index.html index.html jsconfig.json jsconfig.json netlify.toml netlify.toml package-lock.json package-lock.json package.json package.json renovate.json renovate.json screenshot.png screenshot.png webpack.config.js webpack.config.js Repository files navigation Internet Archive BookReader Disclaimer: BookReader v5 is currently in beta.
It is stable enough for production use and is actively deployed on archive.org. Future updates while in v5 beta may introduce breaking changes to public BookReader APIs, although these will be noted in the CHANGELOG. The Internet Archive BookReader is used to view books from the Internet Archive online and can also be used to view other books. See live examples: On details page: https://archive.org/details/birdbookillustra00reedrich Full window: https://archive.org/details/birdbookillustra00reedrich?view=theater Embedded url for iFrames: https://archive.org/embed/birdbookillustra00reedrich Demos See BookReaderDemo directory.
These can be tested by building the source files (make sure Node.js is installed ): npm run build and starting a simple web server in the root directory: npm run serve And then open http://localhost:8000/BookReaderDemo/demo-simple.html . Usage Here is a short example. // Create the BookReader object var options = { data : [ [ { width : 800 , height : 1200 , uri : '//archive.org/download/BookReader/img/page001.jpg' } , ] , [ { width : 800 , height : 1200 , uri : '//archive.org/download/BookReader/img/page002.jpg' } , { width : 800 , height : 1200 , uri : '//archive.org/download/BookReader/img/page003.jpg' } , ] , [ { width : 800 , height : 1200 , uri : '//archive.org/download/BookReader/img/page004.jpg' } , { width : 800 , height : 1200 , uri : '//archive.org/download/BookReader/img/page005.jpg' } , ] ] , bookTitle : 'Simple BookReader Presentation' , // thumbnail is optional, but it is used in the info dialog thumbnail : '//archive.org/download/BookReader/img/page014.jpg' , // Metadata is optional, but it is used in the info dialog metadata : [ { label : 'Title' , value : 'Open Library BookReader Presentation' } , { label : 'Author' , value : 'Internet Archive' } , { label : 'Demo Info' , value : 'This demo shows how one could use BookReader with their own content.' } , ] , ui : 'full' , // embed, full (responsive) } ; var br = new BookReader ( options ) ; // Let's go! br . init ( ) ; Architecture Overview Starting at v5, BookReader introduces hybrid architecture that merges the core code written in jQuery closer to its evolution as a web component.
As we march toward the future of BookReader as a web component, we are taking an Event Driven approach to connect the two together. Approach: Event driven BookReader's (BR) core code emits custom events , reporting the actions it takes: UI changes Core Events src/BookReader/events.js API returns Search API src/BookReader/events.js BookNavigator, BR's web components controller, listens and reacts to these events in order to populate the side menu panels Control BR from the outside by using public methods When BookNavigator reacts to BR's events, BookNavigator can directly control BR core using public functions.
As we continue to decouple the UI from drawing/calculating logic, these logical methods will become easier to spot, raise as a public method, and create unit tests for them. Menu panels: Web Components via LitElement BookReader's side navigation is powered by LitElement flavored web components. Core: jQuery BookReader's core functionality is in jQuery. This includes: drawing & resizing the book and the various modes (1up, 2 page spread, gallery view) the horizontal navigation search API service plugins A peek in how to use/extend core functionality: Properties TODO (for now see src/BookReader/options.js ) Plugins A basic plugin system is used.
See the examples in the plugins directory. The general idea is that they are mixins that augment the BookReader prototype. See the plugins directory for all the included plugins, but here are some examples: plugin.autoplay.js - autoplay mode. Flips pages at set intervals. plugin.chapters.js - render chapter markers plugin.search.js - add search ui, and callbacks plugin.tts.js - add tts (read aloud) ui, sound library, and callbacks plugin.url.js - automatically updates the browser url plugin.resume.js - uses cookies to remember the current page plugin.vendor-fullscreen.js - replaces fullscreen mode with vendor native fullscreen see plugin directory for current plugin files Embedding BookReader in an iFrame BookReader can be embedded within an <iframe> .
If you use the IFrame Plugin inside the <iframe> , the reader will send notifications about changes in the state of the reader via window.postMessage() . The parent window can send messages of its own (also via window.postMessage() ) and the IFrame Plugin will handle updating the reader to match. Message Events Fragment Change The Fragment Change message is sent to the parent window when the embedded BookReader moves between pages/modes.
When the <iframe> receives this message, it moves to the specified page/mode. The “fragment” is formatted in accordance with the BookReader URL spec . { "type" : " bookReaderFragmentChange " , "fragment" : " page/n1/mode/2up " } Development (updates?) The source JavaScript is written in ES6 (located in the src/js directory) and in ES5 (located in BookReader ). npm run serve-dev starts an auto-reloading dev server, that builds js/css that has been edited at localhost:8000 .
Developing icons To see local icon package changes in bookreader, you'll need to install core-js into the icon package and link into bookreader. Let's use icon-share as an example. Confirm your icon package is working properly in the iaux-icons demo Navigate to your icon package ( iaux-icons/packages/icon-share ) and run command: npm install core-js You shouldn't need to commit any of these core-js changes From within your icon package directory run command: npm link You can use the command npm ls -g to confirm your local package now appears in the registry Navigate to /bookreader and run command: npm link @internetarchive/icon-share You can use the command npm ls |grep icon-share to confirm icon-share is now a link to your local directory You may now start a local server to see your changes by running command: npm run serve-dev Releases To version bump the repo and prepare a release, run npm version major|minor|patch (following semver ), then (something like) git push origin HEAD --tags .
It'll automatically update the version number where it appears, build the files, and ask you to update the CHANGELOG. We release BookReader in-repo as tags & also as a node module @internetarchive/bookreader Tests When contributing code, please include unit tests and/or update tests accordingly. Current code coverage can be tracked here . End to end tests We also have end to end tests using Testcafe . We write tests for the repo itself and also for our use on archive.org.
You can read about them in here . These are relatively easy to do, and a fantastic way of getting introduced to the wonders of BookReader. Check the project board for open tickets to work on. And if you don't see a test for som
The rest of this page is on the live site.