@internetarchive/bookreader 5.0.0-4 → 5.0.0-40-a1

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 (228) hide show
  1. package/.eslintrc.js +17 -15
  2. package/.github/workflows/node.js.yml +75 -4
  3. package/.github/workflows/npm-publish.yml +2 -16
  4. package/.testcaferc.js +10 -0
  5. package/BookReader/BookReader.css +83 -323
  6. package/BookReader/BookReader.js +1 -1
  7. package/BookReader/BookReader.js.LICENSE.txt +24 -0
  8. package/BookReader/BookReader.js.map +1 -1
  9. package/BookReader/ia-bookreader-bundle.js +1623 -0
  10. package/BookReader/{bookreader-component-bundle.js.LICENSE.txt → ia-bookreader-bundle.js.LICENSE.txt} +14 -10
  11. package/BookReader/ia-bookreader-bundle.js.map +1 -0
  12. package/BookReader/icons/close-circle-dark.svg +1 -0
  13. package/BookReader/icons/magnify-minus.svg +1 -1
  14. package/BookReader/icons/magnify-plus.svg +1 -1
  15. package/BookReader/icons/voice.svg +1 -0
  16. package/BookReader/plugins/plugin.archive_analytics.js +1 -1
  17. package/BookReader/plugins/plugin.archive_analytics.js.map +1 -1
  18. package/BookReader/plugins/plugin.autoplay.js +1 -1
  19. package/BookReader/plugins/plugin.autoplay.js.map +1 -1
  20. package/BookReader/plugins/plugin.chapters.js +1 -1
  21. package/BookReader/plugins/plugin.chapters.js.map +1 -1
  22. package/BookReader/plugins/plugin.iframe.js +1 -1
  23. package/BookReader/plugins/plugin.iframe.js.map +1 -1
  24. package/BookReader/plugins/plugin.mobile_nav.js +1 -1
  25. package/BookReader/plugins/plugin.mobile_nav.js.map +1 -1
  26. package/BookReader/plugins/plugin.resume.js +1 -1
  27. package/BookReader/plugins/plugin.resume.js.map +1 -1
  28. package/BookReader/plugins/plugin.search.js +1 -1
  29. package/BookReader/plugins/plugin.search.js.map +1 -1
  30. package/BookReader/plugins/plugin.text_selection.js +1 -1
  31. package/BookReader/plugins/plugin.text_selection.js.map +1 -1
  32. package/BookReader/plugins/plugin.tts.js +1 -1
  33. package/BookReader/plugins/plugin.tts.js.map +1 -1
  34. package/BookReader/plugins/plugin.url.js +1 -1
  35. package/BookReader/plugins/plugin.url.js.map +1 -1
  36. package/BookReader/plugins/plugin.vendor-fullscreen.js +1 -1
  37. package/BookReader/plugins/plugin.vendor-fullscreen.js.map +1 -1
  38. package/BookReader/webcomponents-bundle.js +3 -0
  39. package/BookReader/webcomponents-bundle.js.LICENSE.txt +9 -0
  40. package/BookReader/webcomponents-bundle.js.map +1 -0
  41. package/BookReaderDemo/BookReaderDemo.css +14 -1
  42. package/BookReaderDemo/IADemoBr.js +120 -0
  43. package/BookReaderDemo/demo-advanced.html +1 -1
  44. package/BookReaderDemo/demo-autoplay.html +1 -0
  45. package/BookReaderDemo/demo-embed-iframe-src.html +1 -0
  46. package/BookReaderDemo/demo-fullscreen-mobile.html +1 -0
  47. package/BookReaderDemo/demo-fullscreen.html +1 -0
  48. package/BookReaderDemo/demo-iiif.html +1 -0
  49. package/BookReaderDemo/demo-internetarchive.html +74 -17
  50. package/BookReaderDemo/demo-multiple.html +1 -0
  51. package/BookReaderDemo/demo-preview-pages.html +1 -0
  52. package/BookReaderDemo/demo-simple.html +1 -0
  53. package/BookReaderDemo/demo-vendor-fullscreen.html +1 -0
  54. package/BookReaderDemo/ia-multiple-volumes-manifest.js +170 -0
  55. package/BookReaderDemo/immersion-1up.html +1 -0
  56. package/BookReaderDemo/immersion-mode.html +1 -0
  57. package/BookReaderDemo/toggle_controls.html +1 -0
  58. package/BookReaderDemo/view_mode.html +1 -0
  59. package/BookReaderDemo/viewmode-cycle.html +1 -2
  60. package/CHANGELOG.md +166 -0
  61. package/README.md +14 -1
  62. package/babel.config.js +18 -0
  63. package/codecov.yml +6 -0
  64. package/index.html +3 -0
  65. package/jsconfig.json +19 -0
  66. package/package.json +62 -47
  67. package/renovate.json +43 -0
  68. package/src/BookNavigator/assets/bookmark-colors.js +1 -1
  69. package/src/BookNavigator/assets/button-base.js +9 -2
  70. package/src/BookNavigator/assets/ia-logo.js +17 -0
  71. package/src/BookNavigator/assets/icon_checkmark.js +1 -1
  72. package/src/BookNavigator/assets/icon_close.js +1 -1
  73. package/src/BookNavigator/assets/icon_sort_asc.js +5 -0
  74. package/src/BookNavigator/assets/icon_sort_desc.js +5 -0
  75. package/src/BookNavigator/assets/icon_sort_neutral.js +5 -0
  76. package/src/BookNavigator/assets/icon_volumes.js +11 -0
  77. package/src/BookNavigator/book-navigator.js +556 -0
  78. package/src/BookNavigator/bookmarks/bookmark-button.js +3 -2
  79. package/src/BookNavigator/bookmarks/bookmark-edit.js +4 -4
  80. package/src/BookNavigator/bookmarks/bookmarks-list.js +3 -3
  81. package/src/BookNavigator/bookmarks/bookmarks-loginCTA.js +3 -8
  82. package/src/BookNavigator/bookmarks/bookmarks-provider.js +23 -12
  83. package/src/BookNavigator/bookmarks/ia-bookmarks.js +98 -62
  84. package/src/BookNavigator/delete-modal-actions.js +1 -1
  85. package/src/BookNavigator/downloads/downloads-provider.js +23 -17
  86. package/src/BookNavigator/downloads/downloads.js +17 -25
  87. package/src/BookNavigator/search/a-search-result.js +3 -3
  88. package/src/BookNavigator/search/search-provider.js +57 -24
  89. package/src/BookNavigator/search/search-results.js +8 -20
  90. package/src/BookNavigator/sharing.js +27 -0
  91. package/src/BookNavigator/visual-adjustments/visual-adjustments-provider.js +11 -13
  92. package/src/BookNavigator/visual-adjustments/visual-adjustments.js +4 -3
  93. package/src/BookNavigator/volumes/volumes-provider.js +114 -0
  94. package/src/BookNavigator/volumes/volumes.js +188 -0
  95. package/src/BookReader/DebugConsole.js +3 -3
  96. package/src/BookReader/DragScrollable.js +233 -0
  97. package/src/BookReader/Mode1Up.js +51 -351
  98. package/src/BookReader/Mode1UpLit.js +441 -0
  99. package/src/BookReader/Mode2Up.js +104 -71
  100. package/src/BookReader/ModeSmoothZoom.js +179 -0
  101. package/src/BookReader/ModeThumb.js +16 -8
  102. package/src/BookReader/Navbar/Navbar.js +2 -31
  103. package/src/BookReader/PageContainer.js +57 -6
  104. package/src/BookReader/ReduceSet.js +1 -1
  105. package/src/BookReader/Toolbar/Toolbar.js +7 -7
  106. package/src/BookReader/options.js +10 -0
  107. package/src/BookReader/utils/HTMLDimensionsCacher.js +44 -0
  108. package/src/BookReader/utils/ScrollClassAdder.js +31 -0
  109. package/src/BookReader/utils.js +68 -13
  110. package/src/BookReader.js +375 -289
  111. package/src/assets/icons/close-circle-dark.svg +1 -0
  112. package/src/assets/icons/magnify-minus.svg +3 -7
  113. package/src/assets/icons/magnify-plus.svg +3 -7
  114. package/src/assets/icons/voice.svg +1 -0
  115. package/src/css/BookReader.scss +0 -12
  116. package/src/css/_BRComponent.scss +1 -1
  117. package/src/css/_BRmain.scss +19 -24
  118. package/src/css/_BRnav.scss +4 -26
  119. package/src/css/_BRpages.scss +35 -0
  120. package/src/css/_BRsearch.scss +11 -215
  121. package/src/css/_TextSelection.scss +14 -17
  122. package/src/css/_colorbox.scss +2 -2
  123. package/src/css/_controls.scss +16 -3
  124. package/src/css/_icons.scss +6 -0
  125. package/src/ia-bookreader/ia-bookreader.js +224 -0
  126. package/src/plugins/plugin.chapters.js +26 -33
  127. package/src/plugins/plugin.mobile_nav.js +11 -10
  128. package/src/plugins/plugin.resume.js +3 -3
  129. package/src/plugins/plugin.text_selection.js +26 -39
  130. package/src/plugins/plugin.vendor-fullscreen.js +4 -4
  131. package/src/plugins/search/plugin.search.js +106 -107
  132. package/src/plugins/search/view.js +50 -163
  133. package/src/plugins/tts/AbstractTTSEngine.js +46 -37
  134. package/src/plugins/tts/FestivalTTSEngine.js +12 -13
  135. package/src/plugins/tts/PageChunk.js +15 -21
  136. package/src/plugins/tts/PageChunkIterator.js +8 -12
  137. package/src/plugins/tts/WebTTSEngine.js +64 -68
  138. package/src/plugins/tts/plugin.tts.js +79 -108
  139. package/src/plugins/url/UrlPlugin.js +184 -0
  140. package/src/plugins/{plugin.url.js → url/plugin.url.js} +28 -6
  141. package/tests/e2e/README.md +37 -0
  142. package/tests/e2e/autoplay.test.js +2 -2
  143. package/tests/e2e/base.test.js +7 -7
  144. package/tests/e2e/helpers/base.js +8 -3
  145. package/tests/e2e/helpers/debug.js +1 -1
  146. package/tests/e2e/helpers/desktopSearch.js +14 -13
  147. package/tests/e2e/helpers/mobileSearch.js +3 -3
  148. package/tests/e2e/helpers/params.js +17 -0
  149. package/tests/e2e/models/Navigation.js +12 -3
  150. package/tests/e2e/rightToLeft.test.js +4 -5
  151. package/tests/e2e/viewmode.test.js +38 -33
  152. package/tests/{BookReader → jest/BookReader}/BookModel.test.js +3 -3
  153. package/tests/jest/BookReader/BookReaderPublicFunctions.test.js +176 -0
  154. package/tests/{BookReader → jest/BookReader}/DebugConsole.test.js +1 -1
  155. package/tests/{BookReader → jest/BookReader}/ImageCache.test.js +4 -4
  156. package/tests/jest/BookReader/Mode1UpLit.test.js +88 -0
  157. package/tests/{BookReader → jest/BookReader}/Mode2Up.test.js +5 -7
  158. package/tests/jest/BookReader/ModeSmoothZoom.test.js +149 -0
  159. package/tests/jest/BookReader/ModeThumb.test.js +71 -0
  160. package/tests/{BookReader → jest/BookReader}/Navbar/Navbar.test.js +7 -7
  161. package/tests/{BookReader → jest/BookReader}/PageContainer.test.js +79 -6
  162. package/tests/{BookReader → jest/BookReader}/ReduceSet.test.js +1 -1
  163. package/tests/{BookReader → jest/BookReader}/Toolbar/Toolbar.test.js +2 -2
  164. package/tests/jest/BookReader/utils/HTMLDimensionsCacher.test.js +59 -0
  165. package/tests/jest/BookReader/utils/ScrollClassAdder.test.js +49 -0
  166. package/tests/{BookReader → jest/BookReader}/utils/classes.test.js +1 -1
  167. package/tests/jest/BookReader/utils.test.js +136 -0
  168. package/tests/jest/BookReader.keyboard.test.js +190 -0
  169. package/tests/{BookReader.options.test.js → jest/BookReader.options.test.js} +9 -1
  170. package/tests/{BookReader.test.js → jest/BookReader.test.js} +20 -4
  171. package/tests/{plugins → jest/plugins}/plugin.archive_analytics.test.js +2 -2
  172. package/tests/{plugins → jest/plugins}/plugin.autoplay.test.js +2 -2
  173. package/tests/{plugins → jest/plugins}/plugin.chapters.test.js +8 -8
  174. package/tests/{plugins → jest/plugins}/plugin.iframe.test.js +2 -2
  175. package/tests/{plugins → jest/plugins}/plugin.mobile_nav.test.js +5 -5
  176. package/tests/{plugins → jest/plugins}/plugin.resume.test.js +3 -3
  177. package/tests/{plugins → jest/plugins}/plugin.text_selection.test.js +39 -47
  178. package/tests/{plugins → jest/plugins}/plugin.vendor-fullscreen.test.js +2 -2
  179. package/tests/{plugins → jest/plugins}/search/plugin.search.test.js +24 -25
  180. package/tests/{plugins → jest/plugins}/search/plugin.search.view.test.js +6 -6
  181. package/tests/{plugins → jest/plugins}/tts/AbstractTTSEngine.test.js +6 -6
  182. package/tests/{plugins → jest/plugins}/tts/FestivalTTSEngine.test.js +4 -4
  183. package/tests/{plugins → jest/plugins}/tts/PageChunk.test.js +1 -1
  184. package/tests/{plugins → jest/plugins}/tts/PageChunkIterator.test.js +3 -3
  185. package/tests/{plugins → jest/plugins}/tts/WebTTSEngine.test.js +1 -1
  186. package/tests/{plugins → jest/plugins}/tts/utils.test.js +3 -3
  187. package/tests/jest/plugins/url/UrlPlugin.test.js +190 -0
  188. package/tests/{plugins → jest/plugins/url}/plugin.url.test.js +33 -14
  189. package/tests/{util → jest/util}/browserSniffing.test.js +1 -1
  190. package/tests/{util → jest/util}/docCookies.test.js +1 -1
  191. package/tests/{util → jest/util}/strings.test.js +1 -1
  192. package/tests/{utils.js → jest/utils.js} +38 -0
  193. package/tests/karma/BookNavigator/book-navigator.test.js +501 -0
  194. package/tests/karma/BookNavigator/bookmarks/bookmark-button.test.js +44 -0
  195. package/tests/karma/BookNavigator/bookmarks/bookmark-edit.test.js +1 -3
  196. package/tests/karma/BookNavigator/bookmarks/bookmarks-list.test.js +3 -4
  197. package/tests/karma/BookNavigator/bookmarks/ia-bookmarks.test.js +57 -0
  198. package/tests/karma/BookNavigator/downloads/downloads-provider.test.js +67 -0
  199. package/tests/karma/BookNavigator/downloads/downloads.test.js +54 -0
  200. package/tests/karma/BookNavigator/search/search-provider.test.js +123 -0
  201. package/tests/karma/BookNavigator/{search-results.test.js → search/search-results.test.js} +1 -4
  202. package/tests/karma/BookNavigator/sharing/sharing-provider.test.js +49 -0
  203. package/tests/karma/BookNavigator/visual-adjustments.test.js +0 -2
  204. package/tests/karma/BookNavigator/volumes/volumes-provider.test.js +184 -0
  205. package/tests/karma/BookNavigator/volumes/volumes.test.js +98 -0
  206. package/webpack.config.js +10 -4
  207. package/.babelrc +0 -12
  208. package/.dependabot/config.yml +0 -6
  209. package/.testcaferc.json +0 -5
  210. package/BookReader/bookreader-component-bundle.js +0 -1450
  211. package/BookReader/bookreader-component-bundle.js.map +0 -1
  212. package/BookReader/plugins/plugin.menu_toggle.js +0 -2
  213. package/BookReader/plugins/plugin.menu_toggle.js.map +0 -1
  214. package/BookReaderDemo/bookreader-template-bundle.js +0 -7178
  215. package/BookReaderDemo/demo-plugin-menu-toggle.html +0 -34
  216. package/src/BookNavigator/BookModel.js +0 -14
  217. package/src/BookNavigator/BookNavigator.js +0 -435
  218. package/src/BookNavigator/assets/book-loader.js +0 -27
  219. package/src/BookNavigator/br-fullscreen-mgr.js +0 -83
  220. package/src/BookReaderComponent/BookReaderComponent.js +0 -112
  221. package/src/ItemNavigator/ItemNavigator.js +0 -372
  222. package/src/ItemNavigator/providers/sharing.js +0 -29
  223. package/src/dragscrollable-br.js +0 -261
  224. package/src/plugins/menu_toggle/plugin.menu_toggle.js +0 -324
  225. package/tests/BookReader/BookReaderPublicFunctions.test.js +0 -171
  226. package/tests/BookReader/Mode1Up.test.js +0 -164
  227. package/tests/BookReader/utils.test.js +0 -109
  228. package/tests/plugins/menu_toggle/plugin.menu_toggle.test.js +0 -68
