456 lines
12 KiB
TypeScript
Executable File
456 lines
12 KiB
TypeScript
Executable File
/**
|
|
*
|
|
* Calendar also known as DatePicker, is a form component to work with dates.
|
|
*
|
|
* [Live Demo](https://www.primevue.org/calendar/)
|
|
*
|
|
* @module calendar
|
|
*
|
|
*/
|
|
import { HTMLAttributes, InputHTMLAttributes, VNode } from 'vue';
|
|
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
|
|
|
|
/**
|
|
* Custom Calendar responsive options metadata.
|
|
*/
|
|
export interface CalendarResponsiveOptions {
|
|
/**
|
|
* Breakpoint for responsive mode. Exp; @media screen and (max-width: ${breakpoint}) {...}
|
|
*/
|
|
breakpoint: string;
|
|
/**
|
|
* The number of visible months on breakpoint.
|
|
*/
|
|
numMonths: number;
|
|
}
|
|
|
|
/**
|
|
* Custom Calendar month change event.
|
|
* @see {@link CalendarEmits['month-change']]}
|
|
*/
|
|
export interface CalendarMonthChangeEvent {
|
|
/**
|
|
* New month.
|
|
*/
|
|
month: number;
|
|
/**
|
|
* New year.
|
|
*/
|
|
year: number;
|
|
}
|
|
|
|
/**
|
|
* Custom Calendar year change event.
|
|
* @see {@link CalendarEmits['year-change']]}
|
|
*/
|
|
export interface CalendarYearChangeEvent {
|
|
/**
|
|
* New month.
|
|
*/
|
|
month: number;
|
|
/**
|
|
* New year.
|
|
*/
|
|
year: number;
|
|
}
|
|
|
|
/**
|
|
* Custom Calendar blur event.
|
|
* @see {@link CalendarEmits.blur}
|
|
*/
|
|
export interface CalendarBlurEvent {
|
|
/**
|
|
* Browser event
|
|
*/
|
|
originalEvent: Event;
|
|
/**
|
|
* Input value
|
|
*/
|
|
value: string;
|
|
}
|
|
|
|
/**
|
|
* Defines valid properties in Calendar component.
|
|
*/
|
|
export interface CalendarProps {
|
|
/**
|
|
* Value of the component.
|
|
* @defaultValue null
|
|
*/
|
|
modelValue?: string | Date | string[] | Date[] | undefined | null;
|
|
/**
|
|
* Defines the quantity of the selection.
|
|
* @defaultValue single
|
|
*/
|
|
selectionMode?: 'single' | 'multiple' | 'range' | undefined;
|
|
/**
|
|
* Format of the date. Defaults to PrimeVue Locale configuration.
|
|
*/
|
|
dateFormat?: string | undefined;
|
|
/**
|
|
* When enabled, displays the calendar as inline instead of an overlay.
|
|
* @defaultValue false
|
|
*/
|
|
inline?: boolean | undefined;
|
|
/**
|
|
* Whether to display dates in other months (non-selectable) at the start or end of the current month. To make these days selectable use the selectOtherMonths option.
|
|
* @defaultValue true
|
|
*/
|
|
showOtherMonths?: boolean | undefined;
|
|
/**
|
|
* Whether days in other months shown before or after the current month are selectable. This only applies if the showOtherMonths option is set to true.
|
|
* @defaultValue false
|
|
*/
|
|
selectOtherMonths?: boolean | undefined;
|
|
/**
|
|
* When enabled, displays a button with icon next to input.
|
|
* @defaultValue false
|
|
*/
|
|
showIcon?: boolean | undefined;
|
|
/**
|
|
* Icon of the calendar button.
|
|
* @defaultValue 'pi pi-calendar'
|
|
*/
|
|
icon?: string | undefined;
|
|
/**
|
|
* Icon to show in the previous button.
|
|
* @defaultValue 'pi pi-chevron-left'
|
|
*/
|
|
previousIcon?: string | undefined;
|
|
/**
|
|
* Icon to show in the next button.
|
|
* @defaultValue 'pi pi-chevron-right'
|
|
*/
|
|
nextIcon?: string | undefined;
|
|
/**
|
|
* Icon to show in each of the increment buttons.
|
|
* @defaultValue 'pi pi-chevron-up'
|
|
*/
|
|
incrementIcon?: string | undefined;
|
|
/**
|
|
* Icon to show in each of the decrement buttons.
|
|
* @defaultValue 'pi pi-chevron-down'
|
|
*/
|
|
decrementIcon?: string | undefined;
|
|
/**
|
|
* Number of months to display.
|
|
* @defaultValue 1
|
|
*/
|
|
numberOfMonths?: number | undefined;
|
|
/**
|
|
* An array of options for responsive design.
|
|
*/
|
|
responsiveOptions?: CalendarResponsiveOptions[];
|
|
/**
|
|
* Type of view to display.
|
|
* @defaultValue 'date'
|
|
*/
|
|
view?: 'date' | 'month' | 'year' | undefined;
|
|
/**
|
|
* When enabled, calendar overlay is displayed as optimized for touch devices.
|
|
* @defaultValue false
|
|
*/
|
|
touchUI?: boolean | undefined;
|
|
/**
|
|
* Whether the month should be rendered as a dropdown instead of text.
|
|
*
|
|
* @deprecated since version 3.9.0, Navigator is always on.
|
|
* @defaultValue false
|
|
*/
|
|
monthNavigator?: boolean | undefined;
|
|
/**
|
|
* Whether the year should be rendered as a dropdown instead of text.
|
|
*
|
|
* @deprecated since version 3.9.0, Navigator is always on.
|
|
* @defaultValue false
|
|
*/
|
|
yearNavigator?: boolean | undefined;
|
|
/**
|
|
* The range of years displayed in the year drop-down in (nnnn:nnnn) format such as (2000:2020).
|
|
*
|
|
* @deprecated since version 3.9.0, Years are based on decades by default.
|
|
* @defaultValue false
|
|
*/
|
|
yearRange?: string | undefined;
|
|
/**
|
|
* The minimum selectable date.
|
|
*/
|
|
minDate?: Date | undefined;
|
|
/**
|
|
* The maximum selectable date.
|
|
*/
|
|
maxDate?: Date | undefined;
|
|
/**
|
|
* Array with dates to disable.
|
|
*/
|
|
disabledDates?: Date[] | undefined;
|
|
/**
|
|
* Array with disabled weekday numbers.
|
|
*/
|
|
disabledDays?: number[] | undefined;
|
|
/**
|
|
* Maximum number of selectable dates in multiple mode.
|
|
*/
|
|
maxDateCount?: number | undefined;
|
|
/**
|
|
* When disabled, datepicker will not be visible with input focus.
|
|
* @defaultValue true
|
|
*/
|
|
showOnFocus?: boolean | undefined;
|
|
/**
|
|
* Whether to automatically manage layering.
|
|
* @defaultValue true
|
|
*/
|
|
autoZIndex?: boolean | undefined;
|
|
/**
|
|
* Base zIndex value to use in layering.
|
|
* @defaultValue 0
|
|
*/
|
|
baseZIndex?: number | undefined;
|
|
/**
|
|
* Whether to display today and clear buttons at the footer.
|
|
* @defaultValue false
|
|
*/
|
|
showButtonBar?: boolean | undefined;
|
|
/**
|
|
* The cutoff year for determining the century for a date.
|
|
* @defaultValue '+10'
|
|
*/
|
|
shortYearCutoff?: string | undefined;
|
|
/**
|
|
* Whether to display timepicker.
|
|
* @defaultValue false
|
|
*/
|
|
showTime?: boolean | undefined;
|
|
/**
|
|
* Whether to display timepicker only.
|
|
* @defaultValue false
|
|
*/
|
|
timeOnly?: boolean | undefined;
|
|
/**
|
|
* Specifies hour format.
|
|
* @defaultValue 24
|
|
*/
|
|
hourFormat?: '12' | '24' | undefined;
|
|
/**
|
|
* Hours to change per step.
|
|
* @defaultValue 1
|
|
*/
|
|
stepHour?: number | undefined;
|
|
/**
|
|
* Minutes to change per step.
|
|
* @defaultValue 1
|
|
*/
|
|
stepMinute?: number | undefined;
|
|
/**
|
|
* Seconds to change per step.
|
|
* @defaultValue 1
|
|
*/
|
|
stepSecond?: number | undefined;
|
|
/**
|
|
* Whether to show the seconds in time picker.
|
|
* @defaultValue false
|
|
*/
|
|
showSeconds?: boolean | undefined;
|
|
/**
|
|
* Whether to hide the overlay on date selection when showTime is enabled.
|
|
* @defaultValue false
|
|
*/
|
|
hideOnDateTimeSelect?: boolean | undefined;
|
|
/**
|
|
* Whether to hide the overlay on date selection is completed when selectionMode is range.
|
|
* @defaultValue false
|
|
*/
|
|
hideOnRangeSelection?: boolean | undefined;
|
|
/**
|
|
* Separator of time selector.
|
|
* @defaultValue ':'
|
|
*/
|
|
timeSeparator?: string | undefined;
|
|
/**
|
|
* When enabled, calendar will show week numbers.
|
|
* @defaultValue false
|
|
*/
|
|
showWeek?: boolean | undefined;
|
|
/**
|
|
* Wheter to allow prevents entering the date manually via typing.
|
|
* @defaultValue true
|
|
*/
|
|
manualInput?: boolean | undefined;
|
|
/**
|
|
* When present, it specifies that the component should be disabled.
|
|
* @defaultValue false
|
|
*/
|
|
disabled?: boolean | undefined;
|
|
/**
|
|
* When present, it specifies that an input field is read-only.
|
|
* @defaultValue false
|
|
*/
|
|
readonly?: boolean | undefined;
|
|
/**
|
|
* Placeholder text for the input.
|
|
*/
|
|
placeholder?: string | undefined;
|
|
/**
|
|
* A valid query selector or an HTMLElement to specify where the overlay gets attached.
|
|
* @defaultValue 'body'
|
|
*/
|
|
appendTo?: 'body' | 'self' | string | undefined | HTMLElement;
|
|
/**
|
|
* Identifier of the element.
|
|
*/
|
|
id?: string | undefined;
|
|
/**
|
|
* Identifier of the underlying input element.
|
|
*/
|
|
inputId?: string | undefined;
|
|
/**
|
|
* Inline style of the input field.
|
|
*/
|
|
inputStyle?: any | undefined;
|
|
/**
|
|
* Style class of the input field.
|
|
*/
|
|
inputClass?: any | undefined;
|
|
/**
|
|
* Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component.
|
|
*/
|
|
inputProps?: InputHTMLAttributes | undefined;
|
|
/**
|
|
* Inline style of the overlay panel.
|
|
*/
|
|
panelStyle?: any | undefined;
|
|
/**
|
|
* Style class of the overlay panel.
|
|
*/
|
|
panelClass?: any | undefined;
|
|
/**
|
|
* Uses to pass all properties of the HTMLDivElement to the overlay panel inside the component.
|
|
*/
|
|
panelProps?: HTMLAttributes | undefined;
|
|
/**
|
|
* Establishes relationships between the component and label(s) where its value should be one or more element IDs.
|
|
*/
|
|
'aria-labelledby'?: string | undefined;
|
|
/**
|
|
* Establishes a string value that labels the component.
|
|
*/
|
|
'aria-label'?: string | undefined;
|
|
}
|
|
|
|
/**
|
|
* Defines valid slots in Calendar component.
|
|
*/
|
|
export interface CalendarSlots {
|
|
/**
|
|
* Custom header template of panel.
|
|
*/
|
|
header(): VNode[];
|
|
/**
|
|
* Custom footer template of panel.
|
|
*/
|
|
footer(): VNode[];
|
|
/**
|
|
* Custom date template.
|
|
*/
|
|
date(scope: {
|
|
/**
|
|
* Value of the component.
|
|
*/
|
|
date: { day: number; month: number; year: number; today: boolean; selectable: boolean };
|
|
}): VNode[];
|
|
/**
|
|
* Custom decade template.
|
|
*/
|
|
decade(scope: {
|
|
/**
|
|
* An array containing the start and and year of a decade to display at header of the year picker.
|
|
*/
|
|
years: string[] | undefined;
|
|
}): VNode[];
|
|
}
|
|
|
|
/**
|
|
* Defines valid emits in Calendar component.
|
|
*/
|
|
export interface CalendarEmits {
|
|
/**
|
|
* Emitted when the value changes.
|
|
* @param {string | Date | string[] | Date[] | undefined} value - New value.
|
|
*/
|
|
'update:modelValue'(value: string | Date | string[] | Date[] | undefined): void;
|
|
/**
|
|
* Callback to invoke when input field is being typed.
|
|
* @param {Event} event - Browser event
|
|
*/
|
|
input(event: Event): void;
|
|
/**
|
|
* Callback to invoke when a date is selected.
|
|
* @param {Date} value - Selected value.
|
|
*/
|
|
'date-select'(value: Date): void;
|
|
/**
|
|
* Callback to invoke when datepicker panel is shown.
|
|
*/
|
|
show(): void;
|
|
/**
|
|
* Callback to invoke when datepicker panel is hidden.
|
|
*/
|
|
hide(): void;
|
|
/**
|
|
* Callback to invoke when today button is clicked.
|
|
* @param {Date} date - Today as a date instance.
|
|
*/
|
|
'today-click'(date: Date): void;
|
|
/**
|
|
* Callback to invoke when clear button is clicked.
|
|
* @param {Event} event - Browser event.
|
|
*/
|
|
'clear-click'(event: Event): void;
|
|
/**
|
|
* Callback to invoke when a month is changed using the navigators.
|
|
* @param {CalendarMonthChangeEvent} event - Custom month change event.
|
|
*/
|
|
'month-change'(event: CalendarMonthChangeEvent): void;
|
|
/**
|
|
* Callback to invoke when a year is changed using the navigators.
|
|
* @param {CalendarYearChangeEvent} event - Custom year change event.
|
|
*/
|
|
'year-change'(event: CalendarYearChangeEvent): void;
|
|
/**
|
|
* Callback to invoke on focus of input field.
|
|
* @param {Event} event - Focus event
|
|
*/
|
|
focus(event: Event): void;
|
|
/**
|
|
* Callback to invoke on blur of input field.
|
|
* @param {CalendarBlurEvent} event - Blur event
|
|
*/
|
|
blur(event: CalendarBlurEvent): void;
|
|
/**
|
|
* Callback to invoke when a key is pressed.
|
|
*/
|
|
keydown(event: Event): void;
|
|
}
|
|
|
|
/**
|
|
* **PrimeVue - Calendar**
|
|
*
|
|
* _Calendar also known as DatePicker, is a form component to work with dates._
|
|
*
|
|
* [Live Demo](https://www.primevue.org/calendar/)
|
|
* --- ---
|
|
* 
|
|
*
|
|
* @group Component
|
|
*/
|
|
declare class Calendar extends ClassComponent<CalendarProps, CalendarSlots, CalendarEmits> {}
|
|
|
|
declare module '@vue/runtime-core' {
|
|
interface GlobalComponents {
|
|
Calendar: GlobalComponentConstructor<Calendar>;
|
|
}
|
|
}
|
|
|
|
export default Calendar;
|