Aller au contenu

titleFormat

Comment s’écrit le titre de l’en-tête : les options de format de date de la plateforme, ou une fonction.

TypeTitleFormat — DateTimeFormatOptions | ((arg: TitleFormatArg) => string)
Par défautle mois, les jours d'une semaine, un jour en entier
Modifiable en direct (update())Oui, sous le nom formats : update({ formats: … })
Déclaré danspackages/core/src/kernel.ts

Par défaut le titre est le mois (octobre 2026), les jours d’une semaine (19 – 25 oct. 2026) ou un jour en entier, dans la locale du calendrier.

  • Des options de Intl.DateTimeFormat ({ month: 'long', year: 'numeric' }) : une plage s’écrit quand le premier et le dernier jour diffèrent.
  • Une fonction ({ start, end, view, locale }) => string : start et end sont le premier et le dernier jour montrés (des PlainDate), view est le type de la vue.

titleFormat est lu à la création du calendrier. Pour changer le titre ensuite, update({ formats: { title } }) prend les mêmes valeurs — formats.title l’emporte sur titleFormat quand les deux sont donnés.

import { createCalendar } from '@dzcalendar/dom';
const calendar = createCalendar(element, {
timeZone: 'Europe/Paris',
titleFormat: ({ start, view }) => (view === 'timeGridWeek' ? `Week of ${start.toLocaleString('en-GB', { day: 'numeric', month: 'long' })}` : start.toLocaleString('en-GB', { month: 'long', year: 'numeric' })),
});
// Later: the title in another way.
calendar.update({ formats: { title: { month: 'long', year: 'numeric' } } });

titleFormat est lu une fois, à la création du calendrier : en Angular par les valeurs par défaut (DZ_CALENDAR_DEFAULTS, provideDzCalendar), en React et en Vue par initial — ou, à chaud, formats: { title } dans chacun.

Le titre de la semaine écrit par l’application : le mois en entier et l’année.

  • locale — la langue dans laquelle il s’écrit.
  • formats — l’écriture de tous les autres endroits.
  • headerToolbar — où va le titre.