Skip to content

[scheduler] Fix JSDoc defaults and improve public type readability #22784

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

Merged
rita-codes merged 3 commits into from
Jun 15, 2026
Merged

[scheduler] Fix JSDoc defaults and improve public type readability #22784

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b1cdd85
[scheduler] Fix JSDoc defaults and improve public type readability
mustafajw07 Jun 11, 2026
f600b3f
Merge branch 'master' into docs/22744-scheduler-public-types-jsdoc-cl…
rita-codes Jun 15, 2026
df15da0
[scheduler] docs updated for preferences
mustafajw07 Jun 15, 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
2 changes: 1 addition & 1 deletion docs/pages/x/api/scheduler/event-calendar-premium.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@
"name": "union",
"description": "false<br>&#124;&nbsp;{ toggleAmpm?: bool, toggleEmptyDaysInAgenda?: bool, toggleWeekendVisibility?: bool, toggleWeekNumberVisibility?: bool, toggleWeekStartsOn?: bool }"
},
"default": "{ toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true }"
"default": "{ toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true, toggleWeekStartsOn: false }"
},
"readOnly": { "type": { "name": "bool" }, "default": "false" },
"resourceModelStructure": { "type": { "name": "object" } },
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/x/api/scheduler/event-calendar.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@
"name": "union",
"description": "false<br>&#124;&nbsp;{ toggleAmpm?: bool, toggleEmptyDaysInAgenda?: bool, toggleWeekendVisibility?: bool, toggleWeekNumberVisibility?: bool, toggleWeekStartsOn?: bool }"
},
"default": "{ toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true }"
"default": "{ toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true, toggleWeekStartsOn: false }"
},
"readOnly": { "type": { "name": "bool" }, "default": "false" },
"resourceModelStructure": { "type": { "name": "object" } },
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/x/api/scheduler/standalone-agenda-view-premium.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@
"name": "union",
"description": "false<br>&#124;&nbsp;{ toggleAmpm?: bool, toggleEmptyDaysInAgenda?: bool, toggleWeekendVisibility?: bool, toggleWeekNumberVisibility?: bool, toggleWeekStartsOn?: bool }"
},
"default": "{ toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true }"
"default": "{ toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true, toggleWeekStartsOn: false }"
},
"readOnly": { "type": { "name": "bool" }, "default": "false" },
"resourceModelStructure": { "type": { "name": "object" } },
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/x/api/scheduler/standalone-agenda-view.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@
"name": "union",
"description": "false<br>&#124;&nbsp;{ toggleAmpm?: bool, toggleEmptyDaysInAgenda?: bool, toggleWeekendVisibility?: bool, toggleWeekNumberVisibility?: bool, toggleWeekStartsOn?: bool }"
},
"default": "{ toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true }"
"default": "{ toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true, toggleWeekStartsOn: false }"
},
"readOnly": { "type": { "name": "bool" }, "default": "false" },
"resourceModelStructure": { "type": { "name": "object" } },
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/x/api/scheduler/standalone-day-view-premium.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@
"name": "union",
"description": "false<br>&#124;&nbsp;{ toggleAmpm?: bool, toggleEmptyDaysInAgenda?: bool, toggleWeekendVisibility?: bool, toggleWeekNumberVisibility?: bool, toggleWeekStartsOn?: bool }"
},
"default": "{ toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true }"
"default": "{ toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true, toggleWeekStartsOn: false }"
},
"readOnly": { "type": { "name": "bool" }, "default": "false" },
"resourceModelStructure": { "type": { "name": "object" } },
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/x/api/scheduler/standalone-day-view.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@
"name": "union",
"description": "false<br>&#124;&nbsp;{ toggleAmpm?: bool, toggleEmptyDaysInAgenda?: bool, toggleWeekendVisibility?: bool, toggleWeekNumberVisibility?: bool, toggleWeekStartsOn?: bool }"
},
"default": "{ toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true }"
"default": "{ toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true, toggleWeekStartsOn: false }"
},
"readOnly": { "type": { "name": "bool" }, "default": "false" },
"resourceModelStructure": { "type": { "name": "object" } },
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/x/api/scheduler/standalone-month-view-premium.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@
"name": "union",
"description": "false<br>&#124;&nbsp;{ toggleAmpm?: bool, toggleEmptyDaysInAgenda?: bool, toggleWeekendVisibility?: bool, toggleWeekNumberVisibility?: bool, toggleWeekStartsOn?: bool }"
},
"default": "{ toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true }"
"default": "{ toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true, toggleWeekStartsOn: false }"
},
"readOnly": { "type": { "name": "bool" }, "default": "false" },
"resourceModelStructure": { "type": { "name": "object" } },
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/x/api/scheduler/standalone-month-view.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@
"name": "union",
"description": "false<br>&#124;&nbsp;{ toggleAmpm?: bool, toggleEmptyDaysInAgenda?: bool, toggleWeekendVisibility?: bool, toggleWeekNumberVisibility?: bool, toggleWeekStartsOn?: bool }"
},
"default": "{ toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true }"
"default": "{ toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true, toggleWeekStartsOn: false }"
},
"readOnly": { "type": { "name": "bool" }, "default": "false" },
"resourceModelStructure": { "type": { "name": "object" } },
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/x/api/scheduler/standalone-week-view-premium.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@
"name": "union",
"description": "false<br>&#124;&nbsp;{ toggleAmpm?: bool, toggleEmptyDaysInAgenda?: bool, toggleWeekendVisibility?: bool, toggleWeekNumberVisibility?: bool, toggleWeekStartsOn?: bool }"
},
"default": "{ toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true }"
"default": "{ toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true, toggleWeekStartsOn: false }"
},
"readOnly": { "type": { "name": "bool" }, "default": "false" },
"resourceModelStructure": { "type": { "name": "object" } },
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/x/api/scheduler/standalone-week-view.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@
"name": "union",
"description": "false<br>&#124;&nbsp;{ toggleAmpm?: bool, toggleEmptyDaysInAgenda?: bool, toggleWeekendVisibility?: bool, toggleWeekNumberVisibility?: bool, toggleWeekStartsOn?: bool }"
},
"default": "{ toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true }"
"default": "{ toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true, toggleWeekStartsOn: false }"
},
"readOnly": { "type": { "name": "bool" }, "default": "false" },
"resourceModelStructure": { "type": { "name": "object" } },
Expand Down
6 changes: 3 additions & 3 deletions packages/x-scheduler-internals/src/models/event.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -459,15 +459,15 @@ export type SchedulerEventPasteProperties = Partial<
export type EventSurfaceType = 'day-grid' | 'time-grid' | 'timeline';

