Giter VIP home page Giter VIP logo

htmltext's Introduction

HtmlText

Lint Ktlint CodeFactor Maven Central

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:html-text:1.3.1'
}

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

HtmlText

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.

htmltext's People

Contributors

ch4rl3x avatar johngilbertson avatar ovso avatar juost avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.