反应日历加热图
一个基于 SVG 的日历热映射组件,灵感来自 github 的承诺日历图. 该组件可扩展至容器大小并具有超可配置性. 在密码箱里试试看。 。 。 .
设置
用纱线或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.
