Cómo Nordhealth usa propiedades personalizadas en componentes web

Los beneficios de usar propiedades personalizadas en sistemas de diseño y bibliotecas de componentes.

David Darnes
David Darnes

Soy Dave y soy desarrollador sénior de frontend en Nordhealth. Trabajo en el diseño y desarrollo de nuestro sistema de diseño Nord, que incluye la compilación de componentes web para nuestra biblioteca de componentes. Quería compartir cómo resolvimos los problemas relacionados con la aplicación de diseño a los componentes web con las propiedades personalizadas de CSS y algunos de los otros beneficios de usar propiedades personalizadas en sistemas de diseño y bibliotecas de componentes.

Para compilar nuestros componentes web, usamos Lit, una biblioteca que proporciona mucho código de plantilla, como estado, estilos centrados, plantillas y mucho más. Lit no solo es ligero, sino que también se compila en APIs nativas de JavaScript, lo que significa que podemos ofrecer un paquete de código liviano que aprovecha las funciones que ya tiene el navegador.


import {html, css, LitElement} from 'lit';

export class SimpleGreeting extends LitElement {
  static styles = css`:host { color: blue; font-family: sans-serif; }`;

  static properties = {
    name: {type: String},
  };

  constructor() {
    super();
    this.name = 'there';
  }

  render() {
    return html`

Hey ${this.name}, welcome to Web Components!

`
; } } customElements.define('simple-greeting', SimpleGreeting);
Un componente web escrito con Lit.

Pero lo más atractivo de los componentes web es que funcionan con casi cualquier framework de JavaScript existente o incluso sin ningún framework. Una vez que se hace referencia al paquete principal de JavaScript en la página, usar un componente web es muy similar a usar un elemento HTML nativo. El único indicador real de que no es un elemento HTML nativo es el guion constante dentro de las etiquetas, que es un estándar para indicarle al navegador que se trata de un componente web.

Encapsulamiento de estilo de Shadow DOM

De la misma manera que los elementos HTML nativos tienen un Shadow DOM, también lo hacen los componentes web. Shadow DOM es un árbol oculto de nodos dentro de un elemento. La mejor manera de visualizar esto es abrir el inspector web y activar la opción "Show Shadow DOM tree". Una vez que lo hagas, intenta buscar un elemento de entrada nativo en el inspector. Ahora tendrás la opción de abrir esa entrada y ver todos los elementos que contiene. Incluso puedes probar esto con uno de nuestros componentes web. Intenta inspeccionar nuestro componente de entrada personalizado para ver su Shadow DOM.

El DOM secundario inspeccionado en DevTools.
Ejemplo del Shadow DOM en un elemento de entrada de texto normal y en nuestro componente web de entrada Nord.

Una de las ventajas (o desventajas, según tu punto de vista) del Shadow DOM es el encapsulamiento de estilo. Si escribes CSS dentro de tu componente web, esos estilos no pueden filtrarse y afectar la página principal ni otros elementos, ya que están completamente contenidos en el componente. Además, el CSS escrito para la página principal o un componente web superior no puede filtrarse en tu componente web.

Este encapsulamiento de estilos es un beneficio en nuestra biblioteca de componentes. Nos brinda una mayor garantía de que, cuando alguien use uno de nuestros componentes, se verá como queríamos, independientemente de los estilos aplicados a la página superior. Y para asegurarnos aún más, agregamos all: unset; a la raíz, o "host", de todos nuestros componentes web.


:host {
  all: unset;
  display: block;
  box-sizing: border-box;
  text-align: start;
  /* ... */
}
Algunos componentes de código de texto modelo se aplican a la raíz en sombra o al selector de host.

Sin embargo, ¿qué sucede si alguien que usa tu componente web tiene un motivo legítimo para cambiar ciertos estilos? ¿Tal vez hay una línea de texto que necesita más contraste debido a su contexto, o un borde que debe ser más grueso? Si no se puede aplicar ningún estilo a tu componente, ¿cómo puedes desbloquear esas opciones de diseño?

Ahí es donde entran en juego las propiedades personalizadas de CSS.

Propiedades personalizadas de CSS

Las propiedades personalizadas tienen un nombre muy apropiado: son propiedades CSS a las que puedes asignar el nombre que quieras y aplicar cualquier valor que sea necesario. El único requisito es que los prefijes con dos guiones. Una vez que declares tu propiedad personalizada, el valor se podrá usar en tu CSS con la función var().


:root {
  --n-color-accent: rgb(53, 89, 199);
  /* ... */
}

.n-color-accent-text {
  color: var(--n-color-accent);
}
Ejemplo de nuestro framework de CSS de un token de diseño como una propiedad personalizada y su uso en una clase de ayuda.

