3.0.0-alpha.2

[mickael-menu]

Resources

• Migration guide
• API Reference

Changelog

⚠️ Please consult the migration guide to assist you in handling the breaking changes in this latest major release.

Added

Navigator

• The new HyperlinkNavigator.Listener.shouldFollowInternalLink(Link, LinkContext?) allows you to handle footnotes according to your preference.
  • By default, the navigator now moves to the footnote content instead of displaying a pop-up as it did in version 2.x.

LCP

• You can use LcpService.injectLicenseDocument() to insert an LCPL into a package, if you downloaded it manually instead of using LcpService.acquirePublication().

Deprecated

Shared

• The DownloadManager introduced in version 3.0.0-alpha.1 has been removed due to the Android Download Manager introducing unnecessary complexities in the toolkit. Instead, we chose to enable apps to manually handle an LCP download with LcpService.injectLicenseDocument().

Commits

• Fix Maven Central publishing and refactor Gradle configurations by @mickael-menu in Fix Maven Central publishing and refactor Gradle configurations #452
• Use canonical EPUB HREFs by @mickael-menu in Use canonical EPUB HREFs #453
• Extract footnote popups from the Epub navigator by @qnga in Extract footnote popups from the Epub navigator #448
• Implement sniffing of CSS and JS files by @io7m in Implement sniffing of CSS and JS files #455
• Remove android:clearTaskOnLaunch by @mickael-menu in Remove android:clearTaskOnLaunch #459
• Cleanup Gradle and Version files, fix Dokka by @stevenzeck in Cleanup Gradle and Version files, fix Dokka #456
• Use Flow instead of LiveData by @stevenzeck in Use Flow instead of LiveData #461
• Bump css-selector-generator script dependency by @mickael-menu in Bump css-selector-generator script dependency #466
• Remove the download manager by @qnga in Remove the download manager #465
• Small fix by @qnga in Small fix #467
• Use material3 for Compose views by @stevenzeck in Use material3 for Compose views #460
• Add LcpService.injectLicenseDocument by @qnga in Add LcpService.injectLicenseDocument #473
• Fix EPUB deobfuscation by @mickael-menu in Fix EPUB deobfuscation #475
• Prevent infinite recursion in format sniffing by @qnga in Prevent infinite recursion in format sniffing #476
• Fix TTS player crash by @qnga in Fix TTS player crash #477
• Update media3 and fix some issues with MediaService by @qnga in Update media3 and fix some issues with MediaService #478
• Simplify LcpService.injectLicense by @qnga in Simplify LcpService.injectLicense #479
• 3.0.0-alpha.2 by @mickael-menu in 3.0.0-alpha.2 #480

New Contributors

• @io7m made their first contribution in Implement sniffing of CSS and JS files #455

Full Changelog: 3.0.0-alpha.1...3.0.0-alpha.2

---

This discussion was created from the release 3.0.0-alpha.2.

[radusalagean]

@mickael-menu Back in v2.4.0 I used to override onResourceLoadFailed from PdfNavigatorFragment.Listener in order to track errors like OutOfMemory. Is there an alternative to this for v3? Thanks!

[mickael-menu]

Yes, there's a new onResourceLoadFailed in Navigator.Listener. The error is slightly different though:

kotlin-toolkit/readium/navigator/src/main/java/org/readium/r2/navigator/Navigator.kt

Lines 53 to 56 in c9a09ac

	/**
	* Called when a publication resource failed to be loaded.
	*/
	public fun onResourceLoadFailed(href: Url, error: ReadError) {}

override fun onResourceLoadFailed(href: Url, error: ReadError) {
    val message = when (error) {
        is ReadError.OutOfMemory -> ...
    }
}