Aller au contenu

rules

Ce contre quoi sont vérifiés les déplacements, redimensionnements et dépôts d’une personne avant qu’ils aient lieu.

TypeOmit<RulesContext, 'displayZone' | 'businessHours'>
Par défautnon défini
Modifiable en direct (update())Oui
Déclaré danspackages/core/src/kernel.ts
  • constraint : où peuvent aller les événements — 'businessHours' (dans businessHours ; rien sans elles), { groupId } (dans les événements de ce groupe : une garde dont les rendez-vous ne doivent pas sortir), ou { spans: [{ s, e }] } (dans des tranches données en millisecondes depuis l’époque).
  • overlap : false — aucun événement sur un autre (hors événements de fond) ; une fonction (still, moving) => boolean décide paire par paire, true voulant dire qu’ils peuvent se chevaucher.
  • allow : (placement) => boolean, votre dernier mot sur l’endroit où irait un événement (placement.event, start, end, resourceIds, external pour un événement venu d’ailleurs). Le start et le end d’un événement horaire sont dans son propre fuseau.
  • validRange : { start?, end? } (des PlainDate, la fin exclue) : un événement ne peut être déplacé, redimensionné ni déposé sur les jours en dehors (la navigation n’est pas limitée).

Un geste que les règles refusent n’a pas lieu — l’événement revient — et onProposalRefused dit pourquoi. Une commande de votre code est vérifiée aussi quand on le demande : calendar.run(command, { validate: true }). Le eventConstraint et le eventOverlap d’une ressource l’emportent sur celles-ci pour ses événements.

import { Temporal } from '@dzcalendar/core';
import { createCalendar } from '@dzcalendar/dom';
const calendar = createCalendar(element, {
timeZone: 'Europe/Paris',
editable: true,
businessHours: { daysOfWeek: [1, 2, 3, 4, 5], start: '08:30', end: '18:00' },
rules: {
constraint: 'businessHours',
overlap: false,
// Nothing on a Friday afternoon.
allow: ({ start }) => !(start instanceof Temporal.ZonedDateTime && start.dayOfWeek === 5 && start.hour >= 14),
},
onProposalRefused: (proposal) => console.log('refused', proposal),
});
// Later: overlaps allowed again.
calendar.update({ rules: { constraint: 'businessHours' } });

En Angular et en Vue elles vont dans options ; en React c’est une prop.

Glissez un événement hors des heures, ou sur un autre : il revient.

  • businessHours — les heures que veut dire 'businessHours'.
  • editable — ce qu’une personne peut changer.
  • resources — les règles propres d’une ressource.