SpannableStringBuilder Extensions

General

The library adds a couple of methods that make it easy to create modifiable text: bold text; text with colored nested parts, and more.

val textView = findViewById<TextView>(R.id.text_view)
val spannableText = SpannableStringBuilder()
    .append("This is an example with ")
    .appendBold("bold Text")
textView.text = spannableText

val textView = findViewById<TextView>(R.id.text_view)
val spannableText = SpannableStringBuilder()
    .append("This is an example with ")
    .appendBold("bold Text")
    .append(" and ")
    .append { colorHex("#CC0000") { italic { "red italic" } } }
textView.text = spannableText

How to get a library into your build

Gradle

Step 1. Add the JitPack repository to your build file. Add it in your root build.gradle at the end of repositories:

allprojects {
    repositories {
        maven { url 'https://jitpack.io' }
    }
}

Step 2. Add the dependency

dependencies {
    implementation 'com.github.viacheslav-chugunov:spannablestringbuilder-extensions:1.0.2'
}

Maven

Step 1. Add the JitPack repository to your build file

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

Step 2. Add the dependency

<dependency>
    <groupId>com.github.viacheslav-chugunov</groupId>
    <artifactId>spannablestringbuilder-extensions</artifactId>
    <version>1.0.2</version>
</dependency>

Usage

SpannableStringBuilder extensions

// Appends bold text
fun SpannableStringBuilder.appendBold(text: CharSequence): SpannableStringBuilder

// Appends italic text
fun SpannableStringBuilder.appendItalic(text: CharSequence): SpannableStringBuilder

// Appends underlined text
fun SpannableStringBuilder.appendUnderline(text: CharSequence): SpannableStringBuilder

// Appends painted text
fun SpannableStringBuilder.appendColorHex(colorHex: String, text: CharSequence): SpannableStringBuilder
fun SpannableStringBuilder.appendColorInt(@ColorInt colorInt: Int, text: CharSequence): SpannableStringBuilder
fun SpannableStringBuilder.appendColorRes(context: Context, @ColorRes colorRes: Int, text: CharSequence): SpannableStringBuilder

// Appends html text
fun SpannableStringBuilder.appendHtml(startTag: String, text: CharSequence, endTag: String): SpannableStringBuilder

// Appends "\n" to the end of a line
fun SpannableStringBuilder.newLine(): SpannableStringBuilder

// Builder to append text, modified two or more times
fun SpannableStringBuilder.append(builder: SpannableStringBuilderScope.() -> CharSequence): SpannableStringBuilder
fun <T : SpannableStringBuilderScope> SpannableStringBuilder.append(scope: T, builder: T.() -> CharSequence): SpannableStringBuilder

SpannableStringBuilderScope

// Makes wrapped text bold
fun bold(provideText: () -> CharSequence): CharSequence

// Makes wrapped text italic
fun italic(provideText: () -> CharSequence): CharSequence

// Makes wrapped text underlined
fun underline(provideText: () -> CharSequence): CharSequence

// Paints wrapped text
fun colorHex(colorHex: String, provideText: () -> CharSequence): CharSequence
fun colorInt(@ColorInt colorInt: Int, provideText: () -> CharSequence): CharSequence
fun colorRes(context: Context, @ColorRes colorRes: Int, provideText: () -> CharSequence): CharSequence

// Wraps text in html tags
fun html(startTag: String, endTag: String, provideText: () -> CharSequence): CharSequence

Licence

MIT License

Copyright (c) 2022 Viacheslav

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.