hsds react

HSD: reaccionar

React Components for Help Scout's Design System

Demostración en vivo

Consulte el libro de cuentos de HSDS: https://hsds.helpscout.com/.

Instalar

 npm install @helpscout/hsds-react --save

Empezando

Después de clonar este repositorio, corre:

 npm install

Una vez que todo esté instalado, ejecute:

 npm start

Echa un vistazo al libro de cuentos de HSDS en http: // localhost: 8900/en tu navegador!

Adaptador SVG

A partir de V2.18.0, el conjunto svg es optada. Esto se hizo para reducir el tamaño del paquete compilado. Para cargar los iconos svg , agregue el adaptador apropiado a su aplicación.

Se recomienda cargar el adaptador en algún lugar dentro de su punto de entrada principal (por ejemplo, src/index.js ).

 // src/index.js
// For a lighter-weight svg set for embeddables
import '@helpscout/hsds-react/adapters/embed'
// For the complete svg set
import '@helpscout/hsds-react/adapters/app'

Nota: Esto carga todas las imágenes svg , incluidos Icon e Illo .

Pruebas

Para ejecutar broma en modo de reloj, ejecute:

 npm run dev

Para ejecutar todas las pruebas (con informes de cobertura), ejecute:

 npm run test

Publicación

Fusionando un PR

Para fusionar un PR cuando se complete el lanzamiento, haga una calabaza y fusione desde la página de relaciones públicas. Mantendrá el historial limpio en la rama principal

Tendemos a hacer un lanzamiento con solo un PR en ese momento, si es posible

Liberando en NPM

Puede obtener más información sobre cómo lanzar Main o lanzar una construcción beta

Para publicar y lanzar una nueva versión de HSDS, ejecute el siguiente comando:

 npm run release

Se le presentará un mensaje CLI con opciones. ¡Elige el que quieras, y eso es todo! El script se encargará del resto (desde las pruebas hasta la publicación).

Desplegar el libro de cuentos

Para implementar el libro de cuentos, ejecute el siguiente comando:

 npm run deploy

Aprendiendo

• Documentación de HSDS: https://hsds.helpscout.com/
• Desarrollador Documentación en profundidad: Dev Docs
• Además, consulte nuestros videos para obtener más recursos de aprendizaje.

¿Azul?

El 8 de noviembre de 2018, renombramos azul a HSDS: ¿React?

La Biblioteca Azul original aún existirá en NPM, y todavía es instalable a través de:

 npm install @helpscout/blue --save

Sin embargo, el desarrollo continuo de esta biblioteca de componentes continuará bajo HSDS: React, que se puede instalar a través de:

 npm install @helpscout/hsds-react --save

¡Muchas gracias a todas las personas involucradas en Blue! El azul siempre será tu chico? .