Calendar Heatmap

Installation

$ pnpm dlx shadcn-vue@latest add https://uipkge.dev/r/vue/calendar-heatmap.json

$ npx shadcn-vue@latest add https://uipkge.dev/r/vue/calendar-heatmap.json

$ yarn dlx shadcn-vue@latest add https://uipkge.dev/r/vue/calendar-heatmap.json

$ bunx shadcn-vue@latest add https://uipkge.dev/r/vue/calendar-heatmap.json

Examples

Props

Dependencies

Used by

Files (3)

• app/components/ui/charts/calendar-heatmap/CalendarHeatmap.vue 2.8 kB

  <script setup lang="ts">
  import { computed } from 'vue'
  import { use } from 'echarts/core'
  import { CanvasRenderer } from 'echarts/renderers'
  import { HeatmapChart as EChartsHeatmapChart } from 'echarts/charts'
  import { CalendarComponent, TooltipComponent, VisualMapComponent } from 'echarts/components'
  import VChart from 'vue-echarts'
  import { cn } from '@/lib/utils'
  import {
    chartColors,
    chartTextColor,
    chartSplitLineColor,
    chartTooltipBg,
    chartTooltipBorder,
    chartTooltipText,
  } from '../useChartTheme'
  
  interface Props {
    /** [date string YYYY-MM-DD, value] tuples. */
    data: [string, number][]
    range: string | [string, string]
    height?: number | string
    /** Cell colour ramp [from, to] - default: chart-1 from light to saturated. */
    colorRange?: [string, string]
    option?: any
    class?: string
  }
  
  use([CanvasRenderer, EChartsHeatmapChart, CalendarComponent, TooltipComponent, VisualMapComponent])
  
  const props = withDefaults(defineProps<Props>(), {
    height: 200,
    colorRange: () => ['#fef3c7', '#d97706'],
  })
  
  const maxValue = computed(() => props.data.reduce((m, [, v]) => Math.max(m, v), 0) || 1)
  
  const mergedOption = computed(() => ({
    color: chartColors.value,
    tooltip: {
      position: 'top',
      formatter: (p: any) => `<strong>${p.value[0]}</strong><br>${p.value[1]} contributions`,
      backgroundColor: chartTooltipBg.value,
      borderColor: chartTooltipBorder.value,
      textStyle: { color: chartTooltipText.value, fontSize: 12 },
    },
    visualMap: {
      show: false,
      min: 0,
      max: maxValue.value,
      inRange: { color: props.colorRange },
    },
    calendar: {
      top: 24,
      left: 36,
      right: 12,
      cellSize: ['auto', 14],
      range: props.range,
      itemStyle: { color: chartSplitLineColor.value, borderWidth: 0 },
      splitLine: { show: false },
      dayLabel: { color: chartTextColor.value, fontSize: 10, firstDay: 1, nameMap: ['S', 'M', 'T', 'W', 'T', 'F', 'S'] },
      monthLabel: { color: chartTextColor.value, fontSize: 10, fontWeight: 600 },
      yearLabel: { show: false },
    },
    series: (() => {
      const series = [{ type: 'heatmap', coordinateSystem: 'calendar', data: props.data }]
      const userSeries = (props.option as any)?.series
      return Array.isArray(userSeries) ? series.map((s, i) => ({ ...s, ...(userSeries[i] ?? {}) })) : series
    })(),
    // Strip `series` from the rest spread so the merge above isn't clobbered.
    ...(() => {
      const { series: _, ...rest } = (props.option as any) ?? {}
      return rest
    })(),
  }))
  </script>
  
  <template>
    <div
      role="img"
      tabindex="0"
      :style="{ height: /^\d+$/.test(String(height)) ? `${height}px` : String(height) }"
      :class="cn('focus-visible:ring-ring w-full focus-visible:ring-2 focus-visible:outline-none', props.class)"
    >
      <VChart :option="mergedOption" :autoresize="true" class="size-full" />
    </div>
  </template>

• app/components/ui/charts/calendar-heatmap/index.ts 0.1 kB

  export { default as CalendarHeatmap } from './CalendarHeatmap.vue'

