Scatter Chart
Two-axis scatter. Default and Motion variants.
Examples
Installation
Default is a ready-made wrapper from the registry. Motion is the composable engine at @cronus-ui/ui/charts (peer visx + motion).
npx cronus-ui add scatter-chart
import { ScatterChart } from "@cronus-ui/ui";
Usage
import { ScatterChart, Scatter, Grid, XAxis, YAxis, ChartTooltip } from "@cronus-ui/ui/charts";<ScatterChart data={data}><Grid horizontal vertical /><Scatter dataKey="alpha" /><Scatter dataKey="beta" /><XAxis /><YAxis /><ChartTooltip /></ScatterChart>
Components
Motion API — compose these under the chart root. Default wrapper props are in Default API below.
ScatterChart
Root that sizes the SVG, provides scales, and hosts series children.
| Prop | Type | Default | Description |
|---|---|---|---|
data* | Record<string, unknown>[] | — | Rows with a date (or x) field and numeric series. |
xDataKey | string | "date" | Key for the x-axis. |
margin | `Partial<{ top, right, bottom, left }>` | { top: 40, right: 40, bottom: 40, left: 40 } | Plot margins. |
animationDuration | number | 1100 | Clip-reveal duration in ms. |
aspectRatio | string | "2 / 1" | CSS aspect ratio. |
status | "loading" | "ready" | "ready" | Loading ↔ ready choreography. |
xDomain | [Date, Date] | — | Visible x-range for brush zoom. |
className | string | — | Container class. |
Scatter
One series of points. Optional y-gradient, hover fade, ring style.
| Prop | Type | Default | Description |
|---|---|---|---|
dataKey* | string | — | Y-value key. |
fill | string | — | Point fill. Defaults to --chart-1…5 by series order. |
radius | number | 5 | Point radius. |
yGradient | boolean | { from, to } | — | Color by vertical position. |
fadeOnHover | boolean | true | Dim inactive points. |
Grid
Plot-area grid lines. Horizontal by default; optional shimmer while loading.
| Prop | Type | Default | Description |
|---|---|---|---|
horizontal | boolean | true | Show horizontal lines. |
vertical | boolean | false | Show vertical lines. |
numTicksRows | number | 5 | Horizontal line count. |
numTicksColumns | number | 10 | Vertical line count. |
stroke | string | var(--chart-grid) | Line color while ready. |
strokeDasharray | string | "4,4" | Dash pattern. |
shimmer | boolean | false | Animate a band across horizontal lines. |
highlightRowValues | number[] | — | Rows drawn with alternate styling (e.g. zero). |
XAxis
Time-axis labels that fade when the crosshair passes.
| Prop | Type | Default | Description |
|---|---|---|---|
numTicks | number | 5 | Tick labels to show, including first and last. |
tickerHalfWidth | number | 50 | Fade radius around the date pill. |
tickMode | "data" | "domain" | "data" | `data` snaps labels to rows (crosshair-aligned). `domain` spaces ticks evenly. |
YAxis
Value labels on the left or right. Pair `yAxisId` with series for dual axes.
| Prop | Type | Default | Description |
|---|---|---|---|
yAxisId | string | number | "left" | Scale group id. |
orientation | "left" | "right" | "left" | Which side to render. |
numTicks | number | 5 | Approximate tick count. |
formatLargeNumbers | boolean | true | Format 1000 as "1k". |
formatValue | (value: number) => string | — | Custom tick formatter. Overrides formatLargeNumbers. |
ChartTooltip
Motion tooltip: crosshair, series dots, floating panel, optional date pill. This is not the recharts ChartTooltip from `@cronus-ui/ui`.
| Prop | Type | Default | Description |
|---|---|---|---|
showDatePill | boolean | true | Animated date ticker on the x-axis. |
showCrosshair | boolean | true | Vertical crosshair. |
showDots | boolean | true | Dots on series at the hovered x. |
dotVariant | "dot" | "ring" | "dot" | Filled circle or ring. |
indicatorColor | string | (point) => string | — | Crosshair and dot color. |
indicatorDasharray | string | — | Dash pattern for the crosshair. |
indicatorFadeEdges | "both" | "top" | "bottom" | "none" | "both" | Vertical crosshair fade. |
matchCrosshair | boolean | false | Panel uses the crosshair spring when true. |
damping | number | 20 | Panel follow when matchCrosshair is false. 0 = instant. |
content | (props) => ReactNode | — | Custom tooltip renderer. |
rows | (point) => TooltipRow[] | — | Custom row generator. |
Y gradient
yGradient colors each dot by its vertical position. Default stops are danger (low) → success (high).
<Scatter dataKey="score" yGradient /><Scatter dataKey="score" yGradient={{ from: "var(--cronus-danger)", to: "var(--cronus-success)" }} />
Data format
const data = [{ date: new Date("2025-01-01"), alpha: 12, beta: 18 },{ date: new Date("2025-02-01"), alpha: 19, beta: 14 },];
Theming
Motion charts read `--chart-*` aliases that map onto Cronus semantic tokens (`--cronus-chart-1`…`--cronus-chart-5`, `--cronus-border`, `--cronus-fg`, surfaces). Override the aliases or the tokens — never palette scales (`bg-zinc-900`). Default wrappers use `ChartConfig` with `var(--cronus-chart-*)` / `var(--cronus-primary)`.
Full token reference: Theming.
Dependencies
Default needs the recharts peer. Motion needs visx (and sometimes d3) as optional peers — install only what this chart uses.
bun add recharts
bun add @visx/curve @visx/responsive @visx/scale @visx/shape motion react-use-measure
Default API
Generated from the Default wrapper's exported types. Motion subcomponents are documented above.
ScatterChartProps
Extends HTMLAttributes<HTMLDivElement>
| Prop | Type | Default | Description |
|---|---|---|---|
xKey | string | "x" | — |
yKey | string | "y" | — |
series* | ScatterChartSeries[] | — | — |