hsds react

HSDS: réagir

React Composants pour le système de conception de Help Scout

Démo en direct

Consultez le livre de contes de HSDS: https://hsds.helpscout.com/.

Installer

 npm install @helpscout/hsds-react --save

Commencer

Après avoir cloné ce repo, courez:

 npm install

Une fois que tout est installé, exécutez:

 npm start

Consultez le livre de contes de HSDS sur http: // localhost: 8900 / dans votre navigateur!

Adaptateur SVG

Depuis la v2.18.0, l'ensemble svg est opt-in. Cela a été fait pour réduire la taille du faisceau compilé. Pour charger les icônes svg , ajoutez l'adaptateur approprié à votre application.

Il est recommandé que l'adaptateur soit chargé quelque part dans votre point d'entrée principal (par exemple, 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'

Remarque: Cela charge toutes les images svg , y compris Icon et Illo .

Essai

Pour exécuter la plaisanterie en mode montre, exécutez:

 npm run dev

Pour exécuter tous les tests (avec rapport de couverture), exécutez:

 npm run test

Édition

Fusion d'un PR

Pour fusionner un PR lorsque le communiqué est terminé, veuillez faire une courge et fusionner à partir de la page PR. Il gardera l'histoire propre dans la branche principale

Nous avons tendance à faire une libération avec un seul PR à l'époque, si possible

Libérer sur NPM

Vous pouvez en savoir plus sur la libération du principal ou la libération d'une construction bêta

Pour publier et publier une nouvelle version de HSDS, exécutez la commande suivante:

 npm run release

Vous serez présenté avec une invite CLI avec des options. Choisissez celui que vous voulez, et c'est tout! Le script s'occupera du reste (des tests à l'édition).

Déploiement du livre de contes

Pour déployer le livre de contes, exécutez la commande suivante:

 npm run deploy

Apprentissage

• Documentation HSDS: https://hsds.helpscout.com/
• Documentation approfondie du développeur: Doc de développement
• Consultez également nos vidéos pour plus de ressources d'apprentissage

Bleu?

Le 8 novembre 2018, nous avons renommé le bleu à HSDS: React ?.

La bibliothèque bleue d'origine existera toujours sur NPM et est toujours installable via:

 npm install @helpscout/blue --save

Cependant, le développement continu de cette bibliothèque de composants se poursuivra sous HSDS: React, qui est installable via:

 npm install @helpscout/hsds-react --save

Un grand merci à tous les gens impliqués dans le bleu! Le bleu sera toujours votre garçon? .