Skip to content

xaynetwork/xayn_readability

Repository files navigation

xayn_readability

Pub codecov Build Status

Xayn readability provides the reader mode widget, which renders html content as pure Flutter widgets.

The project transforms html content into readable html content, using a native dart port of Mozilla's fantastic readability project.

The rendering to Flutter widgets is done using another great open source project, flutter_widget_from_html_core.


Table of content:


Installing 🛠️

Add this to your package's pubspec.yaml file:

dependencies:
  xayn_readability: `latest version`

after that, shoot it on the command line:

$ flutter pub get

How to use 🏗️

Use case #1 (short description)

	// add some code with ninja-comments here

Use case #2 (short description)

	// add some code with ninja-comments here

Use case #3 (short description)

	// add some code with ninja-comments here

top ⤴️


Attributes ⚙️

attribute name Datatype Default Value Description
child Widget required The widget below this widget in the tree.
isEnabled bool true Responsible for showing component as enabled.
key Key null Controls how one widget replaces another widget in the tree.

top ⤴️


Troubleshooting 🤔

Describe here well known problems and how they can be solved.

top ⤴️


Contributing 👷‍♀️

We're more than happy to accept pull requests 💪

top ⤴️


License 📜

xayn_readability is licensed under Apache 2. View license.

top ⤴️