paletteon-core/dev.teogor.paletteon

Package-level declarations

Types

Contrast

enum Contrast : Enum<Contrast>

Represents different levels of contrast for UI components.

MutablePaletteonConfig

class MutablePaletteonConfig : PaletteonConfig

Mutable implementation of PaletteonConfig to allow changes to configuration settings.

PaletteonConfig

interface PaletteonConfig

Interface for managing Paletteon configuration settings.

PaletteonDsl

@DslMarker

annotation class PaletteonDsl

PaletteonTheme

@Immutable

data class PaletteonTheme(val seedColor: Color = Color.Blue, val useDarkTheme: Boolean = false, val withAmoled: Boolean = false, val style: PaletteStyle = PaletteStyle.TonalSpot, val contrast: Contrast = Contrast.Default, val isExtendedFidelity: Boolean = false, val modifyColorScheme: PaletteonTheme.(ColorScheme) -> ColorScheme? = null)

Data class representing the theme configuration for Paletteon.

PaletteStyle

enum PaletteStyle : Enum<PaletteStyle>

Represents different styles for generating color palettes, aligned with Variant in the Material Design guidelines.

Properties

onSuccess

@get:Composable

val ColorScheme.onSuccess: Color

Returns the on-success color from the current ColorScheme.

onSuccessContainer

@get:Composable

val ColorScheme.onSuccessContainer: Color

Returns the on-success container color from the current ColorScheme.

onWarning

@get:Composable

val ColorScheme.onWarning: Color

Returns the on-warning color from the current ColorScheme.

onWarningContainer

@get:Composable

val ColorScheme.onWarningContainer: Color

Returns the on-warning container color from the current ColorScheme.

success

@get:Composable

val ColorScheme.success: Color

Returns the success color from the current ColorScheme.

successContainer

@get:Composable

val ColorScheme.successContainer: Color

Returns the success container color from the current ColorScheme.

warning

@get:Composable

val ColorScheme.warning: Color

Returns the warning color from the current ColorScheme.

warningContainer

@get:Composable

val ColorScheme.warningContainer: Color

Returns the warning container color from the current ColorScheme.

Functions

configurePaletteonTheme

@Composable

fun configurePaletteonTheme(block: PaletteonTheme.Builder.() -> Unit)

Configures the current PaletteonTheme using a DSL-style builder.

fun configurePaletteonTheme(theme: PaletteonTheme, block: PaletteonTheme.Builder.() -> Unit): PaletteonTheme

Configures a new PaletteonTheme using a DSL-style builder.

paletteonColorScheme

fun paletteonColorScheme(seedColor: Color, isDark: Boolean, isAmoled: Boolean, style: PaletteStyle = PaletteStyle.TonalSpot, contrast: Contrast = Contrast.Default, isExtendedFidelity: Boolean = false, modifyColorScheme: (ColorScheme) -> ColorScheme? = null): ColorScheme

Creates a ColorScheme based on the given seedColor and isDark mode.

PaletteonDynamicTheme

@Composable

fun PaletteonDynamicTheme(seedColor: Color, useDarkTheme: Boolean = isSystemInDarkTheme(), withAmoled: Boolean = false, style: PaletteStyle = PaletteStyle.TonalSpot, contrast: Contrast = Contrast.Default, isExtendedFidelity: Boolean = false, shapes: Shapes = MaterialTheme.shapes, typography: Typography = MaterialTheme.typography, animate: Boolean = false, animationSpec: AnimationSpec<Color> = spring(stiffness = Spring.StiffnessLow), content: @Composable () -> Unit)

A custom theme based on Paletteon, which adapts to the provided seed color and other configuration parameters.

rememberColorForRole

@Composable

fun rememberColorForRole(colorRole: MaterialDynamicColors.() -> DynamicColor): Color

Remembers and returns a Color associated with a specific DynamicColor role.

rememberPaletteonColorScheme

@Composable

fun rememberPaletteonColorScheme(seedColor: Color, isDark: Boolean, isAmoled: Boolean = false, style: PaletteStyle = PaletteStyle.TonalSpot, contrast: Contrast = Contrast.Default, isExtendedFidelity: Boolean = false, modifyColorScheme: (ColorScheme) -> ColorScheme? = null): ColorScheme

Creates and remember a ColorScheme based on the given seedColor and isDark mode.