moko-resources

A StringDesc is a multi-source container for strings. It can represent a resource, a plural, a formatted variant, or a raw string. This abstraction allows you to write logic in commonMain that decides what string to show, while leaving the how to render it to the platform-specific code.

Common Types of StringDesc:

• StringDesc.Resource(MR.strings.key): A standard resource.
• StringDesc.ResourceFormatted(MR.strings.key, arg): A resource with arguments.
• StringDesc.Plural(MR.plurals.key, quantity): A plural resource.
• StringDesc.Raw(string): A plain, non-resource string.

Runtime Localization Control: You can force a specific locale in common code:

• StringDesc.localeType = StringDesc.LocaleType.Custom("es") (e.g., for Spanish).
• StringDesc.localeType = StringDesc.LocaleType.System (returns to device settings).

// Example: Switching between a raw string and a resource
fun getUserName(user: User?): StringDesc {
    return if (user != null) {
        StringDesc.Raw(user.name)
    } else {
        StringDesc.Resource(MR.strings.name_placeholder)
    }
}

Static frameworks cannot contain their own resources. You must add a custom Build Phase in Xcode (placed after the Kotlin Framework Compilation phase) to copy resources into the application.

Choose the script based on whether you are using CocoaPods.

# Using org.jetbrains.kotlin.native.cocoapods
"$SRCROOT/../gradlew" -p "$SRCROOT/../" :yourframeworkproject:copy`YourFrameworkName`FrameworkResourcesToApp \ 
    -Pmoko.resources.BUILT_PRODUCTS_DIR="$BUILT_PRODUCTS_DIR" \ 
    -Pmoko.resources.CONTENTS_FOLDER_PATH="$CONTENTS_FOLDER_PATH" \ 
    -Pkotlin.native.cocoapods.platform="$PLATFORM_NAME" \ 
    -Pkotlin.native.cocoapods.archs="$ARCHS" \ 
    -Pkotlin.native.cocoapods.configuration="${KOTLIN_FRAMEWORK_BUILD_TYPE:-$CONFIGURATION}" 

# Without org.jetbrains.kotlin.native.cocoapods
"$SRCROOT/../gradlew" -p "$SRCROOT/../" :yourframeworkproject:copyFrameworkResourcesToApp \ 
    -Pmoko.resources.PLATFORM_NAME="$PLATFORM_NAME" \ 
    -Pmoko.resources.CONFIGURATION="${KOTLIN_FRAMEWORK_BUILD_TYPE:-$CONFIGURATION}" \ 
    -Pmoko.resources.ARCHS="$ARCHS" \ 
    -Pmoko.resources.BUILT_PRODUCTS_DIR="$BUILT_PRODUCTS_DIR" \ 
    -Pmoko.resources.CONTENTS_FOLDER_PATH="$CONTENTS_FOLDER_PATH" 

To use moko-resources, you must configure both your root build.gradle and your project-level build.gradle. This involves applying the dev.icerock.mobile.multiplatform-resources plugin and adding the necessary dependencies for common code and Compose Multiplatform support.

// root build.gradle
buildscript {
    repositories {
        gradlePluginPortal()
    }

    dependencies {
        classpath "dev.icerock.moko:resources-generator:0.26.4"
    }
}

allprojects {
    repositories {
        mavenCentral()
    }
}

// project build.gradle
apply plugin: "dev.icerock.mobile.multiplatform-resources"

dependencies {
    commonMainApi("dev.icerock.moko:resources:0.26.4")
    commonMainApi("dev.icerock.moko:resources-compose:0.26.4") // for compose multiplatform

    commonTestImplementation("dev.icerock.moko:resources-test:0.26.4")
}

multiplatformResources {
    resourcesPackage.set("org.example.library") // required
    resourcesClassName.set("SharedRes") // optional, default MR
    resourcesVisibility.set(MRVisibility.Internal) // optional, default Public
    iosBaseLocalizationRegion.set("en") // optional, default "en"
    iosMinimalDeploymentTarget.set("11.0") // optional, default "9.0"
}

Plurals allow you to provide different string versions based on a numeric quantity.

1. Define in XML: Create commonMain/moko-resources/base/plurals.xml. You must include items for various quantities (e.g., zero, one, other).
2. Access in common code: Use StringDesc.Plural(MR.plurals.key, quantity) or the .format(quantity, ...) extension.

Compose Multiplatform: Use pluralStringResource(MR.plurals.key, selector, ...args).

Platform Usage:

• Android: StringDesc.toString(context).
• iOS: StringDesc.localized().

<!-- commonMain/moko-resources/base/plurals.xml -->
<resources>
    <plural name="my_plural">
        <item quantity="zero">zero</item>
        <item quantity="one">one</item>
        <item quantity="other">other</item>
    </plural>
</resources>

// commonMain
fun getMyPluralDesc(quantity: Int): StringDesc {
    return StringDesc.Plural(MR.plurals.my_plural, quantity)
}

// Compose Multiplatform
Text(text = pluralStringResource(MR.plurals.my_plural, quantity))