Vooraf
De frontoffice is gebouwd in React met Redux, op het platformpakket @skryv/core-react. Je past ze aan in de module frontoffice van je applicatie. In oudere applicaties heet die module soms eloket. Welke aanpassingen mogelijk zijn en hoe zwaar ze wegen bij een upgrade, lees je in het Overzicht uitbreidingspunten.
Het denkmodel is hetzelfde als bij de backoffice: je configureert platformmodules en registreert ze via een ketting van customize(...)-aanroepen. Alleen de uitvoering verschilt: je werkt met React-componenten in plaats van AngularJS-componenten.
Je hebt nodig:
-
een applicatie die lokaal draait, zie Lokale setup
-
toegang tot de npm-registry van Skryv, voor de
@skryv-pakketten -
basiskennis van React en Redux
Je code staat in src/customizations, met een indeling zoals:
|
Map |
Inhoud |
|---|---|
|
|
Je eigen React-componenten, zoals een eigen dashboard of koptekst |
|
|
Gedeelde constanten, zoals de keys van dossiertypes |
|
|
Je eigen store, met acties en reducers |
|
|
Ondersteunende code |
Stap 1: start de frontoffice op met je eigen app-klasse
De frontoffice start op in src/index.js. Daar maak je een eigen app-klasse die SkryvFrontOfficeApp uitbreidt en je eigen store meekrijgt. Daarna registreer je alle aanpassingen via de ketting:
import {
SkryvFrontOfficeApp,
form,
navigation,
translation,
} from "@skryv/core-react";
import store from "./customizations/store";
import "./theme/overrides.scss";
class MijnappApp extends SkryvFrontOfficeApp {
constructor() {
super(store);
}
}
// hier configureer je navigation, form en translation (stap 2 tot 5)
MijnappApp.createSkryvApp()
.customize(form)
.customize(customizedNavigation)
.customize(customizedTranslation)
.initialize(document.getElementById("root"));
De stijl van de Vlaamse overheid
Moet je frontoffice de huisstijl van de Vlaamse overheid volgen, dan neem je ook het pakket @skryv/core-react-vo op. Dat brengt de componenten in VO-stijl mee, plus standaardroutes en -vertalingen die je als vertrekpunt gebruikt:
import "@skryv/core-react-vo";
import { registerDefaultRouting } from "@skryv/core-react-vo/src/config/routing";
import { registerDefaultTranslations } from "@skryv/core-react-vo/src/config/translations";
const customizedNavigation = registerDefaultRouting(navigation);
const customizedTranslation = registerDefaultTranslations(translation);
Je bouwt dan verder op customizedNavigation en customizedTranslation, zoals in de volgende stappen.
Stap 2: pas de layout aan
De layout bevat de onderdelen die op elke pagina terugkomen, zoals de kop- en voettekst. Je vervangt ze met je eigen React-componenten:
import { layoutNames } from "@skryv/core-react/src/config/layouts";
import MijnappHeader from "./customizations/components/MijnappHeader";
import MijnappFooter from "./customizations/components/MijnappFooter";
customizedNavigation.layout(layoutNames.FRONTOFFICE, {
extend: true,
views: {
header: MijnappHeader,
footer: MijnappFooter,
},
});
Anders dan in de backoffice verwijs je naar het component zelf, niet naar zijn naam.
Stap 3: vervang een pagina of voeg er een toe
Een standaardpagina vervangen
Je vervangt de inhoud van een standaardpagina, zoals het dashboard of het dossieroverzicht, met extend: true. De rest van de paginadefinitie blijft behouden:
import { pageNames } from "@skryv/core-react/src/config/pages";
customizedNavigation
.page(pageNames.DASHBOARD, {
extend: true,
views: { content: MijnappDashboard },
})
.page(pageNames.DOSSIER, {
extend: true,
views: { content: MijnappDossier },
});
Wie een pagina vervangt, neemt de verantwoordelijkheid over voor alles wat ze deed. Vervang daarom zo weinig mogelijk, en controleer bij elke platformupgrade in de release notes of de standaardpagina gewijzigd is.
Een nieuwe pagina toevoegen
Een pagina die de standaardfrontoffice niet heeft, voeg je toe met een eigen naam en URL. Je kiest in welke layout ze verschijnt en of de burger aangemeld moet zijn:
customizedNavigation.page("aanvraagStarten", {
name: "aanvraagStarten",
layout: layoutNames.FRONTOFFICE,
url: "/aanvraag-starten",
views: { content: MijnappAanvraagStarten },
needsAuthentication: true,
});
Stap 4: configureer de formulieren
Met form.setFormConfig(...) stel je in hoe formulieren zich in de frontoffice gedragen, bijvoorbeeld:
form.setFormConfig({
showSectionWizard: true,
showDocumentTitle: false,
attachments: {
acceptedMimeTypes: ["pdf"],
},
});
|
Instelling |
Wat ze doet |
|---|---|
|
|
Toont het formulier als wizard, met één sectie per stap |
|
|
Toont of verbergt de titel van het document |
|
|
Beperkt de bestandstypes die een burger kan opladen |
Via hetzelfde form-object registreer je ook eigen formuliercomponenten en maak je eigen requests beschikbaar voor die componenten. Dat lees je op Eigen formuliercomponenten.
Stap 5: voeg vertalingen toe
Je stelt de taal van de frontoffice in en voegt de vertalingen van je eigen componenten toe:
import translations from "../translations";
customizedTranslation
.locale("nl_BE")
.add("nl_BE", translations.nl_BE);
Stap 6: voeg een eigen store toe
Je eigen store geef je mee aan je app-klasse (stap 1). Daarin zet je acties voor gegevens die de standaardfrontoffice niet ophaalt, bijvoorbeeld uit een eigen REST-endpoint in de back-end. Je roept zo'n actie aan via dispatch, en leest het antwoord uit het resultaat:
store
.dispatch(fetchMijnGegevens(postcode))
.then(({ api }) => api.response.data);
Met je eigen store kun je ook standaardgedrag van de frontoffice bijsturen, bijvoorbeeld een standaardmelding onderdrukken wanneer je zelf al een bevestiging toont.
Een eigen endpoint bouw je als backend-extensie, zie Backend-extensie bouwen.
Stap 7: bouw en test
De frontoffice wordt meegebouwd met de volledige applicatie. Wil je alleen de frontoffice compileren, testen of controleren, dan doe je dat in de module zelf:
cd frontoffice
npm install
npx skr compile
npm test
npm run lint
Na een platformupgrade moet je snapshottests vaak bijwerken. Soms moet je ook de versies van onderliggende pakketten vastzetten in package.json, bijvoorbeeld van de @govflanders-pakketten waarop de VO-stijl steunt. Raadpleeg daarvoor de release notes.
Waar je op moet letten
Verwijs je in code naar keys uit je configuratie, zoals de key van een dossiertype of een mijlpaal? Bundel ze dan in constants, en hernoem ze in Skryv Studio niet zonder ook de code aan te passen. Een hernoemde key geeft geen foutmelding: je eigen scherm of logica werkt dan gewoon niet meer.
Het thema van de frontoffice pas je aan zoals beschreven op Custom frontoffice thema.
Resultaat
Je frontoffice start op met je eigen app-klasse en store. Layout, pagina's, formulieren en vertalingen zijn geconfigureerd vanuit één opstartbestand, en worden mee opgebouwd met de applicatie.