Panneau latéral Flow
Panneau latéral Flow
L'assistant Flow s'affiche sous la forme d'un panneau latéral ancré à droite de la fenêtre. La page se rétrécit pour rester visible à côté du panneau ; si la fenêtre est trop étroite, le panneau recouvre la page, et sur un écran de téléphone il occupe tout l'écran.
Cette page décrit les trois façons de piloter le panneau depuis votre code : l'attribut data-flow-toggle, la fonction window.flow.toggle() et la fonction window.flow.open({ session }), qui ouvre le panneau sur une conversation précise.
Où le panneau est disponible
Le script du lanceur est ajouté aux pages HTML du Desk, de Studio et des applications de l'écran des applications, à l'exception de Raven, qui a sa propre intégration. Il n'est ajouté que pour un utilisateur qui a le droit de lire les sessions Flow (Flow Session). Il n'est pas ajouté sur le site web public ni sur la page /flow elle-même.
Le lanceur n'est pas chargé dans un cadre (iframe) : dans un cadre, window.flow n'est pas défini. Appelez les fonctions depuis la fenêtre principale.
Basculer le panneau avec data-flow-toggle
Ajoutez l'attribut data-flow-toggle à n'importe quel élément HTML. Un clic sur cet élément ouvre le panneau s'il est fermé, et le ferme s'il est ouvert. Les éléments ajoutés à la page après son chargement fonctionnent aussi.
<button data-flow-toggle>Discuter avec Flow</button>
Basculer le panneau avec window.flow.toggle()
La même bascule est exposée en JavaScript :
window.flow.toggle();
toggle() rouvre la conversation que le panneau montrait en dernier. Pour afficher une conversation que votre application vient de démarrer, utilisez window.flow.open().
Le panneau se ferme aussi avec le raccourci Ctrl + I (⌘ + I sur macOS) et avec la croix de l'en-tête du chat.
Ouvrir le panneau sur une conversation avec window.flow.open()
Une application qui démarre une conversation Flow (par exemple depuis sa propre zone de saisie) peut ouvrir le panneau directement sur cette conversation :
window.flow.open({ session: "chat-one" });
Le paramètre session est l'identifiant de la conversation, le même que dans l'adresse /flow/s/<identifiant> de la page Flow.
Comportement :
- Panneau fermé : il s'ouvre sur la conversation demandée.
- Panneau déjà ouvert sur une autre conversation : il passe à la conversation demandée et reste ouvert. Contrairement à
toggle(),open()ne ferme jamais le panneau. - Panneau en cours de chargement (le chat n'est pas encore affiché) : la conversation demandée est conservée, et le chat s'affiche directement sur elle à la fin du chargement. Si le chargement échoue, le panneau affiche son message d'échec à la place du chat.
- Sans
session(window.flow.open()ouwindow.flow.open({})) : le panneau s'ouvre sur la dernière conversation qu'il montrait, ou reste ouvert s'il l'est déjà. - Conversation qui ne peut pas s'ouvrir (identifiant inexistant, conversation supprimée, accès refusé) : le panneau affiche l'erreur, comme la page
/flow, puis revient à une nouvelle conversation. Ce cas diffère de la réouverture automatique : quand le panneau rouvre de lui-même une conversation (la dernière qu'il montrait, ou celle d'un retour en arrière) et que celle-ci n'existe plus, il démarre une nouvelle conversation sans afficher d'erreur.
La conversation demandée devient aussi celle que le panneau rouvrira au chargement de la page suivante.
Exemple fictif : une application démarre une conversation côté serveur, reçoit l'identifiant chat-one, puis l'affiche dans le panneau. Si window.flow n'est pas défini (lanceur non chargé, ou code exécuté dans un cadre), elle ouvre la page Flow en plein écran :
function showChat(session) {
if (window.flow) window.flow.open({ session });
else window.location.assign(`/flow/s/${session}`);
}
La valeur de retour de open() n'est pas documentée : ne vous en servez pas.
Points d'attention
- Le panneau s'ancre à droite de la fenêtre et réduit la largeur de la page affichée : ce n'est pas une fenêtre flottante.
- Le lanceur n'affiche pas de bouton flottant : c'est à votre application de placer son propre élément
data-flow-toggleou d'appelerwindow.flow. - Si le lanceur n'est pas chargé pour l'utilisateur (droit de lecture sur
Flow Sessionmanquant), un boutondata-flow-togglene fait rien.