@d-i-t-a/reader 2.0.2 → 2.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (21) hide show
  1. package/README.md +42 -3
  2. package/dist/esm/index.js +489 -10250
  3. package/dist/esm/index.js.map +3 -3
  4. package/dist/injectables/click/click.js +4 -4
  5. package/dist/injectables/click/click.js.map +1 -1
  6. package/dist/injectables/mui/script.js +205 -0
  7. package/dist/injectables/mui/style.css +271 -0
  8. package/dist/injectables/style/style.css +1 -1
  9. package/dist/injectables/style/toast.css +76 -0
  10. package/dist/reader.css +165 -73
  11. package/dist/reader.js +60 -93
  12. package/dist/reader.js.map +3 -3
  13. package/dist/reader.map.css +1 -1
  14. package/dist/types/modules/TTS/TTSSettings.d.ts +0 -1
  15. package/dist/types/navigator/IFrameNavigator.d.ts +1 -9
  16. package/dist/types/utils/KeyboardEventHandler.d.ts +2 -1
  17. package/dist/types/utils/TouchEventHandler.d.ts +3 -0
  18. package/package.json +1 -3
  19. package/dist/material.css +0 -4637
  20. package/dist/material.map.css +0 -30
  21. package/dist/types/modules/TTS/TTSModule.d.ts +0 -33
package/README.md CHANGED
@@ -46,13 +46,44 @@ Here is the original proposal, initiated by Aferdita Muriqi to the
46
46
 
47
47
  Subsequent development of R2D2BC has been supported by [DITA](https://github.com/d-i-t-a), [Bokbasen](https://www.bokbasen.no/), and [CAST](http://www.cast.org) - which explains the D2, B, and C in the name.
48
48
 
49
+ # Features & Functionalities
50
+ - ePub Reflowable + Fixed Layout
51
+ - Reader Settings
52
+ - Configurable Modules with Callbacks
53
+ - Injectable Fonts, CSS, Javascript
54
+ - Text Selection with Injectable Context Menu
55
+ - Bookmarks
56
+ - Highlights
57
+ - Annotations
58
+ - TTS - Text to speech / Read Aloud
59
+ - Media Overlays - Read Along
60
+ - Search
61
+ - Content Protection
62
+ - Definitions
63
+ - Popup Footnotes
64
+ - Page Breaks - Page Numbers in margin
65
+ - Sample Read
66
+ - Timeline
67
+ - Layers
68
+ - Line Focus (Beta Feature)
69
+ - Popups and Popovers
70
+
49
71
  # Extensions and Implementations
50
72
 
51
73
  The R2D2BC reader has been used in:
52
74
  - The [Clusive](https://github.com/cast-org/clusive) learning environment
53
- - Bokbasen's [Allbok.no](https://www.allbok.no) and [Allvit.no](https://www.allvit.no)
54
- - The UNODC [Fieldguides](https://fieldguides.github.io/library/)
55
- - The DITA Gateway [D2G](https://d2g.dita.digital)
75
+ - Bokbasen's [Allbok.no](https://www.allbok.no)
76
+ - Allvir's [Allvit.no](https://www.allvit.no) Reading Platform
77
+ - The UNODC [Fieldguides](https://fieldguides.github.io/library)
78
+ - The DITA Gateway [D2G](https://d2g.dita.digital) with several open collections
79
+ - [Ekitabu's](https://d2g.dita.digital) Web Reader Implementations through Dita Gateway
80
+ - [NYPL's](https://www.nypl.org/) Web Reader Implementations
81
+ - Bibliotheca's [CloudLibrary](https://www.yourcloudlibrary.com) as Sample Reader and Full ePub Reader
82
+ - Above the Treeline's [Edeweiss+](https://www.edelweiss.plus)
83
+ - [Bluefire's](https://www.bluefirereader.com) Web Reader Implementations
84
+ - In a Project in the Meta Verse (to be named once public)
85
+ - and a few more... :)
86
+
56
87
 
57
88
  # Contributing
58
89
  Contributions are always welcomed! Please see [CONTRIBUTING](CONTRIBUTING.md) for detailed guidelines.
@@ -70,5 +101,13 @@ npm run build && npm run examples
70
101
  ```
71
102
  Then visit `http://localhost:4444/`. Follow the prompts to view example apps.
72
103
 
104
+ ### WIKI
105
+ - [Implementation Guides and Examples](https://github.com/d-i-t-a/R2D2BC/wiki)
106
+
107
+ ### Migration Guides
108
+ - [Version 1.x -> 2.x](MIGRATION.md)
109
+ ### Change Log
110
+ - [2.0.x](CHANGELOG.md)
111
+
73
112
  ## Supporters
74
113
  [<img src="https://dita.digital/jetbrains.png" width="60">](https://www.jetbrains.com/?from=R2D2BC)