BetterAndroid/FlexiUI
5
0
Fork 0
mirror of https://github.com/BetterAndroid/FlexiUI.git synced 2025-09-08 19:44:25 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: some tweaks in Colors

Browse Source
This commit is contained in:
fankesyooni
2024-01-06 12:59:56 +08:00
parent 824f7be99f
commit a713ae44a3
1 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
flexiui-core/src/commonMain/kotlin/com/highcapable/flexiui/Colors.kt
View File

@@ -358,7 +358,7 @@ expect fun isDynamicColorAvailable(): Boolean
* *
* You can use [isDynamicColorAvailable] check it first, otherwise it will return default colors. * You can use [isDynamicColorAvailable] check it first, otherwise it will return default colors.
* @param darkMode whether to use dark mode color scheme. * @param darkMode whether to use dark mode color scheme.
* @param blackDarkMode requires [darkMode] is true, whether to use a pure black color scheme. * @param blackDarkMode requires [darkMode] is true, whether to use a pure black mode scheme.
*/ */
@Composable @Composable
@ReadOnlyComposable @ReadOnlyComposable
@@ -370,7 +370,7 @@ fun dynamicColors(darkMode: Boolean = false, blackDarkMode: Boolean = false) = w
/** /**
* Returns a default color scheme. * Returns a default color scheme.
* @param darkMode whether to use dark mode color scheme. * @param darkMode whether to use dark mode color scheme.
* @param blackDarkMode requires [darkMode] is true, whether to use a pure black color scheme. * @param blackDarkMode requires [darkMode] is true, whether to use a pure black mode scheme.
*/ */
fun defaultColors(darkMode: Boolean = false, blackDarkMode: Boolean = false) = when { fun defaultColors(darkMode: Boolean = false, blackDarkMode: Boolean = false) = when {
darkMode -> if (blackDarkMode) DefaultBlackColors else DefaultDarkColors darkMode -> if (blackDarkMode) DefaultBlackColors else DefaultDarkColors
@@ -380,7 +380,7 @@ fun defaultColors(darkMode: Boolean = false, blackDarkMode: Boolean = false) = w
/** /**
* Returns a red color scheme. * Returns a red color scheme.
* @param darkMode whether to use dark mode color scheme. * @param darkMode whether to use dark mode color scheme.
* @param blackDarkMode requires [darkMode] is true, whether to use a pure black color scheme. * @param blackDarkMode requires [darkMode] is true, whether to use a pure black mode scheme.
*/ */
fun redColors(darkMode: Boolean = false, blackDarkMode: Boolean = false) = when { fun redColors(darkMode: Boolean = false, blackDarkMode: Boolean = false) = when {
darkMode -> if (blackDarkMode) RedBlackColors else RedDarkColors darkMode -> if (blackDarkMode) RedBlackColors else RedDarkColors
@@ -390,7 +390,7 @@ fun redColors(darkMode: Boolean = false, blackDarkMode: Boolean = false) = when
/** /**
* Returns a pink color scheme. * Returns a pink color scheme.
* @param darkMode whether to use dark mode color scheme. * @param darkMode whether to use dark mode color scheme.
* @param blackDarkMode requires [darkMode] is true, whether to use a pure black color scheme. * @param blackDarkMode requires [darkMode] is true, whether to use a pure black mode scheme.
*/ */
fun pinkColors(darkMode: Boolean = false, blackDarkMode: Boolean = false) = when { fun pinkColors(darkMode: Boolean = false, blackDarkMode: Boolean = false) = when {
darkMode -> if (blackDarkMode) PinkBlackColors else PinkDarkColors darkMode -> if (blackDarkMode) PinkBlackColors else PinkDarkColors
@@ -400,7 +400,7 @@ fun pinkColors(darkMode: Boolean = false, blackDarkMode: Boolean = false) = when
/** /**
* Returns a purple color scheme. * Returns a purple color scheme.
* @param darkMode whether to use dark mode color scheme. * @param darkMode whether to use dark mode color scheme.
* @param blackDarkMode requires [darkMode] is true, whether to use a pure black color scheme. * @param blackDarkMode requires [darkMode] is true, whether to use a pure black mode scheme.
*/ */
fun purpleColors(darkMode: Boolean = false, blackDarkMode: Boolean = false) = when { fun purpleColors(darkMode: Boolean = false, blackDarkMode: Boolean = false) = when {
darkMode -> if (blackDarkMode) PurpleBlackColors else PurpleDarkColors darkMode -> if (blackDarkMode) PurpleBlackColors else PurpleDarkColors
@@ -410,7 +410,7 @@ fun purpleColors(darkMode: Boolean = false, blackDarkMode: Boolean = false) = wh
/** /**
* Returns a orange color scheme. * Returns a orange color scheme.
* @param darkMode whether to use dark mode color scheme. * @param darkMode whether to use dark mode color scheme.
* @param blackDarkMode requires [darkMode] is true, whether to use a pure black color scheme. * @param blackDarkMode requires [darkMode] is true, whether to use a pure black mode scheme.
*/ */
fun orangeColors(darkMode: Boolean = false, blackDarkMode: Boolean = false) = when { fun orangeColors(darkMode: Boolean = false, blackDarkMode: Boolean = false) = when {
darkMode -> if (blackDarkMode) OrangeBlackColors else OrangeDarkColors darkMode -> if (blackDarkMode) OrangeBlackColors else OrangeDarkColors
@@ -420,7 +420,7 @@ fun orangeColors(darkMode: Boolean = false, blackDarkMode: Boolean = false) = wh
/** /**
* Returns a yellow color scheme. * Returns a yellow color scheme.
* @param darkMode whether to use dark mode color scheme. * @param darkMode whether to use dark mode color scheme.
* @param blackDarkMode requires [darkMode] is true, whether to use a pure black color scheme. * @param blackDarkMode requires [darkMode] is true, whether to use a pure black mode scheme.
*/ */
fun yellowColors(darkMode: Boolean = false, blackDarkMode: Boolean = false) = when { fun yellowColors(darkMode: Boolean = false, blackDarkMode: Boolean = false) = when {
darkMode -> if (blackDarkMode) YellowBlackColors else YellowDarkColors darkMode -> if (blackDarkMode) YellowBlackColors else YellowDarkColors
@@ -430,7 +430,7 @@ fun yellowColors(darkMode: Boolean = false, blackDarkMode: Boolean = false) = wh
/** /**
* Returns a green color scheme. * Returns a green color scheme.
* @param darkMode whether to use dark mode color scheme. * @param darkMode whether to use dark mode color scheme.
* @param blackDarkMode requires [darkMode] is true, whether to use a pure black color scheme. * @param blackDarkMode requires [darkMode] is true, whether to use a pure black mode scheme.
*/ */
fun greenColors(darkMode: Boolean = false, blackDarkMode: Boolean = false) = when { fun greenColors(darkMode: Boolean = false, blackDarkMode: Boolean = false) = when {
darkMode -> if (blackDarkMode) GreenBlackColors else GreenDarkColors darkMode -> if (blackDarkMode) GreenBlackColors else GreenDarkColors
@@ -440,7 +440,7 @@ fun greenColors(darkMode: Boolean = false, blackDarkMode: Boolean = false) = whe
/** /**
* Returns a blue color scheme. * Returns a blue color scheme.
* @param darkMode whether to use dark mode color scheme. * @param darkMode whether to use dark mode color scheme.
* @param blackDarkMode requires [darkMode] is true, whether to use a pure black color scheme. * @param blackDarkMode requires [darkMode] is true, whether to use a pure black mode scheme.
*/ */
fun blueColors(darkMode: Boolean = false, blackDarkMode: Boolean = false) = when { fun blueColors(darkMode: Boolean = false, blackDarkMode: Boolean = false) = when {
darkMode -> if (blackDarkMode) BlueBlackColors else BlueDarkColors darkMode -> if (blackDarkMode) BlueBlackColors else BlueDarkColors