Add samples for rich text component APIs

Author: florentmaitre

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

@@ -163,9 +163,7 @@ fun OudsAlertMessage(
  *   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
+ * @sample com.orange.ouds.core.component.samples.OudsAlertMessageWithAnnotatedTextSample
  */
 @Composable
 fun OudsAlertMessage(

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

@@ -104,6 +104,7 @@ private const val MaxLevelCount = 3
  * @sample com.orange.ouds.core.component.samples.OudsBulletListUnorderedSample
  * @sample com.orange.ouds.core.component.samples.OudsBulletListOrderedSample
  * @sample com.orange.ouds.core.component.samples.OudsBulletListBareSample
+ * @sample com.orange.ouds.core.component.samples.OudsBulletListWithAnnotatedLabelsSample
  */
 @Composable
 fun OudsBulletList(

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

@@ -82,6 +82,7 @@ import com.orange.ouds.theme.OudsThemeContract
  *   is provided, interactions will still happen internally.
  *
  * @sample com.orange.ouds.core.component.samples.OudsCheckboxItemSample
+ * @sample com.orange.ouds.core.component.samples.OudsCheckboxItemWithAnnotatedErrorMessageSample
  */
 @Composable
 fun OudsCheckboxItem(
@@ -164,6 +165,7 @@ fun OudsCheckboxItem(
  *   if `null` is provided, interactions will still happen internally.
  *
  * @sample com.orange.ouds.core.component.samples.OudsTriStateCheckboxItemSample
+ * @sample com.orange.ouds.core.component.samples.OudsTriStateCheckboxItemWithAnnotatedErrorMessageSample
  */
 @Composable
 fun OudsTriStateCheckboxItem(

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

@@ -98,7 +98,6 @@ import com.orange.ouds.theme.OudsThemeSettings
  *   is provided, interactions will still happen internally.
  *
  * @sample com.orange.ouds.core.component.samples.OudsPasswordInputSample
- *
  * @sample com.orange.ouds.core.component.samples.OudsPasswordInputErrorSample
  */
 @Composable
@@ -192,8 +191,8 @@ fun OudsPasswordInput(
  *   is provided, interactions will still happen internally.
  *
  * @sample com.orange.ouds.core.component.samples.OudsPasswordInputSample
- *
- * @sample com.orange.ouds.core.component.samples.OudsPasswordInputErrorSample
+ * @sample com.orange.ouds.core.component.samples.OudsPasswordInputWithAnnotatedErrorMessageSample
+ * @sample com.orange.ouds.core.component.samples.OudsPasswordInputWithAnnotatedHelperTextSample
  */
 @Composable
 fun OudsPasswordInput(

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

@@ -113,7 +113,6 @@ import kotlinx.coroutines.launch
  *   is provided, interactions will still happen internally.
  *
  * @sample com.orange.ouds.core.component.samples.OudsPinCodeInputSample
- *
  * @sample com.orange.ouds.core.component.samples.OudsPinCodeInputErrorSample
  */
 @Composable
@@ -171,8 +170,8 @@ fun OudsPinCodeInput(
  *   is provided, interactions will still happen internally.
  *
  * @sample com.orange.ouds.core.component.samples.OudsPinCodeInputSample
- *
- * @sample com.orange.ouds.core.component.samples.OudsPinCodeInputErrorSample
+ * @sample com.orange.ouds.core.component.samples.OudsPinCodeInputWithAnnotatedErrorMessageSample
+ * @sample com.orange.ouds.core.component.samples.OudsPinCodeInputWithAnnotatedHelperTextSample
  */
 @Composable
 fun OudsPinCodeInput(

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

@@ -86,6 +86,7 @@ import com.orange.ouds.theme.OudsThemeContract
  *   is provided, interactions will still happen internally.
  *
  * @sample com.orange.ouds.core.component.samples.OudsRadioButtonItemSample
+ * @sample com.orange.ouds.core.component.samples.OudsRadioButtonItemWithAnnotatedErrorMessageSample
  */
 @Composable
 fun OudsRadioButtonItem(

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

@@ -81,6 +81,7 @@ import com.orange.ouds.theme.OudsThemeContract
  *   is provided, interactions will still happen internally.
  *
  * @sample com.orange.ouds.core.component.samples.OudsSwitchItemSample
+ * @sample com.orange.ouds.core.component.samples.OudsSwitchItemWithAnnotatedErrorMessageSample
  */
 @Composable
 fun OudsSwitchItem(

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

@@ -141,7 +141,6 @@ import com.orange.ouds.theme.OudsThemeSettings
  *   is provided, interactions will still happen internally.
  *
  * @sample com.orange.ouds.core.component.samples.OudsTextAreaStateBasedSample
- *
  * @sample com.orange.ouds.core.component.samples.OudsTextAreaStateBasedErrorSample
  */
 @Composable
@@ -241,8 +240,8 @@ fun OudsTextArea(
  *   is provided, interactions will still happen internally.
  *
  * @sample com.orange.ouds.core.component.samples.OudsTextAreaStateBasedSample
- *
- * @sample com.orange.ouds.core.component.samples.OudsTextAreaStateBasedErrorSample
+ * @sample com.orange.ouds.core.component.samples.OudsTextAreaStateBasedWithAnnotatedErrorMessageSample
+ * @sample com.orange.ouds.core.component.samples.OudsTextAreaStateBasedWithAnnotatedHelperTextSample
  */
 @Composable
 fun OudsTextArea(
@@ -409,7 +408,6 @@ private fun OudsTextArea(
  *   is provided, interactions will still happen internally.
  *
  * @sample com.orange.ouds.core.component.samples.OudsTextAreaValueBasedSample
- *
  * @sample com.orange.ouds.core.component.samples.OudsTextAreaValueBasedErrorSample
  */
 @Composable
@@ -504,8 +502,8 @@ fun OudsTextArea(
  *   is provided, interactions will still happen internally.
  *
  * @sample com.orange.ouds.core.component.samples.OudsTextAreaValueBasedSample
- *
- * @sample com.orange.ouds.core.component.samples.OudsTextAreaValueBasedErrorSample
+ * @sample com.orange.ouds.core.component.samples.OudsTextAreaValueBasedWithAnnotatedErrorMessageSample
+ * @sample com.orange.ouds.core.component.samples.OudsTextAreaValueBasedWithAnnotatedHelperTextSample
  */
 @Composable
 fun OudsTextArea(
@@ -670,7 +668,6 @@ private fun OudsTextArea(
  *   is provided, interactions will still happen internally.
  *
  * @sample com.orange.ouds.core.component.samples.OudsTextAreaValueBasedSample
- *
  * @sample com.orange.ouds.core.component.samples.OudsTextAreaValueBasedErrorSample
  */
 @Composable
@@ -765,8 +762,8 @@ fun OudsTextArea(
  *   is provided, interactions will still happen internally.
  *
  * @sample com.orange.ouds.core.component.samples.OudsTextAreaValueBasedSample
- *
- * @sample com.orange.ouds.core.component.samples.OudsTextAreaValueBasedErrorSample
+ * @sample com.orange.ouds.core.component.samples.OudsTextAreaValueBasedWithAnnotatedErrorMessageSample
+ * @sample com.orange.ouds.core.component.samples.OudsTextAreaValueBasedWithAnnotatedHelperTextSample
  */
 @Composable
 fun OudsTextArea(

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

@@ -159,7 +159,6 @@ import com.orange.ouds.theme.OudsThemeSettings
  *   is provided, interactions will still happen internally.
  *
  * @sample com.orange.ouds.core.component.samples.OudsTextInputStateBasedSample
- *
  * @sample com.orange.ouds.core.component.samples.OudsTextInputStateBasedErrorSample
  */
 @Composable
@@ -271,8 +270,8 @@ fun OudsTextInput(
  *   is provided, interactions will still happen internally.
  *
  * @sample com.orange.ouds.core.component.samples.OudsTextInputStateBasedSample
- *
- * @sample com.orange.ouds.core.component.samples.OudsTextInputStateBasedErrorSample
+ * @sample com.orange.ouds.core.component.samples.OudsTextInputStateBasedWithAnnotatedErrorMessageSample
+ * @sample com.orange.ouds.core.component.samples.OudsTextInputStateBasedWithAnnotatedHelperTextSample
  */
 @Composable
 fun OudsTextInput(
@@ -454,7 +453,6 @@ private fun OudsTextInput(
  *   is provided, interactions will still happen internally.
  *
  * @sample com.orange.ouds.core.component.samples.OudsTextInputValueBasedSample
- *
  * @sample com.orange.ouds.core.component.samples.OudsTextInputValueBasedErrorSample
  */
 @Composable
@@ -560,8 +558,8 @@ fun OudsTextInput(
  *   is provided, interactions will still happen internally.
  *
  * @sample com.orange.ouds.core.component.samples.OudsTextInputValueBasedSample
- *
- * @sample com.orange.ouds.core.component.samples.OudsTextInputValueBasedErrorSample
+ * @sample com.orange.ouds.core.component.samples.OudsTextInputValueBasedWithAnnotatedErrorMessageSample
+ * @sample com.orange.ouds.core.component.samples.OudsTextInputValueBasedWithAnnotatedHelperTextSample
  */
 @Composable
 fun OudsTextInput(
@@ -743,7 +741,6 @@ private fun OudsTextInput(
  *   is provided, interactions will still happen internally.
  *
  * @sample com.orange.ouds.core.component.samples.OudsTextInputValueBasedSample
- *
  * @sample com.orange.ouds.core.component.samples.OudsTextInputValueBasedErrorSample
  */
 @Composable
@@ -849,8 +846,8 @@ fun OudsTextInput(
  *   is provided, interactions will still happen internally.
  *
  * @sample com.orange.ouds.core.component.samples.OudsTextInputValueBasedSample
- *
- * @sample com.orange.ouds.core.component.samples.OudsTextInputValueBasedErrorSample
+ * @sample com.orange.ouds.core.component.samples.OudsTextInputValueBasedWithAnnotatedErrorMessageSample
+ * @sample com.orange.ouds.core.component.samples.OudsTextInputValueBasedWithAnnotatedHelperTextSample
  */
 @Composable
 fun OudsTextInput(

core/src/main/java/com/orange/ouds/core/component/samples/OudsAlertMessageSamples.kt

@@ -16,45 +16,87 @@ import androidx.compose.material.icons.Icons
 import androidx.compose.material.icons.filled.FavoriteBorder
 import androidx.compose.runtime.Composable
 import androidx.compose.ui.tooling.preview.PreviewLightDark
-import com.orange.ouds.core.component.OudsAlertMessage
 import com.orange.ouds.core.component.OudsAlertIcon
+import com.orange.ouds.core.component.OudsAlertMessage
 import com.orange.ouds.core.component.OudsAlertMessageActionLink
 import com.orange.ouds.core.component.OudsAlertMessageActionLinkPosition
 import com.orange.ouds.core.component.OudsAlertMessageStatus
+import com.orange.ouds.core.component.common.text.OudsLinkAnnotation
+import com.orange.ouds.core.component.common.text.buildOudsAnnotatedAlertMessageBulletListLabel
+import com.orange.ouds.core.component.common.text.buildOudsAnnotatedAlertMessageDescription
+import com.orange.ouds.core.component.common.text.withLink
+import com.orange.ouds.core.component.common.text.withStrong
 import com.orange.ouds.core.utilities.OudsPreview
 
 @Composable
 internal fun OudsAlertMessageSample() {
     OudsAlertMessage(
-        label = "Label",
-        description = "Description of the alert message.",
+        label = "New features available",
+        description = "We've added exciting new features to improve your experience.",
         status = OudsAlertMessageStatus.Accent(OudsAlertIcon(imageVector = Icons.Filled.FavoriteBorder)),
         onClose = { /* Close the alert message */ },
-        actionLink = OudsAlertMessageActionLink(label = "Action", onClick = { /* Do something */ }),
+        actionLink = OudsAlertMessageActionLink(label = "Learn more", onClick = { /* Navigate to features page */ }),
         bulletList = listOf(
-            "Bullet 1",
-            "Bullet 2",
-            "Bullet 3"
+            "Enhanced security with biometric authentication",
+            "Improved performance and faster load times",
+            "New customization options for your dashboard"
         )
     )
 }
 
 @Composable
 internal fun OudsAlertMessageFunctionalWithTopEndActionLinkSample() {
     OudsAlertMessage(
-        label = "Label",
-        description = "Description of the alert message.",
+        label = "Account successfully verified",
+        description = "Your account has been verified and is now fully activated.",
         status = OudsAlertMessageStatus.Positive,
         onClose = { /* Close the alert message */ },
-        actionLink = OudsAlertMessageActionLink(label = "Action", onClick = { /* Do something */ }, position = OudsAlertMessageActionLinkPosition.TopEnd),
+        actionLink = OudsAlertMessageActionLink(label = "Details", onClick = { /* Navigate to account details */ }, position = OudsAlertMessageActionLinkPosition.TopEnd),
         bulletList = listOf(
-            "Bullet 1",
-            "Bullet 2",
-            "Bullet 3"
+            "All features are now unlocked",
+            "You can start using premium services",
+            "Your data is fully synchronized"
         )
     )
 }
 
+@Composable
+internal fun OudsAlertMessageWithAnnotatedTextSample() {
+    val description = buildOudsAnnotatedAlertMessageDescription {
+        withStrong { append("Important:") }
+        append(" Please read the ")
+        withLink(OudsLinkAnnotation.Url("https://example.com")) {
+            append("terms and conditions")
+        }
+        append(" carefully before proceeding.")
+    }
+
+    val bulletList = listOf(
+        buildOudsAnnotatedAlertMessageBulletListLabel {
+            withStrong { append("Data security:") }
+            append(" Your information will be encrypted and stored securely")
+        },
+        buildOudsAnnotatedAlertMessageBulletListLabel {
+            withStrong { append("Privacy policy:") }
+            append(" We respect your privacy and will not share your data")
+        },
+        buildOudsAnnotatedAlertMessageBulletListLabel {
+            append("For more information, visit our ")
+            withLink(OudsLinkAnnotation.Url("https://help.example.com")) {
+                append("help center")
+            }
+        }
+    )
+
+    OudsAlertMessage(
+        label = "Before you continue",
+        description = description,
+        status = OudsAlertMessageStatus.Accent(OudsAlertIcon(imageVector = Icons.Filled.FavoriteBorder)),
+        onClose = { /* Close the alert message */ },
+        bulletList = bulletList
+    )
+}
+
 @PreviewLightDark
 @Composable
 private fun PreviewOudsAlertMessageSample() = OudsPreview {
@@ -65,4 +107,10 @@ private fun PreviewOudsAlertMessageSample() = OudsPreview {
 @Composable
 private fun PreviewOudsAlertMessageFunctionalWithTopEndActionLinkSample() = OudsPreview {
     OudsAlertMessageFunctionalWithTopEndActionLinkSample()
+}
+
+@PreviewLightDark
+@Composable
+private fun PreviewOudsAlertMessageWithAnnotatedTextSample() = OudsPreview {
+    OudsAlertMessageWithAnnotatedTextSample()
 }