Configuration

Configurez votre SDK en fournissant des options.

Clé API

Votre clé API vous sera fournie par l'équipe Local Logic.

attention

Si vous migrez depuis un ancien produit du SDK Local Logic, les clés API des versions précédentes ne fonctionnent pas avec nos produits actuels.

Veuillez communiquer avec le soutien de Local Logic pour obtenir votre nouvelle clé.

Options globales

const localLogicClient = localLogicSDK(apiKey, globalOptions)

Ces options sont disponibles pour tous les SDK. Vous pourrez également spécifier des options propres à chaque SDK, selon le SDK que vous implémentez. Ces options seront disponibles dans la documentation propre à chaque SDK

Nom	Requis	Type	Valeur par défaut	Description
apiKey	true	string		Clé API requise pour effectuer des requêtes vers l'API Local Logic.
globalOptions.appearance	false	Appearance		L'option appearance permet d'utiliser des variables pour personnaliser l'apparence de vos widgets.
globalOptions.locale	false	"en" ou "fr"	"en"	L'option locale spécifie la langue des pointages et de l'interface utilisateur.
globalOptions.externalId	false	string		Pour les SDK connectés à l'application de gestion de quartier (Neighborhood Management App) du Local Logic Hub. Ce champ est requis pour que les SDK Neighborhood Showcase et Favorite Neighborhoods fonctionnent

Apparence

Les SDK Local Logic prennent en charge la personnalisation visuelle grâce à l'API Appearance, qui vous permet d'adapter l'apparence du SDK à votre marque.

type Appearance = {
  variables?: {
    [key: string]: string;
  };
};

Variables couramment utilisées

Variable	Description
--ll-color-primary	La couleur principale de la marque.
--ll-color-primary-variant1	Une version légèrement plus foncée de la couleur principale de la marque. Cette variable devrait toujours être modifiée en même temps que --ll-color-primary.
--ll-font-family	Change la famille de polices utilisée dans l'ensemble des SDK. Actuellement, les SDK ne prennent en charge que les polices système. Cette valeur devrait toujours inclure une famille de polices de repli, p. ex. Inter, sans-serif.

Fonctions

Une fois que vous avez initialisé votre client SDK avec votre clé API et vos options globales, plusieurs fonctions sont disponibles.

info

Consultez la documentation du SDK que vous implémentez pour connaître les options disponibles.

Create

const sdkInstance = localLogicClient.create("sdk-name", container, sdkOptions)

Cette fonction crée un nouveau widget SDK selon le nom spécifié.

Les sdkOptions sont spécifiques à chaque SDK créé.

Nom	Requis	Type	Valeur par défaut	Description
sdkType	true	string		Le SDK que vous souhaitez créer. "undefined" dans ce cas.
container	true	HTMLElement		L'élément dans lequel effectuer le rendu.
sdkOptions	true	SDKOptions		Options requises pour le sdkType spécifié. Les options sont détaillées ci-dessous.

SDKOptions

Les SDK Options sont des objets clé/valeur spécifiques selon le SDK implémenté.

Update

sdkInstance.update(sdkOptions)

Cette fonction sert à mettre à jour le widget avec de nouvelles valeurs. Cela peut être utile, par exemple, si vous souhaitez changer l'emplacement du widget.

L'objet sdkOptions suit la même structure qu'à la création.

On

sdkInstance.on(event, callback)

Cette fonction prend en argument une fonction de rappel (callback) qui est déclenchée lorsqu'un event survient. Actuellement, il n'existe qu'un seul événement.

Nom	Requis	Type	Valeur par défaut	Description
event	true	"change"		Le nom de l'event.
callback	true	CallbackFunction		La fonction de rappel à déclencher lorsque l'event spécifié survient.

type CallbackFunction = ({ type: string, data: unknown }) => void;

Destroy

sdkInstance.destroy()

Cette fonction sert à détruire le widget SDK créé.