Skip to content

Fix scroll inertia when scrolling an EPUB #304

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 7, 2022
Merged

Fix scroll inertia when scrolling an EPUB #304

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b61466f
Fix scroll inertia when scrolling an EPUB
mickael-menu Dec 5, 2022
c7dd3dd
Add comment explaining why we need to invalidate the resource pager
mickael-menu Dec 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ All notable changes to this project will be documented in this file. Take a look
* `paragraphSpacing` - Vertical margins for paragraphs.
* `hyphens` - Enable hyphenation.
* `ligatures` - Enable ligatures in Arabic.
* Fixed scroll inertia when scrolling an EPUB.

### Changed

Expand Down
6 changes: 6 additions & 0 deletions readium/navigator/src/main/java/org/readium/r2/navigator/R2WebView.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,8 @@ class R2WebView(context: Context, attrs: AttributeSet) : R2BasicWebView(context,

private var mScrollState = SCROLL_STATE_IDLE

internal var useLegacySettings = false

private fun initWebPager() {
setWillNotDraw(false)
descendantFocusability = ViewGroup.FOCUS_AFTER_DESCENDANTS
Expand Down Expand Up @@ -550,6 +552,10 @@ class R2WebView(context: Context, attrs: AttributeSet) : R2BasicWebView(context,
}

override fun computeScroll() {
if (!useLegacySettings && scrollMode) {
return super.computeScroll()
}

mIsScrollStarted = true
if (!mScroller!!.isFinished && mScroller!!.computeScrollOffset()) {
val oldX = scrollX
Expand Down
6 changes: 5 additions & 1 deletion readium/navigator/src/main/java/org/readium/r2/navigator/epub/EpubNavigatorViewModel.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,11 @@ internal class EpubNavigatorViewModel(
oldSettings.readingProgression != newSettings.readingProgression ||
oldSettings.language != newSettings.language ||
oldSettings.verticalText != newSettings.verticalText ||
oldSettings.spread != newSettings.spread
oldSettings.spread != newSettings.spread ||
// We need to invalidate the resource pager when changing from scroll mode to
// paginated, otherwise the horizontal scroll will be broken.
// See https://github.com/readium/kotlin-toolkit/pull/304
oldSettings.scroll != newSettings.scroll
)

if (needsInvalidation) {
Expand Down
1 change: 1 addition & 0 deletions readium/navigator/src/main/java/org/readium/r2/navigator/pager/R2EpubPageFragment.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,7 @@ class R2EpubPageFragment : Fragment() {
@Suppress("DEPRECATION")
webView.setScrollMode(preferences.getBoolean(SCROLL_REF, false))
}
webView.useLegacySettings = viewModel.useLegacySettings
webView.settings.javaScriptEnabled = true
webView.isVerticalScrollBarEnabled = false
webView.isHorizontalScrollBarEnabled = false
Expand Down