Aller au contenu

Référence de l'habillage

Champs d'habillage par niveau, formats et limites des fichiers, objet thème et réponses des appels de l'API publique.

RéférenceAdministrateurDéveloppeur
Voir en Markdown

Cette page rassemble les valeurs de référence de l'habillage. Les endpoints complets sont décrits dans la référence API des contenus de l'application.

Visuels

VisuelChamp renvoyéFormatsTaille maximaleNiveaux
Logo mode clairlogoLightUrlPNG, WebP2 Moapplication, réseau, client
Logo mode sombrelogoDarkUrlPNG, WebP2 Moapplication, réseau, client
Fond mode clairbgLightUrlPNG, WebP2 Moapplication, réseau, client
Fond mode sombrebgDarkUrlPNG, WebP2 Moapplication, réseau, client
FaviconfaviconUrlPNG, WebP, ICO512 Ko depuis la consoleapplication, réseau, client
Asset nomméadresse affichée dans la liste Assets customPNG, WebP2 Moapplication, réseau, client
  • Le SVG est refusé. Le type est contrôlé sur le contenu réel du fichier.
  • Nom d'un asset nommé : minuscules, chiffres, - et _.
  • Chaque fichier est servi par une adresse publique suivie d'un paramètre ?v=<horodatage>, qui change à chaque envoi. Le cache navigateur est de 24 heures.

Thème

ChampTypeContraintesDescription
idUUID—Identifiant du thème
namechaîne1 à 50 caractères, unique sur la plateforme, sans < > & " 'Nom affiché dans les listes
cssVarsLightobjetnom ≤ 200 caractères, valeur ≤ 500 caractèresVariables du mode clair, appliquées sur :root
cssVarsDarkobjetmêmes contraintesVariables du mode sombre, appliquées sur .dark
cssPathchaîne≤ 255 caractères, .css ou .json ; généré si absentChemin de stockage de la feuille de style

GET /api/themes/{id}/css renvoie la feuille de style en text/css, avec l'en-tête Cache-Control: public, max-age=3600.

Objet branding de GET /api/me

ChampRésolutionDescription
logoLightUrl, logoDarkUrlclient → réseau → applicationLogos
bgLightUrl, bgDarkUrlclient → réseau → applicationImages de fond
faviconUrlclient → réseau → applicationFavicon
primaryColor, accentColorapplicationCouleurs de marque, au format #RRGGBB
backgroundapplicationFond CSS (couleur ou dégradé)
themeNameutilisateur → client → réseau → applicationNom du thème retenu
themeCssPathidemChemin de stockage de sa feuille de style
themeCssVarsLight, themeCssVarsDarkidemVariables du thème retenu

Un champ sans valeur à aucun niveau vaut null ou est omis de la réponse.

Réponse de GET /api/apps/{appWid}/runtime-config

ChampDescription
themeThème par défaut de l'application : id, name, cssUrl (chemin relatif à https://api.wakastart.app/api), ou null
languages[]Langues de l'application : code, name, isDefault, i18nUrl (chemin indicatif ; l'URL du fichier s'obtient par GET /api/languages/code/{code}/file)
brandingVisuels du niveau application : logoLightUrl, logoDarkUrl, faviconUrl, bgLightUrl, bgDarkUrl (null si absents)

Revendication du jeton enrichi

RevendicationContenu
wthmNom du thème retenu pour l'utilisateur : préférence, sinon client, sinon réseau. Absente si aucun de ces niveaux n'en désigne.

Écrans de la console

ÉcranCheminSections
Theme Studio d'un réseauAdministration > Réseaux › Configuration avancée › onglet ThèmeLogos, Fonds, Favicon, Theme CSS, Assets custom
Theme Studio d'un clientconfiguration du client › onglet Thèmesmêmes sections
Theme Studio de l'applicationMes Apps › application › Paramétrage › onglet Thèmesmêmes sections et Thème Keycloak, en lecture seule
Thème par défautonglet Général du réseau ou du clientliste Thème par défaut
Thème préféréMon profil › Préférencesliste Thème préféré