@syncfusion/react-calendars
Version:
A complete package of date or time components with built-in features such as date formatting, inline editing, multiple (range) selection, range restriction, month and year selection, strict mode, and globalization.
84 lines (83 loc) • 1.98 kB
TypeScript
import * as React from 'react';
/**
* Defines the props for the CalendarCell component.
*
*/
export interface CalendarCellProps {
/**
* Sets a custom CSS class to the calendar cell.
*
* @default string
*/
className?: string;
/**
* Determines if the calendar cell is disabled and non-interactive.
*
* @default false
*/
isDisabled?: boolean;
/**
* Specifies if the cell is out of current view range (like previous or next month dates in month view).
*
*/
isOutOfRange?: boolean;
/**
* Specifies if the current cell represents today's date.
*
* @default false
*/
isToday?: boolean;
/**
* Specifies if the current cell is selected.
*
* @default false
*/
isSelected?: boolean;
/**
* Specifies if the current cell has focus.
*
* @default false
*/
isFocused?: boolean;
/**
* Specifies if the cell represents a weekend day.
*
* @default false
*/
isWeekend?: boolean;
/**
* The date value represented by the cell.
*
*/
date: Date;
/**
* The content to be displayed inside the cell.
*
* @default null
*/
children?: React.ReactNode;
/**
* Callback function triggered when a cell is clicked.
*
* @default null
*/
onClick?: (event: React.MouseEvent<HTMLTableCellElement>, date: Date) => void;
/**
* The id attribute for the cell.
*
* @default -
*/
id?: string;
/**
* Optional title attribute for the cell.
*
* @default -
*/
title?: string;
}
/**
* The CalendarCell component is internally used for rendering the items in the current view.
* It can also be used as a custom cell of the Calendar.
*/
export declare const CalendarCell: React.ForwardRefExoticComponent<CalendarCellProps & React.RefAttributes<HTMLTableCellElement>>;
export default CalendarCell;