Hex city
Store revenue
€837
| Observation | Value |
|---|---|
| Soho | €98 |
| Marais | €88 |
| Mitte | €83 |
| Shoreditch | €76 |
| Kreuzberg | €69 |
| Jordaan | €64 |
| Camden | €61 |
| Pigalle | €57 |
| De Pijp | €52 |
| Bastille | €49 |
| Brixton | €44 |
| Neukölln | €38 |
| Belleville | €31 |
| Noord | €27 |
Usage
Import the component and the stylesheet once. See Getting started to install the package.
import { HexCityCard } from '@lilt-ui/charts';
import '@lilt-ui/charts/styles.css';<HexCityCard title="Store revenue" data={storeRevenue} label="store" value="revenue" group="region" />Omit title to leave out the visible title. Set header={false} to remove the whole header, and use aria-label to name a chart inside your own card. legend={false} removes the legend independently. surface="ghost" controls only the visual frame. See Card composition.
Data
One row per hexagon with a unique label. By default the largest value stands in the middle and the rest spiral outward by size; arrange="order" keeps your row order instead. group colors the towers and adds a legend with the total for each group. Null stays a low slab.
const storeRevenue = [
{ store: 'Soho', region: 'London', revenue: 98 },
{ store: 'Mitte', region: 'Berlin', revenue: 83 },
// …one row per store
];Props
Every prop HexCityCard accepts, in the order you are likely to reach for them.
| Prop | Type | Description |
|---|---|---|
title | string | Optional visible title. Omit to render no title. Also supplies the accessible name unless aria-label is set. |
header | boolean | Defaults to true. False removes the whole header: title, headline, delta and period controls, with no reserved space. Pass data directly when your app owns period selection. |
aria-label | string | Accessible chart name, independent of the visible title. Falls back to title, then a generic chart name. |
data | Row[] | One row per observation. Omit when using ranges. |
height | number | Minimum plot height, default 260. Dense lanes expand to keep every mark visible. |
depth | boolean | Lit tiles, solid bars, or spheres. Data positions remain exact; loading keeps the same depth treatment. |
color | string | Override the palette with one CSS color. |
aggregate | 'sum' | 'mean' | 'max' | Resting headline summary; Strip defaults to mean, the others to sum. |
headline | number | Override the resting headline. |
delta | number | Fractional change shown alongside the headline. |
deltaTone | 'default' | 'inverse' | 'neutral' | Use inverse when a decrease is good. |
range | string | Static period label. |
ranges | { id, label, data, headline?, delta? }[] | Period choices with their own data. |
defaultRange | string | Initial period id. |
locale | string | Locale for numbers and dates; defaults to en-US. |
formatValue | (value: number) => string | Custom value formatter. |
badge | ReactNode | Content for the glass tab above the card. |
className | string | Class on the card frame. |
style | CSSProperties | ChartStyle | Inline styles and scoped chart variables. |
onSelectionChange | (selection | null) => void | Reports id, original row (or null for an absent day), value, and pinned state. |
renderReadout | (selection | null) => ReactNode | Consumer-owned readout, including when the header is hidden. |
valueFormat | Intl.NumberFormatOptions | Formats the headline, tiles, and axis, e.g. currency. |
surface | 'elevated' | 'outline' | 'ghost' | Card treatment. Ghost removes the visual frame only; header and legend are independent controls. |
palette | 'iris' | 'cobalt' | 'emerald' | Series colors. Iris by default; explicit series colors still win. |
numberStyle | 'count' | 'pop' | 'slide' | 'roll' | 'flow' | 'scramble' | How the headline animates when its value changes. Count (default) counts to the new value. |
loading | boolean | Shows a neutral loading skeleton, not data. |
loadingStyle | 'shimmer' | 'draw' | 'breathe' | Shimmer sweeps a highlight over still shapes; draw reveals them in order; breathe lets them settle. Follows the selected look, including depth, and respects reduced motion. |
empty | 'dots' | 'shape' | ReactElement | null | What the card shows when the period has no data. Dots (default) gathers a quiet dot field around the message; shape lays the chart’s own outline behind it. Pass `<ChartEmpty>` with your own words, any element of your own, or null for nothing. Both looks stay still, so empty never reads as loading, and the headline reads a dash, never zero. |
motion | 'auto' | 'none' | None turns off decorative motion; reduced motion does this automatically. |
label | text key of Row | Unique name for each hexagon. |
value | numeric key of Row | Tower height and headline. |
group | text key of Row | Colors towers by category and adds the legend. |
arrange | 'rank' | 'order' | Largest in the middle (default) or your row order. |
rise | number | How many hexagon widths the largest value rises, default 2. |
gap | number | Space between hexagons as a share of their size, default 0.12. |
legend | false | 'tiles' | 'inline' | 'list' | 'pills' | 'bars' | Group legend layout when group is set. Defaults to tiles. |
domain | [number, number] | Fixed value domain that must contain every value. Defaults to zero through the largest. |
onKeyDown | KeyboardEventHandler<HTMLElement> | Keyboard handler on the card frame. Chart inspection also has its own keyboard handling. |