Working version v32.1.X v32.0.X v29.1.X
Working version v32.1.X v32.0.X v29.1.X Dutch

Custom frontoffice thema

Vooraf

Het thema bepaalt hoe de frontoffice eruitziet voor de burger. Je werkt in de module frontoffice van je applicatie. In oudere applicaties heet die module soms eloket.

Je past het uitzicht op drie niveaus aan:

Niveau

Waar

Wat je ermee doet

Basisthema

package.json en src/index.js van de frontoffice

Kiezen tussen een neutraal thema en de huisstijl van de Vlaamse overheid

Hoofdkleur

processes/src/main/resources/theme.json

De hoofdkleur van het neutrale thema instellen

Eigen stijlregels

src/theme/overrides.scss van de frontoffice

Eigen CSS-regels toevoegen, bijvoorbeeld voor je eigen componenten

Anders dan in de backoffice kies je het basisthema van de frontoffice niet in een SCSS-bestand, maar met een npm-pakket.

Stap 1: kies een basisthema

Het platform levert twee basisthema's voor de frontoffice, elk als eigen npm-pakket:

Basisthema

Pakket

Neutraal

@skryv/react-neutral

Vlaamse overheid

@skryv/core-react-vo

Je neemt het pakket op in de dependencies van package.json, en je gebruikt het in src/index.js als basis voor de navigatie. Voor het thema van de Vlaamse overheid ziet dat er zo uit:

JavaScript
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);

Hoe customizedNavigation en customizedTranslation verder gebruikt worden, lees je op Frontoffice aanpassen.

Van basisthema wisselen

Wil je in een bestaande applicatie wisselen tussen het neutrale thema en dat van de Vlaamse overheid, of omgekeerd?

  1. Vervang in package.json van de frontoffice het pakket @skryv/react-neutral door @skryv/core-react-vo, of omgekeerd.

  2. Pas in src/index.js de imports aan die naar het pakket verwijzen. Voor de navigatie wordt @skryv/react-neutral/src/config/routing dan @skryv/core-react-vo/src/config/routing, of omgekeerd.

  3. Voer npm install opnieuw uit en bouw de frontoffice (stap 4).

Een eigen component dat bouwstenen van het basisthema hergebruikt, zoals invoervelden uit @skryv/core-react-vo, moet je bij een wissel ook aanpassen. Zie Eigen formuliercomponenten.

Stap 2: stel de hoofdkleur in (neutraal thema)

Gebruik je het neutrale thema, dan stel je de hoofdkleur in met het bestand theme.json in de module processes:

JSON
{
  "colors": {
    "main": "#006080"
  }
}

Het bestand staat in processes/src/main/resources/theme.json, bij de configuratie van je applicatie, en niet in de module frontoffice.

Stap 3: voeg eigen stijlregels toe

Eigen stijlregels zet je in src/theme/overrides.scss van de frontoffice. Dat bestand laad je in src/index.js in:

JavaScript
import "./theme/overrides.scss";

Geef je regels een selector met het prefix van je applicatie, zoals .mijnapp-. Zo raak je alleen je eigen componenten, en blijven de componenten van het basisthema ongewijzigd:

.mijnapp-aanvraag-samenvatting {
  margin-bottom: 2rem;
}

Stap 4: bouw en controleer

De frontoffice wordt meegebouwd met de volledige applicatie. Wil je alleen de frontoffice compileren, dan doe je dat in de module zelf:

Bash
cd frontoffice
npm install
npx skr compile

Open daarna de frontoffice lokaal, zie Lokale setup, en controleer de kleuren, de leesbaarheid van tekst op gekleurde achtergronden en het uitzicht van formulieren.

Upgraden van een oudere platformversie

Het thema van de Vlaamse overheid steunt op de @govflanders-pakketten van de Vlaamse overheid. Na een platformupgrade kan het nodig zijn om de versies van die pakketten vast te zetten met een overrides-blok in package.json. Welke versies je nodig hebt, lees je in de release notes.

Resultaat

De frontoffice gebruikt het gekozen basisthema, eventueel met je eigen hoofdkleur, en je eigen stijlregels gelden alleen voor je eigen componenten.