Apps
Une app place un outil qui vous est propre dans la console, à côté du contenu sur lequel il travaille. Son interface est une page web que vous hébergez, et elle lit et écrit via la même API GraphQL que votre application.
Quatre placements
La page d'une app est intégrée à la console dans une iframe, à l'un de quatre endroits : une page complète dans la navigation, un onglet dans l'éditeur d'enregistrement, un panneau latéral dans l'éditeur d'enregistrement, ou un éditeur de champ qui remplace la saisie par défaut d'un champ. Un onglet ou un panneau latéral est lié à des modèles et apparaît quand un enregistrement d'un modèle correspondant est ouvert.
Travailler avec l'enregistrement
Les placements d'éditeur communiquent avec la console via l'Editor SDK de @foir/sdk, qui requiert React 18 ou une version ultérieure. La console envoie les valeurs, le schéma et le thème de l'enregistrement au chargement de la page, et reste responsable de la sauvegarde, de la publication et du versionnement. Une page complète agit comme le membre de l'équipe qui la consulte, avec uniquement les portées que son placement déclare et que cette personne détient aussi. Son jeton dure cinq minutes à la fois et prend fin à la déconnexion.
Un manifeste
Une app est décrite par un manifeste JSON à une URL https de votre choix, dont seuls name et version sont obligatoires. Au-delà d'une page, une app peut apporter des identifiants, des opérations, des hooks de cycle de vie et des formes de données mappées sur vos modèles à l'installation. Elle ne possède jamais de modèles.
Installation et marketplace
Installez une app depuis la marketplace ou en collant l'URL de son manifeste. La marketplace est sélectionnée, et une app qui n'y figure pas s'installe depuis son URL. Dans les deux cas, l'aperçu d'installation montre exactement ce que chacune des opérations de l'app peut lire ou écrire.
Des outils pour un seul projet
Un onglet ou un panneau latéral pour un seul projet peut être déclaré directement dans foir.config.ts puis poussé. Créez une app quand l'outil sera réutilisé entre plusieurs projets. La page que vous servez doit autoriser la console comme ancêtre de frame, sans quoi le navigateur l'affiche vide, et le SDK fournit placementFrameAncestors pour cela.
Lire le détail
Le guide des apps couvre le manifeste, chaque placement, ce qu'une app peut apporter et le fonctionnement des installations et des mises à jour.