[#722] Update documentation

Orange-OpenSource · Nov 30, 2023 · 2141bcc · 2141bcc
1 parent c5418c9
commit 2141bcc
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/docs/components/Cards.md b/docs/components/Cards.md
@@ -168,10 +168,10 @@ Row(
 
 Parameter | Default&nbsp;value | Description
 -- | -- | --
-`title: String` | | Title displayed into the card
+`title: String` | | Title displayed into the card. If the card is clickable, it will be truncated to fit on one line otherwise it will be displayed entirely for accessibility reasons.
 `image: OdsCard.Image` | | Image displayed into the card
 `modifier: Modifier` | `Modifier` | `Modifier` applied to the layout of the card
-`subtitle: String?` | `null` | Subtitle displayed into the card
+`subtitle: String?` | `null` | Subtitle displayed into the card. If the card is clickable, it will be truncated to fit on one line otherwise it will be displayed entirely for accessibility reasons.
 `onClick: (() -> Unit)?` | `null` | Callback invoked on card click
 {:.table}
 

diff --git a/lib/src/main/java/com/orange/ods/compose/component/card/OdsSmallCard.kt b/lib/src/main/java/com/orange/ods/compose/component/card/OdsSmallCard.kt
@@ -36,10 +36,12 @@ import com.orange.ods.compose.theme.OdsTheme
  *
  * Cards contain content and actions about a single subject.
  *
- * @param title Title displayed into the card.
+ * @param title Title displayed into the card. If the card is clickable, it will be truncated to fit on one line otherwise it will be displayed entirely for
+ * accessibility reasons.
  * @param image [OdsCard.Image] displayed into the card.
  * @param modifier [Modifier] applied to the layout of the card.
- * @param subtitle Subtitle displayed into the card.
+ * @param subtitle Subtitle displayed into the card. If the card is clickable, it will be truncated to fit on one line otherwise it will be displayed
+ * entirely for accessibility reasons.
  * @param onClick Callback invoked on card click.
  */
 @Composable