Intégrateurs

Options d'affichage

Options d'affichage

Les options d'affichage permettent de faire varier le mode d'intégration en fonction de vos besoins. Vous pouvez passer ces options pour déterminer si le widget s'affichera en mode dialogue ou intégré au sein de la page, pour changer les couleurs via le thème, modifier la réservation d'espace ou même restreindre l'affichage à des zones essentielles.

Option font

Type Chaîne de caractères
Obligatoire Non

La police de caractères n'est pas une option des widgets.

En effet, les widgets s'emploient à ne jamais surcharger la police du site dans lequel ils sont intégrés de manière à hériter de l'identité graphique fournie par celui-ci.

Note Attention toutefois, en fonction de la réservation d'espace vertical de la police choisie, certains éléments d'interface peuvent être déformés. Il est donc important de vérifier l'adéquation entre cette police et le bon fonctionnement des widgets.

Option theme

Type URL
Obligatoire Non

Afin d'adapter les widgets à l'identité graphique du site dans lequel ils sont intégrés, vous pouvez demander aux widgets de charger un thème avec vos adaptations.

Note Pour initialiser votre thème, vous pouvez vous appuyer sur le thème par défaut. Celui est téléchargeable à l'adresse suivante : https://widget.msem.tech/themes/MseM.css

Option groundedTo

Type Chaîne de caractères
Obligatoire Non

Par défaut, les widgets s'ouvrent en "mode dialogue" (fenêtre volante au dessus des pages). Dans de nombreux cas d'intégration, vous désirerez attacher les widgets à un élément de la page.

Cette option permet d'indiquer au widget de s'intégrer dans cet élément : cela active la réservation d'espace.

Note Une fois intégré de cette façon le widget fera de la réservation d'espace.

Exemple Si votre élément a un id="zone", alors groundedTo devra valoir #zone

Option fullWidth

Type Booléen
Obligatoire Non

Cette option permet d'indiquer au widget de s'étendre au maximum dans l'espace disponible en largeur.

Note Par défaut, le widget arrêtera de s'étendre à 1080 pixels, sauf si cette valeur a été surchargée par l'option maxWidth.

Option verticalMargin

Type Nombre
Obligatoire Non

Cette option permet d'indiquer au widget un nombre de pixels à réserver au dessus et au dessous du dialogue.

Note Cette valeur est répartie à moitié au dessus et à moitié en dessous.

Ainsi, si vous souhaiter décaler le widget de 50 pixels en bas et en haut, vous devez spécifier 100.

Option maxWidth

Type Nombre
Obligatoire Non

Cette option permet d'indiquer au widget de limiter sa réservation d'espace horizontal à la valeur spécifiée.

Note Si vous passez une valeur inférieur au minimum requis pour qu'un widget puisse s'afficher correctement, celui-ci forcera cette dimension.

La valeur minimum respectée est de 320 pixels pour fonctionner sur les petits terminaux mobiles comme l'iPhone 5/SE.

Option draggable

Type Booléen
Obligatoire Non

Permet de déplacer le widget en le faisant glisser en utilisant la barre de titre comme zone d'interaction.

Option noTitlebar

Type Booléen
Obligatoire Non

Dans certains cas d'intégration, vous pouvez ne pas souhaiter afficher la barre de titre du widget. Cette option vous permet de désactiver son affichage.

Attention Désactiver la barre de titre implique que l'utilisateur ne pourra pas fermer le widget. Ce comportement est désirable lorsque le widget est intégré dans sa propre page (voir l'option groundedTo)

Option skipRecap

Type Booléen
Obligatoire Non

L'option skipRecap permet de désactiver l'affichage de l'écran de récapitulatif de commande.

Option disableRouting

Type Booléen
Obligatoire Non

Désactive l'exposition du routage via le hash de l'url dans le navigateur