History

harvey186 7a6de5f3e6 v131		2024-10-12 11:57:06 +02:00
..
src	v131	2024-10-12 11:57:06 +02:00
.gitignore	v131	2024-10-12 11:57:06 +02:00
README.md	v131	2024-10-12 11:57:06 +02:00
build.gradle	v131	2024-10-12 11:57:06 +02:00
proguard-rules.pro	v131	2024-10-12 11:57:06 +02:00

README.md

Reader View

A component wrapping/providing a Reader View WebExtension.

Usage

Setting up the dependency

Use Gradle to download the library from maven.mozilla.org (Setup repository):

implementation "org.mozilla.components:feature-readerview:{latest-version}"

Integration

Initializing the feature:

val readerViewFeature = ReaderViewFeature(
    context,
    engine,
    sessionManager,
    onReaderViewAvailableChange = {
    	// e.g. readerViewToolbarActionVisible = it
    }
)

Showing and hiding Reader View:

readerViewFeature.showReaderView()
readerViewFeature.hideReaderView()

Showing and hiding the Reader View appearance UI (to adjust font size, font type and color scheme). Note that changes to the appearance settings are automatically persisted as user preferences.

readerViewFeature.showAppearanceControls()
readerViewFeature.hideAppearanceControls()

License

This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at http://mozilla.org/MPL/2.0/