Aller au contenu

views

Des vues à vous — trois jours, deux semaines, les dates d’un congrès — à côté des vues intégrées.

TypeReadonly<Record<string, ViewSpec | ViewSettings>>
Par défautnon défini
Modifiable en direct (update())Non — à la création seulement
Déclaré danspackages/core/src/kernel.ts

Chaque clé est le type d’une vue (le nom qu’utilisent initialView, headerViews et update({ view })) ; chaque valeur est soit des réglages — une family et ce qui diffère d’une vue simple — soit une spécification de vue complète. Une clé égale à un nom intégré le remplace.

  • family : 'timeGrid', 'dayGrid', 'list', 'multiMonth', ou la 'timeline' du Pro.
  • duration et alignment ('day', 'week', 'month', 'year', 'none') : la longueur d’une période et l’endroit où elle commence.
  • dateIncrement : de combien avancent précédent / suivant ; dayCount : combien de jours montrés (les jours masqués sautés).
  • visibleRange : une période fixe, quelle que soit la date.
  • hiddenDays : les jours masqués propres à la vue.

Les réglages sont vérifiés à la création du calendrier : une durée nulle, un nombre de jours sous 1 ou une plage qui finit avant de commencer lève une RangeError. Le libellé du bouton de la vue vient de messages.views.

import { createCalendar } from '@dzcalendar/dom';
const calendar = createCalendar(element, {
timeZone: 'Europe/Paris',
initialView: 'threeDays',
headerViews: ['threeDays', 'fortnight', 'timeGridWeek'],
views: {
// Three days from the date shown; previous / next move by three.
threeDays: { family: 'timeGrid', duration: { days: 3 } },
// Two weeks from the week's first day, moving one week at a time.
fortnight: { family: 'dayGrid', duration: { weeks: 2 }, alignment: 'week', dateIncrement: { weeks: 1 } },
},
messages: { views: { threeDays: '3 days', fortnight: 'Fortnight' } },
});

views est lu une fois, à la création du calendrier. En Angular il va dans les valeurs par défaut (provideDzCalendar({ views }) pour l’application, DZ_CALENDAR_DEFAULTS pour un composant) ; en React et en Vue, dans initial.

Deux vues à vous dans l’en-tête : trois jours à la fois, et deux semaines.

  • initialView — la vue montrée en premier.
  • hiddenDays — les jours qu’aucune vue ne montre.
  • Vues — et un dessin à vous avec defineView.