Introducción a Storybook
Descubrimiento e instalación
Muy utilizado en empresas que disponen de un design system, Storybook es una herramienta que ha experimentado un fuerte crecimiento en los últimos años. No vamos a desarrollar un design system completo, ya que sería un proceso largo. Sin embargo, veremos cómo iniciar un proyecto con Storybook y crear un componente inicial. Lo ideal sería ampliar después el número de componentes, establecer reglas para su uso y trabajar en otros aspectos.
1. ¿Qué es un Storybook?
Storybook es una plataforma de desarrollo para crear, visualizar, documentar y probar componentes de interfaz de usuario de forma independiente. Crea un entorno aislado para cada componente, lo que permite desarrollarlos y probarlos uno a uno de forma interactiva y visual.
2. Instalación de Storybook
Para instalar Storybook, primero necesitamos crear un proyecto. La forma más fácil de hacerlo es utilizar Vite y escribir el siguiente comando en un terminal:
npm create vite@latest
Introduzca un nombre de proyecto, elija React y, a continuación, JavaScript en las siguientes preguntas.
Estas instrucciones han sido probadas para la versión 4.4.9 de Vite.js.
Ahora puede entrar en el directorio e iniciar Storybook con el siguiente comando:
npx sb init
Siga las instrucciones para configurar Storybook para su proyecto.
Una vez completada la instalación, tendrás una nueva...
Creación de un componente
En esta sección, veremos cómo crear un componente en Storybook.
1. Creación de un componente
Para crear un componente en Storybook, cree una carpeta para sus componentes (por ejemplo, src/components). Dentro de la carpeta components, cree un nuevo archivo para su componente (por ejemplo, Title.js). Finalmente, implemente su componente en el archivo.
He aquí un ejemplo de componente:
// src/components/Title.js
import React from 'react';
const Title = ({ children, variant }) => {
const classNames = `title ${variant}`;
return (
<h1 className={classNames}>
{children}
</h1>
);
};
export default Title;
En la misma carpeta, cree un archivo para las stories de su componente (por ejemplo, Title.stories.js).
Implemente una o más stories para su componente en el archivo de stories.
El componente título podría tener un estilo primary y un estilo secundary que lo mostrarían de una forma u otra. Pasando cualquiera de estos valores como prop del componente se obtendrá una visualización diferente.
// src/components/Title.stories.js ...
Utilizar stories
1. Visualizar y poner a prueba la story
Una vez que haya creado una o más stories para su componente, puede verlas en la interfaz del Storybook ejecutando el siguiente comando en el terminal:
npm run storybook
Esto iniciará la interfaz Storybook en su navegador, donde podrá ver e interactuar con los diferentes estados y variantes de su componente, así como consultar la documentación generada automáticamente.
2. Ventajas de crear stories
En un contexto de desarrollo ágil, Storybook está demostrando ser un activo inestimable para la creación de componentes React.
Es una herramienta que favorece un enfoque modular, lo que permite examinar y perfeccionar cada componente por separado para facilitar la depuración y el diseño.
También sirve como plataforma de documentación interactiva, lo que simplifica considerablemente el intercambio de información entre desarrolladores y acelera el proceso de colaboración.
Por último, Storybook ofrece sólidas funciones de pruebas visuales, que ayudan a identificar rápidamente los problemas de la interfaz de usuario antes de que se conviertan en obstáculos importantes.
Al integrar Storybook en su proceso de desarrollo, no sólo facilita la creación de componentes React, sino que también contribuye a aumentar la calidad y la eficiencia de sus design systems.
Utilización de add-ons
Los add-ons son módulos complementarios que añaden una funcionalidad a Storybook. Permiten enriquecer la experiencia de desarrollo de la interfaz de usuario con herramientas, funciones e integraciones.
1. Instalación de add-ons
Para utilizar complementos en Storybook, debe instalarlos y configurarlos en su proyecto. Algunos ya están preinstalados con Storybook, a menudo los más populares.
Abra el terminal y navegue hasta el directorio de su proyecto. Utilice el siguiente comando para instalar un add-on específico.
Por ejemplo, para instalar el add-on de visualización de notas sobre la documentación, puede ejecutar:
npm install @storybook/addon-notes --save-dev
Una vez instalado el add-on, añádalo a la configuración de Storybook en el archivo .storybook/main.js:
module.exports = {
addons: [
'@storybook/addon-notes/register', // Añade aquí el
nombre del add-on
// Otros add-ons
],
};
El archivo main.js es el conductor de tu proyecto Storybook. Situado en la carpeta .storybook en la raíz de su proyecto, le permite controlar varios aspectos de su entorno.
2. Utilización de add-ons
Una vez los add-ons instalados y configurados los complementos, puede utilizarlos en sus stories...
Conclusión
Aunque no forma parte de React, Storybook ayuda a muchas empresas a desarrollar y mantener un design system. Por lo tanto, era importante mencionar esta herramienta.
Aquí tiene algunos puntos importantes que debes recordar si quiere ir más allá. La documentación y la comunidad de Storybook le ayudarán.
Storybook se presenta a menudo como una plataforma eficaz para diseñar, visualizar, probar y documentar elementos de la interfaz de usuario.
Las stories ilustran distintas variaciones y estados de un componente, lo que facilita las pruebas visuales y la documentación.
Por último, los add-ons completan la experiencia de desarrollo, introduciendo funciones adicionales, como la documentación enriquecida, pruebas de accesibilidad y mucho más. Los add-ons más importantes, que cubren la mayoría de las necesidades, están preinstalados.