En lo que respecta a la herencia, se heredan todas las propiedades personalizadas, lo que sigue el comportamiento típico de las propiedades y los valores de CSS normales. Cualquier propiedad personalizada aplicada a un elemento superior o al elemento en sí se puede usar como valor en otras propiedades. Hacemos un gran uso de las propiedades personalizadas para nuestros tokens de diseño, ya que los aplicamos al elemento raíz a través de nuestro framework de CSS, lo que significa que todos los elementos de la página pueden usar estos valores de token, ya sea un componente web, una clase auxiliar de CSS o un desarrollador que desee extraer un valor de nuestra lista de tokens.

Esta capacidad de heredar propiedades personalizadas, con el uso de la función var(), es la forma en que penetramos en el Shadow DOM de nuestros componentes web y permitimos que los desarrolladores tengan un control más detallado cuando aplican diseño a nuestros componentes.

Propiedades personalizadas en un componente web de Nord

Cuando desarrollamos un componente para nuestro sistema de diseño, adoptamos un enfoque reflexivo en cuanto a su CSS. Nos gusta apuntar a un código ágil, pero muy fácil de mantener. Los tokens de diseño que tenemos se definen como propiedades personalizadas dentro de nuestro framework de CSS principal en el elemento raíz.


:root {
  --n-space-m: 16px;
  --n-space-l: 24px;
  /* ... */
  --n-color-background: rgb(255, 255, 255);
  --n-color-border: rgb(216, 222, 228);
  /* ... */
}
Propiedades personalizadas de CSS que se definen en el selector raíz.

Luego, se hace referencia a estos valores de token dentro de nuestros componentes. En algunos casos, aplicaremos el valor directamente en la propiedad CSS, pero en otros, definiremos una nueva propiedad personalizada contextual y aplicaremos el valor a esa propiedad.


:host {
  --n-tab-group-padding: 0;
  --n-tab-list-background: var(--n-color-background);
  --n-tab-list-border: inset 0 -1px 0 0 var(--n-color-border);
  /* ... */
}

.n-tab-group-list {
  box-shadow: var(--n-tab-list-border);
  background-color: var(--n-tab-list-background);
  gap: var(--n-space-s);
  /* ... */
}
Las propiedades personalizadas se definen en la raíz de sombra del componente y, luego, se usan en los estilos del componente. También se usan las propiedades personalizadas de la lista de tokens de diseño.

También abstraeremos algunos valores que son específicos del componente, pero no de nuestros tokens, y los convertiremos en una propiedad personalizada contextual. Las propiedades personalizadas que son contextuales para el componente nos proporcionan dos beneficios clave. En primer lugar, significa que podemos ser más "sencillos" con nuestro CSS, ya que ese valor se puede aplicar a varias propiedades dentro del componente.


.n-tab-group-list::before {
  /* ... */
  padding-inline-start: var(--n-tab-group-padding);
}

.n-tab-group-list::after {
  /* ... */
  padding-inline-end: var(--n-tab-group-padding);
}
La propiedad personalizada contextual de padding del grupo de pestañas se usa en varios lugares dentro del código del componente.

En segundo lugar, hace que los cambios de estado y variación del componente sean muy claros: solo se debe cambiar la propiedad personalizada para actualizar todas esas propiedades cuando, por ejemplo, aplicas diseño a un estado activo o de desplazamiento del mouse o, en este caso, a una variación.


:host([padding="l"]) {
  --n-tab-group-padding: var(--n-space-l);
}
Una variación del componente de pestaña en la que se cambia el padding con una sola actualización de la propiedad personalizada en lugar de varias actualizaciones.

Sin embargo, el beneficio más potente es que, cuando definimos estas propiedades personalizadas contextuales en un componente, creamos una especie de API de CSS personalizada para cada uno de nuestros componentes, que el usuario de ese componente puede aprovechar.


<nord-tab-group label="Title">
  <!-- ... -->
</nord-tab-group>

<style>
  nord-tab-group {
    --n-tab-group-padding: var(--n-space-xl);
  }
</style>
Usa el componente de grupo de pestañas en la página y actualiza la propiedad personalizada de padding a un tamaño más grande.

En el ejemplo anterior, se muestra uno de nuestros componentes web con una propiedad personalizada contextual que se cambió a través de un selector. El resultado de todo este enfoque es un componente que le brinda al usuario suficiente flexibilidad de diseño y, al mismo tiempo, mantiene la mayoría de los estilos reales bajo control. Además, como beneficio adicional, nosotros, como desarrolladores de componentes, tenemos la capacidad de interceptar esos estilos que aplica el usuario. Si queremos ajustar o extender una de esas propiedades, podemos hacerlo sin que el usuario tenga que cambiar su código.

Consideramos que este enfoque es muy potente, no solo para nosotros como creadores de los componentes de nuestro sistema de diseño, sino también para nuestro equipo de desarrollo cuando los usa en nuestros productos.

