gumdrops

Gumdrops

Este projeto contém componentes reutilizáveis de reação de JavaScript que você pode importar para o seu projeto.

Pré -requisitos

O Gumdrops deve ser usado com o sistema de design de gumgum (concreto), que lida com todos os estilos, bem como Sass.

Adicione Gumgum-Design e SASS ao seu projeto.

Consulte a documentação do sistema de design de concreto para temas, utilitários CSS e muito mais.

Documentação

Veja a documentação para esta biblioteca e seus componentes.

Instalação

Para adicionar uma versão específica, você pode usar yarn add [email protected] (substitua 1.0.0 por qualquer versão que desejar ou omite para obter a versão mais recente)

As versões atuais e anteriores podem ser encontradas no Changelog.md

Uso

A biblioteca exporta seus componentes como módulos ES, para que você possa importar apenas o que precisa, por exemplo:

 import Button from 'gumdrops/Button';
import Badge from 'gumdrops/Badge';
import Toggle from 'gumdrops/Toggle';

Siga os documentos para usar seu componente com os adereços corretos.

Para retrocompatibilidade, é fornecido um pacote CommonJS. Ele contém toda a biblioteca e pode ser usado com:

 const gumdrops = require('gumdrops');
// Or
import gumdrops from 'gumdrops';

Por conveniência e uso diretamente no navegador, também há um UMD fornecido em:

 node_modules/gumdrops/gumdrops.umd.js

Testando solução de problemas

Infelizmente, o ESM ainda não está amplamente disponível para algumas ferramentas atuais e os testes de execução usando componentes dessa biblioteca podem lançar erros devido à sintaxe do módulo ES. Para evitar isso, tente o seguinte:

• Para o jest : o jest usa sua própria implementação de requisitos e tentará analisar arquivos com ele e Babel-jest, por padrão, ignora o Node_modules, o que resultará em erros de sintaxe das instruções de importação. Adicione a próxima linha à sua configuração de idiotas para que ela ignore tudo em Node_modules, exceto esta biblioteca:

   "transformIgnorePatterns": ["/node_modules/(?!gumdrops)"]
  

• Para mocha + webpack : é muito provável que suas configurações de mocha e webpack também ignorem o diretório Node_modules, para evitar erros de sintaxe, carregue Babel através de um arquivo de configuração em vez de chamar --compilers js:babel-register ou --require babel-register diretamente.

O conteúdo do arquivo pode ser tão simples quanto:

 // testSetup.js
require('babel-register')({
    ignore: /node_modules/(?!gumdrops)/
});

// Import it into mocha or mocha-webpack:
--require ./testSetup.js

Pré -requisitos para executar o projeto localmente

• Fluxo git e git
• Nodejs/npm & Yarn: versões mínimas necessárias - testamos com as seguintes versões - node: ^16.16.0, npm: ^5.5.1, yarn ^1.2.1
• Instale os validadores ESLint e mais bonito no seu editor de escolha. Temos os arquivos de configuração na raiz do projeto, .eslinrc e .prettierrc . Existe um gancho pré -comércio para executar os scripts mais bonitos nos arquivos.

Running Storybook localmente

 yarn # install dependencies
yarn run storybook

Em seguida, abra http://localhost:6006 no seu navegador. Para mais informações, visite react storybook repo.

Contribuindo

Consulte Contribuindo.md para obter informações sobre como contribuir para este projeto.

Colaboradores

Um agradecimento especial a todos os nossos colaboradores! Além do seguinte que contribuiu antes de nos mudarmos para o Github: David Mejorado, Jose Santos, Mike Watt

Licença

Apache 2.0

NOTA IMPORTANTE: Este projeto não redistribui bibliotecas de terceiros, mas identifica sua disponibilidade. As bibliotecas chamadas por este projeto estão sujeitas às suas licenças de criador. Lembre -se de consultar e cumprir todas as licenças em seus usos.