# @freecodecamp/react-calendar-heatmap 中文文档

规范地址：https://npmcn.com/package/%40freecodecamp/react-calendar-heatmap/

版本：1\.1\.0
npm 元数据更新时间：2024-04-05T07:41:37.036Z
中文译文更新时间：2026-11-16T00:30:23.248Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40freecodecamp/react-calendar-heatmap
原文对照：https://npmcn.com/package/%40freecodecamp/react-calendar-heatmap/?lang=original
项目主页：https://github.com/freeCodeCamp/react-calendar-heatmap#readme
源码仓库：https://github.com/freeCodeCamp/react-calendar-heatmap

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：164 kB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：未声明
- 运行依赖：2 个
- peer 依赖：react ^0\.14\.0 \|\| ^15\.0\.0 \|\| ^16\.0\.0 \|\| ^17\.0\.0 \|\| ^18\.0\.0
- 首次发布：2020-03-10T15:42:35.886Z
- 最新版本发布：2023-02-07T16:15:21.946Z
- 近 30 天下载量：1970（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：2（近 12 个月 0 个）

## 中文简介

一个基于 SVG 的日历热映射组件,灵感来自 Github 的承诺日历图.

## 安装

```sh
npm install @freecodecamp/react-calendar-heatmap
```

也可以使用：`pnpm add @freecodecamp/react-calendar-heatmap`、`yarn add @freecodecamp/react-calendar-heatmap`、`bun add @freecodecamp/react-calendar-heatmap`

## README

# 反应日历加热图

