hsds react

HSDS: React

Reaja componentes para o sistema de design da Help Scout

Demoção ao vivo

Confira o livro de histórias do HSDS: https://hsds.helpscout.com/.

Instalar

 npm install @helpscout/hsds-react --save

Começando

Depois de clonar este repo, corra:

 npm install

Quando tudo estiver instalado, execute:

 npm start

Confira o livro de histórias do HSDS em http: // localhost: 8900/no seu navegador!

Adaptador SVG

A partir da v2.18.0, o conjunto svg é optado. Isso foi feito para reduzir o tamanho do pacote compilado. Para carregar os ícones svg , adicione o adaptador apropriado ao seu aplicativo.

Recomenda -se que o adaptador seja carregado em algum lugar dentro do seu ponto de entrada principal (por exemplo, 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: Isso carrega todas as imagens svg , incluindo Icon e Illo .

Teste

Para executar a brincadeira no modo de relógio, execute:

 npm run dev

Para executar todos os testes (com relatórios de cobertura), execute:

 npm run test

Publicação

Mesclando um pr

Para mesclar um PR quando a liberação for concluída, faça uma abóbora e se fundir na página de PR. Isso manterá a história limpa no ramo principal

Tendemos a fazer um lançamento com apenas um PR na época, se possível

Lançamento no NPM

Você pode aprender mais sobre como liberar main ou liberar uma versão beta

Para publicar e lançar uma nova versão do HSDS, execute o seguinte comando:

 npm run release

Você receberá um prompt da CLI com opções. Escolha o que você deseja, e é isso! O script cuidará do resto (desde testes até publicação).

Implantando livro de histórias

Para implantar o livro de histórias, execute o seguinte comando:

 npm run deploy

Aprendizado

• Documentação do HSDS: https://hsds.helpscout.com/
• Documentação detalhada do desenvolvedor: Dev Docs
• Além disso, confira nossos vídeos para obter mais recursos de aprendizado

Azul?

Em 8 de novembro de 2018, renomeamos o Blue to HSDS: React?.

A biblioteca azul original ainda existirá no NPM e ainda é instalável via:

 npm install @helpscout/blue --save

No entanto, o desenvolvimento contínuo desta biblioteca de componentes continuará no HSDS: React, que é instalável via:

 npm install @helpscout/hsds-react --save

Um grande obrigado a todas as pessoas envolvidas em azul! Blue sempre será seu filho? .