Aller au contenu

formats

Comment chaque endroit du calendrier écrit ses dates et ses heures — les options de la plateforme, ou une fonction.

TypeFormats
Par défautnon défini
Modifiable en direct (update())Oui
Déclaré danspackages/dom/src/calendar.ts

Une entrée par endroit : title (celui de l’en-tête, voir titleFormat), dayHeader, dayCell, slotLabel (les libellés des heures), eventTime, eventTimeRange, listDay, listDaySide, monthHeader, morePopover, et weekNumber. Chacune prend des options de Intl.DateTimeFormat ({ hour: 'numeric' }) ou une fonction de son contexte ({ date | time | start, end, locale, … }) qui renvoie le texte — weekNumber une fonction seulement. Un endroit non donné s’écrit comme par défaut, dans locale (et displayCalendar).

update({ formats }) remplace les formats donnés avant.

import { createCalendar } from '@dzcalendar/dom';
createCalendar(element, {
timeZone: 'Europe/Paris',
weekNumbers: true,
formats: {
slotLabel: { hour: 'numeric' },
dayHeader: { weekday: 'short', day: 'numeric' },
// A function: the week's number with a prefix of the clinic's.
weekNumber: ({ week }) => `Wk ${week}`,
},
});

En Angular et en Vue elle va dans options ; en React c’est une prop.

La gouttière étiquetée par l’heure seule (09 h, 10 h…), les jours par leur jour court et leur numéro (lun. 19).