Documentation des widgets et API

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.

Adoption de la police courante

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

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 noTitlebar

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 groundedTo

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 "clouer au sol" les widgets.

Cette option permet d'indiquer au widget de s'intégrer dans un élément de votre page.

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 noMarketing

Dans certains cas d'intégration, vous allez fournir vos propres contenus et vous ne souhaitez pas qu'un widget affiche les siens. Cette option permet de désactiver l'affichage de ces zones au sein des widgets.

Note Pour le moment cette option est respectée par les widgets hébergements et forfaits. Si vous détectez ce besoin dans d'autres widgets, n'hésitez pas à nous le faire savoir.

Option verticalMargin

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 fullWidth

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 maxWidth

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.