Disabled Date/Time Ranges
This demo shows how to disable specific days, dates, and times when a user cannot schedule an appointment. In the demo, appointments are disabled for weekends, certain individual dates (e.g., May 25th), and the time period from 12:00pm to 1:00pm.
To implement this functionality in your application, follow the steps below:
-
Implement date/time validation functions
These functions should check whether a date or time is available. This demo includes the following date/time validation functions: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 widget's upper right corner.
Feel free to share demo-related thoughts here.
If you have technical questions, please create a support ticket in the DevExpress Support Center.
If you have technical questions, please create a support ticket in the DevExpress Support Center.
Thank you!
We appreciate your feedback.
We appreciate your feedback.
<template>
<DxScheduler
:data-source="dataSource"
:current-date="currentDate"
:views="views"
:current-view="currentView"
:height="600"
: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-appointment-form-opening="onAppointmentFormOpening"
:on-appointment-adding="onAppointmentAdding"
:on-appointment-updating="onAppointmentUpdating"
>
<template #dataCellTemplate="{ data: cellData }">
<DataCell :cell-data="cellData"/>
</template>
<template #dateCellTemplate="{ data: cellData }">
<DateCell :cell-data="cellData"/>
</template>
<template #timeCellTemplate="{ data: cellData }">
<TimeCell :cell-data="cellData"/>
</template>
</DxScheduler>
</template>
<script>
import { DxScheduler } from 'devextreme-vue/scheduler';
import { data, holidays } from './data.js';
import notify from 'devextreme/ui/notify';
import Utils from './utils.js';
import DataCell from './DataCell.vue';
import DateCell from './DateCell.vue';
import TimeCell from './TimeCell.vue';
export default {
components: {
DxScheduler,
DataCell,
DateCell,
TimeCell
},
data() {
return {
views: ['workWeek', 'month'],
currentView: 'workWeek',
currentDate: new Date(2017, 4, 25),
dataSource: data
};
},
methods: {
onAppointmentFormOpening: function(e) {
const startDate = new Date(e.appointmentData.startDate);
if(!Utils.isValidAppointmentDate(startDate)) {
e.cancel = true;
this.notifyDisableDate();
}
this.applyDisableDatesToDateEditors(e.form);
},
onAppointmentAdding: function(e) {
const isValidAppointment = Utils.isValidAppointment(e.component, e.appointmentData);
if(!isValidAppointment) {
e.cancel = true;
this.notifyDisableDate();
}
},
onAppointmentUpdating(e) {
const isValidAppointment = Utils.isValidAppointment(e.component, e.newData);
if(!isValidAppointment) {
e.cancel = true;
this.notifyDisableDate();
}
},
notifyDisableDate() {
notify('Cannot create or move an appointment/event to disabled time/date regions.', 'warning', 1000);
},
applyDisableDatesToDateEditors(form) {
const startDateEditor = form.getEditor('startDate');
startDateEditor.option('disabledDates', holidays);
const endDateEditor = form.getEditor('endDate');
endDateEditor.option('disabledDates', holidays);
}
}
};
</script>
<template>
<div :class="markDataCell(cellData)">
{{ cellData.text }}
</div>
</template>
<script>
import Utils from './utils.js';
export default {
props: {
cellData: {
type: Object,
default: () => {}
}
},
methods: {
markDataCell(cellData) {
const date = cellData.startDate;
const isDisableDate = Utils.isHoliday(date) || Utils.isWeekend(date);
const isDinner = Utils.isDinner(date);
return {
'disable-date': isDisableDate,
'dinner': isDinner
};
}
}
};
</script>
<template>
<div :class="markDateCell(cellData)">
{{ cellData.text }}
</div>
</template>
<script>
import Utils from './utils.js';
export default {
props: {
cellData: {
type: Object,
default: () => {}
}
},
methods: {
markDateCell(cellData) {
return { 'disable-date': Utils.isWeekend(cellData.date) };
}
}
};
</script>
<template>
<div :class="markTimeCell(cellData)">
{{ cellData.text }}
<div
v-if="isDinner"
class="cafe"
/>
</div>
</template>
<script>
import Utils from './utils.js';
export default {
props: {
cellData: {
type: Object,
default: () => {}
}
},
computed: {
isDinner: function() {
const date = this.cellData.date;
return Utils.isDinner(date);
}
},
methods: {
markTimeCell(cellData) {
return { 'dinner': Utils.isDinner(cellData.date) };
}
}
};
</script>
import { dinnerTime, holidays } from './data.js';
export default class Utils {
static isHoliday(date) {
const localeDate = date.toLocaleDateString();
return holidays.filter(holiday => {
return holiday.toLocaleDateString() === localeDate;
}).length > 0;
}
static isWeekend(date) {
const day = date.getDay();
return day === 0 || day === 6;
}
static isDinner(date) {
const hours = date.getHours();
return hours >= dinnerTime.from && hours < dinnerTime.to;
}
static isValidAppointment(component, appointmentData) {
const startDate = new Date(appointmentData.startDate);
const endDate = new Date(appointmentData.endDate);
const cellDuration = component.option('cellDuration');
return Utils.isValidAppointmentInterval(startDate, endDate, cellDuration);
}
static isValidAppointmentInterval(startDate, endDate, cellDuration) {
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) {
return !Utils.isHoliday(date) && !Utils.isDinner(date) && !Utils.isWeekend(date);
}
}
import Vue from 'vue';
import App from './App.vue';
new Vue({
el: '#app',
components: { App },
template: '<App/>'
});
<!DOCTYPE html>
<html>
<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=1.0" />
<link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/20.1.8/css/dx.common.css" />
<link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/20.1.8/css/dx.light.css" />
<link rel="stylesheet" type="text/css" href="styles.css" />
<script src="https://unpkg.com/core-js@2.4.1/client/shim.min.js"></script>
<script src="https://unpkg.com/systemjs@0.21.3/dist/system.js"></script>
<script type="text/javascript" src="config.js"></script>
<script type="text/javascript">
System.import('./index.js');
</script>
</head>
<body class="dx-viewport">
<div class="demo-container">
<div id="app">
</div>
</div>
</body>
</html>
.disable-date,
.dinner {
height: 100%;
}
.disable-date {
background-image: repeating-linear-gradient(135deg,
rgba(244, 67, 54, 0.1),
rgba(244, 67, 54, 0.1) 4px,
transparent 4px,
transparent 9px);
color: #9B6467;
}
.dx-scheduler-header-panel-cell .disable-date {
display: flex;
flex-direction: column;
justify-content: center;
}
.dinner {
background: rgba(255, 193, 7, 0.2);
}
.dx-scheduler-time-panel-cell .dinner {
color: rgba(255, 193, 7);
font-weight: 400;
background: transparent;
}
.dx-draggable {
cursor: auto;
}
td.dx-scheduler-first-group-cell.dx-scheduler-time-panel-cell .dinner .cafe {
height: 200%;
width: 100%;
left: 50%;
-webkit-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>');
-webkit-mask-repeat: no-repeat;
-webkit-mask-position-y: 50%;
-webkit-mask-position-x: 100%;
margin-top: -4px;
background-color: #ffc107;
}
.dx-scheduler-date-table-cell {
padding: 0;
opacity: 1;
}
export const dinnerTime = { from: 12, to: 13 };
export const holidays = [
new Date(2017, 4, 25),
new Date(2017, 6, 4)
];
export const data = [
{
'text': 'Website Re-Design Plan',
'startDate': '2017-05-22T06:30:00.000Z',
'endDate': '2017-05-22T08:30:00.000Z'
},
{
'text': 'Install New Router in Dev Room',
'startDate': '2017-05-22T10:00:00.000Z',
'endDate': '2017-05-22T11:00:00.000Z',
'allDay': false
},
{
'text': 'Approve Personal Computer Upgrade Plan',
'startDate': '2017-05-23T07:00:00.000Z',
'endDate': '2017-05-23T08:00:00.000Z'
},
{
'text': 'Final Budget Review',
'startDate': '2017-05-23T10:30:00.000Z',
'endDate': '2017-05-23T12:00:00.000Z',
'allDay': false
},
{
'text': 'New Brochures',
'startDate': '2017-05-22T12:00:00.000Z',
'endDate': '2017-05-22T13:15:00.000Z',
'allDay': false
},
{
'text': 'Install New Database',
'startDate': '2017-05-24T06:45:00.000Z',
'endDate': '2017-05-24T09:00:00.000Z'
},
{
'text': 'Approve New Online Marketing Strategy',
'startDate': '2017-05-24T11:30:00.000Z',
'endDate': '2017-05-24T13:30:00.000Z',
'allDay': false
},
{
'text': 'Upgrade Personal Computers',
'startDate': '2017-05-23T12:30:00.000Z',
'endDate': '2017-05-23T13:45:00.000Z',
'allDay': false
},
{
'text': 'Prepare 2015 Marketing Plan',
'startDate': '2017-05-29T10:00:00.000Z',
'endDate': '2017-05-29T12:00:00.000Z',
'allDay': false
},
{
'text': 'Brochure Design Review',
'startDate': '2017-05-30T12:30:00.000Z',
'endDate': '2017-05-30T14:00:00.000Z',
'allDay': false
},
{
'text': 'Create Icons for Website',
'startDate': '2017-05-26T07:00:00.000Z',
'endDate': '2017-05-26T09:00:00.000Z'
},
{
'text': 'Upgrade Server Hardware',
'startDate': '2017-05-26T13:30:00.000Z',
'endDate': '2017-05-26T15:00:00.000Z',
'allDay': false
},
{
'text': 'Submit New Website Design',
'startDate': '2017-05-31T07:00:00.000Z',
'endDate': '2017-05-31T08:30:00.000Z',
'allDay': false
},
{
'text': 'Launch New Website',
'startDate': '2017-05-26T11:30:00.000Z',
'endDate': '2017-05-26T13:10:00.000Z',
'allDay': false
}
];
System.config({
transpiler: 'plugin-babel',
meta: {
'*.vue': {
loader: 'vue-loader'
},
},
paths: {
'npm:': 'https://unpkg.com/'
},
map: {
'vue': 'npm:vue@2.6.3/dist/vue.esm.browser.js',
'vue-loader': 'npm:dx-systemjs-vue-browser@latest/index.js',
'devextreme': 'npm:devextreme@20.1',
'devextreme-vue': 'npm:devextreme-vue@20.1',
'jszip': 'npm:jszip@3.1.3/dist/jszip.min.js',
'quill': 'npm:quill@1.3.7/dist/quill.js',
'devexpress-diagram': 'npm:devexpress-diagram@1.0.17',
'devexpress-gantt': 'npm:devexpress-gantt@1.0.10',
'plugin-babel': 'npm:systemjs-plugin-babel@0/plugin-babel.js',
'systemjs-babel-build': 'npm:systemjs-plugin-babel@0/systemjs-babel-browser.js'
},
packages: {
'devextreme-vue': {
main: 'index.js'
},
'devextreme': {
defaultExtension: 'js'
},
'devextreme/events/utils': {
main: 'index'
},
'devextreme/events': {
main: 'index'
},
},
babelOptions: {
sourceMaps: false,
stage0: true
}
});