material-kolor/com.materialkolor

Package-level declarations

Types

Link copied to clipboard
Link copied to clipboard
@Stable
class DynamicMaterialThemeState

State object that holds the current values for a dynamic material theme.

Link copied to clipboard
class MaterialKolors(scheme: DynamicScheme, isAmoled: Boolean = false)

A class that provides various color functions based on the given dynamic scheme.

Link copied to clipboard
enum PaletteStyle : Enum<PaletteStyle>

The style of the palette to generate.

Properties

Link copied to clipboard
val LocalDynamicMaterialThemeSeed: ProvidableCompositionLocal<Color>

LocalDynamicMaterialThemeSeed is a CompositionLocal that provides the seed color for the dynamic material theme.

Functions

Link copied to clipboard
fun dynamicColorScheme(primary: Color, isDark: Boolean, isAmoled: Boolean = false, secondary: Color? = null, tertiary: Color? = null, neutral: Color? = null, neutralVariant: Color? = null, error: Color? = null, style: PaletteStyle = PaletteStyle.TonalSpot, contrastLevel: Double = Contrast.Default.value, specVersion: ColorSpec.SpecVersion = ColorSpec.SpecVersion.Default, platform: DynamicScheme.Platform = DynamicScheme.Platform.Default, modifyColorScheme: (ColorScheme) -> ColorScheme? = null): ColorScheme

Create a custom ColorScheme based on the provided colors. Uses primary as the seed color.

fun dynamicColorScheme(seedColor: Color, isDark: Boolean, isAmoled: Boolean = false, primary: Color? = null, secondary: Color? = null, tertiary: Color? = null, neutral: Color? = null, neutralVariant: Color? = null, error: Color? = null, style: PaletteStyle = PaletteStyle.TonalSpot, contrastLevel: Double = Contrast.Default.value, specVersion: ColorSpec.SpecVersion = ColorSpec.SpecVersion.Default, platform: DynamicScheme.Platform = DynamicScheme.Platform.Default, modifyColorScheme: (ColorScheme) -> ColorScheme? = null): ColorScheme

Create a custom ColorScheme based on the provided colors.

Link copied to clipboard
@Composable
fun DynamicMaterialTheme(state: DynamicMaterialThemeState, shapes: Shapes = MaterialTheme.shapes, typography: Typography = MaterialTheme.typography, animate: Boolean = false, animationSpec: FiniteAnimationSpec<Color> = defaultColorSpring, content: @Composable () -> Unit)

A Material Theme that adapts to the given DynamicMaterialThemeState.seedColor.

@Composable
fun DynamicMaterialTheme(primary: Color, isDark: Boolean = isSystemInDarkTheme(), isAmoled: Boolean = false, secondary: Color? = null, tertiary: Color? = null, neutral: Color? = null, neutralVariant: Color? = null, error: Color? = null, style: PaletteStyle = PaletteStyle.TonalSpot, contrastLevel: Double = Contrast.Default.value, specVersion: ColorSpec.SpecVersion = ColorSpec.SpecVersion.Default, platform: DynamicScheme.Platform = DynamicScheme.Platform.Default, shapes: Shapes = MaterialTheme.shapes, typography: Typography = MaterialTheme.typography, animate: Boolean = false, animationSpec: FiniteAnimationSpec<Color> = defaultColorSpring, content: @Composable () -> Unit)
@Composable
fun DynamicMaterialTheme(seedColor: Color, isDark: Boolean = isSystemInDarkTheme(), isAmoled: Boolean = false, primary: Color? = null, secondary: Color? = null, tertiary: Color? = null, neutral: Color? = null, neutralVariant: Color? = null, error: Color? = null, style: PaletteStyle = PaletteStyle.TonalSpot, contrastLevel: Double = Contrast.Default.value, specVersion: ColorSpec.SpecVersion = ColorSpec.SpecVersion.Default, platform: DynamicScheme.Platform = DynamicScheme.Platform.Default, shapes: Shapes = MaterialTheme.shapes, typography: Typography = MaterialTheme.typography, animate: Boolean = false, animationSpec: FiniteAnimationSpec<Color> = defaultColorSpring, content: @Composable () -> Unit)

A Material Theme that adapts to the given seed color and the provided custom colors.

Link copied to clipboard
@Composable
fun rememberDynamicColorScheme(primary: Color, isDark: Boolean, isAmoled: Boolean = false, secondary: Color? = null, tertiary: Color? = null, neutral: Color? = null, neutralVariant: Color? = null, error: Color? = null, style: PaletteStyle = PaletteStyle.TonalSpot, contrastLevel: Double = Contrast.Default.value, specVersion: ColorSpec.SpecVersion = ColorSpec.SpecVersion.Default, platform: DynamicScheme.Platform = DynamicScheme.Platform.Default, modifyColorScheme: (ColorScheme) -> ColorScheme? = null): ColorScheme

Create and remember a custom ColorScheme based on the provided colors. Uses primary as the seed color.

@Composable
fun rememberDynamicColorScheme(seedColor: Color, isDark: Boolean, isAmoled: Boolean = false, primary: Color? = null, secondary: Color? = null, tertiary: Color? = null, neutral: Color? = null, neutralVariant: Color? = null, error: Color? = null, style: PaletteStyle = PaletteStyle.TonalSpot, contrastLevel: Double = Contrast.Default.value, specVersion: ColorSpec.SpecVersion = ColorSpec.SpecVersion.Default, platform: DynamicScheme.Platform = DynamicScheme.Platform.Default, modifyColorScheme: (ColorScheme) -> ColorScheme? = null): ColorScheme

Create and remember a custom ColorScheme based on the provided colors.

Link copied to clipboard
@Composable
fun rememberDynamicMaterialThemeState(primary: Color, isDark: Boolean, isAmoled: Boolean = false, secondary: Color? = null, tertiary: Color? = null, neutral: Color? = null, neutralVariant: Color? = null, error: Color? = null, style: PaletteStyle = PaletteStyle.TonalSpot, contrastLevel: Double = Contrast.Default.value, specVersion: ColorSpec.SpecVersion = ColorSpec.SpecVersion.Default, platform: DynamicScheme.Platform = DynamicScheme.Platform.Default, modifyColorScheme: DynamicMaterialThemeState.(ColorScheme) -> ColorScheme? = null): DynamicMaterialThemeState
@Composable
fun rememberDynamicMaterialThemeState(seedColor: Color, isDark: Boolean, isAmoled: Boolean = false, primary: Color? = null, secondary: Color? = null, tertiary: Color? = null, neutral: Color? = null, neutralVariant: Color? = null, error: Color? = null, style: PaletteStyle = PaletteStyle.TonalSpot, contrastLevel: Double = Contrast.Default.value, specVersion: ColorSpec.SpecVersion = ColorSpec.SpecVersion.Default, platform: DynamicScheme.Platform = DynamicScheme.Platform.Default, modifyColorScheme: DynamicMaterialThemeState.(ColorScheme) -> ColorScheme? = null): DynamicMaterialThemeState

Creates a DynamicMaterialThemeState that can be remembered across compositions using custom colors.

Link copied to clipboard
fun DynamicScheme.toColorScheme(isAmoled: Boolean = false, modifyColorScheme: (ColorScheme) -> ColorScheme? = null): ColorScheme

Create the actual ColorScheme based on the given DynamicScheme.