@types/react-calendar-heatmap

Installation

npm install --save @types/react-calendar-heatmap

Summary

This package contains type definitions for react-calendar-heatmap (https://github.com/patientslikeme/react-calendar-heatmap).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-calendar-heatmap.

index.d.ts

import * as React from "react";

export type ReactCalendarHeatmapDate = string | number | Date;
export interface ReactCalendarHeatmapValue<T extends ReactCalendarHeatmapDate> {
    date: T;
    [key: string]: any;
}

export interface Props<T extends ReactCalendarHeatmapDate> {
    classForValue?: ((value: ReactCalendarHeatmapValue<T> | undefined) => string) | undefined;
    endDate?: string | number | Date | undefined;
    gutterSize?: number | undefined;
    horizontal?: boolean | undefined;
    monthLabels?: string[] | undefined;
    numDays?: number | undefined;
    onClick?: ((value: ReactCalendarHeatmapValue<T> | undefined) => void) | undefined;
    onMouseLeave?:
        | ((e: React.MouseEvent<SVGRectElement, MouseEvent>, value: ReactCalendarHeatmapValue<T> | undefined) => void)
        | undefined;
    onMouseOver?:
        | ((e: React.MouseEvent<SVGRectElement, MouseEvent>, value: ReactCalendarHeatmapValue<T> | undefined) => void)
        | undefined;
    showMonthLabels?: boolean | undefined;
    showOutOfRangeDays?: boolean | undefined;
    showWeekdayLabels?: boolean | undefined;
    startDate?: string | number | Date | undefined;
    titleForValue?: ((value: ReactCalendarHeatmapValue<T> | undefined) => string) | undefined;
    tooltipDataAttrs?: object | undefined;
    transformDayElement?:
        | ((
            element: React.ReactElement,
            value: ReactCalendarHeatmapValue<T> | undefined,
            index: number,
        ) => React.ReactNode)
        | undefined;
    values: Array<ReactCalendarHeatmapValue<T>>;
    weekdayLabels?: string[] | undefined;
}

export default class ReactCalendarHeatmap<T extends ReactCalendarHeatmapDate> extends React.Component<Props<T>> {}

Additional Details

• Last updated: Sun, 14 Jan 2024 08:07:40 GMT
• Dependencies: @types/react

Credits

These definitions were written by Keisuke Kan.