UNPKG

1.27 kBTypeScriptView Raw
1import { type DateLib } from "./DateLib.js";
2/**
3 * Represent the day displayed in the calendar.
4 *
5 * In DayPicker, a `Day` is a `Date` that can be displayed in the calendar. It
6 * is used as extension of the native `Date` object to provide additional
7 * information about the day.
8 */
9export declare class CalendarDay {
10 constructor(date: Date, displayMonth: Date, dateLib?: DateLib);
11 /**
12 * The utility functions to manipulate dates.
13 *
14 * @private
15 */
16 readonly dateLib: DateLib;
17 /**
18 * Whether the day is not belonging to the displayed month.
19 *
20 * When `outside` is `true`, use `displayMonth` to know to which month the day
21 * belongs.
22 */
23 readonly outside: boolean;
24 /**
25 * The months where the day is displayed.
26 *
27 * In DayPicker, days can fall out the displayed months (e.g. when
28 * `showOutsideDays` is `true`). This property is useful to know if the day is
29 * in the same month of the displayed month.
30 */
31 readonly displayMonth: Date;
32 /** The date represented by this day. */
33 readonly date: Date;
34 /**
35 * Check if the day is the same as the given day: considering if it is in the
36 * same display month.
37 */
38 isEqualTo(day: CalendarDay): boolean;
39}