DevExtreme v23.2 is now available.

Explore our newest features/capabilities and share your thoughts with us.

Your search did not match any results.

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:

  1. 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 the isHoliday, isWeekend, and isDinner functions.
    • isHoliday / isWeekend / isDinner
      Check whether a date/time interval is a holiday, a weekend, or dinner time.
  2. 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, cancel the 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.

  3. 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 the applyDisableDatesToDateEditors function to see how this is done. Call this function from onAppointmentFormOpening.

  4. 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.

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-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 { DxScheduler, 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'); function onAppointmentFormOpening(e: DxSchedulerTypes.AppointmentFormOpeningEvent) { const startDate = new Date(e.appointmentData.startDate); if (!Utils.isValidAppointmentDate(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) { const startDateEditor = form.getEditor('startDate'); startDateEditor.option('disabledDates', holidays); const endDateEditor = form.getEditor('endDate'); endDateEditor.option('disabledDates', holidays); } </script>
<template> <div :class="markDataCell(cellData)"> <slot/> </div> </template> <script setup lang="ts"> import Utils from './utils.ts'; withDefaults(defineProps<{ cellData?: any }>(), { cellData: () => {}, }); function markDataCell(cellData) { 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 = withDefaults(defineProps<{ cellData?: any }>(), { cellData: () => {}, }); 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, currentView) { 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) { return { dinner: Utils.isDinner(cellData.date) }; } </script>
window.exports = window.exports || {}; window.config = { transpiler: 'plugin-babel', meta: { '*.vue': { loader: 'vue-loader', }, '*.ts': { loader: 'demo-ts-loader', }, '*.svg': { loader: 'svg-loader', }, 'devextreme/time_zone_utils.js': { 'esModule': true, }, 'devextreme/localization.js': { 'esModule': true, }, 'devextreme/viz/palette.js': { 'esModule': true, }, }, paths: { 'root:': '../../../../../', 'npm:': 'https://unpkg.com/', }, map: { 'vue': 'npm:vue@3.3.4/dist/vue.esm-browser.js', 'vue-loader': 'npm:dx-systemjs-vue-browser@1.1.1/index.js', 'demo-ts-loader': 'root:utils/demo-ts-loader.js', 'svg-loader': 'root:utils/svg-loader.js', 'mitt': 'npm:mitt/dist/mitt.umd.js', 'rrule': 'npm:rrule@2.6.4/dist/es5/rrule.js', 'luxon': 'npm:luxon@1.28.1/build/global/luxon.min.js', 'es6-object-assign': 'npm:es6-object-assign@1.1.0', 'devextreme': 'npm:devextreme@23.2.5/cjs', 'devextreme-vue': 'npm:devextreme-vue@23.2.5/cjs', 'jszip': 'npm:jszip@3.10.1/dist/jszip.min.js', 'devextreme-quill': 'npm:devextreme-quill@1.6.4/dist/dx-quill.min.js', 'devexpress-diagram': 'npm:devexpress-diagram@2.2.5/dist/dx-diagram.js', 'devexpress-gantt': 'npm:devexpress-gantt@4.1.51/dist/dx-gantt.js', '@devextreme/runtime': 'npm:@devextreme/runtime@3.0.12', 'inferno': 'npm:inferno@7.4.11/dist/inferno.min.js', 'inferno-compat': 'npm:inferno-compat/dist/inferno-compat.min.js', 'inferno-create-element': 'npm:inferno-create-element@7.4.11/dist/inferno-create-element.min.js', 'inferno-dom': 'npm:inferno-dom/dist/inferno-dom.min.js', 'inferno-hydrate': 'npm:inferno-hydrate@7.4.11/dist/inferno-hydrate.min.js', 'inferno-clone-vnode': 'npm:inferno-clone-vnode/dist/inferno-clone-vnode.min.js', 'inferno-create-class': 'npm:inferno-create-class/dist/inferno-create-class.min.js', 'inferno-extras': 'npm:inferno-extras/dist/inferno-extras.min.js', 'plugin-babel': 'npm:systemjs-plugin-babel@0.0.25/plugin-babel.js', 'systemjs-babel-build': 'npm:systemjs-plugin-babel@0.0.25/systemjs-babel-browser.js', // Prettier 'prettier/standalone': 'npm:prettier@2.8.4/standalone.js', 'prettier/parser-html': 'npm:prettier@2.8.4/parser-html.js', }, packages: { 'devextreme-vue': { main: 'index.js', }, 'devextreme': { defaultExtension: 'js', }, 'devextreme/events/utils': { main: 'index', }, 'devextreme/events': { main: 'index', }, 'es6-object-assign': { main: './index.js', defaultExtension: 'js', }, }, packageConfigPaths: [ 'npm:@devextreme/*/package.json', 'npm:@devextreme/runtime@3.0.12/inferno/package.json', ], babelOptions: { sourceMaps: false, stage0: true, }, }; System.config(window.config);
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 { 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, 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: 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); } }
@-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, 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; } .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: 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-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; } @media all and (-ms-high-contrast: none) { td.dx-scheduler-time-panel-cell .dinner .cafe { background-color: transparent; } }
<!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/23.2.5/css/dx.light.css" /> <link rel="stylesheet" type="text/css" href="styles.css" /> <script src="https://unpkg.com/typescript@4.2.4/lib/typescript.js"></script> <script type="module"> import * as vueCompilerSFC from "https://unpkg.com/@vue/compiler-sfc@3.3.4/dist/compiler-sfc.esm-browser.js"; window.vueCompilerSFC = vueCompilerSFC; </script> <script type="module"> import * as vueCompilerSFC from "https://unpkg.com/@vue/compiler-sfc@3.3.4/dist/compiler-sfc.esm-browser.js"; window.vueCompilerSFC = vueCompilerSFC; </script> <script src="https://unpkg.com/core-js@2.6.12/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.ts"); </script> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="app"> </div> </div> </body> </html>