UNPKG

react-day-picker

Version:

Customizable Date Picker for React

88 lines (87 loc) 3.17 kB
/** * The UI elements composing DayPicker. These elements are mapped to * {@link CustomComponents}, the {@link ClassNames} and the {@link Styles} used by * DayPicker. * * Some of these elements are extended by flags and modifiers. */ export declare enum UI { /** The previous button in the navigation. */ ButtonPrevious = "button_previous", /** The next button the navigation. */ ButtonNext = "button_next", /** The root component displaying the months and the navigation bar. */ Root = "root", /** The Chevron SVG element used by navigation buttons and dropdowns. */ Chevron = "chevron", /** * The grid cell with the day's date. Extended by {@link DayFlag} and * {@link SelectionFlag}. */ Day = "day", /** The button containing the formatted day's date, inside the grid cell. */ DayButton = "day_button", /** The caption label of the month (when not showing the dropdown navigation). */ CaptionLabel = "caption_label", /** The container of the dropdown navigation (when enabled). */ Dropdowns = "dropdowns", /** The dropdown element to select for years and months. */ Dropdown = "dropdown", /** The container element of the dropdown. */ DropdownRoot = "dropdown_root", /** The root element of the footer. */ Footer = "footer", /** The month grid. */ MonthGrid = "month_grid", /** Contains the dropdown navigation or the caption label. */ MonthCaption = "month_caption", /** The dropdown with the months. */ MonthsDropdown = "months_dropdown", /** Wrapper of the month grid. */ Month = "month", /** The container of the displayed months. */ Months = "months", /** The navigation bar with the previous and next buttons. */ Nav = "nav", /** The row containing the week. */ Week = "week", /** The group of row weeks in a month. */ Weeks = "weeks", /** The column header with the weekday. */ Weekday = "weekday", /** The row grouping the weekdays in the column headers. */ Weekdays = "weekdays", /** The row header containing the week number. */ WeekNumber = "week_number", /** The row header containing the week number. */ WeekNumberHeader = "week_number_header", /** The dropdown with the years. */ YearsDropdown = "years_dropdown" } /** The flags for the {@link UI.Day}. */ export declare enum DayFlag { /** The day is disabled. */ disabled = "disabled", /** The day is hidden. */ hidden = "hidden", /** The day is outside the current month. */ outside = "outside", /** The day is focused. */ focused = "focused", /** The day is today. */ today = "today" } /** * The state that can be applied to the {@link UI.Day} element when in selection * mode. */ export declare enum SelectionState { /** The day is at the end of a selected range. */ range_end = "range_end", /** The day is at the middle of a selected range. */ range_middle = "range_middle", /** The day is at the start of a selected range. */ range_start = "range_start", /** The day is selected. */ selected = "selected" }