HTML DSL
Provides a DSL to build HTML for Android TextView
Description
There is a lovely method on the android.text.Html
class, fromHtml
, that converts HTML into a Spannable
for use with a TextView
.
However, the documentation does not stipulate what HTML tags are supported, which makes this method a bit hit-or-miss. This small library provides a DSL for building valid HTML for android.widget.TextView
.
Download
Download the latest AAR or grab via Gradle:
implementation("com.jaredrummler:html-dsl:1.0.0")
Structure
buildSrc
— Gradle dependencies, plugins, versionslibrary
- The HTML DSL librarylibrary/src/test
- Unit tests for the librarydemo
- Android demo project using HTML DSLscripts
- Scripts to publish library to Maven
Usage
Create HTML:
HTML.create {
h1("HTML DSL")
strong("Provides a DSL to build HTML for Android TextView")
}
TextView
:
Set HTML on a textView.setHtml {
h1("HTML DSL").br()
strong("Build valid HTML for Android TextView.").br().br()
h3("Android Versions:")
ul {
li {
a(href = "https://developer.android.com/about/versions/12/get") {
+"Android 12 Beta"
}
}
li("Android 11")
li("Android 10")
li("Pie")
li("Oreo")
li("Nougat")
li("Marshmallow")
li("Lollipop")
// ...
}
small {
sub {
+"by "
a {
href = "https://github.com/jaredrummler"
text = "Jared Rummler"
}
}
}
}
Render HTML to a string
val htmlString = HTML.create {
p {
font(face = "monospace", color = "#3ddc84") {
unsafe {
+"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."
}
}
}
}.render(prettyPrint = true)
Write HTML to a file:
HtmlRenderer<FileWriter>(HTML.create {
small {
sub {
+"by "
a {
href = "https://github.com/jaredrummler"
text = "Jared Rummler"
}
}
}
}, FileWriter("output.html"), true)
Supported HTML elements:
<a href="...">
<b>
<big>
<blockquote>
<br>
<cite>
<dfn>
<div align="...">
<em>
<font color="..." face="...">
<h1>
<h2>
<h3>
<h4>
<h5>
<h6>
<i>
<img src="...">
<p>
<small>
<strike>
<strong>
<sub>
<sup>
<tt>
<u>
<ul>
<li>
License
Copyright 2021 Jared Rummler
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
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.