[PR #3729] [CLOSED] Add flow option. Add snap option UI only. #4064

Closed
opened 2026-04-25 00:18:10 +02:00 by adam · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/advplyr/audiobookshelf/pull/3729
Author: @KaiStarkk
Created: 12/18/2024
Status: Closed

Base: masterHead: epubjs-implementations


📝 Commits (1)

  • ffffa7e Add flow option. Add snap option UI only.

📊 Changes

3 files changed (+68 additions, -8 deletions)

View changed files

📝 client/components/readers/EpubReader.vue (+17 -5)
📝 client/components/readers/Reader.vue (+45 -3)
📝 client/strings/en-us.json (+6 -0)

📄 Description

Brief summary

This implements additional upstream features from epub.js.

Which issue is fixed?

TBD - currently in draft. I'm aware of several issues related to epubjs features (we previously tagged these as 'ereader' together.

In-depth Description

In particular this:

  • fixes a double paging issue (epubjs already turns the page so these gestures were double-paging)
  • implements the epubjs flow settings as a settable option
  • implements the epubjs snap settings as a settable option (draft - only UI complete. having issues)

I recommend we default snapping to off in the interim, then this draft could be published and we could move settable snapping to its own issue. As-is, this PR fixes a couple issues (one about half-pagination getting stuck, and one about ereaders struggling to render smooth animations), so it'd be to get those merged while still figuring out snapping. If you want to do so I can remove the snap settings UI. This would also need to be merged into the app, I believe it doesn't currently have the settings modal.

How have you tested this?

Tested on Firefox (PC and Android) only with epub files only.
Further testing needed (in particular, other filetypes and clients).

Screenshots

E-Reader settings modal:

image


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/advplyr/audiobookshelf/pull/3729 **Author:** [@KaiStarkk](https://github.com/KaiStarkk) **Created:** 12/18/2024 **Status:** ❌ Closed **Base:** `master` ← **Head:** `epubjs-implementations` --- ### 📝 Commits (1) - [`ffffa7e`](https://github.com/advplyr/audiobookshelf/commit/ffffa7e4f5cb947e700b514b6a070189c3e9bb69) Add flow option. Add snap option UI only. ### 📊 Changes **3 files changed** (+68 additions, -8 deletions) <details> <summary>View changed files</summary> 📝 `client/components/readers/EpubReader.vue` (+17 -5) 📝 `client/components/readers/Reader.vue` (+45 -3) 📝 `client/strings/en-us.json` (+6 -0) </details> ### 📄 Description <!-- For Work In Progress Pull Requests, please use the Draft PR feature, see https://github.blog/2019-02-14-introducing-draft-pull-requests/ for further details. If you do not follow this template, the PR may be closed without review. Please ensure all checks pass. If you are a new contributor, the workflows will need to be manually approved before they run. --> ## Brief summary This implements additional upstream features from epub.js. <!-- Please provide a brief summary of what your PR attempts to achieve. --> ## Which issue is fixed? TBD - currently in draft. I'm aware of several issues related to epubjs features (we previously tagged these as 'ereader' together. <!-- Which issue number does this PR fix? Ex: "Fixes #1234" --> ## In-depth Description In particular this: - fixes a double paging issue (epubjs already turns the page so these gestures were double-paging) - implements the epubjs flow settings as a settable option - implements the epubjs snap settings as a settable option (draft - only UI complete. having issues) I recommend we default snapping to off in the interim, then this draft could be published and we could move settable snapping to its own issue. As-is, this PR fixes a couple issues (one about half-pagination getting stuck, and one about ereaders struggling to render smooth animations), so it'd be to get those merged while still figuring out snapping. If you want to do so I can remove the snap settings UI. This would also need to be merged into the app, I believe it doesn't currently have the settings modal. <!-- Describe your solution in more depth. How does it work? Why is this the best solution? Does it solve a problem that affects multiple users or is this an edge case for your setup? --> ## How have you tested this? Tested on Firefox (PC and Android) only with epub files only. Further testing needed (in particular, other filetypes and clients). <!-- Please describe in detail with reproducible steps how you tested your changes. --> ## Screenshots E-Reader settings modal: ![image](https://github.com/user-attachments/assets/eeeb71f4-1a66-4101-b970-e257987d9eca) <!-- If your PR includes any changes to the web client, please include screenshots or a short video from before and after your changes. --> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
adam added the pull-request label 2026-04-25 00:18:10 +02:00
adam closed this issue 2026-04-25 00:18:10 +02:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/audiobookshelf#4064