@freecodecamp/react-calendar-heatmap

中文文档
1.1.0发布于 2023/02/08MITESM + CJS近 30 天下载 1970

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

中文使用文档
文档目录6 节
  1. 设置
  2. 使用量
  3. 道具
  4. 配置颜色
  5. 捐款
  6. 许可证

反应日历加热图

一个基于 SVG 的日历热映射组件,灵感来自 github 的承诺日历图. 该组件可扩展至容器大小并具有超可配置性. 在密码箱里试试看。 。 。 .

npm version Build Status bundle size

react-calendar-heatmap screenshot

设置

用纱线或npm安装 npm 模块 :

yarn add react-calendar-heatmap

使用量

导入组件 :

import CalendarHeatmap from 'react-calendar-heatmap';

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

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

CSS加载器默认包含在创建-反应-app中. 如果你没有CSS装载器,你可以简单 复制样式表 输入您的工程中的文件,然后导入它.

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

<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 })。 。 。 .

配置颜色

使用显示在 现场演示 您可以根据 github 贡献图设置 classForValue prop,一个函数,它决定适用于每个值的 CSS 类:

<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 为每个类设置颜色 :

.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; }

捐款

看看这个 捐款额 以查看如何在反应-日历-热图上开发.

许可证

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

版本与发布记录

@freecodecamp/react-calendar-heatmap 共发布 2 个版本,首次发布于 2020/03/10;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.1.0latest2023/02/083 年前
1.0.02020/03/106 年前

关于 @freecodecamp/react-calendar-heatmap 的常见问题

@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 和提交记录判断。