[#677] Review: Restrict header image type with a sealed interface

Orange-OpenSource · Nov 8, 2023 · ea44188 · ea44188
1 parent f468cf6
commit ea44188
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 5 deletions.
diff --git a/docs/components/NavigationDrawers.md b/docs/components/NavigationDrawers.md
@@ -87,7 +87,7 @@ Parameter | Default&nbsp;value | Description
 Parameter | Default&nbsp;value | Description
 -- | -- | --
 <b>`title: String`</b> | | Title displayed in the header
-`image: OdsComponentImage<Nothing>?` | `null` | Image displayed in the header. It should be an avatar image of `OdsModalDrawerHeaderAvatar` type or a background image of `OdsModalDrawerHeaderBackground` type. <b>Note that other component images will not be taken into account.</b>
+`image: OdsModalDrawerHeaderImage?` | `null` | Image displayed in the header. It should be an avatar image of `OdsModalDrawerHeaderAvatar` type or a background image of `OdsModalDrawerHeaderBackground` type.
 `subtitle: String?` | `null` | Subtitle displayed below the `title` in the header
 {:.table}
 

diff --git a/lib/src/main/java/com/orange/ods/compose/component/navigationdrawer/OdsModalDrawer.kt b/lib/src/main/java/com/orange/ods/compose/component/navigationdrawer/OdsModalDrawer.kt
@@ -176,12 +176,12 @@ data class OdsModalDrawerListItem(
  *
  * @property title Title displayed in the header.
  * @property image Image displayed in the header. It should be an avatar image of type [OdsModalDrawerHeaderAvatar] or a background image
- * of type [OdsModalDrawerHeaderBackground]. Note that other component images will not be taken into account.
+ * of type [OdsModalDrawerHeaderBackground].
  * @property subtitle Subtitle displayed below the [title] in the header.
  */
 class OdsModalDrawerHeader(
     private var title: String,
-    private val image: OdsComponentImage<Nothing>? = null,
+    private val image: OdsModalDrawerHeaderImage? = null,
     private var subtitle: String? = null
 ) : OdsComponentContent<Nothing>() {
 
@@ -228,10 +228,15 @@ class OdsModalDrawerHeader(
 
 }
 
+/**
+ * An image that can be added in the [OdsModalDrawerHeader].
+ */
+sealed interface OdsModalDrawerHeaderImage
+
 /**
  * An avatar in [OdsModalDrawerHeader].
  */
-class OdsModalDrawerHeaderAvatar : OdsComponentCircularImage {
+class OdsModalDrawerHeaderAvatar : OdsModalDrawerHeaderImage, OdsComponentCircularImage {
 
     /**
      * Creates an instance of [OdsModalDrawerHeaderAvatar].
@@ -261,7 +266,7 @@ class OdsModalDrawerHeaderAvatar : OdsComponentCircularImage {
 /**
  * A background image in the [OdsModalDrawerHeader].
  */
-class OdsModalDrawerHeaderBackground : OdsComponentImage<Nothing> {
+class OdsModalDrawerHeaderBackground : OdsModalDrawerHeaderImage, OdsComponentImage<Nothing> {
 
     /**
      * Creates an instance of [OdsModalDrawerHeaderBackground].