#Configuration

Même si la configuration par défaut convient à la plupart des cas d'utilisation, vous voudrez peut-être configurer certains comportements de Engage.js.

ℹ️ La configuration de votre dashboard remplacera ces valeurs de configuration à moins qu'elles n'aient été définies avec un mode en lecture seule.

#Utilisation

.config(optionName: String, optionValue: Any, readOnly?: Boolean): Engage

.config(options: Object, readOnly?: Boolean): Engage

index.js

const engage = Engage.init('<your app id>');

// Exemple simple
engage.config({ debug: true });

// Le 3ème paramètre de la fonction engage.config définit la valeur de configuration
// comme étant en lecture seule (optionnel).
// Elle ne pourra donc pas être écrasée par une valeur du Dashboard.
// true -> lecture seule
// false -> écrasable
engage.config('debug', true, true);

// Vous pouvez passer une seule valeur en faisant
engage.config('debug', true);

// Mais vous pouvez aussi passer plusieurs valeurs de configuration en utilisant un objet
engage.config({
  debug: true,
});

// Vous pouvez utiliser le paramètre `lecture seule` même avec un objet
// ça l'appliquera sur chacune des valeurs de configuration passée dans l'objet
engage.config({
  debug: true,
}, true);

#Options

#debug

Type: Boolean
Défaut: false

Si le mode debug est activé, Poool affichera tout ce qu'il fait dans la console du navigateur.

Example

engage.config('debug', true);

#autoPageViews

Type: Boolean
Défaut: true

Lorsque autoPageViews est activé, Engage.js incrémentera automatiquement le compteur de pages vues à chaque chargement de page (les applications front-end qui utilisent un routage virtuel doivent mettre à jour manuellement les pages vues en utilisant .commitPageView()).

Example

engage.config('autoPageViews', true);

#stripePublicKey

Type: String
Défaut: null

Utilisé pour activer les champs de formulaire de carte de crédit Stripe à l'intérieur des éléments.

Example

engage.config('stripePublicKey', 'pk_live_12345');

#locale

Type: String
Défaut: 'en'

La langue utilisé par défaut pour les textes à l'intérieur des éléments.

Example

engage.config('locale', 'fr');

#pianoAutoTrackingEnabled

Type: Boolean
Défaut: false

Permet d'activer le tracking automatique Piano (nécessite l'intégration du SDK Piano) pour certains events.

⚠️ Nécessite une intégration du SDK Piano, i.e l'usage de la fonction pa().

Exemple

engage.config('pianoAutoTrackingEnabled', true);

#gtagAutoTrackingEnabled

Type: Boolean
Défaut: false

Permet d'activer le tracking automatique Google Analytics 4 (nécessite l'intégration du tag Google Analytics 4) pour certains events.

⚠️ Nécessite une intégration de Google Analytics 4, i.e l'usage de la fonction gtag().,

Exemple

engage.config('gtagAutoTrackingEnabled', true);

PrécédentUtiliser Engage.js

SuivantPersonnaliser les textes