menu
close
CI

#Installer Engage sur React

Le moyen le plus simple d'ajouter Poool Engage à votre application React ✨

#Installation

#Utilisation avec createElement (manuel)

#Utilisation avec autoCreate

#Documentation

#EngageContext

<EngageContext />

#Props

  • appId {String} Votre Poool App ID
  • config {Object} (optionnel) Configuration par défaut des éléments (voir la documentation configuration)
  • variables {Object} (optionnel) Variables des éléments utilisées dans les textes (voir la documentation variables)
  • texts {Object} (optionnel) Textes personnalisés des éléments (voir la documentation textes)
  • events {Object} (optionnel) Écouteurs d'événements des éléments (voir la documentation événements)
  • scriptUrl {String} (optionnel, par défaut : 'https://assets.poool.fr/engage.js') URL du SDK Poool Engage par défaut

#Element

<Element />

#Props

  • slug {String} Slug de l'élément.
  • tag {String | React.ReactElement} (optionnel, par défaut : 'div') Balise conteneur de l'élément
  • useGlobalFactory {Boolean} (optionnel, par défaut : true) Indique s'il faut utiliser la factory de <EngageContext /> ou non
  • config {Object} (optionnel) Configuration de l'élément, surcharge celle de <EngageContext /> (voir la documentation configuration)
  • variables {Object} (optionnel) Variables de l'élément utilisées dans les textes, surcharge celles de <EngageContext /> (voir la documentation variables)
  • texts {Object} (optionnel) Textes personnalisés de l'élément, surcharge ceux de <EngageContext /> (voir la documentation textes)
  • events {Object} (optionnel) Événements de l'élément, surcharge ceux de <EngageContext /> (voir la documentation événements)

#Elements

<Elements />

#Props

  • useGlobalFactory {Boolean} (optionnel, par défaut : true) Indique s'il faut utiliser la factory de <EngageContext /> ou non
  • filters {Array<String>} (optionnel) Liste des filtres à appliquer aux éléments
  • config {Object} (optionnel) Configuration de l'élément, surcharge celle de <EngageContext /> (voir la documentation configuration)
  • variables {Object} (optionnel) Variables de l'élément utilisées dans les textes, surcharge celles de <EngageContext /> (voir la documentation variables)
  • texts {Object} (optionnel) Textes personnalisés de l'élément, surcharge ceux de <EngageContext /> (voir la documentation textes)
  • events {Object} (optionnel) Écouteurs d'événements de l'élément, surcharge ceux de <EngageContext /> (voir la documentation événements)

#useEngage()

Peut être utilisé pour récupérer certaines propriétés du contexte Engage actuel, ainsi que le SDK Engage lui-même.

#Returns

  • lib {Function} Le SDK Engage complet
  • appId {String} App ID actuel
  • config {Object} Configuration du contexte Engage actuel
  • variables {Object} Variables du contexte Engage actuel
  • texts {Object} Textes du contexte Engage actuel
  • events {Object} Écouteurs d'événements du contexte Engage actuel
  • scriptURL {Object} URL du SDK Engage
  • commitPageView {Function} Enregistrer une page vue (voir la documentation commitPageView)

#Exemple