Aprovecha al máximo las propiedades personalizadas

En el momento de escribir este artículo, no revelamos estas propiedades personalizadas contextuales en nuestra documentación. Sin embargo, planeamos hacerlo para que nuestro equipo de desarrollo más amplio pueda comprender y aprovechar estas propiedades. Nuestros componentes se empaquetan en npm con un archivo de manifiesto, que contiene todo lo que se necesita saber sobre ellos. Luego, consumimos el archivo de manifiesto como datos cuando se implementa nuestro sitio de documentación, lo que se hace con Eleventy y su función de datos globales. Planeamos incluir estas propiedades personalizadas contextuales en este archivo de datos de manifiesto.

Otro aspecto que queremos mejorar es la forma en que estas propiedades personalizadas contextuales heredan valores. Actualmente, por ejemplo, si deseas ajustar el color de dos componentes de divisor, debes segmentar ambos componentes específicamente con selectores o aplicar la propiedad personalizada directamente en el elemento con el atributo de diseño. Esto puede parecer bien, pero sería más útil si el desarrollador pudiera definir esos estilos en un elemento contenedor o incluso en el nivel raíz.


<nord-divider></nord-divider>

<section>
  <nord-divider></nord-divider>
   <!-- ... -->
</section>

<style>
  nord-divider {
    --n-divider-color: var(--n-color-status-danger);
  }

  section {
    padding: var(--n-space-s);
    background: var(--n-color-surface-raised);
  }
  
  section nord-divider {
    --n-divider-color: var(--n-color-status-success);
  }
</style>
Dos instancias de nuestro componente de divisor que necesitan dos tratamientos de color diferentes. Uno está anidado dentro de una sección que podemos usar para un selector más específico, pero debemos segmentar el divisor de forma específica.

La razón por la que debes establecer el valor de la propiedad personalizada directamente en el componente es porque los definimos en el mismo elemento a través del selector de host de componentes. Los tokens de diseño globales que usamos directamente en el componente pasan directamente, sin verse afectados por este problema, y hasta se pueden interceptar en elementos superiores. ¿Cómo podemos obtener lo mejor de ambos mundos?

Propiedades personalizadas privadas y públicas

Lea Verou creó las propiedades personalizadas privadas, que son una propiedad personalizada contextual "privada" en el componente en sí, pero configurada como una propiedad personalizada "pública" con un resguardo.



:host {
  --_n-divider-color: var(--n-divider-color, var(--n-color-border));
  --_n-divider-size: var(--n-divider-size, 1px);
}

.n-divider {
  border-block-start: solid var(--_n-divider-size) var(--_n-divider-color);
  /* ... */
}
El CSS del componente web del divisor con las propiedades personalizadas contextuales ajustadas para que el CSS interno dependa de una propiedad personalizada privada, que se estableció como una propiedad personalizada pública con un resguardo.

Definir nuestras propiedades personalizadas contextuales de esta manera significa que aún podemos hacer todo lo que hacíamos antes, como heredar valores de tokens globales y volver a usar valores en todo el código de nuestro componente. Sin embargo, el componente también heredará de forma fluida nuevas definiciones de esa propiedad en sí mismo o en cualquier elemento superior.


<nord-divider></nord-divider>

<section>
  <nord-divider></nord-divider>
   <!-- ... -->
</section>

<style>
  nord-divider {
    --n-divider-color: var(--n-color-status-danger);
  }

  section {
    padding: var(--n-space-s);
    background: var(--n-color-surface-raised);
    --n-divider-color: var(--n-color-status-success);
  }
</style>
Los dos divisores de nuevo, pero esta vez se puede cambiar el color del divisor agregando la propiedad personalizada contextual del divisor al selector de secciones. El divisor lo heredará, lo que producirá un código más limpio y flexible.

Si bien se puede argumentar que este método no es realmente “privado”, creemos que es una solución bastante elegante para un problema que nos preocupaba. Cuando tengamos la oportunidad, abordaremos este problema en nuestros componentes para que nuestro equipo de desarrollo tenga más control sobre el uso de los componentes y, al mismo tiempo, se beneficie de los controles que tenemos implementados.

Espero que esta información sobre cómo usamos los componentes web con propiedades personalizadas de CSS te resulte útil. Cuéntanos qué te parece y, si decides usar alguno de estos métodos en tu propio trabajo, puedes encontrarme en Twitter @DavidDarnes. También puedes encontrar a Nordhealth @NordhealthHQ en Twitter, así como al resto de mi equipo, que trabajó arduamente para crear este sistema de diseño y ejecutar las funciones mencionadas en este artículo: @Viljamis, @WickyNilliams y @eric_habich.

Imagen hero de Dan Cristian Pădureț