Backend API
<template>
<DxScheduler
:data-source="dataSource"
:current-date="currentDate"
:views="views"
v-model:current-view="currentView"
:height="730"
:show-all-day-panel="false"
:first-day-of-week="0"
:start-day-hour="9"
:end-day-hour="19"
data-cell-template="dataCellTemplate"
date-cell-template="dateCellTemplate"
time-cell-template="timeCellTemplate"
:on-content-ready="onContentReady"
:on-appointment-form-opening="onAppointmentFormOpening"
:on-appointment-adding="onAppointmentAdding"
:on-appointment-updating="onAppointmentUpdating"
>
<template #dataCellTemplate="{ data: cellData }">
<DataCellMonth
v-if="isMonthView"
:cell-data="cellData"
/>
<DataCell
v-else
:cell-data="cellData"
/>
</template>
<template #dateCellTemplate="{ data: cellData }">
<DateCell
:cell-data="cellData"
:current-view="currentView"
/>
</template>
<template #timeCellTemplate="{ data: cellData }">
<TimeCell :cell-data="cellData"/>
</template>
</DxScheduler>
</template>
<script setup lang="ts">
import { computed, ref } from 'vue';
import { DxForm } from 'devextreme-vue';
import { DxScheduler, type DxSchedulerTypes } from 'devextreme-vue/scheduler';
import notify from 'devextreme/ui/notify';
import { data, holidays } from './data.ts';
import Utils from './utils.ts';
import DataCell from './DataCell.vue';
import DataCellMonth from './DataCellMonth.vue';
import DateCell from './DateCell.vue';
import TimeCell from './TimeCell.vue';
const views: DxSchedulerTypes.ViewType[] = ['workWeek', 'month'];
const currentView = ref<DxSchedulerTypes.ViewType>('workWeek');
const currentDate = new Date(2021, 3, 27);
const dataSource = data;
const isMonthView = computed(() => currentView.value === 'month');
const ariaDescription = computed(() => {
const disabledDates = holidays
.filter((date) => !Utils.isWeekend(date))
.map((date) => new Date(date).toLocaleDateString('en-US', {
weekday: 'long',
year: 'numeric',
month: 'long',
day: 'numeric',
}),
);
if (disabledDates?.length === 1) {
return `${disabledDates} is a disabled date`;
}
if (disabledDates?.length > 1) {
return `${disabledDates.join(', ')} are disabled dates`;
}
return '';
});
function onContentReady(e: DxSchedulerTypes.ContentReadyEvent) {
setComponentAria(e.component?.$element());
}
function onAppointmentFormOpening(e: DxSchedulerTypes.AppointmentFormOpeningEvent) {
if (e.appointmentData?.startDate
&& !Utils.isValidAppointmentDate(new Date(e.appointmentData.startDate))) {
e.cancel = true;
notifyDisableDate();
applyDisableDatesToDateEditors(e.form);
}
}
function onAppointmentAdding(e: DxSchedulerTypes.AppointmentAddingEvent) {
const isValidAppointment = Utils.isValidAppointment(e.component, e.appointmentData);
if (!isValidAppointment) {
e.cancel = true;
notifyDisableDate();
}
}
function onAppointmentUpdating(e: DxSchedulerTypes.AppointmentUpdatingEvent) {
const isValidAppointment = Utils.isValidAppointment(e.component, e.newData);
if (!isValidAppointment) {
e.cancel = true;
notifyDisableDate();
}
}
function notifyDisableDate() {
notify('Cannot create or move an appointment/event to disabled time/date regions.', 'warning', 1000);
}
function applyDisableDatesToDateEditors(form: DxForm['instance']) {
if (!form) {
return;
}
const startDateEditor = form.getEditor('startDate');
startDateEditor?.option('disabledDates', holidays);
const endDateEditor = form.getEditor('endDate');
endDateEditor?.option('disabledDates', holidays);
}
function setComponentAria(element: Record<string, any>) {
const prevAria = element?.attr('aria-label') || '';
const description = ariaDescription.value;
const nextAria = `${prevAria}${description ? ` ${description}` : ''}`;
element?.attr('aria-label', nextAria);
}
</script>
<template>
<div :class="markDataCell(cellData)">
<slot/>
</div>
</template>
<script setup lang="ts">
import Utils from './utils.ts';
defineProps<{
cellData: Record<string, any>
}>();
function markDataCell(cellData: Record<string, any>) {
const date = cellData.startDate;
const isDisableDate = Utils.isHoliday(date) || Utils.isWeekend(date);
const isDinner = !isDisableDate && Utils.isDinner(date);
return {
'disable-date': isDisableDate,
dinner: isDinner,
};
}
</script>
<template>
<DataCell
class="dx-scheduler-date-table-cell-text"
:cell-data="cellData"
>
{{ day() }}
</DataCell>
</template>
<script setup lang="ts">
import DataCell from './DataCell.vue';
const props = defineProps<{
cellData: Record<string, any>
}>();
function day() {
return props.cellData.startDate.getDate();
}
</script>
<template>
<div :class="markDateCell(cellData, currentView)">
{{ cellData.text }}
</div>
</template>
<script setup lang="ts">
import Utils from './utils.ts';
withDefaults(defineProps<{
cellData?: any
currentView?: string
}>(), {
cellData: () => {},
currentView: '',
});
function markDateCell(cellData: Record<string, any>, currentView: string) {
const isDisabled = currentView === 'month'
? Utils.isWeekend(cellData.date)
: Utils.isDisableDate(cellData.date);
return { 'disable-date': isDisabled };
}
</script>
<template>
<div :class="markTimeCell(cellData)">
{{ cellData.text }}
<div
v-if="hasCoffeeCupIcon"
class="cafe"
/>
</div>
</template>
<script setup lang="ts">
import { computed } from 'vue';
import Utils from './utils.ts';
const props = withDefaults(defineProps<{
cellData?: any
}>(), {
cellData: () => {},
});
const hasCoffeeCupIcon = computed(() => {
const { date } = props.cellData;
return Utils.hasCoffeeCupIcon(date);
});
function markTimeCell(cellData: Record<string, any>) {
return { dinner: Utils.isDinner(cellData.date) };
}
</script>
export const dinnerTime = { from: 12, to: 13 };
export const holidays = [
new Date(2021, 3, 29),
new Date(2021, 5, 6),
];
export const data = [
{
text: 'Website Re-Design Plan',
startDate: new Date(2021, 3, 26, 9, 30),
endDate: new Date(2021, 3, 26, 11, 30),
},
{
text: 'Install New Router in Dev Room',
startDate: new Date(2021, 3, 26, 13),
endDate: new Date(2021, 3, 26, 14),
},
{
text: 'Approve Personal Computer Upgrade Plan',
startDate: new Date(2021, 3, 27, 10),
endDate: new Date(2021, 3, 27, 11),
},
{
text: 'Final Budget Review',
startDate: new Date(2021, 3, 27, 13, 30),
endDate: new Date(2021, 3, 27, 15),
},
{
text: 'New Brochures',
startDate: new Date(2021, 3, 26, 15),
endDate: new Date(2021, 3, 26, 16, 15),
},
{
text: 'Install New Database',
startDate: new Date(2021, 3, 28, 9, 45),
endDate: new Date(2021, 3, 28, 12),
},
{
text: 'Approve New Online Marketing Strategy',
startDate: new Date(2021, 3, 28, 14, 30),
endDate: new Date(2021, 3, 28, 16, 30),
},
{
text: 'Upgrade Personal Computers',
startDate: new Date(2021, 3, 27, 15, 30),
endDate: new Date(2021, 3, 27, 16, 45),
},
{
text: 'Prepare 2021 Marketing Plan',
startDate: new Date(2021, 4, 3, 13),
endDate: new Date(2021, 4, 3, 15),
},
{
text: 'Brochure Design Review',
startDate: new Date(2021, 4, 4, 15, 30),
endDate: new Date(2021, 4, 5),
},
{
text: 'Create Icons for Website',
startDate: new Date(2021, 3, 30, 10),
endDate: new Date(2021, 3, 30, 12),
},
{
text: 'Upgrade Server Hardware',
startDate: new Date(2021, 3, 30, 16, 30),
endDate: new Date(2021, 3, 30, 18),
},
{
text: 'Submit New Website Design',
startDate: new Date(2021, 4, 5, 10),
endDate: new Date(2021, 4, 5, 11, 30),
},
{
text: 'Launch New Website',
startDate: new Date(2021, 3, 30, 14, 30),
endDate: new Date(2021, 3, 30, 16, 10),
},
];
import { createApp } from 'vue';
import App from './App.vue';
createApp(App).mount('#app');
import type { DxScheduler } from 'devextreme-vue';
import { dinnerTime, holidays } from './data.ts';
export default class Utils {
static isHoliday(date: Date) {
const localeDate = date.toLocaleDateString();
return holidays.filter((holiday) => holiday.toLocaleDateString() === localeDate).length > 0;
}
static isWeekend(date: Date) {
const day = date.getDay();
return day === 0 || day === 6;
}
static isDisableDate(date: Date) {
return Utils.isHoliday(date) || Utils.isWeekend(date);
}
static isDinner(date: Date) {
const hours = date.getHours();
return hours >= dinnerTime.from && hours < dinnerTime.to;
}
static hasCoffeeCupIcon(date: Date) {
const hours = date.getHours();
const minutes = date.getMinutes();
return hours === dinnerTime.from && minutes === 0;
}
static isValidAppointment(component: DxScheduler['instance'], appointmentData: Record<string, any>) {
const startDate = new Date(appointmentData.startDate);
const endDate = new Date(appointmentData.endDate);
const cellDuration = component?.option('cellDuration') || 0;
return Utils.isValidAppointmentInterval(startDate, endDate, cellDuration);
}
static isValidAppointmentInterval(startDate: Date, endDate: Date, cellDuration: number) {
const edgeEndDate = new Date(endDate.getTime() - 1);
if (!Utils.isValidAppointmentDate(edgeEndDate)) {
return false;
}
const durationInMs = cellDuration * 60 * 1000;
const date = startDate;
while (date <= endDate) {
if (!Utils.isValidAppointmentDate(date)) {
return false;
}
const newDateTime = date.getTime() + durationInMs - 1;
date.setTime(newDateTime);
}
return true;
}
static isValidAppointmentDate(date: Date) {
return !Utils.isHoliday(date) && !Utils.isDinner(date) && !Utils.isWeekend(date);
}
}
/* stylelint-disable-next-line at-rule-no-vendor-prefix, at-rule-prelude-no-invalid */
@-moz-document url-prefix() {
.dx-scheduler-work-space-month .dx-scheduler-date-table-cell {
position: relative;
}
.dx-scheduler-work-space-month .dx-scheduler-date-table-cell .disable-date {
position: absolute;
width: 100%;
height: 100%;
}
}
.disable-date,
.dinner {
height: 100%;
width: 100%;
}
.disable-date {
background-image:
repeating-linear-gradient(
135deg,
var(--dx-datagrid-row-alternation-bg),
var(--dx-datagrid-row-alternation-bg) 2px,
transparent 2px,
transparent 6px
);
color: var(--dx-color-success);
}
.dx-scheduler-header-panel-cell .disable-date {
display: flex;
flex-direction: column;
justify-content: center;
}
.dx-theme-fluent .dx-scheduler-header-panel-cell .disable-date,
.dx-theme-material .dx-scheduler-header-panel-cell .disable-date {
flex-direction: row;
align-items: flex-end;
justify-content: initial;
}
.dinner {
background: var(--dx-datagrid-row-alternation-bg);
}
.dx-scheduler-time-panel-cell .dinner {
color: var(--dx-color-success);
font-weight: 400;
background: transparent;
}
.dx-draggable {
cursor: auto;
}
td.dx-scheduler-time-panel-cell .dinner .cafe {
height: 200%;
width: 100%;
left: 50%;
mask: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" height="24" viewBox="0 0 24 24" width="24"><path d="M0 0h24v24H0V0z" fill="none"/><path d="M20 3H4v10c0 2.21 1.79 4 4 4h6c2.21 0 4-1.79 4-4v-3h2c1.11 0 2-.9 2-2V5c0-1.11-.89-2-2-2zm0 5h-2V5h2v3zM4 19h16v2H4z"/></svg>');
mask-repeat: no-repeat;
-webkit-mask-position-y: 50%;
-webkit-mask-position-x: 100%;
margin-top: -4px;
background-color: var(--dx-color-success);
}
.dx-scheduler-date-table-cell {
padding: 0;
opacity: 1;
}
@media all and (-ms-high-contrast: none) {
td.dx-scheduler-time-panel-cell .dinner .cafe {
background-color: transparent;
}
}
<!DOCTYPE html>
<html lang="en">
<head>
<title>DevExtreme Demo</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=5.0" />
<link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/26.1.5/css/dx.light.css" />
<link rel="stylesheet" type="text/css" href="./bundle.css" />
</head>
<body class="dx-viewport">
<div class="demo-container">
<div id="app"> </div>
</div>
<script src="bundles/vendor/vue.vendor.js"></script>
<script src="./bundle.js"></script>
</body>
</html>
To implement this functionality in your application, follow the steps below:
-
Implement custom date/time validation functions
These functions should check whether a date or time is available. This demo includes the date/time validation functions listed below. In your application, they can be different.isValidAppointment
Prepares data and begins validation.isValidAppointmentInterval
Validates a date/time interval.isValidAppointmentDate
Calls theisHoliday,isWeekend, andisDinnerfunctions.isHoliday/isWeekend/isDinner
Check whether a date/time interval is a holiday, a weekend, or dinner time.
-
Validate appointments before they are created or updated
Before an appointment is created or updated, the Scheduler executes the onAppointmentAdding and onAppointmentUpdating functions. Use them to start validation. If a date or time is invalid,cancelthe creation or update. Implement the same logic in the onAppointmentFormOpening function so that users cannot open the appointment details form for a disabled date or time. -
Customize the appointment details form
The appointment details form includes two calendars that allow users to select an appointment's start and end date/time. You should also disable dates in these calendars. Review theapplyDisableDatesToDateEditorsfunction to see how this is done. Call this function from onAppointmentFormOpening. -
Customize the timetable appearance
Use templates to customize the appearance of data cells (dataCellTemplate), time cells (timeCellTemplate), and date cells (dateCellTemplate). In this demo, date cell customization is visible only in the Month view. To switch to this view, use the view switcher in the Scheduler's upper right corner.