Skip to main content
196

Search Lumen

Find components, APIs, guides, and recipes.

GitHub
React Native docs
Data displayReact Native

Calendar heatmap

Shows daily activity with explicit missing dates and a numeric intensity legend.

Public APILumenCalendarHeatmapReact Native

Native example

Use Calendar heatmap

Use Gregorian date-only identities and an inclusive range of at most 3660 days. Missing days stay distinct from zero.

View captured React Native example
Calendar heatmap rendered in the Expo web renderer Lumen playground
Captured exampleExpo web renderer
tsx
<LumenCalendarHeatmap label="Daily activity" startDate="2026-08-01" endDate="2026-08-28" data={[{ date: "2026-08-01", value: 3 }]} />

Reference

Public API

The primary shared and platform-specific options exposed by LumenCalendarHeatmap.

APIValues or typeDefaultDescription
dataLumenCalendarHeatmapDatum[]RequiredDate-only identity and nullable finite value.
startDate, endDateYYYY-MM-DDRequiredInclusive range. Duplicate, invalid or out-of-range dates fail closed.
weekStartsOn0 or 10Sunday or Monday. weekdayLabels is always Sunday-indexed.
formatDate, labelsLocalized formatters and labelsPlatform defaultsFormats dates and exact measurements consistently.
showDataBooleantrueProvides the visible expandable exact values.

Native behavior

Design and accessibility

When to use it

Use Gregorian date-only identities and an inclusive range of at most 3660 days. Missing days stay distinct from zero.

Accessibility

Retains exact date and value facts, including when the visible data list is hidden.

Shared component

Available on other platforms

Apple / SwiftUIAndroid / Compose
React Native docsNative primitives