HtmlText

Material

Material 3

Text composable to show html text from resources

Supported Tags:
<b> - Bold text
<i> - Italic text
<strike> - Striked text
<u> - Underlined text (Markdown does not allow a preview here)
<a href="..."> - Link
<span style="color: #0000FF"> - Colored text (Markdown does not allow a preview here)
<span style="color: red"> - Colored text (Markdown does not allow a preview here)
<font color="#FF0000"> - Colored text (Markdown does not allow a preview here)
<font color="red"> - Colored text (Markdown does not allow a preview here)

MaterialTheme colors in HtmlText

To use colors like MaterialTheme.colors.primary in HtmlText, map simple colors.

HtmlText(
    textId = R.string.hello_world,
    colorMapping = mapOf(Color.Red to MaterialTheme.colors.primary)
)

<resources>
    <string name="hello_world">"Hello <span style="color: red">World</span>"</string>
</resources>

String arguments in HtmlText

To use string arguments with HtmlText, use CDATA

HtmlText(
    text = stringResource(R.string.hello_world, "Hello")
)

<resources>
    <string name="hello_world"><![CDATA[%1$s World]]></string>
</resources>

Combine MaterialTheme colors and string arguments in HtmlText

You can combine colorMapping with string arguments (CDATA) and all other HTML tags. If you use CDATA, you have to escape double quotes.

<resources>
    <string name="hello_world"><![CDATA[Hello <span style=\"color: red\">World</span>]]></string>
</resources>

Add to your project

Add actual HtmlText library:

dependencies {
    implementation 'de.charlex.compose.material:material-html-text:2.0.0-beta01'
}

or

dependencies {
    implementation 'de.charlex.compose.material3:material3-html-text:2.0.0-beta01'
}

How does it work?

Use it like a normal Text composable

HtmlText(textId = R.string.hello_world)

<resources>
    <string name="hello_world">Hello <b>World</b>. This <i><strike>text</strike>sentence</i> is form<b>att<u>ed</u></b> in simple html. <a href="https://github.com/ch4rl3x/HtmlText">HtmlText</a></string>
</resources>

Preview

That's it!

License

Copyright 2021 Alexander Karkossa

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.