Estilo Seguro para Paquetes de Componentes React: Vanilla Extract CSS

¿Alguna vez te has encontrado luchando con CSS en una aplicación React y pensando, tiene que haber una mejor manera? ¿Suena familiar, verdad? Hoy vamos a hablar sobre el método de estilo seguro de tipo en las aplicaciones React.

Hola, mi nombre es Negar Jamwani-Farad. Soy desarrolladora de software en Lightspeed Commerce, y mis amigos y colegas me conocen por mi pasión por CSS y trabajar en sistemas de diseño. Y hoy, voy a hablar de una de las cosas que recientemente llamó mi atención. Voy a comenzar con una rápida comparación entre algunas de las herramientas más populares para el estilo en React, como CSS en JS en general, módulos CSS, y este nuevo kit en el blog, Vanilla Extracts CSS. Y confía en mí, al final de esto, vas a tener un nuevo favorito.

Te podrías preguntar, ya tenemos tantas opciones geniales. Quiero decir, ¿a quién no le gusta CSS en JS? Bueno, es popular de hecho. Ofrece un estilo con alcance justo dentro del componente, y también tiene una buena experiencia de desarrollador sin cambios de contexto cuando vas y vienes entre tus archivos CSS y de estilo, entre tus archivos JS y de estilo. Pero todo esto viene con algunos costos. Tiene cierta sobrecarga en tiempo de ejecución, y si tu aplicación es muy grande, vas a terminar con un gran archivo de paquete JS.

Ahora tenemos módulos CSS. También ofrece un estilo con alcance. Se compila a CSS plano, lo que significa que no hay sobrecarga en tiempo de ejecución y un tamaño de paquete JS más pequeño. Pero para ser justos, la experiencia del desarrollador no es tan buena como las soluciones de CSS y JS, especialmente cuando TypeScript entra en juego. Y ahora, entra el CSS de extracto de vainilla. Piénsalo como un paquete que une lo mejor de ambos mundos, un estilo con alcance, cero sobrecarga en tiempo de ejecución, y proporciona una gran experiencia de desarrollador con un CSS y TS, una sintaxis hermosa. Así que para un paquete de componentes de sistema de diseño que necesita eficiencia, escalabilidad y mantenibilidad, queremos tanto rendimiento como una buena experiencia de desarrollador. Y en mi opinión, el CSS de extracto de vainilla es una opción que vale la pena considerar.

Así que vamos a profundizar en por qué el extracto de vainilla está llamando la atención de tantos. Así que mencioné cero tiempo de ejecución. Vanilla extract genera un archivo CSS estático en el momento de la construcción, por lo que no tiene sobrecarga en tiempo de ejecución, y como resultado, tiene un mejor rendimiento. Es agnóstico al marco. Así que desarrollas tus estilos una vez, y luego puedes usarlos en diferentes bibliotecas, ya sea React, Vue, o cualquier nueva biblioteca que tu equipo decida usar de repente. Tiene un kit de herramientas muy poderoso. Estás pensando en Tailwinds por sus clases de utilidad. Bueno, el CSS de Vanilla Extract tiene Sprinkles, y podrías pensar, Oh, pero necesito hacer algún cálculo en mi CSS. Pero Vanilla Extract ofrece utilidades CSS y algunas otras herramientas de las que voy a hablar durante la demostración. También, encima de todas estas características, tiene seguridad de tipo. Y con la seguridad de tipo, puedes definir temas con tokens profundamente anidados y dejar que TypeScript se encargue de todo eso.

O autocompletar, y no perderse un cambio de token en alguna parte de su aplicación. Creo que he hablado mucho sobre Vanilla Extract hasta ahora. Vamos a saltar al código y verlo en práctica, y ver de qué se trata todo esto.

Así que permítanme cambiar a mi editor, aquí. Así que aquí tengo una aplicación React muy simple. He creado esto con Vite. Es TypeScript, React, y Vite como un bundler. He creado un componente de botón muy, muy simple, aquí. Vamos a imitar la creación de componentos en paquetes de componentes de sistemas de design, y voy a hacer lo posible para en un tiempo muy corto, crear temas, añadir variación a este botón, y añadiré todo el estilo a este botón. Así que ahora si quieres ver el componente, se ve así. Es básicamente el botón HTML básico.