export type SchedulerEventModelStructure<TEvent extends object> = {
[key in keyof SchedulerEvent]?: {
getter: (event: TEvent) => SchedulerEvent[key];
[K in keyof SchedulerEvent]?: {
getter: (event: TEvent) => SchedulerEvent[K];
/**
* Setter for the event property.
* If not provided, the property won't be editable.
*/
setter?: (
event: TEvent | Partial<TEvent>,
value: SchedulerEvent[key],
value: SchedulerEvent[K],
) => TEvent | Partial<TEvent>;
};
};
Expand Down
2 changes: 1 addition & 1 deletion packages/x-scheduler-internals/src/models/preferences.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ export interface EventCalendarPreferencesMenuConfig {
toggleWeekNumberVisibility: boolean;
/**
* Whether the menu item to toggle AM/PM time format is visible.
* @default false
* @default true
*/
toggleAmpm: boolean;
/**
Expand Down
2 changes: 1 addition & 1 deletion packages/x-scheduler-internals/src/use-event-calendar/EventCalendarStore.types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ export interface EventCalendarParameters<
* Config of the preferences menu.
* Defines which options are visible in the menu.
* If `false`, the menu will be entirely hidden.
* @default { toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true }
* @default { toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true, toggleWeekStartsOn: false }
*/
preferencesMenuConfig?: Partial<EventCalendarPreferencesMenuConfig> | false;
}
2 changes: 1 addition & 1 deletion packages/x-scheduler-premium/src/agenda-view-premium/StandaloneAgendaViewPremium.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ StandaloneAgendaViewPremium.propTypes = {
* Config of the preferences menu.
* Defines which options are visible in the menu.
* If `false`, the menu will be entirely hidden.
* @default { toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true }
* @default { toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true, toggleWeekStartsOn: false }
*/
preferencesMenuConfig: PropTypes.oneOfType([
PropTypes.oneOf([false]),
Expand Down
2 changes: 1 addition & 1 deletion packages/x-scheduler-premium/src/day-view-premium/StandaloneDayViewPremium.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ StandaloneDayViewPremium.propTypes = {
* Config of the preferences menu.
* Defines which options are visible in the menu.
* If `false`, the menu will be entirely hidden.
* @default { toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true }
* @default { toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true, toggleWeekStartsOn: false }
*/
preferencesMenuConfig: PropTypes.oneOfType([
PropTypes.oneOf([false]),
Expand Down
2 changes: 1 addition & 1 deletion packages/x-scheduler-premium/src/event-calendar-premium/EventCalendarPremium.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@ EventCalendarPremium.propTypes = {
* Config of the preferences menu.
* Defines which options are visible in the menu.
* If `false`, the menu will be entirely hidden.
* @default { toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true }
* @default { toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true, toggleWeekStartsOn: false }
*/
preferencesMenuConfig: PropTypes.oneOfType([
PropTypes.oneOf([false]),
Expand Down
2 changes: 1 addition & 1 deletion packages/x-scheduler-premium/src/month-view-premium/StandaloneMonthViewPremium.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ StandaloneMonthViewPremium.propTypes = {
* Config of the preferences menu.
* Defines which options are visible in the menu.
* If `false`, the menu will be entirely hidden.
* @default { toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true }
* @default { toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true, toggleWeekStartsOn: false }
*/
preferencesMenuConfig: PropTypes.oneOfType([
PropTypes.oneOf([false]),
Expand Down
2 changes: 1 addition & 1 deletion packages/x-scheduler-premium/src/week-view-premium/StandaloneWeekViewPremium.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ StandaloneWeekViewPremium.propTypes = {
* Config of the preferences menu.
* Defines which options are visible in the menu.
* If `false`, the menu will be entirely hidden.
* @default { toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true }
* @default { toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true, toggleWeekStartsOn: false }
*/
preferencesMenuConfig: PropTypes.oneOfType([
PropTypes.oneOf([false]),
Expand Down
2 changes: 1 addition & 1 deletion packages/x-scheduler/src/agenda-view/StandaloneAgendaView.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ StandaloneAgendaView.propTypes = {
* Config of the preferences menu.
* Defines which options are visible in the menu.
* If `false`, the menu will be entirely hidden.
* @default { toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true }
* @default { toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true, toggleWeekStartsOn: false }
*/
preferencesMenuConfig: PropTypes.oneOfType([
PropTypes.oneOf([false]),
Expand Down
2 changes: 1 addition & 1 deletion packages/x-scheduler/src/day-view/StandaloneDayView.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ StandaloneDayView.propTypes = {
* Config of the preferences menu.
* Defines which options are visible in the menu.
* If `false`, the menu will be entirely hidden.
* @default { toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true }
* @default { toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true, toggleWeekStartsOn: false }
*/
preferencesMenuConfig: PropTypes.oneOfType([
PropTypes.oneOf([false]),
Expand Down
2 changes: 1 addition & 1 deletion packages/x-scheduler/src/event-calendar/EventCalendar.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ EventCalendar.propTypes = {
* Config of the preferences menu.
* Defines which options are visible in the menu.
* If `false`, the menu will be entirely hidden.
* @default { toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true }
* @default { toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true, toggleWeekStartsOn: false }
*/
preferencesMenuConfig: PropTypes.oneOfType([
PropTypes.oneOf([false]),
Expand Down
2 changes: 1 addition & 1 deletion packages/x-scheduler/src/month-view/StandaloneMonthView.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ StandaloneMonthView.propTypes = {
* Config of the preferences menu.
* Defines which options are visible in the menu.
* If `false`, the menu will be entirely hidden.
* @default { toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true }
* @default { toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true, toggleWeekStartsOn: false }
*/
preferencesMenuConfig: PropTypes.oneOfType([
PropTypes.oneOf([false]),
Expand Down
2 changes: 1 addition & 1 deletion packages/x-scheduler/src/week-view/StandaloneWeekView.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ StandaloneWeekView.propTypes = {
* Config of the preferences menu.
* Defines which options are visible in the menu.
* If `false`, the menu will be entirely hidden.
* @default { toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true }
* @default { toggleWeekendVisibility: true, toggleWeekNumberVisibility: true, toggleAmpm: true, toggleEmptyDaysInAgenda: true, toggleWeekStartsOn: false }
*/
preferencesMenuConfig: PropTypes.oneOfType([
PropTypes.oneOf([false]),
Expand Down
Loading