Développement 5 min de lecture

Pourquoi j’ai créé une bibliothèque de composants Svelte

James Barnes Ingénieur design et développeur front-end

Chaque fois que je commençais un nouveau projet Svelte, je cherchais une bibliothèque de composants, et chaque fois je tombais sur le même problème. Presque toutes les bonnes options sont construites autour de Tailwind. C’est très bien si Tailwind est votre façon de travailler. J’écris pourtant beaucoup de mes design systems en CSS pur, et avec ces bibliothèques je passais plus de temps à contourner le style qu’à m’en servir.

Alors j’ai créé la mienne. Distill UI est une bibliothèque de composants Svelte open source, désormais aussi disponible pour Vue, où chaque composant est stylé en CSS pur et scopé. Ce billet raconte pourquoi, et ce que j’ai décidé en cours de route.

Le problème des bibliothèques pensées pour Tailwind

Svelte vous offre quelque chose de très agréable dès le départ : un bloc <style> dans chaque composant, limité à ce composant. Vous écrivez du CSS normal, il ne s’applique que là où vous l’avez écrit, et vous n’avez jamais à vous soucier de noms de classes en conflit.

La plupart des bibliothèques d’interface Svelte ignorent complètement cette possibilité. Leurs composants arrivent avec de longues chaînes de classes utilitaires, et on s’attend à ce que vous les surchargiez avec d’autres classes utilitaires. Si votre projet n’utilise pas Tailwind, il vous reste deux mauvaises options. Vous pouvez recourir à :global() et styler l’intérieur de la bibliothèque depuis l’extérieur, ce qui casse justement la portée qui rendait Svelte agréable. Ou vous pouvez tout envelopper de balises et de sélecteurs supplémentaires jusqu’à obtenir le résultat voulu, ce qui fait beaucoup de code répétitif pour un simple bouton.

J’ai déjà écrit sur les compromis de Tailwind, et je l’utilise encore sur certains projets. Je voulais une bibliothèque pour les projets où je ne l’utilise pas.

Copier le code, posséder le code

L’idée que j’ai empruntée est celle que shadcn/ui a popularisée : au lieu d’installer un paquet auquel vous ne pouvez pas toucher, vous copiez le code source de chaque composant dans votre propre projet. Distill UI suit la même structure que shadcn-svelte et shadcn-vue, donc si vous les avez déjà utilisés, vous vous y retrouverez.

Un petit outil en ligne de commande s’occupe de la copie :

npx distill-ui init
npx distill-ui add button dialog

init ajoute les design tokens et les importe dans votre layout racine, et add dépose les fichiers des composants dans votre projet. À partir de là, ils vous appartiennent. Si vous voulez qu’un bouton se comporte autrement, vous ouvrez le fichier et vous le modifiez. L’outil ne remplace pas non plus un fichier que vous avez déjà modifié, ce qui compte dès que vous commencez à vous approprier un composant.

Du CSS pur, facile à lire

Chaque composant a un seul nom de classe et un court bloc de CSS dans son propre bloc <style>. Voici une version abrégée du bouton :

.button {
	height: var(--dui-button-height, 2.25rem);
	border-radius: var(--dui-button-radius, var(--dui-radius-md));
	background: var(--dui-button-bg, var(--dui-color-primary));
	color: var(--dui-button-fg, var(--dui-color-primary-foreground));

	&:hover {
		background: var(--dui-button-hover-bg, var(--dui-color-primary-hover));
	}
}

Les variantes et les tailles sont des attributs de données, comme data-variant="outline" ou data-size="sm", plutôt que des piles de classes. Les états de survol et désactivé se trouvent exactement là où on s’attend à les trouver. N’importe qui dans une équipe qui connaît le CSS peut ouvrir ce fichier et le modifier sans apprendre un nouveau vocabulaire.

Tokens et thèmes

Les couleurs, les espacements et les arrondis reposent tous sur des propriétés personnalisées CSS, préfixées par --dui-. Il y a deux niveaux. Les tokens globaux comme --dui-color-primary et --dui-radius-md définissent l’apparence de toute la bibliothèque, et chaque composant a ses propres variables, comme --dui-button-bg, qui se rabattent sur ces valeurs globales.

Cela vous donne deux façons de créer un thème. Changez quelques valeurs globales et toute la bibliothèque s’accorde à votre marque. Ou définissez une variable de composant sur un seul bouton, ou sur n’importe quel élément parent, quand une partie de la page doit avoir un style différent. Pas de surcharges à écrire, pas de bataille de spécificité.

Le mode sombre suit le réglage du système par défaut, et vous pouvez le forcer avec un seul attribut sur la page.

Accessible par défaut

C’est là que je ne voulais pas tourner les coins ronds, et aussi là où je ne voulais rien réinventer. Bien gérer la navigation au clavier, le focus et le comportement avec les lecteurs d’écran pour une boîte de dialogue ou un menu déroulant est difficile, et d’autres l’ont déjà bien fait.

Distill UI utilise donc des éléments HTML natifs partout où le navigateur fait déjà le travail, et s’appuie sur des primitives headless pour les parties difficiles : Melt UI pour Svelte et Reka UI pour Vue. Elles gèrent le comportement, et Distill UI gère le style. Chaque composant a aussi été vérifié avec axe en mode clair et en mode sombre, parce qu’un contraste qui passe dans un thème peut facilement échouer dans l’autre.

Svelte d’abord, puis Vue

Je l’ai d’abord créée pour Svelte 5, parce que c’est ce que j’utilise le plus. Une fois la version Svelte stabilisée, l’adapter à Vue 3 a surtout consisté à reproduire la même API. Les noms des composants, les options et les styles sont identiques dans les deux, donc un seul design system peut couvrir des projets dans l’un ou l’autre framework.

Ce que j’ai appris

La plus grande leçon a été de voir à quel point un design system dépend de décisions prises avant même d’écrire le premier composant. La façon de nommer les tokens, et le choix des valeurs qui appartiennent à toute la bibliothèque plutôt qu’à un seul composant, ont façonné chaque fichier qui a suivi. Bien faire ces choix tôt a rendu les composants suivants rapides à construire.

J’ai aussi appris qu’une grande partie du travail dans une bibliothèque de composants, c’est la documentation. Chaque composant a sa propre page avec un aperçu en direct, le code à copier et des notes pour le personnaliser. Sans cela, les composants ne sont que des fichiers.

C’est la même façon de penser que j’applique au travail pour mes clients. Je conçois l’interface et je la développe moi-même, donc le design system et le code viennent du même endroit et rien ne se perd lors d’une passation.

L’essayer

Distill UI est gratuite et sous licence MIT. La documentation, les aperçus en direct et le guide d’installation pour Svelte et Vue sont sur distill-ui.vercel.app, et le code source est sur GitHub. Si vous l’essayez et qu’il manque quelque chose, j’aimerais le savoir.

Continuer la lecture
enfr