3.17 kBTypeScriptView Raw
1/**
2 * The UI elements composing DayPicker. These elements are mapped to
3 * {@link CustomComponents}, the {@link ClassNames} and the {@link Styles} used by
4 * DayPicker.
5 *
6 * Some of these elements are extended by flags and modifiers.
7 */
8export declare enum UI {
9 /** The previous button in the navigation. */
10 ButtonPrevious = "button_previous",
11 /** The next button the navigation. */
12 ButtonNext = "button_next",
13 /** The root component displaying the months and the navigation bar. */
14 Root = "root",
15 /** The Chevron SVG element used by navigation buttons and dropdowns. */
16 Chevron = "chevron",
17 /**
18 * The grid cell with the day's date. Extended by {@link DayFlag} and
19 * {@link SelectionFlag}.
20 */
21 Day = "day",
22 /** The button containing the formatted day's date, inside the grid cell. */
23 DayButton = "day_button",
24 /** The caption label of the month (when not showing the dropdown navigation). */
25 CaptionLabel = "caption_label",
26 /** The container of the dropdown navigation (when enabled). */
27 Dropdowns = "dropdowns",
28 /** The dropdown element to select for years and months. */
29 Dropdown = "dropdown",
30 /** The container element of the dropdown. */
31 DropdownRoot = "dropdown_root",
32 /** The root element of the footer. */
33 Footer = "footer",
34 /** The month grid. */
35 MonthGrid = "month_grid",
36 /** Contains the dropdown navigation or the caption label. */
37 MonthCaption = "month_caption",
38 /** The dropdown with the months. */
39 MonthsDropdown = "months_dropdown",
40 /** Wrapper of the month grid. */
41 Month = "month",
42 /** The container of the displayed months. */
43 Months = "months",
44 /** The navigation bar with the previous and next buttons. */
45 Nav = "nav",
46 /** The row containing the week. */
47 Week = "week",
48 /** The group of row weeks in a month. */
49 Weeks = "weeks",
50 /** The column header with the weekday. */
51 Weekday = "weekday",
52 /** The row grouping the weekdays in the column headers. */
53 Weekdays = "weekdays",
54 /** The row header containing the week number. */
55 WeekNumber = "week_number",
56 /** The row header containing the week number. */
57 WeekNumberHeader = "week_number_header",
58 /** The dropdown with the years. */
59 YearsDropdown = "years_dropdown"
60}
61/** The flags for the {@link UI.Day}. */
62export declare enum DayFlag {
63 /** The day is disabled. */
64 disabled = "disabled",
65 /** The day is hidden. */
66 hidden = "hidden",
67 /** The day is outside the current month. */
68 outside = "outside",
69 /** The day is focused. */
70 focused = "focused",
71 /** The day is today. */
72 today = "today"
73}
74/**
75 * The state that can be applied to the {@link UI.Day} element when in selection
76 * mode.
77 */
78export declare enum SelectionState {
79 /** The day is at the end of a selected range. */
80 range_end = "range_end",
81 /** The day is at the middle of a selected range. */
82 range_middle = "range_middle",
83 /** The day is at the start of a selected range. */
84 range_start = "range_start",
85 /** The day is selected. */
86 selected = "selected"
87}