App
Un'app mette uno strumento tuo dentro la console, accanto ai contenuti su cui lavora. La sua interfaccia è una pagina web che ospiti tu, e legge e scrive tramite la stessa API GraphQL che usa la tua applicazione.
Quattro placement
La pagina di un'app è incorporata nella console come iframe, in uno di quattro posti: una pagina intera nella navigazione, una scheda nell'editor dei record, un pannello laterale nell'editor dei record, o un editor di campo che sostituisce l'input predefinito su un campo. Una scheda o un pannello laterale è legato a dei modelli e compare quando è aperto un record di un modello corrispondente.
Lavorare con il record
I placement dell'editor comunicano con la console tramite l'Editor SDK in @foir/sdk, che richiede React 18 o successivo. La console invia i valori, lo schema e il tema del record quando la pagina si carica, e resta responsabile di salvataggio, pubblicazione e versioni. Una pagina intera agisce come il membro del team che la sta guardando, solo con gli scope che il suo placement dichiara e che anche quella persona ha. Il suo token dura cinque minuti alla volta e termina quando esce.
Un solo manifest
Un'app è descritta da un manifest JSON a un URL https che scegli tu, con name e version come unici campi obbligatori. Oltre a una pagina, un'app può fornire credenziali, operazioni, hook del ciclo di vita e forme di dati mappate sui tuoi modelli all'installazione. Non possiede mai modelli.
Installare, e il marketplace
Installa un'app dal marketplace o incollando l'URL del suo manifest. Il marketplace è curato, e un'app che non è elencata si installa dal suo URL. In entrambi i casi, l'anteprima di installazione mostra esattamente cosa può leggere o scrivere ciascuna operazione dell'app.
Strumenti per un solo progetto
Una scheda o un pannello laterale per un singolo progetto può essere dichiarato direttamente in foir.config.ts e pushato. Costruisci un'app quando lo strumento verrà riusato tra progetti. La pagina che servi deve consentire alla console di inquadrarla come frame ancestor, altrimenti il browser la mostra vuota, e l'SDK fornisce placementFrameAncestors per questo.
Leggi il dettaglio
La guida alle app copre il manifest, ogni placement, cosa può fornire un'app e come funzionano installazioni e aggiornamenti.