Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Le invito a conocer 2 estrategias de estructuración de tu repositorio para tu proyecto como sistemas de diseño.
Puede ser confuso abordar a el desarrollo de un sistema de diseño sin saber como estructurar nuestro proyecto, la estructura de nuestro repositorio definirá en gran medida el formato de publicación de su sistema de diseño sea:
Es la forma más eficiente de asilar las herramientas que gira entorno a nuestro sistema de diseño.
Esto mantendrá limpio el workspaces, ejemplo:
Storybook puede consumir las historias fuera de su repositorio
Es grato saber que hoy te enfrentas al desafío de implementar un sistema de diseño con Atomico, espero que esta guía te ayude a abordar:
La siguiente guía está en desarrollo
Abstracción de componentes.
Composición. (Slots)
Distribución.
Documentación.
Trata de un repositorio que posee un componentes versionados a nivel de sistema de diseño.
Trata de un repositorio que posee un componentes versionados a nivel de sistema de diseño esto quiere decir que cualquier cambio a nivel de componente se publicara como una nueva versión del sistema de diseño.
Mayor agilidad al crear nuevos componentes, ya que no deberemos crear un nuevo package para un nuevo componente.
Facil centralización de todo el sistema de diseño, bastara con un fichero components
para definir que se exporta a nivel de sistema de diseño.
No podremos individualizar las dependencias por componente, ya que estas estarán atadas al package de todo el sistema de diseño.
Trata de un repositorio que posee un sistema de diseño versionados por componentes
Es la estrategia más habitual al momento de crear sistemas de diseño, ya que permite individualizar los cambios a nivel de componente:
Gracias a que cada componente posee su package.json se lograra:
Versionamiento: Cada package estará versionado, ejemplo @ds/button@1.0.0
, esto permite que podamos agregar mejoras o corregir problemas apuntando solo a la versión del componente afectado.
Mantenimiento: Al ser un package, podemos individualizar sus dependencias y pruebas, lo que facilita el mantenimiento.
Abstracción: Trata de que cada componente aislara en su package los slots de composición(Subcomponentes que únicamente dependen del componente principal, ejemplo el tag option depende del tag select) y alguna otra utilidad especifica del componente.
Las siguientes desventajas son prácticas:
Mayor lentitud al crear nuevos componentes, ya que cada componente requerirá ser un nuevo package.
Mayor dificultad de centralización de componentes en un solo package, ya que cada cambio requerirá actualizar el package principal y adjuntar la nueva exportación.
Las desventajas prácticas pueden ser reparadas mediante herramientas de CLI que automatizan la generación de archivos y centralización de packages
Atomico hoy ofrece un set de utilidades para mejorar la creacion de sistemas de diseño usando Storybook.
@atomico/vite
@atomico/postcss-tokens
Los tokens son valores configurables de nuestro sistema de diseño representados usando css custom properties, en esta guía encontraras recomendaciones de uso para que tu proyecto sea más escale y configurable sin complicaciones
El seudo selector :root nos permite definir tokens que podrán ser accedidos a nivel de todo el documento incluso shadowDOM, para aprovechar esta ventaja lo ideal es mantener el siguiente patrón.
un documento theme sea CSS o JS que defina todos los tokens como custom property a nivel de :root, ejemplo:
Te invito a notar que para este caso hemos asociado el como prefijo de nombre la cadena--my-design-system
, la idea de esto es minimizar conflicto y definir un namespace que identifique las css custom properties que nos pertenecen a nivel de sistema de diseño.
El seudo selector :host nos permite encapsular estilos que apuntan a la instancia de nuestro webcomponent, gracias a :host podemos facilitar el acceso a las css custom properties provenientes de :root, esto es práctico ya que facilita el mantenimiento y es automatizable, ejemplo:
Una microlibrería inspirada en React Hooks, diseñada y optimizada para la creación de webcomponentes.
Atomico simplifica el aprendizaje, flujo de trabajo y el mantenimiento al crear webcomponents y lo logra con :
Interfaces escalable y reutilizable: con Atomico el código es más simple y podrás aplicar practicas que faciliten la reutilización de tu código.
Comunicación abierta: su webcomponent podrá comunicar su estado sea por eventos, propiedades o métodos.
Agnóstico: su webcomponent servirá en cualquier librería compatible con la web, ejemplo React, Vue o Svelte.
Performance: Atomico posee un performance comparativo a niveles de Svelte, ganando la tercera posición en performance según webcomponents.dev en una comparativa de 55 librerías entre las cuales esta React, Vue, Stencil y Lit.
Mejora la experiencia de desarrollo y documentación en Storybook de los webcomponents creados con Atomico
@atomico/storybook posee como objetivo:
Entregar un decorador para renderizar el JSX/HTML y serializar el codigo de las historias.
Entregar un generador de argTypes/args segun el componente dado.
decorator
permite renderizar el JSX/HTML usando el render de Atomico, este también permite serializar el JSX y HTML declarado en su historia, ejemplo:
La serialización del JSX ocurre solo si se defineparameters.docs.source = 'jsx'
por historia o global en .storybook/preview.js.
Esta funcionalidad solo es compatible con versiones >= atomico@1.70.0 gracias a la característica de nombres automáticos según definición del componente
Esta guía conocerás lo esencial para comenzar a desarrollar webcomponents con Atomico
Gracias por estar aquí e iniciarte con Atomico. Hablemos un poco de lo que hoy ofrece atomico:
Agilidad de desarrollo, el enfoque funcional de Atomico simplifica el código en todas las etapas de desarrollo.
Ligero por dentro y por fuera, Atomico te permite crear un componente con menos código y con un bajo impacto de dependencias 3kb Aproximadamente.
Realmente rapido, Atomico posee un buen performance en el browser y una experiencia de desarrollo ágil.
Entendamos el como luce un webcomponent creado con Atomico:
Analicemos el código por partes...
¿Qué hemos importado?
c
: Función que transforma el componente funcional en un customElement estándar.
html
: Función para declarar la plantilla de nuestro componente, también puedes usar JSX.
css
: Función que permite crear el CSSStyleSheet(CSS) para nuestro componente siempre y cuando este declare el shadowDom.
Nuestra función component
recibe todas las props(Propiedades y Atributos) declaradas en component.props
, la función component
declara toda la lógica y plantilla del webcomponent. Una regla importante dentro de Atomico es "todo componente creado con Atomico debe siempre retornar el tag <host>
".
Atomico detecta las prop(Propiedades y Atributos) del componente gracias a la asociación del objeto props, esto mediante el uso de índices y valores te permite definir:
índice: Nombre de la propiedad y atributo.
Valor: tipo de la prop.
Del ejemplo podemos inferir que Atomico creará en nuestro webcomponente una propiedad y atributo llamada mensaje y esta solo puede recibir valores del tipo String.
Atomico detecta los estilos estáticos de tu componente gracias a la asociación de la propiedad styles
:
styles
acepta valores CSSStyleSheet(CSS) de forma individual o en lista, el retorno de la función css
es un CSSStyleSheet estándar, por lo que puede ser compartido fuera de Atomico.
Para crear nuestro customElement estándar deberemos entregar nuestro componente funcional a la función c
del módulo de Atomico, la función c
generará como retorno un customElement que puede ser definido o extendido.
El uso de slots mejora la composición permitiéndote reflejar el contenido expuesto en el lightDOM
del componente en el shadowDOM
de este, ejemplo:
El selector slotted
permite la manipulación del contenido expuesto como slot del lightDOM desde el shadowDOM, ejemplo:
Con Atomico puedes definir un slot por defecto para tus componentes, esto es útil si buscas mantener cierta consistencia de composición sin la necesidad de declarar el uso de slot, ejemplo:
Para definir un slot por defecto solo debes declarar en las props la prop slot, ejemplo: