Skip to content

Scheduler - sanitize Appointment type in d.ts #32691

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Tucchhaa wants to merge 4 commits into
base: 26_1
Choose a base branch
from
Draft

Scheduler - sanitize Appointment type in d.ts #32691

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a687dcd
sanitize
Tucchhaa Feb 25, 2026
a4fb0a3
fix alias.d.ts
Tucchhaa Feb 25, 2026
1d4e003
Merge branch '26_1' into sanitize_appointment_type_26_1
Tucchhaa Mar 4, 2026
52ccd94
Merge branch '26_1' into sanitize_appointment_type_26_1
Tucchhaa Mar 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions packages/devextreme-angular/src/ui/scheduler/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ import dxScheduler from 'devextreme/ui/scheduler';
import dxSortable from 'devextreme/ui/sortable';
import dxDraggable from 'devextreme/ui/draggable';
import DataSource from 'devextreme/data/data_source';
import { AllDayPanelMode, ViewType, dxSchedulerAppointment, AppointmentFormProperties, CellAppointmentsLimit, AppointmentAddedEvent, AppointmentAddingEvent, AppointmentClickEvent, AppointmentContextMenuEvent, AppointmentDblClickEvent, AppointmentDeletedEvent, AppointmentDeletingEvent, AppointmentFormOpeningEvent, AppointmentRenderedEvent, AppointmentTooltipShowingEvent, AppointmentUpdatedEvent, AppointmentUpdatingEvent, CellClickEvent, CellContextMenuEvent, ContentReadyEvent, DisposingEvent, InitializedEvent, OptionChangedEvent, RecurrenceEditMode, dxSchedulerScrolling, dxSchedulerToolbar } from 'devextreme/ui/scheduler';
import { AllDayPanelMode, ViewType, Appointment, AppointmentFormProperties, CellAppointmentsLimit, AppointmentAddedEvent, AppointmentAddingEvent, AppointmentClickEvent, AppointmentContextMenuEvent, AppointmentDblClickEvent, AppointmentDeletedEvent, AppointmentDeletingEvent, AppointmentFormOpeningEvent, AppointmentRenderedEvent, AppointmentTooltipShowingEvent, AppointmentUpdatedEvent, AppointmentUpdatingEvent, CellClickEvent, CellContextMenuEvent, ContentReadyEvent, DisposingEvent, InitializedEvent, OptionChangedEvent, RecurrenceEditMode, dxSchedulerScrolling, dxSchedulerToolbar } from 'devextreme/ui/scheduler';
import { event } from 'devextreme/events/events.types';
import { DataSourceOptions } from 'devextreme/data/data_source';
import { Store } from 'devextreme/data/store';
Expand Down Expand Up @@ -327,10 +327,10 @@ export class DxSchedulerComponent extends DxComponent implements OnDestroy, OnCh