@@ -0,0 +1,233 @@
1
+ // @ts-check
2
+ /*
3
+ * jQuery dragscrollable Plugin
4
+ * Based off version: 1.0 (25-Jun-2009)
5
+ * Copyright (c) 2009 Miquel Herrera
6
+ *
7
+ * Portions Copyright (c) 2010 Reg Braithwaite
8
+ * Copyright (c) 2010 Internet Archive / Michael Ang
9
+ * Copyright (c) 2016 Internet Archive / Richard Caceres
10
+ *
11
+ * Dual licensed under the MIT and GPL licenses:
12
+ * http://www.opensource.org/licenses/mit-license.php
13
+ * http://www.gnu.org/licenses/gpl.html
14
+ */
15
+
16
+ /**
17
+ * @param {string} string_of_events
18
+ * @param {string} ns
19
+ * @returns
20
+ */
21
+ function append_namespace(string_of_events, ns) {
22
+ return string_of_events
23
+ .split(' ')
24
+ .map(event_name => event_name + ns)
25
+ .join(' ');
26
+ }
27
+
28
+ function left_top(event) {
29
+ /** @type {number} */
30
+ let x;
31
+ /** @type {number} */
32
+ let y;
33
+ if (typeof(event.clientX) != 'undefined') {
34
+ x = event.clientX;
35
+ y = event.clientY;
36
+ }
37
+ else if (typeof(event.screenX) != 'undefined') {
38
+ x = event.screenX;
39
+ y = event.screenY;
40
+ }
41
+ else if (typeof(event.targetTouches) != 'undefined') {
42
+ x = event.targetTouches[0].pageX;
43
+ y = event.targetTouches[0].pageY;
44
+ }
45
+ else if (typeof(event.originalEvent) == 'undefined') {
46
+ console.error("don't understand x and y for " + event.type, event);
47
+ }
48
+ else if (typeof(event.originalEvent.clientX) != 'undefined') {
49
+ x = event.originalEvent.clientX;
50
+ y = event.originalEvent.clientY;
51
+ }
52
+ else if (typeof(event.originalEvent.screenX) != 'undefined') {
53
+ x = event.originalEvent.screenX;
54
+ y = event.originalEvent.screenY;
55
+ }
56
+ else if (typeof(event.originalEvent.targetTouches) != 'undefined') {
57
+ x = event.originalEvent.targetTouches[0].pageX;
58
+ y = event.originalEvent.targetTouches[0].pageY;
59
+ }
60
+
61
+ return { left: x, top: y };
62
+ }
63
+
64
+ const DEFAULT_OPTIONS = {
65
+ /**
66
+ * @type {String|HTMLElement} jQuery selector to apply to each wrapped element to
67
+ * find which will be the dragging elements. Defaults to the first child of scrollable
68
+ * element
69
+ */
70
+ dragSelector: '>:first',
71
+
72
+ /** Will the dragging element accept propagated events? default is yes, a propagated
73
+ * mouse event on a inner element will be accepted and processed. If set to false,
74
+ * only events originated on the draggable elements will be processed. */
75
+ acceptPropagatedEvent: true,
76
+
77
+ /**
78
+ * Prevents the event to propagate further effectively disabling other default actions
79
+ */
80
+ preventDefault: true,
81
+
82
+ dragstart: 'mousedown touchstart',
83
+ dragcontinue: 'mousemove touchmove',
84
+ dragend: 'mouseup touchend', // mouseleave
85
+ dragMinDistance: 5,
86
+ namespace: '.ds',
87
+
88
+ /** Scroll the window rather than the element */
89
+ scrollWindow: false,
90
+ };
91
+
92
+ /**
93
+ * Adds the ability to manage elements scroll by dragging
94
+ * one or more of its descendant elements. Options parameter
95
+ * allow to specifically select which inner elements will
96
+ * respond to the drag events.
97
+ * usage examples:
98
+ *
99
+ * To add the scroll by drag to the element id=viewport when dragging its
100
+ * first child accepting any propagated events
101
+ * `new DragScrollable($('#viewport')[0]);`
102
+ *
103
+ * To add the scroll by drag ability to any element div of class viewport
104
+ * when dragging its first descendant of class dragMe responding only to
105
+ * evcents originated on the '.dragMe' elements.
106
+ * ```js
107
+ * new DragScrollable($('div.viewport')[0], {
108
+ * dragSelector: '.dragMe:first',
109
+ * acceptPropagatedEvent: false
110
+ * });
111
+ * ```
112
+ *
113
+ * Notice that some 'viewports' could be nested within others but events
114
+ * would not interfere as acceptPropagatedEvent is set to false.
115
+ */
116
+ export class DragScrollable {
117
+ /**
118
+ * @param {HTMLElement} element
119
+ * @param {Partial<DEFAULT_OPTIONS>} options
120
+ */
121
+ constructor(element, options = {}) {
122
+ this.handling_element = $(element);
123
+ /** @type {typeof DEFAULT_OPTIONS} */
124
+ this.settings = $.extend({}, DEFAULT_OPTIONS, options || {});
125
+ this.firstCoord = { left: 0, top: 0 };
126
+ this.lastCoord = { left: 0, top: 0 };
127
+
128
+ this.settings.dragstart = append_namespace(this.settings.dragstart, this.settings.namespace);
129
+ this.settings.dragcontinue = append_namespace(this.settings.dragcontinue, this.settings.namespace);
130
+ //settings.dragend = append_namespace(settings.dragend, settings.namespace);
131
+
132
+ // Set mouse initiating event on the desired descendant
133
+ this.handling_element.find(this.settings.dragSelector)
134
+ .on(this.settings.dragstart, this._dragStartHandler);
135
+ }
136
+
137
+ _shouldAbort() {
138
+ const isTouchDevice = !!('ontouchstart' in window) || !!('msmaxtouchpoints' in window.navigator);
139
+ return isTouchDevice;
140
+ }
141
+
142
+ /** @param {MouseEvent} event */
143
+ _dragStartHandler = (event) => {
144
+ if (this._shouldAbort()) { return true; }
145
+
146
+ // mousedown, left click, check propagation
147
+ if (event.which > 1 ||
148
+ (!this.settings.acceptPropagatedEvent && event.target != this.handling_element[0])) {
149
+ return false;
150
+ }
151
+
152
+ // Initial coordinates will be the last when dragging
153
+ this.lastCoord = this.firstCoord = left_top(event);
154
+
155
+ this.handling_element
156
+ .on(this.settings.dragcontinue, this._dragContinueHandler)
157
+ //.on(this.settings.dragend, this._dragEndHandler)
158
+ ;
159
+
160
+ // Note, we bind using addEventListener so we can use "capture" binding
161
+ // instead of "bubble" binding
162
+ this.settings.dragend.split(' ').forEach(event_name => {
163
+ this.handling_element[0].addEventListener(event_name, this._dragEndHandler, true);
164
+ });
165
+
166
+ if (this.settings.preventDefault) {
167
+ event.preventDefault();
168
+ return false;
169
+ }
170
+ }
171
+
172
+ /** @param {MouseEvent} event */
173
+ _dragContinueHandler = (event) => { // User is dragging
174
+ // console.log('drag continue');
175
+ if (this._shouldAbort()) { return true; }
176
+
177
+ const lt = left_top(event);
178
+
179
+ // How much did the mouse move?
180
+ const delta = {
181
+ left: (lt.left - this.lastCoord.left),
182
+ top: (lt.top - this.lastCoord.top)
183
+ };
184
+
185
+ const scrollTarget = this.settings.scrollWindow ? $(window) : this.handling_element;
186
+
187
+ // Set the scroll position relative to what ever the scroll is now
188
+ scrollTarget.scrollLeft( scrollTarget.scrollLeft() - delta.left );
189
+ scrollTarget.scrollTop( scrollTarget.scrollTop() - delta.top );
190
+
191
+ // Save where the cursor is
192
+ this.lastCoord = lt;
193
+
194
+ if (this.settings.preventDefault) {
195
+ event.preventDefault();
196
+ return false;
197
+ }
198
+ }
199
+
200
+ /** @param {MouseEvent} event */
201
+ _dragEndHandler = (event) => { // Stop scrolling
202
+ //console.log('dragEndHandler');
203
+
204
+ if (this._shouldAbort()) { return true; }
205
+
206
+ this.handling_element
207
+ .off(this.settings.dragcontinue)
208
+ // Note, for some reason, even though I removeEventListener below,
209
+ // this call to unbind is still necessary. I don't know why.
210
+ .off(this.settings.dragend);
211
+
212
+ // Note, we bind using addEventListener so we can use "capture" binding
213
+ // instead of "bubble" binding
214
+ this.settings.dragend.split(' ').forEach(event_name => {
215
+ this.handling_element[0].removeEventListener(event_name, this._dragEndHandler, true);
216
+ });
217
+
218
+ // How much did the mouse move total?
219
+ const delta = {
220
+ left: Math.abs(this.lastCoord.left - this.firstCoord.left),
221
+ top: Math.abs(this.lastCoord.top - this.firstCoord.top)
222
+ };
223
+ const distance = Math.max(delta.left, delta.top);
224
+
225
+ // Allow event to propagate if min distance was not achieved
226
+ if (this.settings.preventDefault && distance > this.settings.dragMinDistance) {
227
+ event.preventDefault();
228
+ event.stopImmediatePropagation();
229
+ event.stopPropagation();
230
+ return false;
231
+ }
232
+ }
233
+ }
@@ -1,5 +1,6 @@
1
1
  // @ts-check
