chartycolor-over-color

name

chartycolor-over-color

description

Public color API convention for Charty — use when adding or changing any public config property, data-class field, or composable parameter that sets the color of a chart element (fill, stroke, series, segment, arc, band, needle, point), and before committing. Such colors must be typed as ChartyColor (Solid or Gradient), never a raw androidx.compose.ui.graphics.Color. Trigger on "add a config", "new chart", "expose a color", "gauge/arc/zone color".

Prefer ChartyColor over raw Color in public APIs

Charty's colors are expressed with com.himanshoe.charty.color.ChartyColor — a sealed type with Solid(color) and Gradient(colors). Every color a caller can set for a drawn chart element goes through it, so any element can be a solid or a gradient, and the API stays consistent.

Rule

A public val/parameter that colors a chart element must be ChartyColor, not Color. This covers fills, strokes, series/segment/arc/band/needle/point/zone colors — anything painted.

// Do
val fillColor: ChartyColor = ChartyColor.Solid(Color(0xFF1E88E5))
val zones: List<GaugeZone>            // where GaugeZone.color: ChartyColor

// Don't
val fillColor: Color = Color(0xFF1E88E5)

Resolve to a Brush at draw time (private helper, at the drawing site):

private fun ChartyColor.: Brush =
     () {
         ChartyColor.Solid -> SolidColor(color)
         ChartyColor.Gradient -> Brush.verticalGradient(colors)
    }