@d-i-t-a/reader 2.0.0-alpha.2 → 2.0.0-beta.10

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 (93) hide show
  1. package/README.md +10 -0
  2. package/dist/esm/index.js +60633 -0
  3. package/dist/esm/index.js.map +7 -0
  4. package/dist/injectables/click/click.js +1774 -2
  5. package/dist/injectables/click/click.js.map +7 -1
  6. package/dist/injectables/style/linefocus.css +55 -0
  7. package/dist/injectables/style/popup.css +121 -0
  8. package/dist/injectables/style/style.css +250 -0
  9. package/dist/{material.css.map → material.map.css} +0 -0
  10. package/dist/reader.css +2 -5
  11. package/dist/reader.js +161 -3
  12. package/dist/reader.js.map +7 -1
  13. package/dist/reader.map.css +21 -0
  14. package/dist/types/index.d.ts +7 -0
  15. package/dist/{model → types/model}/Link.d.ts +1 -1
  16. package/dist/{model → types/model}/Locator.d.ts +3 -18
  17. package/dist/{model → types/model}/Publication.d.ts +17 -13
  18. package/dist/{model → types/model}/user-settings/ReadiumCSS.d.ts +0 -0
  19. package/dist/{model → types/model}/user-settings/UserProperties.d.ts +3 -2
  20. package/dist/{model → types/model}/user-settings/UserSettings.d.ts +6 -6
  21. package/dist/{modules → types/modules}/AnnotationModule.d.ts +30 -18
  22. package/dist/types/modules/BookmarkModule.d.ts +57 -0
  23. package/dist/types/modules/ReaderModule.d.ts +2 -0
  24. package/dist/types/modules/TTS/TTSModule.d.ts +33 -0
  25. package/dist/types/modules/TTS/TTSModule2.d.ts +73 -0
  26. package/dist/{modules → types/modules}/TTS/TTSSettings.d.ts +41 -17
  27. package/dist/{modules → types/modules}/highlight/HtmlElementSelector.d.ts +0 -0
  28. package/dist/types/modules/highlight/LayerSettings.d.ts +19 -0
  29. package/dist/{modules → types/modules}/highlight/TextHighlighter.d.ts +57 -57
  30. package/dist/{modules → types/modules}/highlight/common/document.d.ts +0 -0
  31. package/dist/{modules → types/modules}/highlight/common/events.d.ts +0 -0
  32. package/dist/types/modules/highlight/common/highlight.d.ts +71 -0
  33. package/dist/{modules → types/modules}/highlight/common/rect-utils.d.ts +1 -1
  34. package/dist/{modules → types/modules}/highlight/common/selection.d.ts +8 -3
  35. package/dist/{modules → types/modules}/highlight/renderer/common/cssselector.d.ts +0 -0
  36. package/dist/{modules → types/modules}/highlight/renderer/common/cssselector2.d.ts +0 -0
  37. package/dist/{modules → types/modules}/highlight/renderer/iframe/selection.d.ts +2 -2
  38. package/dist/{modules → types/modules}/highlight/renderer/iframe/state.d.ts +0 -3
  39. package/dist/types/modules/linefocus/LineFocusModule.d.ts +45 -0
  40. package/dist/{modules → types/modules}/mediaoverlays/MediaOverlayModule.d.ts +19 -14
  41. package/dist/{modules → types/modules}/mediaoverlays/MediaOverlaySettings.d.ts +20 -16
  42. package/dist/types/modules/pagebreak/PageBreakModule.d.ts +30 -0
  43. package/dist/{modules → types/modules}/positions/TimelineModule.d.ts +4 -4
  44. package/dist/{modules → types/modules}/protection/ContentProtectionModule.d.ts +11 -7
  45. package/dist/types/modules/sampleread/SampleReadEventHandler.d.ts +8 -0
  46. package/dist/types/modules/search/DefinitionsModule.d.ts +52 -0
  47. package/dist/types/modules/search/Popup.d.ts +8 -0
  48. package/dist/{modules → types/modules}/search/SearchModule.d.ts +17 -13
  49. package/dist/{modules → types/modules}/search/searchWithDomSeek.d.ts +1 -1
  50. package/dist/{navigator → types/navigator}/IFrameNavigator.d.ts +88 -57
  51. package/dist/{navigator → types/navigator}/Navigator.d.ts +0 -0
  52. package/dist/types/reader.d.ts +200 -0
  53. package/dist/types/store/Annotator.d.ts +25 -0
  54. package/dist/types/store/LocalAnnotator.d.ts +31 -0
  55. package/dist/{store → types/store}/LocalStorageStore.d.ts +3 -3
  56. package/dist/{store → types/store}/MemoryStore.d.ts +3 -3
  57. package/dist/types/store/Store.d.ts +6 -0
  58. package/dist/{utils → types/utils}/BrowserUtilities.d.ts +0 -7
  59. package/dist/{utils → types/utils}/EventHandler.d.ts +12 -0
  60. package/dist/{utils → types/utils}/HTMLTemplates.d.ts +0 -0
  61. package/dist/{utils → types/utils}/HTMLUtilities.d.ts +3 -3
  62. package/dist/{utils → types/utils}/IconLib.d.ts +1 -0
  63. package/dist/{utils → types/utils}/JsonUtil.d.ts +0 -0
  64. package/dist/types/utils/KeyboardEventHandler.d.ts +9 -0
  65. package/dist/{utils → types/utils}/TouchEventHandler.d.ts +1 -1
  66. package/dist/types/utils/index.d.ts +6 -0
  67. package/dist/{views → types/views}/BookView.d.ts +9 -7
  68. package/dist/{views → types/views}/FixedBookView.d.ts +7 -4
  69. package/dist/{views → types/views}/ReflowableBookView.d.ts +6 -4
  70. package/package.json +35 -19
  71. package/CHANGELOG.md +0 -6
  72. package/NOTICE +0 -20
  73. package/dist/index.d.ts +0 -140
  74. package/dist/injectables/click/click.d.ts +0 -1
  75. package/dist/injectables/footnotes/footnotes.d.ts +0 -1
  76. package/dist/injectables/footnotes/footnotes.js +0 -2
  77. package/dist/injectables/footnotes/footnotes.js.map +0 -1
  78. package/dist/injectables/glossary/glossary.d.ts +0 -5
  79. package/dist/injectables/glossary/glossary.js +0 -3
  80. package/dist/injectables/glossary/glossary.js.LICENSE.txt +0 -6
  81. package/dist/injectables/glossary/glossary.js.map +0 -1
  82. package/dist/modules/BookmarkModule.d.ts +0 -46
  83. package/dist/modules/ReaderModule.d.ts +0 -3
  84. package/dist/modules/TTS/TTSModule.d.ts +0 -58
  85. package/dist/modules/highlight/common/highlight.d.ts +0 -19
  86. package/dist/modules/highlight/common/styles.d.ts +0 -35
  87. package/dist/reader.css.map +0 -21
  88. package/dist/reader.js.LICENSE.txt +0 -68
  89. package/dist/store/Annotator.d.ts +0 -25
  90. package/dist/store/LocalAnnotator.d.ts +0 -31
  91. package/dist/store/Store.d.ts +0 -6
  92. package/dist/utils/KeyboardEventHandler.d.ts +0 -7
  93. package/dist/utils/index.d.ts +0 -1
package/README.md CHANGED
@@ -59,6 +59,16 @@ Contributions are always welcomed! Please see [CONTRIBUTING](CONTRIBUTING.md) fo
59
59
 
60
60
  [![DepShield Badge](https://depshield.sonatype.org/badges/d-i-t-a/R2D2BC/depshield.svg)](https://depshield.github.io)
61
61
 
62
+ # Get Started
63
+
64
+ Download ebook examples here: https://standardebooks.org/ebooks and copy them to `./examples/streamed/epubs`. Then:
65
+
66
+ ```
67
+ npm install
68
+
69
+ npm run build && npm run examples && npm run streamed
70
+ ```
71
+ Then visit `http://localhost:4444/`. Follow the prompts to view example apps. The most up-to-date example is "D2 Reader" /viewer/index_dita.html.
62
72
 
63
73
  ## Supporters
64
74
  [<img src="https://dita.digital/jetbrains.png" width="60">](https://www.jetbrains.com/?from=R2D2BC)