FormattedText & FallbackValue

This library introduces a FormattingText and a FallbackValue to use language independent texts in the application view models.

Example

View model

class MyAwesomeViewModel {    
    private val nullInt: Int? = null    
    
    // not formatted text
    val notFormatted = FormattedText(R.string.not_formatted)
    // formatted text
    val formattedNumber = 16.format(R.string.formatted_number)
    val formattedNumberWithFallback = 32.format(R.string.formatted_number, R.string.fallback)
    val formattedNullNumberWithFallback = nullInt.format(R.string.formatted_number, R.string.fallback)
    // null fallback
    val valueWithFallback = 32.textIfNull(R.string.fallback)
    val nullValueWithFallback = nullInt.textIfNull(R.string.fallback)
    // quantity
    val quantityOne = 16.formatQuantity(R.plurals.formatted_plural, 1)
    val quantityMany = 16.formatQuantity(R.plurals.formatted_plural, 2)
    val quantityWithFallback = nullInt.formatQuantity(R.plurals.formatted_plural, 2, R.string.fallback)
}

View binding

override fun onCreate(savedInstanceState: Bundle?) {    
    super.onCreate(savedInstanceState)    
    binding = ActivityViewBindingBinding.inflate(layoutInflater)    
    setContentView(binding.root)
    // not formatted text
    binding.notFormatted.text = viewModel.notFormatted.resolveString(this)
    // formatted text
    binding.formattedNumber.text = viewModel.formattedNumber.resolveString(this)
    binding.formattedNumberWithFallback.text = viewModel.formattedNumberWithFallback.resolveString(this)    
    binding.formattedNullNumberWithFallback.text = viewModel.formattedNullNumberWithFallback.resolveString(this)
    // fallback    
    binding.valueWithFallback.text = viewModel.valueWithFallback.resolveString(this)
    binding.nullValueWithFallback.text = viewModel.nullValueWithFallback.resolveString(this)
    // quantity
    binding.quantityValueOne.text = viewModel.quantityOne.resolveString(this)
    binding.quantityValueMany.text = viewModel.quantityMany.resolveString(this)
    binding.quantityValueWithFallback.text = viewModel.quantityWithFallback.resolveString(this)
}

Data binding

Activity

override fun onCreate(savedInstanceState: Bundle?) {    
    super.onCreate(savedInstanceState)    
    binding = ActivityDataBindingBinding.inflate(layoutInflater)    
    setContentView(binding.root)    
    binding.viewModel = viewModel 
}

Layout

<?xml version="1.0" encoding="utf-8"?>
<layout>        
    <data>    
        <variable
            name="viewModel"
            type="net.grandcentrix.android.formatted_text.sample.MyAwesomeViewModel" />
	</data>    
    
    <LinearLayout
	    xmlns:android="http://schemas.android.com/apk/res/android"  
	    xmlns:app="http://schemas.android.com/apk/res-auto"
	    android:layout_width="match_parent"
	    android:layout_height="match_parent"
	    android:orientation="vertical">

        <TextView
            android:id="@+id/not_formatted"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="@{viewModel.notFormatted}" />
        
        <TextView
            android:id="@+id/formatted_number"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="@{viewModel.formattedNumber}" />
        <TextView
            android:id="@+id/formatted_number_with_fallback"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="@{viewModel.formattedNumberWithFallback}" />
        <TextView
            android:id="@+id/formatted_null_number_with_fallback"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="@{viewModel.formattedNullNumberWithFallback}" />
        <TextView
            android:id="@+id/value_with_fallback"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="@{viewModel.valueWithFallback}" />
        <TextView
            android:id="@+id/null_value_with_fallback"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="@{viewModel.nullValueWithFallback}" />
        <TextView
            android:id="@+id/quantity_value_one"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="@{viewModel.quantityOne}" />
        <TextView
            android:id="@+id/quantity_value_many"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="@{viewModel.quantityMany}" />
        <TextView
            android:id="@+id/quantity_value_with_fallback"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="@{viewModel.quantityWithFallback}" />
    </LinearLayout>
</layout>  

Usage

The library is available on GitHub Packages.

In your project main build.gradle you need:

maven {
    url 'https://maven.pkg.github.com/GCX-HCI/grandcentrix-formatted-text-android/'
    credentials {
        username = project.findProperty("github.user") ?: System.getenv("GITHUB_ACTOR")
        password = project.findProperty("github.token") ?: System.getenv("GITHUB_TOKEN")
    }
}

Note: Add your github user and token to your ~/.gradle/gradle.properties file.

And in your module build.gradle:

implementation("net.grandcentrix.formatted-text:android:1.0.0")

For the newest version please always check the Packages page.