2
- import { calcScreenDPI, notInArray } from '../BookReader/utils.js';
2
+ import { Mode1UpLit } from './Mode1UpLit.js';
3
+ import { DragScrollable } from './DragScrollable.js';
3
4
  /** @typedef {import('../BookReader.js').default} BookReader */
4
5
  /** @typedef {import('./BookModel.js').BookModel} BookModel */
5
6
  /** @typedef {import('./BookModel.js').PageIndex} PageIndex */
@@ -12,392 +13,91 @@ export class Mode1Up {
12
13
  constructor(br, bookModel) {
13
14
  this.br = br;
14
15
  this.book = bookModel;
16
+ this.mode1UpLit = new Mode1UpLit(bookModel, br);
15
17
 
16
18
  /** @private */
17
- this.$documentContainer = $('<div class="BRpageview" />');
18
- /** @private */
19
- this.screenDPI = calcScreenDPI();
20
- /** @private */
21
- this.LEAF_SPACING_IN = 0.2;
19
+ this.$el = $(this.mode1UpLit)
20
+ // We CANNOT use `br-mode-1up` as a class, because it's the same
21
+ // as the name of the web component, and the webcomponents polyfill
22
+ // uses the name of component as a class for style scoping 😒
23
+ .addClass('br-mode-1up__root BRmode1up');
22
24
 
23
- /**
24
- * How much smaller the picture on screen is than the real-world item
25
- *
26
- * Mode1Up doesn't use the br.reduce because it is DPI aware. The reduction factor
27
- * of a given leaf can change (since leaves can have different DPIs), but the real-world
28
- * reduction is constant throughout.
29
- */
30
- this.realWorldReduce = 1;
25
+ /** Has mode1up ever been rendered before? */
26
+ this.everShown = false;
31
27
  }
32
28
 
29
+ // TODO: Might not need this anymore? Might want to delete.
33
30
  /** @private */
34
- get $scrollContainer() { return this.br.refs.$brContainer; }
31
+ get $brContainer() { return this.br.refs.$brContainer; }
35
32
 
36
33
  /**
37
34
  * This is called when we switch to one page view
38
35
  */
39
36
  prepare() {
40
37
  const startLeaf = this.br.currentIndex();
41
-
42
- this.$scrollContainer
38
+ this.$brContainer
43
39
  .empty()
44
- .css({ overflowX: 'auto', overflowY: 'scroll' })
45
- .append(this.$documentContainer);
46
-
47
- // Attaches to first child - child must be present
48
- this.$scrollContainer.dragscrollable();
49
- this.br.bindGestures(this.$scrollContainer);
50
-
51
- // This calls drawLeafs
52
- this.resizePageView();
53
-
54
- this.br.jumpToIndex(startLeaf);
55
- this.br.updateBrClasses();
56
- }
57
-
58
- /**
59
- * Get the number of pixels required to display the given inches with the given reduce
60
- * @param {number} inches
61
- * @param reduce Reduction factor currently at play
62
- * @param screenDPI The DPI of the screen
63
- **/
64
- physicalInchesToDisplayPixels(inches, reduce = this.realWorldReduce, screenDPI = this.screenDPI) {
65
- return inches * screenDPI / reduce;
66
- }
67
-
68
- /**
69
- * Iterate over pages, augmented with their top/bottom bounds
70
- * @param reduce Reduction factor currently at play
71
- * @param pageSpacing Inches of space to place between pages
72
- **/
73
- * pagesWithBounds(reduce = this.realWorldReduce, pageSpacing = this.LEAF_SPACING_IN) {
74
- let leafTop = 0;
75
- let leafBottom = 0;
76
-
77
- for (const page of this.book.pagesIterator({ combineConsecutiveUnviewables: true })) {
78
- const height = this.physicalInchesToDisplayPixels(page.heightInches, reduce);
79
- leafBottom += height;
80
- yield { page, top: leafTop, bottom: leafBottom };
81
- leafTop += height + this.physicalInchesToDisplayPixels(pageSpacing, reduce);
82
- leafBottom += this.physicalInchesToDisplayPixels(pageSpacing, reduce);
83
- }
84
- }
85
-
86
- /**
87
- * How much do the two bounds intersection?
88
- * @param {{ top: number; bottom: number; }} bound1
89
- * @param {{ top: number; bottom: number; }} bound2
90
- * @returns {number}
91
- */
92
- static boundIntersection(bound1, bound2) {
93
- const intersect = (bound1.bottom >= bound2.top) && (bound1.top <= bound2.bottom);
94
- if (!intersect) return 0;
95
-
96
- const boundingBox = {
97
- top: Math.min(bound1.top, bound2.top),
98
- bottom: Math.max(bound1.bottom, bound2.bottom),
99
- };
100
- const intersection = {
101
- top: Math.max(bound1.top, bound2.top),
102
- bottom: Math.min(bound1.bottom, bound2.bottom),
103
- };
104
- return (intersection.bottom - intersection.top) / (boundingBox.bottom - boundingBox.top);
105
- }
106
-
107
- /**
108
- * Find the pages that intersect the current viewport, including 1 before/after
109
- **/
110
- * findIntersectingPages() {
111
- // Rectangle of interest
112
- const height = this.$scrollContainer.height();
113
- const scrollTop = this.$scrollContainer.scrollTop();
114
- const scrollBottom = scrollTop + height;
115
- const scrollRegion = { top: scrollTop, bottom: scrollBottom };
116
-
117
- let prev = null;
118
- for (const {page, top, bottom} of this.pagesWithBounds()) {
119
- const intersection = Mode1Up.boundIntersection({ top, bottom }, scrollRegion);
120
- const cur = {page, top, bottom, intersection: intersection};
121
- if (intersection) {
122
- // Also yield the page just before the visible page
123
- if (prev && !prev.intersection) yield prev;
124
- yield cur;
125
- }
126
- // Also yield the page just after the last visible page
127
- else if (!cur.intersection && prev?.intersection) {
128
- yield cur;
129
- break;
40
+ .css({ overflow: 'hidden' })
41
+ .append(this.$el);
42
+
43
+ // Need this in a setTimeout so that it happens after the browser has _actually_
44
+ // appended the element to the DOM
45
+ setTimeout(async () => {
46
+ if (!this.everShown) {
47
+ this.mode1UpLit.initFirstRender(startLeaf);
48
+ this.everShown = true;
49
+ this.mode1UpLit.requestUpdate();
50
+ await this.mode1UpLit.updateComplete;
51
+ new DragScrollable(this.mode1UpLit, {
52
+ preventDefault: true,
53
+ dragSelector: '.br-mode-1up__visible-world',
54
+ // Only handle mouse events; let browser/HammerJS handle touch
55
+ dragstart: 'mousedown',
56
+ dragcontinue: 'mousemove',
57
+ dragend: 'mouseup',
58
+ });
130
59
  }
131
- prev = cur;
132
- }
133
- }
134
-
135
- drawLeafs() {
136
- const pagesToDisplay = Array.from(this.findIntersectingPages());
137
-
138
- if (pagesToDisplay.length) {
139
- const documentContainerWidth = this.$documentContainer.width();
140
-
141
- // The first page that's reasonably in view we set to the current index
142
- const firstProperPage = (
143
- pagesToDisplay.find(({intersection}) => intersection > 0.33) ||
144
- pagesToDisplay[0]
145
- ).page;
146
- this.br.updateFirstIndex(firstProperPage.index);
147
-
148
- for (const {page, top, bottom} of pagesToDisplay) {
149
- if (!this.br.displayedIndices.includes(page.index)) {
150
- const height = bottom - top;
151
- const width = this.physicalInchesToDisplayPixels(page.widthInches);
152
- const reduce = page.width / width;
153
-
154
- const pageContainer = this.br._createPageContainer(page.index)
155
- .update({
156
- dimensions: {
157
- width,
158
- height,
159
- top,
160
- left: Math.floor((documentContainerWidth - width) / 2),
161
- },
162
- reduce,
163
- });
164
- pageContainer.$container.appendTo(this.$documentContainer);
165
- }
166
- }
167
- }
168
-
169
- // Remove any pages we no longer need
170
- const displayedIndices = pagesToDisplay.map(({page}) => page.index);
171
- for (const index of this.br.displayedIndices) {
172
- if (notInArray(index, displayedIndices)) {
173
- this.br.$(`.pagediv${index}`).remove();
174
- }
175
- }
176
-
177
- this.br.displayedIndices = displayedIndices;
178
- if (this.br.enableSearch) this.br.updateSearchHilites();
179
-
180
- this.br.updateToolbarZoom(this.realWorldReduce);
181
-
182
- // Update the slider
183
- this.br.updateNavIndexThrottled();
60
+ this.mode1UpLit.jumpToIndex(startLeaf);
61
+ });
62
+ this.br.updateBrClasses();
184
63
  }
185
64
 
186
65
  /**
66
+ * BREAKING CHANGE: No longer supports pageX/pageY
187
67
  * @param {PageIndex} index
188
68
  * @param {number} [pageX] x position on the page (in pixels) to center on
189
69
  * @param {number} [pageY] y position on the page (in pixels) to center on
190
70
  * @param {boolean} [noAnimate]
191
71
  */
192
72
  jumpToIndex(index, pageX, pageY, noAnimate) {
193
- const prevCurrentIndex = this.br.currentIndex();
194
- const { abs } = Math;
195
- let offset = 0;
196
- let leafTop = this.getPageTop(index);
197
- let leafLeft = 0;
198
-
199
- if (pageY) {
200
- const page = this.book.getPage(index);
201
- const clientHeight = this.$scrollContainer.prop('clientHeight');
202
- offset = this.physicalInchesToDisplayPixels((pageY / page.height) * page.heightInches) - (clientHeight / 2);
203
- leafTop += offset;
204
- } else {
205
- // Show page just a little below the top
206
- leafTop -= this.br.padding / 2;
207
- }
208
-
209
- if (pageX) {
210
- const page = this.book.getPage(index);
211
- const clientWidth = this.$scrollContainer.prop('clientWidth');
212
- offset = this.physicalInchesToDisplayPixels((pageX / page.width) * page.widthInches) - (clientWidth / 2);
213
- leafLeft += offset;
214
- } else {
215
- // Preserve left position
216
- leafLeft = this.$scrollContainer.scrollLeft();
217
- }
218
-
219
- // Only animate for small distances
220
- if (!noAnimate && abs(prevCurrentIndex - index) <= 4) {
221
- this.animating = true;
222
- this.$scrollContainer.stop(true).animate({
223
- scrollTop: leafTop,
224
- scrollLeft: leafLeft,
225
- }, 'fast', () => { this.animating = false });
226
- } else {
227
- this.$scrollContainer.stop(true).prop('scrollTop', leafTop);
228
- }
73
+ // Only smooth for small distances
74
+ const distance = Math.abs(this.br.currentIndex() - index);
75
+ const smooth = !noAnimate && distance <= 4;
76
+ this.mode1UpLit.jumpToIndex(index, { smooth });
229
77
  }
230
78
 
231
79
  /**
232
80
  * @param {'in' | 'out'} direction
233
81
  */
234
82
  zoom(direction) {
235
- const nextReductionFactor = this.br.nextReduce(this.realWorldReduce, direction, this.br.onePage.reductionFactors);
236
-
237
- if (this.realWorldReduce == nextReductionFactor.reduce) {
238
- // Already at this level
239
- return;
240
- }
241
-
242
- this.realWorldReduce = nextReductionFactor.reduce;
243
- this.br.onePage.autofit = nextReductionFactor.autofit;
244
-
245
- this.resizePageView();
246
- this.br.updateToolbarZoom(this.realWorldReduce);
247
-
248
- // Recalculate search hilites
249
- if (this.br.enableSearch) {
250
- this.br.removeSearchHilites();
251
- this.br.updateSearchHilites();
83
+ switch (direction) {
84
+ case 'in':
85
+ this.mode1UpLit.zoomIn();
86
+ break;
87
+ case 'out':
88
+ this.mode1UpLit.zoomOut();
89
+ break;
90
+ default:
91
+ console.error(`Unsupported direction: ${direction}`);
252
92
  }
253
93
  }
254
94
 
255
- /**
256
- * Returns the reduce factor which has the pages fill the width of the viewport.
257
- */
258
- getAutofitWidth() {
259
- const widthPadding = 20;
260
- const availableWidth = this.$scrollContainer.prop('clientWidth') - 2 * widthPadding;
261
-
262
- const medianWidthInches = this.book.getMedianPageSizeInches().width;
263
- const medianPageWidth = this.physicalInchesToDisplayPixels(medianWidthInches, 1);
264
- return medianPageWidth / availableWidth;
265
- }
266
-
267
- getAutofitHeight() {
268
- // make sure a little of adjacent pages show
269
- const availableHeight = this.$scrollContainer.innerHeight() - 2 * this.br.padding;
270
- const medianHeightInches = this.book.getMedianPageSizeInches().height;
271
- const medianPageHeight = this.physicalInchesToDisplayPixels(medianHeightInches, 1);
272
-
273
- return medianPageHeight / availableHeight;
274
- }
275
-
276
- /**
277
- * Returns where the top of the page with given index should be in one page view
278
- * @param {PageIndex} index
279
- * @return {number}
280
- */
281
- getPageTop(index) {
282
- for (const {page, top} of this.pagesWithBounds()) {
283
- if (page.index == index) return top;
284
- }
285
- }
286
-
287
- /**
288
- * Update the reduction factors for 1up mode given the available width and height.
289
- * Recalculates the autofit reduction factors.
290
- */
291
- calculateReductionFactors() {
292
- this.br.onePage.reductionFactors = this.br.reductionFactors.concat(
293
- [
294
- { reduce: this.getAutofitWidth(), autofit: 'width' },
295
- { reduce: this.getAutofitHeight(), autofit: 'height' },
296
- ]);
297
- this.br.onePage.reductionFactors.sort(this.br._reduceSort);
298
- }
299
-
300
95
  /**
301
96
  * Resize the current one page view
302
97
  * Note this calls drawLeafs
303
98
  */
304
99
  resizePageView() {
305
- const viewWidth = this.$scrollContainer.prop('clientWidth');
306
- const oldScrollTop = this.$scrollContainer.prop('scrollTop');
307
- const oldPageViewHeight = this.$documentContainer.height();
308
- const oldPageViewWidth = this.$documentContainer.width();
309
-
310
- // May have come here after preparing the view, in which case the scrollTop and view height are not set
311
-
312
- let scrollRatio = 0;
313
- let oldCenterX;
314
- if (oldScrollTop > 0) {
315
- // We have scrolled - implies view has been set up
316
- const oldCenterY = this.centerY();
317
- oldCenterX = this.centerX();
318
- scrollRatio = oldCenterY / oldPageViewHeight;
319
- } else {
320
- // Have not scrolled, e.g. because in new container
321
-
322
- // We set the scroll ratio so that the current index will still be considered the
323
- // current index in drawLeafsOnePage after we create the new view container
324
-
325
- // Make sure this will count as current page after resize
326
- const fudgeFactor = 0.6 * this.physicalInchesToDisplayPixels(this.book.getPage(this.br.currentIndex()).heightInches);
327
- const oldLeafTop = this.getPageTop(this.br.currentIndex()) + fudgeFactor;
328
- const oldViewDimensions = this.calculateViewDimensions();
329
- scrollRatio = oldLeafTop / oldViewDimensions.height;
330
- }
331
-
332
- // Recalculate 1up reduction factors
333
- this.calculateReductionFactors();
334
- // Update current reduce (if in autofit)
335
- if (this.br.onePage.autofit) {
336
- const reductionFactor = this.br.nextReduce(this.realWorldReduce, this.br.onePage.autofit, this.br.onePage.reductionFactors);
337
- this.realWorldReduce = reductionFactor.reduce;
338
- }
339
-
340
- const viewDimensions = this.calculateViewDimensions();
341
- this.$documentContainer.height(viewDimensions.height);
342
- this.$documentContainer.width(viewDimensions.width);
343
-
344
- // Remove all pages
345
- this.$documentContainer.empty();
346
- this.br.displayedIndices = [];
347
-
348
- // Scroll to the right spot
349
- const newCenterX = oldCenterX * (viewWidth / oldPageViewWidth);
350
- const newCenterY = scrollRatio * viewDimensions.height;
351
- const sizeX = this.$scrollContainer.prop('clientWidth'); // Use clientWidth because of scroll bar
352
- const sizeY = this.$scrollContainer.height();
353
- this.$scrollContainer.prop({
354
- scrollLeft: Math.max(0, newCenterX - sizeX / 2),
355
- scrollTop: Math.max(0, newCenterY - sizeY / 2),
356
- });
357
-
358
- // Draw all visible pages
359
- this.drawLeafs();
360
-
361
- if (this.br.enableSearch) {
362
- this.br.removeSearchHilites();
363
- this.br.updateSearchHilites();
364
- }
365
- }
366
-
367
- /**
368
- * Calculate the total width/height in pixels of the document container
369
- * @param {number} reduce
370
- * @param {number} leafSpacing spacing between pages in inches
371
- */
372
- calculateViewDimensions(reduce = this.realWorldReduce, leafSpacing = this.LEAF_SPACING_IN) {
373
- let width = 0;
374
- let height = 0;
375
- for (const {page, bottom} of this.pagesWithBounds(reduce, leafSpacing)) {
376
- const pageWidth = this.physicalInchesToDisplayPixels(page.widthInches, reduce);
377
- width = Math.max(width, pageWidth);
378
- height = bottom;
379
- }
380
- return { width, height };
381
- }
382
-
383
- /**
384
- * Returns the current offset of the viewport center in scaled document coordinates.
385
- */
386
- centerX($scrollContainer = this.$scrollContainer, $documentContainer = this.$documentContainer) {
387
- let centerX;
388
- if ($documentContainer.width() < $scrollContainer.prop('clientWidth')) { // fully shown
389
- centerX = $documentContainer.width();
390
- } else {
391
- centerX = $scrollContainer.scrollLeft() + $scrollContainer.prop('clientWidth') / 2;
392
- }
393
- return Math.floor(centerX);
394
- }
395
-
396
- /**
397
- * Returns the current offset of the viewport center in scaled document coordinates.
398
- */
399
- centerY($scrollContainer = this.$scrollContainer) {
400
- const centerY = $scrollContainer.scrollTop() + $scrollContainer.height() / 2;
401
- return Math.floor(centerY);
100
+ this.mode1UpLit.htmlDimensionsCacher.updateClientSizes();
101
+ this.mode1UpLit.requestUpdate();
402
102
  }
403
103
  }