2.4.0

Resources

• Migration guide
• API Reference

Changelog

• Readium is now distributed with Maven Central. Take a look at the migration guide to update your Gradle configuration.

Added

Navigator

• The EPUB backgroundColor preference is now available with fixed-layout publications.
• New EPUBNavigatorFragment.Configuration.useReadiumCssFontSize option to revert to the 2.2.0 strategy for setting the font size of reflowable EPUB publications.
  • The native font size strategy introduced in 2.3.0 uses the Android web view's WebSettings.textZoom property to adjust the font size. 2.2.0 was using Readium CSS's --USER__fontSize variable.
  • WebSettings.textZoom will work with more publications than --USER__fontSize, even the ones poorly authored. However the page width is not adjusted when changing the font size to keep the optimal line length.
• Scroll mode: jumping between two EPUB resources with a horizontal swipe triggers the Navigator.Listener.onJumpToLocator() callback.
  • This can be used to allow the user to go back to their previous location if they swiped across chapters by mistake.
• Support for non-linear EPUB resources with an opt-in in reading apps (contributed by @chrfalch in #375 and #376).
  1. Override loading non-linear resources with VisualNavigator.Listener.shouldJumpToLink().
  2. Present a new EpubNavigatorFragment by providing a custom readingOrder with only this resource to the constructor.
• Added dummy navigator fragment factories to prevent crashes caused by Android restoring the fragments after a process death.
  • To use it, set the dummy fragment factory when you don't have access to the Publication instance. Then, either finish the Activity or pop the fragment from the UI before it resumes.

    override fun onCreate(savedInstanceState: Bundle?) {
        val publication = model.publication ?: run {
            childFragmentManager.fragmentFactory = EpubNavigatorFragment.createDummyFactory()
            super.onCreate(savedInstanceState)
    
            requireActivity().finish()
            // or
            navController?.popBackStack()
    
            return
        }
    
        // Create the real navigator factory as usual...
    }

Streamer

• The EPUB content iterator now returns audio and video elements.

Changed

Navigator

• EpubNavigatorFragment.firstVisibleElementLocator() now returns the first block element that is visible on the screen, even if it starts on previous pages.
  • This is used to make sure the user will not miss any context when restoring a TTS session in the middle of a resource.

Fixed

Navigator

• #360 Fix EPUB JavaScript interface injection when rotating the screen on some devices.

Streamer

• Fixed issue with the TTS starting from the beginning of the chapter instead of the current position.