Produits Entr'ouvert » Godo

L'idée est de pouvoir configurer dynamiquement dans Godo une liste de classes CSS qui peuvent être posées sur les différents nodes et marks définis par le schéma. Les définir dynamiquement permettrait de définir une liste de classes personnalisées par thèmes dans les config.json de PBT, pour qu'elles soient remontées au éditeurs Godo de Combo ou WCS.

Les bénéfices à mon avis sont les suivants :

• Dans l'idée de généraliser l'utilisation de Godo pour remplacer le CKEditor, on garde la possibilité d'ajouter des classes sur des éléments des cellules textes, des commentaires, etc... mais sans donner accès au HTML sous-jacent.
• Ça permet d'éviter les erreurs humaines, en forçant l'endroit où sont utilisées les classes CSS : pas de pk-button posée sur un paragraphe par ex.
• Dans la suite de ce qui a été évoqué pendant les EO Days front sur les outils qualité du CSS qui viendront un jour inch'allah, ça permettra d'avoir un moyen formel de définir quelle classe peut aller où.
• Ça permet de documenter les classes CSS personnalisées pour chaque thème dans PBT, et permet aux CPF d'en avoir la liste directement dans l'interface quand ils sont dans Combo, plutôt que d'aller chercher une liste de classes sur le wiki des projets. Voir, ça permettra aux clients de le faire eux-mêmes plus facilement, donc de décharger les CPFs.
• On peut imaginer étendre par la suite le système de déclaration des classes pour les classes des cellules ou des liens de liste de liens, pour en fournir une liste plutôt que de devoir les rentrer à la main, pour les mêmes avantages que cités ci-dessus.

J'ai fait une PR en POC. L'idée est de passer un paramètre "data-godo-custom-classes" qui contient un objet json de la forme :

{
  'pk-button': {
    'allowOn': [
        'links'
    ],
    label: 'button'
  }
}

Un module parcours ça, ajoute les attributs et le code de sérialisation / déserialisation voulu sur les nodes et marks correspondantes, et fourni un menu pour sélectionner les classes à ajouter sur la mark / le node actif.

Plusieurs questions à ce stade :

• Certaines classes sont exclusives (warning-notice, error-notice...) : ça se gère en ajoutant un attribut "group" ou quelque chose dans l'idée sur les classes configurées dans Godo, et en retirant toute classe du même groupe qui serait déjà définie avant d'en ajouter une autre.
• On peut vouloir définir une classe sur un bloc ou une mark, mais aussi à l'intérieur d'un bloc (cas assez courant d'un <span class="theme-blabla"> utilisé à l'intérieur d'un paragraphe par ex.). Pour gérer ça, on peut simplement dédoubler ajouter un attribut "allowIn" dans la configuration des classes, qui permettra de définir une classe sur la sélection dans Godo, si la sélection est dans un bloc supporté.
• Sur l'UI, dans le POC dans la PR associée, c'est juste un select qui permet de sélectionner une unique classe (et seuls les nodes sont supportés, pas les marks). Si on peut sélectionner plusieurs classes, dont certaines exclusives, plus des classes sur la sélection à l'intérieur des blocs, il faudra pousser ça un peu plus.

Ce ticket pour discuter et pousser un POC, mais si l'idée avance, il faudra découper en plusieurs tickets, entre PBT, Godo et Combo.