一个基于 SVG 的日历热映射组件,灵感来自 github 的承诺日历图. 该组件可扩展至容器大小并具有超可配置性. [**在密码箱里试试看**](https://codesandbox.io/s/73mk9wlyx)。 。 。 .

[![npm version](https://badge.fury.io/js/react-calendar-heatmap.svg)](https://badge.fury.io/js/react-calendar-heatmap) [![Build Status](https://travis-ci.org/kevinsqi/react-calendar-heatmap.svg?branch=master)](https://travis-ci.org/kevinsqi/react-calendar-heatmap) [![bundle size](https://img.shields.io/bundlephobia/min/react-calendar-heatmap.svg)](https://bundlephobia.com/result?p=react-calendar-heatmap)

[![react-calendar-heatmap screenshot](https://npmcn.com/demo/public/react-calendar-heatmap.png?raw=true)](https://codesandbox.io/s/73mk9wlyx)

## 设置

用纱线或npm安装 npm 模块 :

```bash
yarn add react-calendar-heatmap
```

## 使用量

导入组件 :

```javascript
import CalendarHeatmap from 'react-calendar-heatmap';
```

导入样式 。 您可以直接从模块导入, 这需要 CSS 加载器 :

```javascript
import 'react-calendar-heatmap/dist/styles.css';
```

CSS加载器默认包含在创建-反应-app中. 如果你没有CSS装载器,你可以简单 [复制样式表](https://npmcn.com/package/%40freecodecamp/react-calendar-heatmap/src/styles.css) 输入您的工程中的文件,然后导入它.

显示1月1日至4月1日的基本热图:

```javascript
<CalendarHeatmap
  startDate={new Date('2016-01-01')}
  endDate={new Date('2016-04-01')}
  values={[
    { date: '2016-01-01', count: 12 },
    { date: '2016-01-22', count: 122 },
    { date: '2016-01-30', count: 38 },
    // ...and so on
  ]}
/>
```

## 道具

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| `values` | **需求**,对象阵列 | 所需的对象数组,每个对象都有日期属性,可以是日期对象,可解析字符串,或毫秒印. 示例 `[{ date: '2016-01-01', count: 6 }]` |
| `startDate` | 字符串、 数字或日期 | 开始日期范围. |
| `endDate` | 字符串、 数字或日期 | 日期范围的结束 - a Date 对象,可解析字符串,或毫秒印. |
| `showMonthLabels` | 布尔 | 切换为删除月标签 . |
| `showWeekdayLabels` | 布尔 | 切换为去除工作日标签 . |
| `showOutOfRangeDays` | 布尔 | 切换显示周内超过结束时间和开始范围之前的额外天数 . |
| `horizontal` | 布尔 | 无论是水平方向还是垂直方向 。 可用 numDays/ endDate 组合显示当前月份 . |
| `gutterSize` | 数目 | 与平方相对的地沟大小. |
| `onClick` | 函数 | 点击正方形时召回以引用, 例如 . `(value) => alert(value)` |
| `onMouseOver` | 函数 | 当鼠标指针在正方形上时,如回叫以引用. `(event, value) => console.log(event, value)` |
| `onMouseLeave` | 函数 | 鼠标指针离开正方形时召回引用,例如. `(event, value) => console.log(event, value)` |
| `titleForValue` | 函数 | 用于确定每个正方形的标题属性的函数,用于生成第3方悬浮工具提示(可能还需要配置工具提示DataAttrs). 示例 `(value) =>` 日期为${值.date} |
| `tooltipDataAttrs` | 对象或函数 | 设定所有方块的数据属性, 用于生成 3rd party 悬浮工具提示 。 无论是物体喜欢 `{ 'data-tooltip': 'tooltip' }` 或函数类似 `(value) => { return { 'data-tooltip': 'Tooltip: ' + value } }` |
| `classForValue` | 函数 | 回调用于确定 CSS 类适用于每个值,例如. `(value) => (value.count > 0 ? 'blue' : 'white')`。 。 。 . |
| `monthLabels` | 字符串阵列 | 一个包含12个字符串的阵列,代表1月至12月的文本,例如. `['01', '02', ..., '12']` |
| `weekdayLabels` | 字符串阵列 | 一个包含7个字符串的阵列,代表星期日至星期六的文字 |
| `transformDayElement` | 函数 | 用于一天内进一步转换生成 svg 元素的函数 。 可用于附加事件处理器,添加工具提示等. 示例 `(element, value, index) => React.cloneElement(element, { title: value.date })`。 。 。 . |

## 配置颜色

使用显示在 [现场演示](https://www.kevinqi.com/react-calendar-heatmap/) 您可以根据 github 贡献图设置 `classForValue` prop,一个函数,它决定适用于每个值的 CSS 类:

```javascript
<CalendarHeatmap
  values={[
    { date: '2016-01-01', count: 1 },
    { date: '2016-01-03', count: 4 },
    { date: '2016-01-06', count: 2 },
    // ...and so on
  ]}
  classForValue={(value) => {
    if (!value) {
      return 'color-empty';
    }
    return `color-scale-${value.count}`;
  }}
/>
```

然后您使用 CSS 为每个类设置颜色 :

```css
.react-calendar-heatmap .color-scale-1 { fill: #d6e685; }
.react-calendar-heatmap .color-scale-2 { fill: #8cc665; }
.react-calendar-heatmap .color-scale-3 { fill: #44a340; }
.react-calendar-heatmap .color-scale-4 { fill: #1e6823; }
```

## 捐款

看看这个 [捐款额](https://npmcn.com/CONTRIBUTING.md) 以查看如何在反应-日历-热图上开发.

## 许可证

反应-calendar-heatmap为版权"2016 Patients LikeMe"(2016 Patients LikeMe, Inc.),并依据MIT许可发行. 详情请见Cating.

## 常见问题

### @freecodecamp/react-calendar-heatmap 是什么？

一个基于 SVG 的日历热映射组件,灵感来自 Github 的承诺日历图\.

### 如何安装 @freecodecamp/react-calendar-heatmap？

在项目目录运行 npm install @freecodecamp/react-calendar-heatmap，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^0\.14\.0 \|\| ^15\.0\.0 \|\| ^16\.0\.0 \|\| ^17\.0\.0 \|\| ^18\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @freecodecamp/react-calendar-heatmap 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/freecodecamp\_\_react-calendar-heatmap 是否存在。

### @freecodecamp/react-calendar-heatmap 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @freecodecamp/react-calendar-heatmap 可以商用吗？

@freecodecamp/react-calendar-heatmap 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @freecodecamp/react-calendar-heatmap 的下载量有多少？

根据 npm 官方下载统计，@freecodecamp/react-calendar-heatmap 在 2026/10/16 – 2026/11/14 这 30 天内被下载 1,970 次，日均约 66 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @freecodecamp/react-calendar-heatmap 还在维护吗？

最新版本 1\.1\.0 发布于 2023/02/08（3 年前）；至今共发布 2 个版本，其中过去 12 个月发布了 0 个；首次发布于 2020/03/10。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