*/
@Input()
get dataSource(): Array<dxSchedulerAppointment> | DataSource | DataSourceOptions | null | Store | string {
get dataSource(): Array<Appointment> | DataSource | DataSourceOptions | null | Store | string {
return this._getOption('dataSource');
}
set dataSource(value: Array<dxSchedulerAppointment> | DataSource | DataSourceOptions | null | Store | string) {
set dataSource(value: Array<Appointment> | DataSource | DataSourceOptions | null | Store | string) {
this._setOption('dataSource', value);
}

Expand Down Expand Up @@ -1166,7 +1166,7 @@ export class DxSchedulerComponent extends DxComponent implements OnDestroy, OnCh
* This member supports the internal infrastructure and is not intended to be used directly from your code.

*/
@Output() dataSourceChange: EventEmitter<Array<dxSchedulerAppointment> | DataSource | DataSourceOptions | null | Store | string>;
@Output() dataSourceChange: EventEmitter<Array<Appointment> | DataSource | DataSourceOptions | null | Store | string>;

/**

Expand Down
4 changes: 2 additions & 2 deletions packages/devextreme-vue/src/scheduler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import dxDraggable from "devextreme/ui/draggable";
import {
AllDayPanelMode,
ViewType,
dxSchedulerAppointment,
Appointment,
CellAppointmentsLimit,
AppointmentAddedEvent,
AppointmentAddingEvent,
Expand Down Expand Up @@ -231,7 +231,7 @@ const componentConfig = {
currentView: String as PropType<string | ViewType>,
customizeDateNavigatorText: Function as PropType<((info: { endDate: Date, startDate: Date, text: string }) => string)>,
dataCellTemplate: {},
dataSource: [Array, Object, String] as PropType<Array<dxSchedulerAppointment> | DataSource | DataSourceOptions | null | Store | string | Record<string, any>>,
dataSource: [Array, Object, String] as PropType<Array<Appointment> | DataSource | DataSourceOptions | null | Store | string | Record<string, any>>,
dateCellTemplate: {},
dateSerializationFormat: String,
descriptionExpr: String,
Expand Down
35 changes: 3 additions & 32 deletions packages/devextreme/js/ui/scheduler.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,12 +55,10 @@ interface AppointmentDraggingEvent {
export interface TargetedAppointmentInfo {
/**
* @docid
* @type dxSchedulerAppointment
*/
readonly appointmentData: Appointment;
/**
* @docid
* @type dxSchedulerAppointment
*/
readonly targetedAppointmentData?: Appointment;
}
Expand Down Expand Up @@ -111,7 +109,6 @@ export type SchedulerPredefinedDateNavigatorItem = 'prev' | 'next' | 'dateInterv
export type AppointmentAddedEvent = EventInfo<dxScheduler> & {
/**
* @docid _ui_scheduler_AppointmentAddedEvent.appointmentData
* @type dxSchedulerAppointment
*/
readonly appointmentData: Appointment;
/** @docid _ui_scheduler_AppointmentAddedEvent.error */
Expand All @@ -127,7 +124,6 @@ export type AppointmentAddedEvent = EventInfo<dxScheduler> & {
export type AppointmentAddingEvent = EventInfo<dxScheduler> & {
/**
* @docid _ui_scheduler_AppointmentAddingEvent.appointmentData
* @type dxSchedulerAppointment
*/
readonly appointmentData: Appointment;
/**
Expand Down Expand Up @@ -179,7 +175,6 @@ export type AppointmentDblClickEvent = Cancelable & NativeEventInfo<dxScheduler,
export type AppointmentDeletedEvent = EventInfo<dxScheduler> & {
/**
* @docid _ui_scheduler_AppointmentDeletedEvent.appointmentData
* @type dxSchedulerAppointment
*/
readonly appointmentData: Appointment;
/** @docid _ui_scheduler_AppointmentDeletedEvent.error */
Expand All @@ -195,7 +190,6 @@ export type AppointmentDeletedEvent = EventInfo<dxScheduler> & {
export type AppointmentDeletingEvent = EventInfo<dxScheduler> & {
/**
* @docid _ui_scheduler_AppointmentDeletingEvent.appointmentData
* @type dxSchedulerAppointment
*/
readonly appointmentData: Appointment;
/**
Expand All @@ -214,7 +208,6 @@ export type AppointmentDeletingEvent = EventInfo<dxScheduler> & {
export type AppointmentFormOpeningEvent = Cancelable & EventInfo<dxScheduler> & {
/**
* @docid _ui_scheduler_AppointmentFormOpeningEvent.appointmentData
* @type dxSchedulerAppointment
*/
readonly appointmentData?: Appointment;
/** @docid _ui_scheduler_AppointmentFormOpeningEvent.form */
Expand Down Expand Up @@ -269,7 +262,6 @@ export type AppointmentRenderedEvent = EventInfo<dxScheduler> & TargetedAppointm
export type AppointmentUpdatedEvent = EventInfo<dxScheduler> & {
/**
* @docid _ui_scheduler_AppointmentUpdatedEvent.appointmentData
* @type dxSchedulerAppointment
*/
readonly appointmentData: Appointment;
/** @docid _ui_scheduler_AppointmentUpdatedEvent.error */
Expand Down Expand Up @@ -427,7 +419,6 @@ export type AppointmentCollectorTemplateData = {
readonly appointmentCount: number;
/**
* @docid
* @type Array<dxSchedulerAppointment>
*/
readonly items: Appointment[];
/**
Expand Down Expand Up @@ -587,7 +578,7 @@ export interface dxSchedulerOptions extends WidgetOptions<dxScheduler> {
* @docid
* @default null
* @public
* @type string|Array<dxSchedulerAppointment>|Store|DataSource|DataSourceOptions|null
* @type string|Array<Appointment>|Store|DataSource|DataSourceOptions|null
*/
dataSource?: DataSourceLike<Appointment> | null;
/**
Expand Down Expand Up @@ -1254,21 +1245,18 @@ export default class dxScheduler extends Widget<dxSchedulerOptions> {
/**
* @docid
* @publicName addAppointment(appointment)
* @param1 appointment:dxSchedulerAppointment
* @public
*/
addAppointment(appointment: Appointment): void;
/**
* @docid
* @publicName deleteAppointment(appointment)
* @param1 appointment:dxSchedulerAppointment
* @public
*/
deleteAppointment(appointment: Appointment): void;
/**
* @docid
* @publicName deleteRecurrence(appointment, date, recurrenceEditMode)
* @param1 appointmentData:dxSchedulerAppointment
* @public
*/
deleteRecurrence(
Expand All @@ -1286,7 +1274,6 @@ export default class dxScheduler extends Widget<dxSchedulerOptions> {
/**
* @docid
* @publicName getOccurrences(startDate, endDate, appointments)
* @param3 appointments:Array<dxSchedulerAppointment>
* @public
*/
getOccurrences(startDate: Date, endDate: Date, appointments: Appointment[]): Occurrence[];
Expand Down Expand Up @@ -1335,45 +1322,30 @@ export default class dxScheduler extends Widget<dxSchedulerOptions> {
/**
* @docid
* @publicName showAppointmentPopup(appointmentData, createNewAppointment, currentAppointmentData)
* @param1 appointmentData:dxSchedulerAppointment|undefined
* @param2 createNewAppointment:Boolean|undefined
* @param3 currentAppointmentData:dxSchedulerAppointment|undefined
* @public
*/
showAppointmentPopup(appointmentData?: Appointment, createNewAppointment?: boolean, currentAppointmentData?: Appointment): void;
/**
* @docid
* @publicName showAppointmentTooltip(appointmentData, target, currentAppointmentData)
* @param1 appointmentData:dxSchedulerAppointment
* @param2 target:string|Element|jQuery
* @param3 currentAppointmentData:dxSchedulerAppointment|undefined
* @public
*/
showAppointmentTooltip(appointmentData: Appointment, target: string | UserDefinedElement, currentAppointmentData?: Appointment): void;
/**
* @docid
* @publicName updateAppointment(target, appointment)
* @param1 target:dxSchedulerAppointment
* @param2 appointment:dxSchedulerAppointment
* @public
*/
updateAppointment(target: Appointment, appointment: Appointment): void;
}

/**
* @docid
* @public
* @docid dxSchedulerAppointment
* @namespace DevExpress.ui
* @inherits CollectionWidgetItem
* @type object
*/
export type Appointment = dxSchedulerAppointment;

/**
* @namespace DevExpress.ui
* @deprecated Use the Scheduler's Appointment type instead
*/
export type dxSchedulerAppointment = CollectionWidgetItem & {
export type Appointment = CollectionWidgetItem & {
/**
* @docid
* @public
Expand Down Expand Up @@ -1461,7 +1433,6 @@ export type Occurrence = {
/**
* @docid
* @public
* @type dxSchedulerAppointment
*/
appointmentData: Appointment;
};
Expand Down
4 changes: 2 additions & 2 deletions packages/devextreme/ts/aliases.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,8 +227,8 @@ declare namespace DevExpress.ui {
/** @deprecated Use DevExpress.ui.dxResponsiveBoxItem */
export type dxResponsiveBoxItemTemplate = dxResponsiveBoxItem;

/** @deprecated Use DevExpress.ui.dxSchedulerAppointment */
export type dxSchedulerAppointmentTemplate = dxSchedulerAppointment;
/** @deprecated Use DevExpress.ui.dxScheduler.Appointment */
export type dxSchedulerAppointmentTemplate = dxScheduler.Appointment;

/** @deprecated Use DevExpress.ui.dxTabsItem */
export type dxTabsItemTemplate = dxTabsItem;
Expand Down
Loading
Loading