• app/components/ui/charts/useChartTheme.ts 6.4 kB

  import { computed, ref, type ComputedRef } from 'vue'
  
  // Chart palette is driven by Tailwind v4 CSS variables (`--chart-1`..`--chart-5`,
  // `--muted-foreground`, `--border`, `--popover`, etc.) so dark/light flips
  // happen automatically when the consumer toggles their theme class. The
  // values resolve at runtime via `getComputedStyle`, so they pick up whatever
  // the consumer set in their own `tailwind.css` -- no fork required.
  //
  // We bump `themeKey` whenever `<html>` class/style changes (the typical
  // shadcn dark-mode pivot) so every consuming `computed` re-resolves and
  // downstream ECharts options re-paint.
  
  const themeKey = ref(0)
  
  if (typeof window !== 'undefined') {
    // Bump once on the first paint so post-hydration getComputedStyle reads
    // the *resolved* CSS values (during SSR-built bundles the very first
    // computed pass returns the fallbacks below).
    requestAnimationFrame(() => themeKey.value++)
    new MutationObserver(() => themeKey.value++).observe(document.documentElement, {
      attributes: true,
      attributeFilter: ['class', 'style', 'data-theme'],
    })
  }
  
  // Lazy canvas context used to normalize any CSS color string (including
  // `oklch(...)`, `oklab(...)`, `color(display-p3 ...)`) into a hex / rgba
  // string ECharts' canvas renderer can consume. Without this, code that
  // does `color + '40'` (8-digit hex alpha trick) produces invalid color
  // strings like `oklch(...)40` and the canvas API throws.
  let _hexCanvas: CanvasRenderingContext2D | null = null
  function toHex(cssColor: string): string {
    if (typeof document === 'undefined') return cssColor
    if (!_hexCanvas) {
      _hexCanvas = document.createElement('canvas').getContext('2d')
    }
    if (!_hexCanvas) return cssColor
    // Reset, then assign; the browser normalizes whatever it accepted into
    // the canonical hex/rgba form when read back.
    _hexCanvas.fillStyle = '#000'
    _hexCanvas.fillStyle = cssColor
    return _hexCanvas.fillStyle as string
  }
  
  // Convert any CSS color (hex, rgb, oklch, color()) + alpha 0..1 to a
  // canvas-safe rgba(r,g,b,a). `colorString + '40'` (8-digit hex alpha)
  // only works when `colorString` is `#rrggbb`; once tokens resolve to
  // oklch() post-hydration the gradient stops break and the canvas paint
  // throws every frame. Stay defensive and always return rgba.
  export function toRgba(cssColor: string, alpha: number): string {
    if (typeof document === 'undefined') return cssColor
    if (!_hexCanvas) {
      _hexCanvas = document.createElement('canvas').getContext('2d')
    }
    if (!_hexCanvas) return cssColor
    _hexCanvas.fillStyle = '#000'
    _hexCanvas.fillStyle = cssColor
    const normalized = _hexCanvas.fillStyle as string
    if (normalized.startsWith('#') && normalized.length === 7) {
      const r = parseInt(normalized.slice(1, 3), 16)
      const g = parseInt(normalized.slice(3, 5), 16)
      const b = parseInt(normalized.slice(5, 7), 16)
      return `rgba(${r},${g},${b},${alpha})`
    }
    if (normalized.startsWith('rgba(')) {
      return normalized.replace(/,\s*[\d.]+\s*\)$/, `,${alpha})`)
    }
    if (normalized.startsWith('rgb(')) {
      return normalized.replace(/^rgb\(/, 'rgba(').replace(/\)$/, `,${alpha})`)
    }
    // Canvas refused to parse this color -- ship the original string and
    // let ECharts complain (better than crashing the paint loop).
    return cssColor
  }
  
  function resolveVar(name: string, fallback: string): string {
    if (typeof window === 'undefined') return fallback
    const v = getComputedStyle(document.documentElement).getPropertyValue(name).trim()
    if (!v) return fallback
    return toHex(v)
  }
  
  // SSR / pre-hydration fallback palette. Hex values picked to roughly
  // match the shadcn Neutral defaults in `tailwind.css` so the first paint
  // doesn't flicker.
  const CHART_FALLBACK = ['#f59e0b', '#14b8a6', '#3b82f6', '#f97316', '#eab308']
  
  export const chartColors: ComputedRef<string[]> = computed(() => {
    themeKey.value
    return Array.from({ length: 5 }, (_, i) => resolveVar(`--chart-${i + 1}`, CHART_FALLBACK[i]!))
  })
  
  export const chartTextColor: ComputedRef<string> = computed(() => {
    themeKey.value
    return resolveVar('--muted-foreground', '#888888')
  })
  
  export const chartAxisColor: ComputedRef<string> = computed(() => {
    themeKey.value
    return resolveVar('--border', '#e5e5e5')
  })
  
  export const chartSplitLineColor: ComputedRef<string> = computed(() => {
    themeKey.value
    return resolveVar('--border', '#f0f0f0')
  })
  
  export const chartTooltipBg: ComputedRef<string> = computed(() => {
    themeKey.value
    return resolveVar('--popover', 'rgba(255,255,255,0.96)')
  })
  
  export const chartTooltipBorder: ComputedRef<string> = computed(() => {
    themeKey.value
    return resolveVar('--border', '#e5e5e5')
  })
  
  export const chartTooltipText: ComputedRef<string> = computed(() => {
    themeKey.value
    return resolveVar('--popover-foreground', '#333333')
  })
  
  // Two-level deep merge for ECharts option blocks (xAxis, yAxis, grid,
  // tooltip, legend, singleAxis, parallel, etc.). The top-level keys merge
  // shallowly, but one nested level (axisLabel, axisLine, splitLine, etc.)
  // merges shallowly too so a consumer passing `xAxis: { axisLabel: { fontSize: 9 } }`
  // doesn't blow away the wrapper's `color` + base font defaults on the same
  // axisLabel block. Arrays + primitives replace outright.
  //
  // This is the merge strategy the chart wrappers use to fold `props.option`
  // onto their computed base option without forcing consumers to spell out
  // every default they want to preserve.
  export function mergeOptionBlock<T extends Record<string, any>>(base: T, user: Partial<T> | undefined): T {
    if (!user) return base
    const out: any = { ...base }
    for (const k of Object.keys(user)) {
      const bv = (base as any)[k]
      const uv = (user as any)[k]
      if (
        bv != null &&
        uv != null &&
        typeof bv === 'object' &&
        typeof uv === 'object' &&
        !Array.isArray(bv) &&
        !Array.isArray(uv)
      ) {
        out[k] = { ...bv, ...uv }
      } else {
        out[k] = uv
      }
    }
    return out
  }
  
  // Default gauge stoplight: teal (safe) -> amber (warning) -> red (danger).
  // Pulled off saturated green and onto teal so the gauge ties back to the
  // dashboard palette; red is kept as the universal "limit reached" cue.
  // GaugeChart consumes this via its `thresholds` prop default; consumers
  // pass their own array to override. Static because gauges have semantic
  // meaning (green safe / red danger) that we deliberately don't theme-flip.
  export const gaugeThresholds: [number, string][] = [
    [0.6, '#14b8a6'],
    [0.85, '#f59e0b'],
    [1, '#dc2626'],
  ]

Raw manifest: https://uipkge.dev/r/vue/calendar-heatmap.json