updated: [ANDROAPP-6097] Documentation added

dhis2 · May 10, 2024 · 443f761 · 443f761
1 parent 51e2e11
commit 443f761
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/...system/src/commonMain/kotlin/org/hisp/dhis/mobile/ui/designsystem/component/AssistChip.kt b/...system/src/commonMain/kotlin/org/hisp/dhis/mobile/ui/designsystem/component/AssistChip.kt
@@ -8,6 +8,7 @@ import androidx.compose.material.ripple.LocalRippleTheme
 import androidx.compose.material3.AssistChip
 import androidx.compose.material3.AssistChipDefaults
 import androidx.compose.material3.ExperimentalMaterial3Api
+import androidx.compose.material3.FilterChip
 import androidx.compose.material3.Text
 import androidx.compose.runtime.Composable
 import androidx.compose.runtime.CompositionLocalProvider
@@ -24,6 +25,18 @@ import org.hisp.dhis.mobile.ui.designsystem.theme.Ripple
 import org.hisp.dhis.mobile.ui.designsystem.theme.SurfaceColor
 import org.hisp.dhis.mobile.ui.designsystem.theme.TextColor
 
+/**
+ * DHIS2 [AssistChip] button with custom icon slot.
+ * wraps Material 3 [AssistChip].
+ * AssistChips are used to trigger actions.
+ * @param label: the text to be shown.
+ * @param icon: custom leading icon to be shown, use AssistChipDefaults in the
+ * Icon composable modifier to set the size of the icon.
+ * @param enabled: controls the enabled state. "False" will disabled the component
+ * @param modifier: optional [Modifier].
+ * @param onClick: Will be called when the user taps the chip.
+ * @param badge: the text to be displayed within the badge.
+ */
 @OptIn(ExperimentalMaterial3Api::class)
 @Composable
 fun AssistChip(