Vooraf
Het thema bepaalt hoe de backoffice eruitziet: kleuren, lettertypes, het logo. Je past het aan zonder iets aan de werking van de backoffice te veranderen. Je werkt in SCSS, een uitbreiding van CSS met onder meer variabelen.
Het thema staat in de map theme van de module backoffice van je applicatie. In oudere applicaties heet die module soms frontend. Je werkt met twee bestanden:
|
Bestand |
Wanneer het geladen wordt |
Wat erin hoort |
|---|---|---|
|
|
Vóór alle stijlbestanden van het platform en van je eigen componenten |
Alleen variabelen, mixins en placeholders: de keuze van het basisthema en de waarden die je overschrijft |
|
|
Na alle stijlbestanden |
Je eigen stijlregels |
Zet in includes.scss nooit stijlregels met selectors. Dat bestand wordt vóór elk stijlbestand ingeladen, dus elke regel komt per component opnieuw in de uiteindelijke CSS terecht.
Stap 1: kies een basisthema
Het platform levert drie basisthema's. Je kiest er één met een @forward-regel in includes.scss:
|
Basisthema |
Regel |
|---|---|
|
Neutraal |
|
|
Vlaamse overheid |
|
|
eGovFlow |
|
Een volledig includes.scss voor het thema van de Vlaamse overheid bestaat dan uit één regel:
@forward "@skryv/core-ng1/theme/includes/index-vo";
Stap 2: overschrijf kleuren en logo
Wil je de kleuren of het logo van het basisthema aanpassen? Geef dan de nieuwe waarden mee met with (...) op dezelfde @forward-regel.
@forward "@skryv/core-ng1/theme/includes/index" with (
// het logo van je applicatie
$url-brand-logo: "~/theme/assets/mijn-logo.svg",
// de primaire en secundaire kleur
$primary-brand-color: #ffffff,
$secondary-brand-color: #000000
);
Het logo zet je in de map theme/assets en je verwijst ernaar met $url-brand-logo.
Enkele variabelen die je kunt overschrijven:
|
Variabele |
Wat ze bepaalt |
|---|---|
|
|
Het logo |
|
|
De primaire kleur |
|
|
De secundaire kleur |
|
|
De kleur van de gewone tekst |
|
|
De tekstkleur op actie-elementen in de primaire kleur |
|
|
De tekstkleur op actie-elementen in de secundaire kleur |
Welke variabelen er nog zijn, zie je in de themabestanden van het platform. Die vind je na npm install in node_modules/@skryv/core-ng1/theme/includes.
Stap 3: voeg eigen stijlregels toe
Volstaan de variabelen niet, dan voeg je eigen stijlregels toe in overrides.scss. Dat bestand wordt als laatste ingeladen, dus je regels krijgen voorrang op die van het platform.
Begin overrides.scss met een @use-regel voor hetzelfde basisthema als in includes.scss. Zo kun je in je regels de variabelen en mixins van het thema gebruiken:
@use "@skryv/core-ng1/theme/includes/index-vo" as *;
.mijnapp-dossier-header {
border-bottom: 2px solid $primary-brand-color;
}
Geef je eigen regels een selector met het prefix van je applicatie, zoals .mijnapp-. Zo raak je alleen je eigen componenten en blijven de platformcomponenten ongewijzigd.
Variabelen die je in overrides.scss definieert, hebben geen invloed op stijlbestanden die eerder ingeladen zijn. Wil je een waarde voor de hele backoffice wijzigen? Doe dat dan in includes.scss (stap 2).
Stap 4: bouw en controleer
Het thema wordt meegebouwd met de volledige applicatie. Wil je alleen de backoffice compileren? Dan doe je dat in de module zelf.
cd backoffice
npm install
npx skryv-cli compile
Open daarna de backoffice lokaal, zie Lokale setup, en controleer het logo, de kleuren van knoppen en links, en de leesbaarheid van tekst op gekleurde achtergronden.
Upgraden van een oudere platformversie
Sinds platformversie 29 werkt het thema anders dan in eerdere versies:
-
@forwarden@usezijn verplicht.includes.scssmoet het basisthema met@forwarddoorgeven, enoverrides.scssmoet het met@useinladen. Zonder die regels faalt de compilatie op ontbrekende variabelen. -
Het logo stel je alleen nog in via SCSS. De vroegere JavaScript-functie
theme.logo(...)en de aanroep.customize(theme)inindex.jsbestaan niet meer. Verwijder ze bij een upgrade en zet het logo via$url-brand-logo.
Meer over upgrades lees je in de release notes.
Resultaat
De backoffice gebruikt het gekozen basisthema met jouw kleuren, logo en eigen stijlregels. Omdat je alleen variabelen en eigen selectors aanpast, blijven de platformcomponenten bij een upgrade hun standaardgedrag behouden.