Skip to content
Binary Dreams UI Kit reference CalendarHeatmap

Calendar heatmap

Daily calendar values with distinct zero and missing states.

Loading interactive example

Use CalendarHeatmap for daily activity over an inclusive ISO date range. Supply UTC calendar dates and keep missing values null; zero means a measured zero. Provide localized day descriptions and an accessible label for the chart and its expandable data table. The component does not fetch data.

API

MemberTypeKindRequiredDefault
describeDay(date: string, value: number | null) => stringcallbackNoundefined
endstringpropYes
labelstringpropYes
localestringpropNoundefined
startstringpropYes
valuesCalendarHeatmapValue[]propYes

Source

Loading source