Aller au contenu

headerToolbar

Ce que contient l’en-tête du calendrier — les flèches, « aujourd’hui », le titre, les boutons des vues, vos propres boutons — et où ; false pour aucun en-tête.

TypeHeaderToolbar | false
Par défaut{ start: 'prev,next today', center: 'title', end: headerViews }
Modifiable en direct (update())Oui
Déclaré danspackages/dom/src/calendar.ts

L’en-tête a trois places : start, center et end. start et end suivent le sens d’écriture — en arabe, start est à droite. Chaque place est une chaîne de noms :

  • une espace sépare des groupes : 'prev today' donne deux boutons séparés ;
  • une virgule joint des boutons en un groupe : 'prev,next' est dessiné d’un seul tenant. Un groupe de noms de vues est le sélecteur de vue, sa vue courante enfoncée.

Les noms :

Nom Quoi
prev, next La période précédente et la suivante
today Retour à aujourd’hui
title Le titre de la période (une région live, aria-live="polite", pour les lecteurs d’écran)
le nom d’une vue Un bouton pour cette vue : dayGridMonth, timeGridWeek, listWeek…
une clé de customButtons L’un de vos boutons
une clé de headerItems Une place pour votre propre contenu (un menu, un filtre)

false retire l’en-tête : votre application dessine le sien, avec calendar.navigate() et calendar.kernel.getState().title — ou, dans les frameworks, le contrôleur.

Sans headerToolbar, la fin de l’en-tête montre les vues de headerViews (par défaut : mois, semaine, jour) ; une vue seule ne montre pas de sélecteur.

Un nom inconnu, ou une vue dont l’entrée n’a pas été importée, est laissé de côté et signalé une fois dans la console. Rien ne lève d’exception.

Un bouton « Recharger » à vous, avant les vues :

import { createCalendar } from '@dzcalendar/dom';
const calendar = createCalendar(element, {
timeZone: 'Europe/Paris',
locale: 'fr-FR',
headerToolbar: { start: 'title', center: '', end: 'reload today prev,next dayGridMonth,timeGridWeek' },
customButtons: {
reload: { text: 'Recharger', click: () => calendar.refetch() },
},
});
// Plus tard : plus d'en-tête du tout.
calendar.update({ headerToolbar: false });

Un bouton de customButtons prend text (ses mots et son nom accessible), hint (au survol ; le nom accessible quand il n’y a pas de texte), icon (une classe à vous, posée sur un span masqué avant les mots), click(event, element) et active (un booléen ou une fonction : le bouton devient une bascule, dessinée enfoncée). De nouvelles fonctions pour les mêmes boutons — les closures qu’un framework recrée à chaque rendu — sont prises sans redessiner l’en-tête : le bouton garde le focus.

Le titre au début ; « aujourd’hui », les flèches et le sélecteur de vue à la fin.