Storybook en Nx Angular monorepo: Documentos MDX

storybook documentos sueltos
Foto de Annie Spratt en Unsplash

Habitualmente no basta con crear las stories para que el usuario vea cómo funciona un determinado componente. Se necesita también explicar cómo se instala y se configura, sus características, casos de uso, y un largo etcétera.

En este artículo vamos a ver cómo crear esas páginas de Storybook en Nx Angular monorepo con documentación extra para dar más información al usuario, són, los documentos Leer más »

Storybook en Nx Angular monorepo: Stories

Libro en blanco
Foto de Markus Spiske en Unsplash

Llegado el momento hay que crear las stories necesarias para las diferentes funcionalidades. Pero, ¿Qué es una stories? ¿Cómo se escriben?

Bien, según la web de Storybook, una story  captura el estado representado de un componente de la interfaz de usuario. Es una función que devuelve el estado de un componente dado un conjunto de argumentos.

Como siempre mejor explicarlo mediante la … Leer más »

Storybook en Nx Angular monorepo: Estilos

Libro de dibujo para pintar
Foto de Nico Smit en Unsplash

Storybook viene por defecto con un diseño propio. No obstante, mostraremos cómo cambiar esos estilos propios mediante lo que Storybook llama «Theming«, es decir, crearemos un tema que incorpore las características de una guía de estilos: marca, tipografías, colores, etc.

Instalación

Comprueba que tienes instalada la librería @storybook/theming en tu carpeta de node_modules, si no existe, puedes instalarla (con la misma versión … Leer más »

Storybook en Nx Angular monorepo: Linting

mosaico de libros
Foto de Robert Anasch en Unsplash

Para llevar a cabo la escritura de stories y la documentación vamos a seguir algunas recomendaciones. Mediante el proceso de linting nos comprometemos a seguir correctamente unas buenas prácticas a la hora de escribir.

Para ello, nos apoyaremos en el eslint y unos packages para poner a punto una configuración de reglas que deberemos cumplir. Este cumplimiento lo podremos ver tanto en el proceso … Leer más »

Storybook en Nx Angular monorepo: Configuración

cuatro libros apilados
Foto de Hope House Press – Leather Diary Studio en Unsplash

En el artículo anterior vimos la instalación de Storybook en Nx Angular monorepo. Esa instalación venía con una configuración mínima por defecto que ahora vamos a ampliar un poco más para conocer un poco más su estructura y de paso tener alguna característica más.

Antes que nada vamos a ver un poco la estructura que nos ha dejado … Leer más »

Storybook en Nx Angular monorepo: Instalación

Libros apilados
Foto de Kimberly Farmer en Unsplash

Cuando vas a desarrollar, se necesita tener a mano buena documentación para tirar de ella en algún momento cuando desconoces sobre el tema o tienes dudas. Esa documentación suele estar redactada formalmente con ejemplos de código en algunos casos para basarse o clarificar el concepto que se explica. Son básicamente los llamados manuales, tutoriales, guías, …

Pero también hay otra manera de explicar el … Leer más »