@progress/kendo-react-dateinputs/dist/es/calendar/models/CalendarSettings.d.ts

KendoReact Date Inputs package

/// <reference types="react" />
import { ActiveView } from './ActiveView';
import { CalendarCellProps } from '../components/CalendarCell';
import { CalendarWeekCellProps } from '../components/CalendarWeekCell';
import { CalendarHeaderTitleProps } from '../components/CalendarHeaderTitle';
import { CalendarNavigationItemProps } from '../components/CalendarNavigationItem';
/**
 * @hidden
 */
export interface CalendarSettings {
    /**
     * Defines the bottommost view to which the user can navigate.
     */
    bottomView?: ActiveView;
    /**
     * Sets the `className` of the Calendar.
     */
    className?: string;
    /**
     * Sets the default active view of the Calendar.
     * If not set, the Calendar will display the month view.
     */
    defaultActiveView?: ActiveView;
    /**
     * Determines whether the Calendar is disabled.
     */
    disabled?: boolean;
    /**
     * Sets the initial focused date of the Calendar.
     */
    focusedDate?: Date;
    /**
     * Sets the `id` of the Calendar.
     */
    id?: string;
    /**
     * Sets the maximum allowed date of the Calendar. Defaults to `2099-12-31`.
     */
    max?: Date;
    /**
     * Sets the minimum allowed date of the Calendar. Defaults to `1900-1-1`.
     */
    min?: Date;
    /**
     * Determines if the navigation sidebar will be displayed.
     */
    navigation?: boolean;
    /**
     * Toggles the smooth scroll animation on navigation item click. By default, the animation is enabled.
     */
    smoothScroll?: boolean;
    /**
     * Fires each time the Calendar is blurred.
     */
    onBlur?: (event: React.FocusEvent<any>) => void;
    /**
     * Fires each time the Calendar is focused.
     */
    onFocus?: (event: React.FocusEvent<any>) => void;
    /**
     * Sets the `tabIndex` property of the Calendar.
     */
    tabIndex?: number;
    /**
     * Defines the topmost view to which the user can navigate.
     */
    topView?: ActiveView;
    /**
     * Determines if the week number column will be displayed.
     */
    weekNumber?: boolean;
    /**
     * Enables the customization or the override of the default Calendar cell
     * ([see example]({% slug custom_rendering_calendar %}#toc-cells-inside-the-view)).
     */
    cell?: React.ComponentType<CalendarCellProps>;
    /**
     * Enables the customization or the override of the default week-column cell in the Calendar
     * ([see example]({% slug custom_rendering_calendar %}#toc-cells-inside-the-week-column)).
     */
    weekCell?: React.ComponentType<CalendarWeekCellProps>;
    /**
     * Enables the customization or the override of the default header title in the Calendar
     * ([see example]({% slug custom_rendering_calendar %}#toc-titles-of-current-views)).
     */
    headerTitle?: React.ComponentType<CalendarHeaderTitleProps>;
    /**
     * Enables the customization or the override of the default navigation item in the Calendar
     * ([see example]({% slug custom_rendering_calendar %}#toc-items-in-the-side-navigation)).
     */
    navigationItem?: React.ComponentType<CalendarNavigationItemProps>;
}