Así que tenemos que empezar añadiendo Vanilla Extract CSS. Para empezar, hay dos paquetes que necesitamos instalar. Y uno de ellos es Vanilla Extract en sí, y el otro es recipe. Voy a hablar de recipe más adelante en esta charla. Pero los tengo instalados ahora mismo por el bien del tiempo, así que no tenemos que instalar ellos.

Así que otro paquete que necesitas empezar al principio de un proyecto es un bundler. Y Vanilla Extract CSS ofrece un par de integraciones de bundler con diferentes plataformas. Ahora mismo, estoy usando Vit, así que necesito instalar un plugin de Vit Bundler para poder agrupar nuestros archivos CSS en el momento de la construcción. Así que para configurar eso, necesitamos ir a vit.config y, como puedes ver, ya lo he hecho, importas el plugin y luego lo añades a tu configuración de Vit. Y tan simple como eso, estás listo. Tienes todo configurado para empezar a escribir tus cosas. Así que lo primero que voy a crear es una configuración muy básica para mi botón para que no sea sólo el aburrido botón HTML. Así que en mi carpeta de componentes, voy a añadir un archivo button.css.ts, y por eso necesitamos el bundler. Y voy a crear, voy a llamarlo estilo de botón, oh dios mío, odio la codificación en vivo. Así que hay una función de estilo en Vanilla CSS que vamos a usar aquí. Y por el bien del tiempo, sólo voy a copiar y pegar de mis notas el estilo que he creado para este componente. Así que un estilo muy básico, como hover y focus y todo eso. Y necesitamos exportar esto desde este archivo. Y luego, volvemos a nuestro botón, y aquí para el nombre de la clase, voy a exportar el estilo de botón que exporté en mi otro archivo.

Muy similar a lo que hacemos en CSS modules. Así que ahora vamos a verlo en el navegador, y como pueden ver, este archivo ha sido aplicado, y tan simple como eso.

Bien, ahora quiero añadir algunos colores y algunos bordes a mi botón, pero no quiero simplemente codificar estos valores en mi CSS. Quiero usar los valores que provienen de un tema. Así que necesitamos crear un tema. Así que he creado un archivo theme.css.ts. Y en este archivo, voy a crear un tema por defecto, y voy a usar otra función de Vanilla Extract CSS, que se llama create theme, muy intuitivo. Y en este archivo, voy a pasar los tokens que quiero tener para mi tema. Así que tengo una estructura de tokens muy simplificada aquí lista para la demostración. Sólo tiene como dos colores, pero puede ser todo el tema que quieras para tu aplicación. Lo que create theme hace aquí por nosotros es que crea variables CSS para cada uno de estos tokens, y luego envuelve estos valores con una clase. Y esta clase se expone aquí como, voy a llamarla clase de tema por defecto. Y luego como segundo parámetro, también devuelve una var. Me gusta llamarlo una var. Y esto es en realidad una estructura de data que sigue la misma estructura que proporcionamos en nuestro token aquí. Y luego podemos usarlo en nuestro estilo para obtener estos valores en mi, por ejemplo, button.css.ts5.

Así que hasta ahora tenemos un tema para nuestra aplicación. Pero vamos más allá y añadimos otro color. Digamos que quiero tener otro tema rosa. Y voy a usar la misma función create theme, pero esta vez como primer parámetro voy a pasar vars porque no quiero, quiero seguir el mismo patrón. Así es como, así es como decimos, cuando vas a extraer CSS, que voy a seguir la misma estructura. Y como segundo parámetro, voy a pasar mis nuevos valores que van a sobrescribir el anterior. Así que aquí, voy a pasar mis valores de tema rosa. Así que necesito exportar todos estos valores al final. Así que tengo una clase por defecto, tengo una clase de tema rosa, y luego tengo mis vars. Y luego he creado, toda mi aplicación está envuelta por un componente llamado themeSweepter. Es simplemente un componente que cambia la clase en el nivel superior de un tema a otro para que podamos... Veamos, probablemente tuve algún error de tipeo... Vale. Y bien, volvamos a nuestro componente.

