vCarousel/src/vCarousel.ts

const Flickity = require("flickity");

interface options
{
    firstVideoId?: string;
    playFirstVideo?: boolean;
    playNextVideos?: boolean;
    noStop?: boolean;
}


/// La fonction vCarousel reçoit un tableau d'ids des conteneurs HTML des vidéos à afficher successivement.
/// Le tableau n'est pas dédoublonné, pour rester libre d'afficher plusieurs fois la même vidéo durant un tour du carrousel.
/// Plusieurs options sont possibles :
/// -  firstVideoId est une chaîne permettant de fournir l'id du conteneur de la première vidéo à afficher lors de l'appel. Par défaut la première vidéo de la liste sera affichée. Si on passe une chaîne vide, aucune ne sera affichée.
/// - playFirstVideo et playNextVideos demandent de lancer automatiquement la lecture respectivement de la vidéo demandée et de celles automatiquement chargée par la fonction. Ce n'est pas le cas par défaut et peut être bloqué par le navigateur.
/// - noStop permet de demander à ce que les vidéos continuent à tourner même quand toutes ont été affichées. Par défaut, le carrousel s'arrête.
export const vCarousel = (vContainers:string[], opts:options={}) : void =>
{    
    interface videoDOM
    {
        id: string;
        containerElt: HTMLElement;
        videoElt: HTMLMediaElement;
    }

    // On commence par vérifier que les ids de conteneurs fournis sont correctes.
    // C'est-à-dire qu'il s'agit bien d'éléments HTML contenant au moins une vidéo.
    const realVContainers : videoDOM[] = [];
    for(let containerId of vContainers)
    {
        let checkContainerExist=document.getElementById(containerId);
        if(checkContainerExist===null)
            console.error("Aucun élément HTML trouvé dans la page pour l'id fourni "+containerId);
        else
        {
            let checkVideoExist=<HTMLMediaElement>document.querySelector("#"+containerId+" video");
            if(checkVideoExist===null)
                console.error("Aucune balise vidéo trouvée dans l'élément HTML ayant comme id "+containerId);
            else
                realVContainers.push({id:containerId, containerElt:checkContainerExist, videoElt:checkVideoExist});
        }
    }
    
    // Si opts.firstVideoId a été fourni, on vérifie aussi qu'il est valide.
    if(opts.firstVideoId!==undefined && opts.firstVideoId!=="" && (realVContainers.findIndex(video => video.id === opts.firstVideoId) === -1))
    {
        console.error("Vous avez fourni l'id de la vidéo à afficher en premier ("+opts.firstVideoId+"), mais il n'est pas valide.");
        opts.firstVideoId=undefined;
    }

    // Il doit rester au moins deux vidéos à faire tourner.
    let nbVContainers=realVContainers.length;
    if(nbVContainers < 2)
        console.error("Il faut fournir au moins deux conteneurs valides pour faire tourner le carrousel.");
    else
    {
        // Tous les conteneurs sont cachés, sauf celui demandé.
        // La fin de lecture d'une vidéo provoque son remplacement par la suivante.
        for (let i = 0; i < nbVContainers; i++)
        {
            let vContainer=realVContainers[i].containerElt;
            let video=realVContainers[i].videoElt;
            if((opts.firstVideoId!==undefined && realVContainers[i].id!==opts.firstVideoId) || (opts.firstVideoId===undefined && i!==0) || opts.firstVideoId==="")
                vContainer.style.display = "none";
            else
            {
                vContainer.style.display = "block";
                if(opts.firstVideoId!==undefined && opts.playFirstVideo===true)
                    video.play();                  
            }
            var nbTurn=0;
            video.addEventListener("ended", function()
            {
                // Sauf si demandé en option, le carrousel s'arrête lorsque toutes les vidéos ont été affichées une fois.
                if(nbTurn < (nbVContainers-1) || opts.noStop===true)
                {
                    vContainer.style.display = "none";
                    let nextVContainer: HTMLElement, nextVideo: HTMLMediaElement, nextHash: string;
                    if(i < (nbVContainers-1))
                    {
                        nextVContainer=realVContainers[i+1].containerElt;
                        nextVideo=realVContainers[i+1].videoElt;
                        nextHash=realVContainers[i+1].id;
                    }
                    else
                    {
                        nextVContainer=realVContainers[0].containerElt;
                        nextVideo=realVContainers[0].videoElt;                   
                        nextHash=realVContainers[0].id;
                    }
                    nextVContainer.style.display = "block";
                    // On adapte l'ancre de l'url de manière à ce qu'elle soit cohérente avec la vidéo affichée.
                    // Attention car cela peut provoquer un déplacement dans la page la première fois pour atteindre l'ancre.
                    window.location.assign("#"+nextHash);
                    if(opts.playNextVideos===true)
                        nextVideo.play();
                    nbTurn++;
                }
            });
        }
    }
}