diff --git a/flexiui-core/src/commonMain/kotlin/com/highcapable/flexiui/Colors.kt b/flexiui-core/src/commonMain/kotlin/com/highcapable/flexiui/Colors.kt index cc09bee..4850f0b 100644 --- a/flexiui-core/src/commonMain/kotlin/com/highcapable/flexiui/Colors.kt +++ b/flexiui-core/src/commonMain/kotlin/com/highcapable/flexiui/Colors.kt @@ -335,6 +335,7 @@ private val BlueBlackColors = Colors( * Returns a default color scheme. * @param darkMode whether to use dark mode color scheme. * @param blackDarkMode requires [darkMode] is true, whether to use a pure black mode scheme. + * @return [Colors] */ fun defaultColors(darkMode: Boolean = false, blackDarkMode: Boolean = false) = when { darkMode -> if (blackDarkMode) DefaultBlackColors else DefaultDarkColors @@ -345,6 +346,7 @@ fun defaultColors(darkMode: Boolean = false, blackDarkMode: Boolean = false) = w * Returns a red color scheme. * @param darkMode whether to use dark mode color scheme. * @param blackDarkMode requires [darkMode] is true, whether to use a pure black mode scheme. + * @return [Colors] */ fun redColors(darkMode: Boolean = false, blackDarkMode: Boolean = false) = when { darkMode -> if (blackDarkMode) RedBlackColors else RedDarkColors @@ -355,6 +357,7 @@ fun redColors(darkMode: Boolean = false, blackDarkMode: Boolean = false) = when * Returns a pink color scheme. * @param darkMode whether to use dark mode color scheme. * @param blackDarkMode requires [darkMode] is true, whether to use a pure black mode scheme. + * @return [Colors] */ fun pinkColors(darkMode: Boolean = false, blackDarkMode: Boolean = false) = when { darkMode -> if (blackDarkMode) PinkBlackColors else PinkDarkColors @@ -365,6 +368,7 @@ fun pinkColors(darkMode: Boolean = false, blackDarkMode: Boolean = false) = when * Returns a purple color scheme. * @param darkMode whether to use dark mode color scheme. * @param blackDarkMode requires [darkMode] is true, whether to use a pure black mode scheme. + * @return [Colors] */ fun purpleColors(darkMode: Boolean = false, blackDarkMode: Boolean = false) = when { darkMode -> if (blackDarkMode) PurpleBlackColors else PurpleDarkColors @@ -375,6 +379,7 @@ fun purpleColors(darkMode: Boolean = false, blackDarkMode: Boolean = false) = wh * Returns a orange color scheme. * @param darkMode whether to use dark mode color scheme. * @param blackDarkMode requires [darkMode] is true, whether to use a pure black mode scheme. + * @return [Colors] */ fun orangeColors(darkMode: Boolean = false, blackDarkMode: Boolean = false) = when { darkMode -> if (blackDarkMode) OrangeBlackColors else OrangeDarkColors @@ -385,6 +390,7 @@ fun orangeColors(darkMode: Boolean = false, blackDarkMode: Boolean = false) = wh * Returns a yellow color scheme. * @param darkMode whether to use dark mode color scheme. * @param blackDarkMode requires [darkMode] is true, whether to use a pure black mode scheme. + * @return [Colors] */ fun yellowColors(darkMode: Boolean = false, blackDarkMode: Boolean = false) = when { darkMode -> if (blackDarkMode) YellowBlackColors else YellowDarkColors @@ -395,6 +401,7 @@ fun yellowColors(darkMode: Boolean = false, blackDarkMode: Boolean = false) = wh * Returns a green color scheme. * @param darkMode whether to use dark mode color scheme. * @param blackDarkMode requires [darkMode] is true, whether to use a pure black mode scheme. + * @return [Colors] */ fun greenColors(darkMode: Boolean = false, blackDarkMode: Boolean = false) = when { darkMode -> if (blackDarkMode) GreenBlackColors else GreenDarkColors @@ -405,6 +412,7 @@ fun greenColors(darkMode: Boolean = false, blackDarkMode: Boolean = false) = whe * Returns a blue color scheme. * @param darkMode whether to use dark mode color scheme. * @param blackDarkMode requires [darkMode] is true, whether to use a pure black mode scheme. + * @return [Colors] */ fun blueColors(darkMode: Boolean = false, blackDarkMode: Boolean = false) = when { darkMode -> if (blackDarkMode) BlueBlackColors else BlueDarkColors diff --git a/flexiui-core/src/commonMain/kotlin/com/highcapable/flexiui/SystemColors.kt b/flexiui-core/src/commonMain/kotlin/com/highcapable/flexiui/SystemColors.kt index 3989c78..f613a7e 100644 --- a/flexiui-core/src/commonMain/kotlin/com/highcapable/flexiui/SystemColors.kt +++ b/flexiui-core/src/commonMain/kotlin/com/highcapable/flexiui/SystemColors.kt @@ -47,6 +47,7 @@ expect fun isSystemColorAvailable(): Boolean * You can use [isSystemColorAvailable] check it first, otherwise it will return default colors. * @param darkMode whether to use dark mode color scheme. * @param blackDarkMode requires [darkMode] is true, whether to use a pure black mode scheme. + * @return [Colors] */ @Composable fun systemColors(darkMode: Boolean = false, blackDarkMode: Boolean = false) = when { diff --git a/flexiui-core/src/commonMain/kotlin/com/highcapable/flexiui/component/Tab.kt b/flexiui-core/src/commonMain/kotlin/com/highcapable/flexiui/component/Tab.kt index fa3c39e..53e9348 100644 --- a/flexiui-core/src/commonMain/kotlin/com/highcapable/flexiui/component/Tab.kt +++ b/flexiui-core/src/commonMain/kotlin/com/highcapable/flexiui/component/Tab.kt @@ -356,6 +356,7 @@ interface TabRowScope { /** * [Modifier] that offsets the tab indicator. + * @receiver [Modifier] * @param currentTabPosition the current tab position. * @param indicatorWidth the indicator width. */ @@ -386,6 +387,7 @@ interface TabRowScope { /** * [Modifier] that offsets the pager tab indicator. + * @receiver [Modifier] * @param pagerState the pager state. * @param tabPositions the tab positions. * @param indicatorWidth the indicator width. diff --git a/flexiui-core/src/commonMain/kotlin/com/highcapable/flexiui/interaction/Interaction.kt b/flexiui-core/src/commonMain/kotlin/com/highcapable/flexiui/interaction/Interaction.kt index 033b20d..9cdcf0b 100644 --- a/flexiui-core/src/commonMain/kotlin/com/highcapable/flexiui/interaction/Interaction.kt +++ b/flexiui-core/src/commonMain/kotlin/com/highcapable/flexiui/interaction/Interaction.kt @@ -68,6 +68,7 @@ fun rememberRipple(style: RippleStyle = InteractionDefaults.rippleStyle) = /** * The clickable modifier has a ripple effect. * @see Modifier.clickable + * @receiver [Modifier] * @param rippleStyle the ripple style, default is [InteractionDefaults.rippleStyle]. * @param interactionSource the interaction source. * @param enabled whether to enable the event, default is true. @@ -108,6 +109,7 @@ fun Modifier.rippleClickable( /** * The combined clickable modifier has a ripple effect. * @see Modifier.combinedClickable + * @receiver [Modifier] * @param rippleStyle the ripple style, default is [InteractionDefaults.rippleStyle]. * @param interactionSource the interaction source. * @param enabled whether to enable the event, default is true. @@ -160,6 +162,7 @@ fun Modifier.rippleCombinedClickable( /** * The toggleable modifier has a ripple effect. * @see Modifier.toggleable + * @receiver [Modifier] * @param rippleStyle the ripple style, default is [InteractionDefaults.rippleStyle]. * @param interactionSource the interaction source. * @param enabled whether to enable the event, default is true. @@ -199,6 +202,7 @@ fun Modifier.rippleToggleable( /** * The selectable modifier has a ripple effect. * @see Modifier.selectable + * @receiver [Modifier] * @param rippleStyle the ripple style, default is [InteractionDefaults.rippleStyle]. * @param interactionSource the interaction source. * @param enabled whether to enable the event, default is true.