primevue-mirror/components/lib/calendar/Calendar.d.ts

128 lines
3.5 KiB
TypeScript
Raw Normal View History

2023-03-01 06:38:59 +00:00
/**
*
* Calendar also known as DatePicker, is a form component to work with dates.
*
2024-04-18 14:13:33 +00:00
* [Live Demo](https://www.primevue.org/datepicker/)
2023-03-01 06:38:59 +00:00
*
* @module calendar
*
*/
2024-04-18 14:13:33 +00:00
import 'vue';
import * as DatePicker from '../datepicker';
import { DefineComponent, EmitFn, GlobalComponentConstructor } from '../ts-helpers';
2023-08-02 14:07:22 +00:00
2023-05-04 14:50:30 +00:00
/**
* Custom passthrough(pt) option method.
*/
2024-04-18 14:13:33 +00:00
export interface CalendarPassThroughMethodOptions extends DatePicker.DatePickerPassThroughMethodOptions {}
2023-05-04 14:50:30 +00:00
/**
* Custom shared passthrough(pt) option method.
*/
2024-04-18 14:13:33 +00:00
export interface CalendarSharedPassThroughMethodOptions extends DatePicker.DatePickerSharedPassThroughMethodOptions {}
2023-03-01 06:38:59 +00:00
/**
* Custom Calendar responsive options metadata.
*/
2024-04-18 14:13:33 +00:00
export interface CalendarResponsiveOptions extends DatePicker.DatePickerResponsiveOptions {}
2022-09-06 12:03:37 +00:00
2023-03-01 06:38:59 +00:00
/**
* Custom Calendar month change event.
2023-03-06 20:35:39 +00:00
* @see {@link CalendarEmits['month-change']]}
2023-03-01 06:38:59 +00:00
*/
2024-04-18 14:13:33 +00:00
export interface CalendarMonthChangeEvent extends DatePicker.DatePickerMonthChangeEvent {}
2022-09-06 12:03:37 +00:00
2023-03-01 06:38:59 +00:00
/**
* Custom Calendar year change event.
2023-03-06 20:35:39 +00:00
* @see {@link CalendarEmits['year-change']]}
2023-03-01 06:38:59 +00:00
*/
2024-04-18 14:13:33 +00:00
export interface CalendarYearChangeEvent extends DatePicker.DatePickerYearChangeEvent {}
2022-09-06 12:03:37 +00:00
2023-03-01 06:38:59 +00:00
/**
* Custom Calendar blur event.
2023-03-06 20:35:39 +00:00
* @see {@link CalendarEmits.blur}
2023-03-01 06:38:59 +00:00
*/
2024-04-18 14:13:33 +00:00
export interface CalendarBlurEvent extends DatePicker.DatePickerBlurEvent {}
2022-09-06 12:03:37 +00:00
2023-05-04 14:50:30 +00:00
/**
* Custom passthrough(pt) options.
2024-04-01 13:36:40 +00:00
* @see {@link CalendarProps.pt}
2023-05-04 14:50:30 +00:00
*/
2024-04-18 14:13:33 +00:00
export interface CalendarPassThroughOptions extends DatePicker.DatePickerPassThroughOptions {}
2023-05-04 14:50:30 +00:00
/**
* Custom passthrough attributes for each DOM elements
*/
2024-04-18 14:13:33 +00:00
export interface CalendarPassThroughAttributes extends DatePicker.DatePickerPassThroughAttributes {}
2023-05-04 14:50:30 +00:00
/**
* Defines current inline state in Calendar component.
*/
2024-04-18 14:13:33 +00:00
export interface CalendarState extends DatePicker.DatePickerState {}
2023-05-04 14:50:30 +00:00
/**
* Defines current date options in Calendar component.
*/
2024-04-18 14:13:33 +00:00
export interface CalendarDateContext extends DatePicker.DatePickerDateContext {}
2023-07-31 06:18:21 +00:00
/**
* Defines current options in Calendar component.
*/
2024-04-18 14:13:33 +00:00
export interface CalendarContext extends DatePicker.DatePickerContext {}
2023-07-31 06:18:21 +00:00
/**
2023-09-05 09:14:08 +00:00
* Defines current month options.
2023-07-31 06:18:21 +00:00
*/
2024-04-18 14:13:33 +00:00
export interface CalendarMonthOptions extends DatePicker.DatePickerMonthOptions {}
2023-07-31 06:18:21 +00:00
/**
* Defines current year options.
*/
2024-04-18 14:13:33 +00:00
export interface CalendarYearOptions extends DatePicker.DatePickerYearOptions {}
2023-07-31 06:18:21 +00:00
2023-03-01 06:38:59 +00:00
/**
2024-04-01 13:36:40 +00:00
* Defines valid properties in Calendar component.
2023-03-01 06:38:59 +00:00
*/
2024-04-18 14:13:33 +00:00
export interface CalendarProps extends DatePicker.DatePickerProps {}
/**
* Defines valid options of the date slot in Calendar component.
*/
2024-04-18 14:13:33 +00:00
export interface CalendarDateSlotOptions extends DatePicker.DatePickerDateSlotOptions {}
2022-09-06 12:03:37 +00:00
2023-03-01 06:38:59 +00:00
/**
* Defines valid slots in Calendar component.
*/
2024-04-18 14:13:33 +00:00
export interface CalendarSlots extends DatePicker.DatePickerSlots {}
2022-09-06 12:03:37 +00:00
2023-03-01 06:38:59 +00:00
/**
* Defines valid emits in Calendar component.
*/
interface CalendarEmitsOptions {}
export declare type CalendarEmits = EmitFn<CalendarEmitsOptions> & DatePicker.DatePickerEmits;
2022-09-06 12:03:37 +00:00
2023-03-01 06:38:59 +00:00
/**
2024-04-18 14:13:33 +00:00
* @deprecated Deprecated since v4. Use DatePicker component instead.
*
2023-03-01 06:38:59 +00:00
* **PrimeVue - Calendar**
*
* _Calendar also known as DatePicker, is a form component to work with dates._
*
2024-04-18 14:13:33 +00:00
* [Live Demo](https://www.primevue.org/datepicker/)
2023-03-01 06:38:59 +00:00
* --- ---
* ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
*
* @group Component
*
2023-03-01 06:38:59 +00:00
*/
declare const Calendar: DefineComponent<CalendarProps, CalendarSlots, CalendarEmits>;
2022-09-06 12:03:37 +00:00
declare module 'vue' {
export interface GlobalComponents {
Calendar: GlobalComponentConstructor<CalendarProps, CalendarSlots, CalendarEmits>;
2022-09-06 12:03:37 +00:00
}
}
export default Calendar;