Introduction: Compatibility library for Android's Html class.
More: Author   ReportBugs   

Compaibility library for Android's Html class.


Google has introduced the official HtmlCompat library as part of AndroidX. This library will no longer be updated or maintained; please use the official library.


Nougat introduced improvements to the Html class for converting HTML to spannables. Unfortunately, these new features lay within the Android SDK itself. This means that the behavior in which HTML is converted is subject to the version of Android that the user is running.

HtmlCompat attempts to address this problem by providing developers with a compatibility library. All logic for converting HTML is enclosed within this library and can be bundled within an app. This means that the presentation is agnostic to the version of Android of the device.

How can I use it?

Download the latest AAR or grab from Bintray using Gradle:

dependencies {
    compile 'com.pixplicity.htmlcompat:library:[VERSION_HERE]'


Important: Specify the latest version from Bintray as [VERSION_HERE].

Sample code:

Spanned fromHtml = HtmlCompat.fromHtml(context, source, 0);
// You may want to provide an ImageGetter, TagHandler and SpanCallback:
//Spanned fromHtml = HtmlCompat.fromHtml(context, source, 0,
//        imageGetter, tagHandler, spanCallback);

What’s supported?

All the latest functionality from the current Html for Android Nougat is included in this library. While this may continue to be improved in the future, currently, the following tags are supported out of the box:

  • <br>
  • <p>
  • <ul>
  • <li>
  • <div>
  • <span>
  • <strong>, <b>
  • <em>, <i>
  • <u>
  • <s>, <strike>, <del>
  • <cite>
  • <dfn>
  • <big>
  • <small>
  • <font>
  • <blockquote>
  • <tt>
  • <a>
  • <sup>
  • <sub>
  • <h1>, <h2>, <h3>, <h4>, <h5>, <h6>
  • <img>

The following CSS inline styles are supported:

  • text-align
  • color
  • background, background-color
  • text-decoration

All CSS color declarations as defined here are supported.

What’s added?

A few new features have been added to the interface to ease the life of the developer:

  • Callbacks into ImageGetter and TagHandler provide the tag attributes;
  • SpanCallback can be registered so the implementor may be informed of new spans; this allows for spans to be modified;
  • All CSS color declarations have been added.

What’s next?

We’re looking to support more tags and styles in future releases. Feel free to contribute with pull requests or by reporting issues on the GitHub project page.

This library has become obsolete, in favor of the official HtmlCompat library as part of AndroidX. This library will no longer be updated or maintained; please use the official library.

Made with ❤ by Pixplicity


   Copyright 2017 Pixplicity

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   See the License for the specific language governing permissions and
   limitations under the License.
Support Me
About Me
Google+: Trinea trinea
GitHub: Trinea