Les emplacements · Hodi SDK

Un plugin n'affiche rien n'importe où : il remplit des emplacements, des endroits précis de Hodi prévus pour les plugins. Chaque carte ci-dessous porte le nom d'un emplacement, tel qu'il s'écrit dans le code, et mène à sa page : où l'emplacement se trouve dans Hodi, un exemple et ce que Hodi donne au composant.

settingsPageUne carte du plugin dans Serveur › Plugins, sous ses réglages, pour ce qu'un réglage seul ne permet pas.pageUne page du plugin dans Réglages, pour ce que chaque profil du foyer règle ou consulte lui-même.serverSectionsUn groupe de sections dans l'espace Serveur, pour ce que seul l'admin du serveur doit voir et gérer.overviewCardsUne carte du plugin dans le tableau de bord du serveur, avec un chiffre ou un graphique sur la période choisie.readerActionUn bouton sous un article ouvert, à côté de Lire l'original, pour que le plugin agisse sur cet article.signInExtrasUn bouton ou un lien du plugin sous le formulaire de Connexion, comme Créer mon foyer.afterSignInUne étape du plugin juste après la connexion, avant d'entrer dans l'app, comme Quel foyer ?.whoIsReadingFooterUn bouton du plugin à côté de Gérer les profils, sous les profils de Qui lit ?.ageConsentUn texte du plugin après la case J'ai au moins 13 ans, comme et j'accepte les conditions.feedsDes flux d'articles que le plugin fournit, et qu'un foyer suit comme n'importe quelle autre source.setupStepsDes étapes du plugin dans la mise en route de Hodi, pour ce qu'il doit savoir dès le premier démarrage.accountRowsDes lignes du plugin à la fin de la carte Ton compte, dans Réglages › Compte et données.avatarMenuDes entrées du plugin dans le menu de l'avatar, comme Changer de foyer.

Ce qu'est un emplacement

Hodi garde la main sur ses propres écrans. Un plugin ne peut pas modifier une page de Hodi, ni y ajouter un bouton où il veut. À la place, Hodi prévoit des emplacements : une entrée dans Réglages, une carte dans le tableau de bord du serveur, un bouton sous un article…

Pour chaque emplacement, le plugin donne un composant React. Hodi affiche ce composant au bon endroit, au bon moment, et seulement pour les bonnes personnes.

Déclarer un emplacement

La partie web appelle definePlugin() une seule fois, dans web/index.tsx. definePlugin() reçoit un objet : chaque clé de cet objet est le nom d'un emplacement, et la valeur de la clé est ce que le plugin affiche dans cet emplacement.

web/index.tsx

import { definePlugin } from 'hodi:sdk'

definePlugin({
  settingsPage: HelloCard,
  readerAction: ReportButton
})

Dans cet exemple, le plugin remplit deux emplacements :

settingsPage : la carte HelloCard, sur la page du plugin dans Serveur › Plugins ;
readerAction : le bouton ReportButton, sous chaque article ouvert.

Un emplacement que le plugin ne donne pas reste vide. Si le composant d'un plugin plante, Hodi enlève ce composant, et le reste de la page continue de marcher.