Hooks

Les hooks de hodi:sdk donnent à un composant du plugin ses textes, ses routes, ses liens et les réglages du serveur. Chaque hook sait quel plugin l'appelle : il ne marche que dans les composants de ce plugin.

usePluginTranslation()

Ce hook donne les textes du plugin, dans la langue de la personne. Il les lit dans les fichiers locales/ du plugin, jamais dans ceux de Hodi.

import { usePluginTranslation } from 'hodi:sdk'

const { t, language } = usePluginTranslation()
t('greeting', { name: 'Anna' })

usePluginApi()

Ce hook renvoie une fonction qui appelle les routes du plugin. api('/hello') demande /api/plugins/<id>/hello : le plugin n'écrit jamais l'adresse entière. Deux autres hooks font la même chose pour les deux autres sortes de routes, que le contexte serveur explique.

import { usePluginApi, usePluginPublicApi, usePluginServerApi } from 'hodi:sdk'

const api = usePluginApi()
const answer = await api('/hello', { method: 'POST' })
const { greeting } = await answer.json()

La fonction renvoyée prend les mêmes options que fetch, plus une : proof, la preuve que askToConfirm() a reçue quand la personne a retapé son mot de passe. Une route marquée proof: true ne tourne qu'avec elle.

usePluginLinks()

Ce hook donne les adresses des écrans de Hodi et du plugin. Un plugin ne les écrit jamais à la main : elles restent justes même quand Hodi change ses adresses.

import { Button, navigate, usePluginLinks } from 'hodi:sdk'

const links = usePluginLinks()
<Button href={links.page('week/3')}>Cette semaine</Button>
<Button onClick={() => navigate(links.frontPage)}>Accueil</Button>

Pour aller à une de ces adresses depuis le code, après une action par exemple, navigate(href) fait la même chose qu'un clic sur un lien.

usePluginPath()

Ce hook dit quel écran la page du plugin doit montrer. Il renvoie ce qui suit l'adresse de la page : '' à sa racine, 'week/3' pour l'adresse que links.page('week/3') donne.

import { usePluginPath } from 'hodi:sdk'

const path = usePluginPath()
return path.startsWith('week/') ? <Week n={Number(path.slice(5))} /> : <Home />

useServerSettings()

Ce hook donne les durées et les limites choisies par l'admin dans Serveur › Contenu et Sauvegardes, en lecture seule. Un plugin s'en sert pour écrire les vrais chiffres, par exemple dans ses pages légales. Il vaut null tant que le serveur n'a pas répondu.

import { useServerSettings } from 'hodi:sdk'

const settings = useServerSettings()
settings && t('privacy.kept', { days: settings.articleDays })