add documentation and test tag

dhis2 · Oct 2, 2023 · 2bc1de4 · 2bc1de4
1 parent d4ef1b0
commit 2bc1de4
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 0 deletions.
diff --git a/...src/androidMain/kotlin/org/hisp/dhis/mobile/ui/designsystem/component/BottomSheetShell.kt b/...src/androidMain/kotlin/org/hisp/dhis/mobile/ui/designsystem/component/BottomSheetShell.kt
@@ -38,12 +38,14 @@ actual fun BottomSheetShell(
     searchBar: @Composable (() -> Unit)?,
     buttonBlock: @Composable (() -> Unit)?,
     content: @Composable (() -> Unit)?,
+    modifier: Modifier,
     onDismiss: () -> Unit,
 ) {
     val sheetState = rememberModalBottomSheetState(true)
     val scope = rememberCoroutineScope()
 
     ModalBottomSheet(
+        modifier = modifier,
         containerColor = Color.Transparent,
         onDismissRequest = {
             onDismiss()

diff --git a/...ystem/src/commonMain/kotlin/org/hisp/dhis/mobile/ui/designsystem/component/BottomSheet.kt b/...ystem/src/commonMain/kotlin/org/hisp/dhis/mobile/ui/designsystem/component/BottomSheet.kt
@@ -57,6 +57,19 @@ fun BottomSheetHeader(
     }
 }
 
+/**
+ * DHIS2 BottomSheetShell. Wraps compose · [ModalBottomSheet].
+ * desktop version to be implemented
+ * @param title: title to be shown
+ * @param subtitle: subTitle to be shown
+ * @param description: PopUp description
+ * @param icon: the icon to be shown
+ * @param searchBar: dhis searchBar
+ * @param buttonBlock: Space for the lower buttons
+ * @param content: to be shown under the header
+ * @param onDismiss: gives access to the onDismiss event
+ * @param modifier allows a modifier to be passed externally
+ */
 @Composable
 expect fun BottomSheetShell(
     title: String,
@@ -66,5 +79,6 @@ expect fun BottomSheetShell(
     searchBar: @Composable (() -> Unit)? = null,
     buttonBlock: @Composable (() -> Unit)? = null,
     content: @Composable (() -> Unit)? = null,
+    modifier: Modifier = Modifier,
     onDismiss: () -> Unit,
 )
diff --git a/designsystem/src/commonMain/kotlin/org/hisp/dhis/mobile/ui/designsystem/component/Legend.kt b/designsystem/src/commonMain/kotlin/org/hisp/dhis/mobile/ui/designsystem/component/Legend.kt
@@ -29,6 +29,7 @@ import androidx.compose.ui.Alignment
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.draw.clip
 import androidx.compose.ui.graphics.Color
+import androidx.compose.ui.platform.testTag
 import org.hisp.dhis.mobile.ui.designsystem.theme.Border
 import org.hisp.dhis.mobile.ui.designsystem.theme.InternalSizeValues
 import org.hisp.dhis.mobile.ui.designsystem.theme.Ripple
@@ -93,6 +94,7 @@ fun Legend(
 
     if (showBottomSheetShell) {
         BottomSheetShell(
+            modifier = Modifier.testTag("LEGEND_BOTTOM_SHEET"),
             title = legendData.title,
             icon = {
                 Icon(

diff --git a/...src/desktopMain/kotlin/org/hisp/dhis/mobile/ui/designsystem/component/BottomSheetShell.kt b/...src/desktopMain/kotlin/org/hisp/dhis/mobile/ui/designsystem/component/BottomSheetShell.kt
@@ -16,6 +16,7 @@ actual fun BottomSheetShell(
     searchBar: @Composable (() -> Unit)?,
     buttonBlock: @Composable (() -> Unit)?,
     content: @Composable (() -> Unit)?,
+    modifier: Modifier,
     onDismiss: () -> Unit,
 ) {
     Box(modifier = Modifier.fillMaxSize(), contentAlignment = Alignment.Center) {