Add rich text for alert message

Author: florentmaitre

core/src/main/java/com/orange/ouds/core/component/OudsAlertMessage.kt

@@ -45,10 +45,13 @@ import androidx.compose.ui.platform.LocalConfiguration
 import androidx.compose.ui.res.painterResource
 import androidx.compose.ui.res.stringResource
 import androidx.compose.ui.semantics.semantics
+import androidx.compose.ui.text.AnnotatedString
 import androidx.compose.ui.tooling.preview.Preview
 import androidx.compose.ui.tooling.preview.PreviewParameter
 import androidx.compose.ui.unit.dp
 import com.orange.ouds.core.R
+import com.orange.ouds.core.component.common.text.OudsAnnotatedAlertMessageBulletListLabel
+import com.orange.ouds.core.component.common.text.OudsAnnotatedAlertMessageDescription
 import com.orange.ouds.core.component.content.OudsComponentContent
 import com.orange.ouds.core.theme.LocalDrawableResources
 import com.orange.ouds.core.theme.LocalThemeSettings
@@ -59,6 +62,7 @@ import com.orange.ouds.core.utilities.OudsPreview
 import com.orange.ouds.core.utilities.OudsPreviewDevice
 import com.orange.ouds.core.utilities.OudsPreviewableComponent
 import com.orange.ouds.core.utilities.getPreviewTheme
+import com.orange.ouds.foundation.extensions.orElse
 import com.orange.ouds.foundation.utilities.BasicPreviewParameterProvider
 import com.orange.ouds.theme.OudsThemeContract
 
