Fonctions d'aide Javascript

Description #

Afin de faciliter l’utilisation du thème, des fonctions d’aide javascripts définies dans le fichier assets/js/theme/modules/helpers.js sont mises à disposition. Ces fonctions sont définies de manières globales à l’aide du fichier assets/js/theme/modules/helpersGlobal.js et peuvent donc être appelées depuis n’importe quel scope.

Fonctions d’aide javascript #

CodeDescription
closeModals(modal);

Fonction qui gère la fermeture des fenêtres modales:

  • Si renseigné, seul la fenêtre modale définie en entrée est fermée
  • Si aucune entrée, toutes les fenêtres modales sont fermées
disableSmoothScroll();Fonction désactivant le défilement doux du contenu principal.
enableSmoothScroll();Fonction activant le défilement doux du contenu principal.
getFirstVisibleElement(selector);

Function récupérant le premier élement visible d’un sélecteur CSS:

manageDefaultCollapsibleSidebar();

Fonction qui gère le comportement par défaut de la table des matières:

  • Si la fenêtre est supérieure ou égale à 1024 pixels de large, la table des matières est développée
  • Si la fenêtre est inférieure à 1024 pixels de large, la table des matières est réduite
manageDefaultToc();

Fonction qui gère le comportement par défaut du menu latéral:

  • Si la fenêtre est supérieure ou égale à 1216 pixels de large, le menu est développé
  • Si la fenêtre est inférieure à 1216 pixels de large, le menu est réduit
toggleExtendMenu(force);

Fonction qui gère le comportement du menu d’extension de la barre de navigation (uniquement si celui-ci est visible):

  • force
    • true: le menu d’extension est affiché
    • false: le menu d’extension est caché
toggleSidebar(force, noTransition);

Fonction qui gère le comportement du menu latéral:

  • force
    • true: le menu latéral est developpé
    • false: le menu latéral est réduit
  • noTransition
    • true: désactive l’animation de transition du menu
    • false: active l’animation de transition du menu (comportement par défaut)
toggleSidebarEntry(entry, force);

Fonction qui gère le comportement d’une entrée du menu latéral:

  • entry
    • entrée du ménu latéral permettant de développer ou réduire ses entrées (éléments <a> contenant la classe is-icon-expandable)
  • force
    • true: l’entrée du ménu latéral est developpée
    • false: l’entrée du ménu latéral est réduite
toggleSidebarEntries(force);

Fonction qui gère le comportement des entrées du menu latéral:

  • force
    • true: toutes les entrées du menu latéral sont développées
    • false: toutes les entrées du menu latéral sont réduites
toggleToc(force);

Fonction qui gère le comportement de la table des matières:

  • force
    • true: la table des matières est developpée
    • false: la table des matières est réduite