core/com.orange.ouds.core.component.common.text/OudsAnnotatedHelperText

OudsAnnotatedHelperText

class OudsAnnotatedHelperText : OudsAnnotatedString<OudsAnnotatedHelperText>

An annotated string for helper text in text input components.

This class supports strong (bold/emphasized) text formatting to highlight important information in helper text. It is used by components like com.orange.ouds.core.component.OudsTextInput, com.orange.ouds.core.component.OudsTextArea, com.orange.ouds.core.component.OudsPasswordInput, and com.orange.ouds.core.component.OudsPinCodeInput.

Use buildOudsAnnotatedHelperText to create instances:

val helperText = buildOudsAnnotatedHelperText {
    append("Password must be ")
    withStrong { append("at least 8 characters") }
    append(" long")
}

OudsTextInput(
    textFieldState = rememberTextFieldState(),
    label = "Password",
    helperText = helperText
)

Types

class Builder(capacity: Int = 16) : OudsAnnotatedString.Builder<OudsAnnotatedHelperText> , OudsAnnotatedString.StrongBuilder

Builder for creating OudsAnnotatedHelperText with strong text formatting.

Properties

open override val length: Int

val text: String

The plain text content without any formatting annotations.

Functions

fun capitalize(localeList: LocaleList = LocaleList.current): OudsAnnotatedHelperText

Create capitalized OudsAnnotatedString.

fun decapitalize(localeList: LocaleList = LocaleList.current): OudsAnnotatedHelperText

Create decapitalized OudsAnnotatedString.

open operator override fun equals(other: Any?): Boolean

open operator override fun get(index: Int): Char

open override fun hashCode(): Int

operator fun plus(other: OudsAnnotatedHelperText): OudsAnnotatedHelperText

Concatenates this annotated string with another annotated string.

open override fun subSequence(startIndex: Int, endIndex: Int): CharSequence

fun toLowerCase(localeList: LocaleList = LocaleList.current): OudsAnnotatedHelperText

Create lower case transformed OudsAnnotatedString.

open override fun toString(): String

fun toUpperCase(localeList: LocaleList = LocaleList.current): OudsAnnotatedHelperText

Create upper case transformed OudsAnnotatedString.