@@ -107,6 +111,90 @@ fun OudsAlertMessage(
     onClose: (() -> Unit)? = null,
     actionLink: OudsAlertMessageActionLink? = null,
     bulletList: List<String>? = null
+) {
+    OudsAlertMessage(
+        label = label,
+        modifier = modifier,
+        status = status,
+        description = description,
+        annotatedDescription = null,
+        onClose = onClose,
+        actionLink = actionLink,
+        bulletList = bulletList,
+        annotatedBulletList = null
+    )
+}
+
+/**
+ * Alert message is a UI element that displays system feedback, status changes or required action; throughout detailed, prominent, persistent and actionable
+ * communication. Alert message includes functional icon and semantic colour, and may include as well a close button and/or action link.
+ * Alert Message does not disappear automatically and remains visible until dismissed or resolved by the user.
+ *
+ * > Design guidelines: [unified-design-system.orange.com](https://r.orange.fr/r/S-ouds-doc-alert-message)
+ *
+ * > Design version: 1.1.0
+ *
+ * @param label Label displayed in the alert message. Main message that should be short, clear, and readable at a glance.
+ * @param modifier [Modifier] applied to the alert message.
+ * @param status The status of the alert message. Its background color and its icon color are based on this status.
+ *   There are two types of statuses:
+ *   - Non-functional statuses ([OudsAlertMessageStatus.Neutral] or [OudsAlertMessageStatus.Accent]) used for informational or decorative alert messages. They
+ *   provide context or highlight content without implying a specific state, system event, or user action. These alerts are not tied to UX patterns such as
+ *   success, error, or warning, and may use contextual or brand-related icons to enhance recognition or storytelling.
+ *   - Functional statuses communicate specific system statuses, results, or user feedback: [OudsAlertMessageStatus.Positive], [OudsAlertMessageStatus.Warning],
+ *   [OudsAlertMessageStatus.Negative], [OudsAlertMessageStatus.Info].
+ *   Each variant conveys a clear semantic meaning and must always be paired with its dedicated functional icon to ensure clarity and accessibility.
+ *   Use functional alerts to inform user about state changes, confirmations, or issues that are directly connected to system logic or user actions. These
+ *   messages carry functional meaning and help guide user response or acknowledgment.
+ * @param description Annotated supplementary text in an alert message. Use only when additional detail or guidance is needed beyond the label. It should remain
+ *   short, clear and scannable, helping the user to understand what happened and what he can do next.
+ * @param onClose Callback invoked when the close button is clicked. If `null`, the close button is not displayed and the alert message remains visible until
+ *   the context changes (e.g., the issue is resolved, the screen is refreshed). Otherwise, the alert message is dismissable and includes a close button,
+ *   allowing the user to dismiss it when he has acknowledged the message.
+ *   Some alerts must remain visible to ensure user is aware of important information; others can be closed to reduce visual clutter.
+ * @param actionLink An optional link to be displayed in the alert message. It can be used to trigger an action.
+ * @param bulletList A list of annotated bullet points to be displayed in the alert message following the label or the optional [description].
+ *   Add this list when you need to highlight multiple points, such as service features, plan details, or next steps. Each bullet should be short and written
+ *   as a clear phrase or fragment — avoid long sentences or complex structures.
+ *
+ * @sample com.orange.ouds.core.component.samples.OudsAlertMessageSample
+ *
+ * @sample com.orange.ouds.core.component.samples.OudsAlertMessageFunctionalWithTopEndActionLinkSample
+ */
+@Composable
+fun OudsAlertMessage(
+    label: String,
+    modifier: Modifier = Modifier,
+    status: OudsAlertMessageStatus = OudsAlertMessageDefaults.Status,
+    description: OudsAnnotatedAlertMessageDescription,
+    onClose: (() -> Unit)? = null,
+    actionLink: OudsAlertMessageActionLink? = null,
+    bulletList: List<OudsAnnotatedAlertMessageBulletListLabel>?
+) {
+    OudsAlertMessage(
+        label = label,
+        modifier = modifier,
+        status = status,
+        description = null,
+        annotatedDescription = description,
+        onClose = onClose,
+        actionLink = actionLink,
+        bulletList = null,
+        annotatedBulletList = bulletList
+    )
+}
+
+@Composable
+private fun OudsAlertMessage(
+    label: String,
+    modifier: Modifier = Modifier,
+    status: OudsAlertMessageStatus = OudsAlertMessageDefaults.Status,
+    description: String? = null,
+    annotatedDescription: OudsAnnotatedAlertMessageDescription? = null,
+    onClose: (() -> Unit)? = null,
+    actionLink: OudsAlertMessageActionLink? = null,
+    bulletList: List<String>? = null,
+    annotatedBulletList: List<OudsAnnotatedAlertMessageBulletListLabel>? = null
 ) {
     with(OudsTheme.componentsTokens.alert) {
         val scale = LocalConfiguration.current.fontScale
@@ -150,15 +238,15 @@ fun OudsAlertMessage(
                         color = status.contentColor,
                         style = OudsTheme.typography.label.moderate.large
                     )
-                    description?.let {
-                        Text(
-                            modifier = Modifier.widthIn(max = OudsTheme.sizes.maxWidth.type.label.medium),
-                            text = description,
-                            color = status.contentColor,
-                            style = OudsTheme.typography.label.default.medium
-                        )
+                    val descriptionModifier = Modifier.widthIn(max = OudsTheme.sizes.maxWidth.type.label.medium)
+                    val descriptionText = annotatedDescription?.annotatedString.orElse { description }
+                    val descriptionColor = status.contentColor
+                    val descriptionStyle = OudsTheme.typography.label.default.medium
+                    when (descriptionText) {
+                        is AnnotatedString -> Text(modifier = descriptionModifier, text = descriptionText, color = descriptionColor, style = descriptionStyle)
+                        is String -> Text(modifier = descriptionModifier, text = descriptionText, color = descriptionColor, style = descriptionStyle)
                     }
-                    bulletList?.let { list ->
+                    annotatedBulletList.orElse { bulletList }?.let { list ->
                         Column(verticalArrangement = Arrangement.spacedBy(spaceRowGapBullet.value)) {
                             list.forEach { label ->
                                 if (label.isNotBlank()) OudsAlertMessageBulletListItem(label = label, color = status.contentColor)
@@ -360,7 +448,7 @@ sealed class OudsAlertMessageStatus(internal val value: OudsAlertStatus, val ico
 }
 
 @Composable
-private fun OudsAlertMessageBulletListItem(label: String, color: Color) {
+private fun OudsAlertMessageBulletListItem(label: CharSequence, color: Color) {
     val scale = LocalConfiguration.current.fontScale
     Row(
         modifier = Modifier
@@ -383,15 +471,15 @@ private fun OudsAlertMessageBulletListItem(label: String, color: Color) {
                 tint = color
             )
         }
-        Text(
-            modifier = Modifier
-                .fillMaxHeight()
-                .wrapContentHeight() // Allows to center the text vertically when its height is smaller than the row height
-                .widthIn(max = OudsTheme.sizes.maxWidth.type.label.medium),
-            text = label,
-            style = OudsTheme.typography.label.default.medium,
-            color = color
-        )
+        val modifier = Modifier
+            .fillMaxHeight()
+            .wrapContentHeight() // Allows to center the text vertically when its height is smaller than the row height
+            .widthIn(max = OudsTheme.sizes.maxWidth.type.label.medium)
+        val style = OudsTheme.typography.label.default.medium
+        when (label) {
+            is AnnotatedString -> Text(modifier = modifier, text = label, color = color, style = style)
+            is String -> Text(modifier = modifier, text = label, color = color, style = style)
+        }
     }
 }
 

core/src/main/java/com/orange/ouds/core/component/common/text/OudsAnnotatedAlertMessageBulletListLabel.kt

@@ -0,0 +1,46 @@
+/*
+ * Software Name: OUDS Android
+ * SPDX-FileCopyrightText: Copyright (c) Orange SA
+ * SPDX-License-Identifier: MIT
+ *
+ * This software is distributed under the MIT license,
+ * the text of which is available at https://opensource.org/license/MIT/
+ * or see the "LICENSE" file for more details.
+ *
+ * Software description: Android library of reusable graphical components 
+ */
+
+package com.orange.ouds.core.component.common.text
+
+import androidx.compose.ui.text.AnnotatedString
+
+class OudsAnnotatedAlertMessageBulletListLabel internal constructor(annotatedString: AnnotatedString) :
+    OudsAnnotatedString<OudsAnnotatedAlertMessageBulletListLabel>(annotatedString) {
+
+    class Builder(capacity: Int = 16) :
+        OudsAnnotatedString.Builder<OudsAnnotatedAlertMessageBulletListLabel>(capacity, OudsAnnotatedAlertMessageBulletListLabel::class.java),
+        StrongBuilder, LinkBuilder {
+
+        constructor(text: String) : this() {
+            append(text)
+        }
+
+        constructor(text: OudsAnnotatedHelperText) : this() {
+            append(text)
+        }
+
+        override fun addStrong(start: Int, end: Int) = addStrongImpl(start, end)
+
+        override fun pushStrong(): Int = pushStrongImpl()
+
+        override fun addLink(url: OudsLinkAnnotation.Url, start: Int, end: Int) = addLinkImpl(url, start, end)
+
+        override fun addLink(clickable: OudsLinkAnnotation.Clickable, start: Int, end: Int) = addLinkImpl(clickable, start, end)
+
+        override fun pushLink(link: OudsLinkAnnotation): Int = pushLinkImpl(link)
+    }
+}
+
+fun buildOudsAnnotatedAlertMessageBulletListLabel(builder: (OudsAnnotatedAlertMessageBulletListLabel.Builder).() -> Unit): OudsAnnotatedAlertMessageBulletListLabel {
+    return buildOudsAnnotatedString<OudsAnnotatedAlertMessageBulletListLabel, OudsAnnotatedAlertMessageBulletListLabel.Builder>(builder)
+}

core/src/main/java/com/orange/ouds/core/component/common/text/OudsAnnotatedAlertMessageDescription.kt

@@ -0,0 +1,46 @@
+/*
+ * Software Name: OUDS Android
+ * SPDX-FileCopyrightText: Copyright (c) Orange SA
+ * SPDX-License-Identifier: MIT
+ *
+ * This software is distributed under the MIT license,
+ * the text of which is available at https://opensource.org/license/MIT/
+ * or see the "LICENSE" file for more details.
+ *
+ * Software description: Android library of reusable graphical components 
+ */
+
+package com.orange.ouds.core.component.common.text
+
+import androidx.compose.ui.text.AnnotatedString
+
+class OudsAnnotatedAlertMessageDescription internal constructor(annotatedString: AnnotatedString) :
+    OudsAnnotatedString<OudsAnnotatedAlertMessageDescription>(annotatedString) {
+
+    class Builder(capacity: Int = 16) :
+        OudsAnnotatedString.Builder<OudsAnnotatedAlertMessageDescription>(capacity, OudsAnnotatedAlertMessageDescription::class.java),
+        StrongBuilder, LinkBuilder {
+
+        constructor(text: String) : this() {
+            append(text)
+        }
+
+        constructor(text: OudsAnnotatedHelperText) : this() {
+            append(text)
+        }
+
+        override fun addStrong(start: Int, end: Int) = addStrongImpl(start, end)
+
+        override fun pushStrong(): Int = pushStrongImpl()
+
+        override fun addLink(url: OudsLinkAnnotation.Url, start: Int, end: Int) = addLinkImpl(url, start, end)
+
+        override fun addLink(clickable: OudsLinkAnnotation.Clickable, start: Int, end: Int) = addLinkImpl(clickable, start, end)
+
+        override fun pushLink(link: OudsLinkAnnotation): Int = pushLinkImpl(link)
+    }
+}
+
+fun buildOudsAnnotatedAlertMessageString(builder: (OudsAnnotatedAlertMessageDescription.Builder).() -> Unit): OudsAnnotatedAlertMessageDescription {
+    return buildOudsAnnotatedString<OudsAnnotatedAlertMessageDescription, OudsAnnotatedAlertMessageDescription.Builder>(builder)
+}

core/src/main/java/com/orange/ouds/core/component/common/text/OudsAnnotatedErrorMessage.kt

@@ -27,12 +27,12 @@ class OudsAnnotatedErrorMessage internal constructor(annotatedString: AnnotatedS
             append(text)
         }
 
-        override fun addStrong(start: Int, end: Int) = addStrongInternal(start, end)
+        override fun addStrong(start: Int, end: Int) = addStrongImpl(start, end)
 
-        override fun pushStrong(): Int = pushStrongInternal()
+        override fun pushStrong(): Int = pushStrongImpl()
     }
 }
 
 fun buildOudsAnnotatedErrorMessage(builder: (OudsAnnotatedErrorMessage.Builder).() -> Unit): OudsAnnotatedErrorMessage {
-    return buildOudsAnnotatedString<OudsAnnotatedErrorMessage.Builder, OudsAnnotatedErrorMessage>(builder)
+    return buildOudsAnnotatedString<OudsAnnotatedErrorMessage, OudsAnnotatedErrorMessage.Builder>(builder)
 }

core/src/main/java/com/orange/ouds/core/component/common/text/OudsAnnotatedHelperText.kt

@@ -26,12 +26,12 @@ class OudsAnnotatedHelperText internal constructor(annotatedString: AnnotatedStr
             append(text)
         }
 
-        override fun addStrong(start: Int, end: Int) = addStrongInternal(start, end)
+        override fun addStrong(start: Int, end: Int) = addStrongImpl(start, end)
 
-        override fun pushStrong(): Int = pushStrongInternal()
+        override fun pushStrong(): Int = pushStrongImpl()
     }
 }
 
 fun buildOudsAnnotatedHelperText(builder: (OudsAnnotatedHelperText.Builder).() -> Unit): OudsAnnotatedHelperText {
-    return buildOudsAnnotatedString<OudsAnnotatedHelperText.Builder, OudsAnnotatedHelperText>(builder)
+    return buildOudsAnnotatedString<OudsAnnotatedHelperText, OudsAnnotatedHelperText.Builder>(builder)
 }

core/src/main/java/com/orange/ouds/core/component/common/text/OudsAnnotatedString.kt

@@ -50,7 +50,7 @@ open class OudsAnnotatedString<T> internal constructor(internal val annotatedStr
 
     open class Builder<T> internal constructor(capacity: Int, private val clazz: Class<T>) : Appendable where T : OudsAnnotatedString<T> {
 
-        internal companion object {
+        private companion object {
 
             val strongStyle = SpanStyle(fontWeight = FontWeight.Bold)
         }
@@ -74,21 +74,21 @@ open class OudsAnnotatedString<T> internal constructor(internal val annotatedStr
             return constructor(builder.toAnnotatedString())
         }
 
-        internal fun addStrongInternal(start: Int, end: Int) {
+        protected fun addStrongImpl(start: Int, end: Int) {
             builder.addStyle(strongStyle, start, end)
         }
 
-        internal fun addLinkInternal(url: OudsLinkAnnotation.Url, start: Int, end: Int) {
+        protected fun addLinkImpl(url: OudsLinkAnnotation.Url, start: Int, end: Int) {
             builder.addLink(url.linkAnnotation, start, end)
         }
 
-        internal fun addLinkInternal(clickable: OudsLinkAnnotation.Clickable, start: Int, end: Int) {
+        protected fun addLinkImpl(clickable: OudsLinkAnnotation.Clickable, start: Int, end: Int) {
             builder.addLink(clickable.linkAnnotation, start, end)
         }
 
-        internal fun pushStrongInternal(): Int = builder.pushStyle(strongStyle)
+        protected fun pushStrongImpl(): Int = builder.pushStyle(strongStyle)
 
-        internal fun pushLinkInternal(link: OudsLinkAnnotation): Int = builder.pushLink(link.linkAnnotation)
+        protected fun pushLinkImpl(link: OudsLinkAnnotation): Int = builder.pushLink(link.linkAnnotation)
 
         fun pop(): Unit = builder.pop()
 
@@ -153,8 +153,8 @@ inline fun <R : Any> OudsAnnotatedString.LinkBuilder.withLink(link: OudsLinkAnno
     }
 }
 
-inline fun <reified T, U> buildOudsAnnotatedString(noinline builder: (T).() -> Unit): U where T : OudsAnnotatedString.Builder<U>, U : OudsAnnotatedString<U> {
-    return buildOudsAnnotatedString(T::class.java, builder)
+inline fun <T, reified U> buildOudsAnnotatedString(noinline builder: (U).() -> Unit): T where U : OudsAnnotatedString.Builder<T>, T : OudsAnnotatedString<T> {
+    return buildOudsAnnotatedString(U::class.java, builder)
 }
 
 @PublishedApi