Block city

Taller and darker: more · Grey: no data

Sales by region
Observation	Value
Jan · North	$20
Feb · North	$66
Mar · North	$34
Apr · North	$80
May · North	$48
Jun · North	$94
Jul · North	$62
Aug · North	$108
Jan · East	$86
Feb · East	$54
Mar · East	$100
Apr · East	$68
May · East	$36
Jun · East	$82
Jul · East	$50
Aug · East	$96
Jan · South	$74
Feb · South	$42
Mar · South	$88
Apr · South	$56
May · South	$102
Jun · South	$70
Jul · South	$116
Aug · South	$84
Jan · West	$62
Feb · West	$30
Mar · West	$76
Apr · West	$44
May · West	$90
Jun · West	$58
Jul · West	$104
Aug · West	$72

Usage

Import the component and the stylesheet once. See Getting started to install the package.

import { BlockCityCard } from '@lilt-ui/charts';
import '@lilt-ui/charts/styles.css';

<BlockCityCard title="Sales by region" data={regionSales} x="month" y="region" value="sales" />

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. surface="ghost" controls only the visual frame. See Card composition.

Data

One row per x and y pair. Columns and rows keep the order they first appear in. A pair with no row stays a low grey slab, so a gap never reads as zero. Duplicate pairs are rejected; sum them first.

const regionSales = [
  { region: 'North', month: 'Jan', sales: 62 },
  { region: 'North', month: 'Feb', sales: 98 },
  // …one row per region and month
];

Props

Every prop BlockCityCard 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 300px. Dense data may expand within the scrollable viewport.
`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.
`x`	`text key of Row`	Columns, running away to the right.
`y`	`text key of Row`	Rows, coming toward the viewer.
`value`	`numeric key of Row`	Height, color, and headline.
`domain`	`[number, number]`	Fixed value domain that must contain every value. Defaults to zero through the largest.
`rise`	`number`	How many cell lengths the largest value rises above the floor, default 4.
`gap`	`number`	Space between neighbouring prisms as a share of a cell, 0 to 0.6, default 0.2.
`onKeyDown`	`KeyboardEventHandler<HTMLElement>`	Keyboard handler on the card frame. Chart inspection also has its own keyboard handling.

Sales by region

Observation

Value

Jan · North

$20

Feb · North

$66

Mar · North

$34

Apr · North

$80

May · North

$48

Jun · North

$94

Jul · North

$62

Aug · North

$108

Jan · East

$86

Feb · East

$54

Mar · East

$100

Apr · East

$68

May · East

$36

Jun · East

$82

Jul · East

$50

Aug · East

$96

Jan · South

$74

Feb · South

$42

Mar · South

$88

Apr · South

$56

May · South

$102

Jun · South

$70

Jul · South

$116

Aug · South

$84

Jan · West

$62

Feb · West

$30

Mar · West

$76

Apr · West

$44

May · West

$90

Jun · West

$58

Jul · West

$104

Aug · West

$72

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 300px. Dense data may expand within the scrollable viewport.

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

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.

x

text key of Row

Columns, running away to the right.

y

text key of Row

Rows, coming toward the viewer.

value

numeric key of Row

Height, color, and headline.

domain

[number, number]

Fixed value domain that must contain every value. Defaults to zero through the largest.

rise

number

How many cell lengths the largest value rises above the floor, default 4.

gap

number

Space between neighbouring prisms as a share of a cell, 0 to 0.6, default 0.2.

onKeyDown

KeyboardEventHandler<HTMLElement>

Keyboard handler on the card frame. Chart inspection also has its own keyboard handling.

Chart style

Palette

Theme

Appearance

Reading & motion

Usage

Data

Props

Chart style

Palette

Theme

Appearance

Reading & motion

Block city

Usage

Data

Props