Aller au contenu

Atelier des composants embarqués

Choisissez un composant, réglez ses attributs, voyez-le en direct dans l’un de vos bacs à sable et copiez le code qui le place dans votre page. Le script est épinglé sur la version 1.0.0avec son intégrité. Chaque attribut est expliqué dans le guide des composants embarqués.

Composant

L’élément, ce qu’il montre et comment il se place : chaque attribut de la balise.

1 à 255 caractères parmi A-Z a-z 0-9 : . _ - ; sur <lexopti-client>, utilisée sans identifiant de client.
Afficher avec l’en-tête (header)Désactivé : l’écran masque son en-tête et son parcours (fil d’Ariane, carte de titre, état, étapes, barre d’onglets) et garde son contenu. Les pages l’affichent par défaut (header="false" le masque) ; la classification le masque par défaut (header="true" affiche celui du dossier ou du client au-dessus du questionnaire).
Dans le composant : il se borne à sa partie visible tant qu’un dialogue est ouvert, qui s’affiche là où il est. Plein écran : le composant couvre votre page tant qu’un dialogue est ouvert.
Vide : le composant suit son contenu.
Parties à garder (features)
Toutes cochées : pas d’attribut, toutes les parties que votre serveur a gardées dans la session.

Apparence

Chaque couleur, le rayon des angles, la taille du texte et la police du composant : l’aperçu en direct suit chaque mouvement, et le code ci-dessous montre exactement ce que vous écrivez. Chaque variable s’applique à l’un des jetons de design de LexOpti.

Départs rapides
Des polices que vos visiteurs ont déjà : rien n’est téléchargé. Un nom qui leur manque retombe sur la famille générique en fin de liste.

Ce que le partenaire écrit

Les mêmes variables que l’attribut style du HTML ci-dessous, en règle de feuille de style pour tous ces éléments de votre page ; rien pour le thème de LexOpti.

/* Le thème de LexOpti : rien à écrire */

Aperçu en direct<lexopti-client>

Non connecté : autorisez un bac à sable pour voir le composant.

Comment l’aperçu fonctionne

Autorisez l’un de vos bacs à sable, comme le fait « Try it » de la référence de l’API : la page demande alors POST /v1/embed-sessions pour chaque session dont le composant a besoin, comme le ferait votre serveur, et affiche le composant avec les données de votre bac à sable. Le jeton reste dans la mémoire de cette page et n’est jamais enregistré ; l’application du portail n’agit que pour des structures bac à sable. Sans bac à sable, lisez le guide du bac à sable. Dans votre propre page, c’est votre serveur qui ouvre les sessions (l’étape 4 du guide) pour une origine que vous enregistrez dans la console développeur.

Événements reçus

    HTML

    <script
    	type="module"
    	src="https://embed.lexopti.com/embed/v1.0.0.js"
    	integrity="sha384-2N9mNdBzYHj8ZSUxBaHxKXNPRwcwlKcJQ7PopEKhcDnoKBmAJ8RVKFcn4FXAOWTZ"
    	crossorigin="anonymous"
    ></script>
    <lexopti-client
    	integration="YOUR_PUBLIC_ID"
    	client="LEXOPTI_CLIENT_ID"
    ></lexopti-client>
    <script type="module">
    	const element = document.querySelector("lexopti-client");
    	element.sessionProvider = async ({
    		codeChallenge,
    		codeChallengeMethod,
    		component,
    	}) => {
    		const response = await fetch("/your-server/lexopti-embed-session", {
    			body: JSON.stringify({ codeChallenge, codeChallengeMethod, component }),
    			headers: { "content-type": "application/json" },
    			method: "POST",
    		});
    		return { code: (await response.json()).code };
    	};
    	for (const type of ["ready","resize","navigate","client-created","case-created","check-started","check-completed","alert-reviewed","classification-validated","mention-created","session-ended","display-changed","error"]) {
    		element.addEventListener(`lexopti-${type}`, (event) => {
    			console.log(event.type, event.detail);
    		});
    	}
    </script>

    React

    Avec @lexopti/embed-react ; la page charge toujours le script ci-dessus.

    import { LexoptiClient } from "@lexopti/embed-react";
    import type { LexoptiSessionProvider } from "@lexopti/embed-react";
    
    const sessionProvider: LexoptiSessionProvider = async (request) => {
    	const response = await fetch("/your-server/lexopti-embed-session", {
    		body: JSON.stringify(request),
    		headers: { "content-type": "application/json" },
    		method: "POST",
    	});
    	return { code: (await response.json()).code };
    };
    
    const log = (type: string, detail: unknown) => console.log(type, detail);
    
    export function LexoptiEmbed() {
    	return (
    		<LexoptiClient
    			integration="YOUR_PUBLIC_ID"
    			client="LEXOPTI_CLIENT_ID"
    			sessionProvider={sessionProvider}
    			onReady={(event) => log(event.type, event.detail)}
    			onResize={(event) => log(event.type, event.detail)}
    			onNavigate={(event) => log(event.type, event.detail)}
    			onClientCreated={(event) => log(event.type, event.detail)}
    			onCaseCreated={(event) => log(event.type, event.detail)}
    			onCheckStarted={(event) => log(event.type, event.detail)}
    			onCheckCompleted={(event) => log(event.type, event.detail)}
    			onAlertReviewed={(event) => log(event.type, event.detail)}
    			onClassificationValidated={(event) => log(event.type, event.detail)}
    			onMentionCreated={(event) => log(event.type, event.detail)}
    			onSessionEnded={(event) => log(event.type, event.detail)}
    			onDisplayChanged={(event) => log(event.type, event.detail)}
    			onError={(event) => log(event.type, event.detail)}
    		/>
    	);
    }