Como pueden ver, esta parte se ha añadido pero no está funcionando porque no estamos utilizando los valores del tema. Así que vuelvo a mi botón.css.ts y para el color de fondo, voy a importar las vars que exporté en mi tema y aquí voy a decir que elija los colores primarios y principales. Y voy a usar otro aquí. Así que quiero el color negro. Mira eso. Autocompletar. Dios mío. Es tan emocionante. Así que luego voy a usar el tema oscuro para mi hover y para mi contorno, voy a usar otro color. Así que simplemente voy a ir con gris y principal. Ahora volvamos a nuestro ordenador. Vamos a nuestro navegador y como pueden ver, el tema se ha aplicado y ahora cambiemos de tema. Tenemos nuestros dos colores en dos temas en pocos minutos. Así que voy a ir incluso más allá. Así que en los paquetes de componentes, normalmente sucede que queremos pasar una prop a nuestro componente como una variante, un tipo, un tamaño, y luego basado en la prop que pasamos a el componente queremos ser capaces de cambiar nuestro design y nuestro estilo del componente. Así que para eso necesitamos usar recipe. Así que para empezar a implementar eso voy a reemplazar el estilo con la función recipe y necesito mover todos estos estilos bajo base. Así que va a ser el estilo base de mi componente. Así que voy a comentar estos porque vamos a moverlos en otra sección y recipe proporciona una variante, oh lo siento, supongo que variantes, sí. Así que las variantes pueden ser cualquier cosa desde tipo a tamaño, incluso puede ser un booleano como deshabilitado. Así que aquí simplemente voy a crear una variante de tipo y quiero que mi variante de tipo tenga un relleno y luego quiero que tenga un contorno. Así que estos van a ser diferentes tipos de mi bun y quiero un tipo de texto simple sin ningún fondo o nada. Así que ahora necesitamos añadir todo el estilo para cada uno de estos tipos que se supone que sobrescribirá el estilo base que tenemos aquí arriba. Así que lo tengo listo así que voy a copiarlo y pegarlo de mis notas. Así que si puedo, aparentemente, uso mi habilidad para copiar y pegar. Y el texto. Así que aquí vamos. Simplemente está añadiendo fondo y hover para cada tipo. Pero hay una cosa más que necesitamos hacer. Necesitamos decirle a Banyuda Extract cuál es nuestra variante por defecto. Así que decimos, para las variantes por defecto, para el tipo, quiero que sea relleno. Y como es TypeScript, está totalmente tipado, así que tiene grandes sugerencias. Si queremos implementar eso en un botón, normalmente lo que deberías hacer es añadir el tipo aquí, y luego necesitas añadirlo a tu tipo de props, pero entonces tienes que seguir el nombre exacto de tu estilo, y mantener estos sincronizados con el tiempo es un lío. Así que tienes que ir, tipo, quiero que sea relleno, y luego bla, bla, y mantener eso consistente con el tiempo es realmente difícil, pero realmente no tienes que hacer eso con Vanilla Xtract, hay una herramienta, así que voy a decir, voy a exportar la variante del botón, y voy a usar recipe, recipe, ayúdame, oh dios mío, oh, lo siento, mi mal, necesito, okay, ahí vas, y voy a decir que obtenga todos los tipos de button style, y button style no es una clase más, así que es lo que sea que se devuelva de recipe. Así que ahora vuelvo a nuestro componente y voy a importar el tipo que acabo de crear, lo que se llama bun variantes, ahí vas, y luego voy a añadir mi nueva prop, y aquí vamos a decir que para mi nombre de clase, ahora el bun side como mencioné no es una simple cadena más, es una función y pasas en tu prop de tipo aquí, y basado en la prop que estás pasando devolverá la clase correcta que necesitas para tu componente. Así que hay una última cosa que necesito hacer, es añadir estas props aquí, así que quiero tener contorno, y luego quiero tener texto, y el primero tiene un valor por defecto que es relleno. Ahora volvamos a nuestro navegador, y ta-da, tenemos tres variantes del mismo botón, Veamos si el tema funciona, y sí lo hace, y tan fácil como eso, en pocos minutos he podido crear un botón con tres variaciones y dos temas, y ese es el poder de Vanilla Extract. Espero que estén tan emocionados como yo y estén tan interesados como yo en Vanilla Extract, y si han disfrutado de esta masterclass y quieren hablar más sobre este paquete o CSS o React o cualquier cosa relacionada con el front-end, pueden encontrarme en Twitter, y gracias por ver, que tengan un día increíble.