kubit react components

---

Começando

Instalação

Para instalar o pacote, execute o seguinte comando:

npm

npm install @kubit-ui-web/react-components

fio

yarn add @kubit-ui-web/react-components

Isso instalará o pacote e suas dependências. Agora você pode importar os componentes e usá -los em seu aplicativo.

Uso

Para usar os componentes, importe -os do pacote e use -os em seu aplicativo.

 import { Button , KubitProvider } from '@kubit-ui-web/react-components' ;
import React from 'react' ;

const App = ( ) => {
  return (
    < KubitProvider >
      < Button variant = "PRIMARY" size = "MEDIUM" >
        Click me
      </ Button >
    </ KubitProvider >
  ) ;
} ;

export default App ;

Isso renderizará o botão com os estilos e funcionalidade padrão.

Nota: O KubitProvider é necessário para usar os componentes. Ele fornece o tema e outro contexto para os componentes.

Você pode superar mais informações sobre a mudança do tema e outras opções no tema personalizado

Documentação

Você pode encontrar a documentação para os componentes da web no site da UI da Kubit

Livro de histórias

Para executar o livro de histórias, clone o repositório e instale as dependências. Em seguida, execute o seguinte comando:

npm run storybook

yarn storybook

Isso iniciará o servidor do livro de histórias e você poderá ver os componentes em ação.

Testes

Para executar os testes, você pode usar o seguinte comando:

npm run test

yarn test

Isso executará os testes e mostrará os resultados no terminal.

Contribuindo

Estamos abertos a contribuições. Se você deseja contribuir com o projeto, siga as etapas abaixo:

1. Gire o repositório : clique no botão "Garfo" no canto superior direito da página do repositório no Github. Isso criará uma cópia do repositório em sua conta.

2. Clone o repositório : use git clone para clonar o repositório da sua máquina local.

   git clone

3. Crie uma filial : use git checkout para criar uma nova ramificação para suas alterações.

   git checkout -b < branch-name >

4. Faça alterações : faça as alterações necessárias na base de código. E teste as alterações.

5. Compromete as alterações : use git commit para comprometer suas alterações na filial.

   git commit -m " Your commit message "

6. Alterações de empurrar : use git push para empurrar suas alterações no repositório bifurcado.

   git push origin < branch-name >

7. Abra uma solicitação de tração : vá para o repositório original no Github e clique no botão "Novo solicitação de puxar". Preencha o formulário com detalhes sobre suas alterações e envie a solicitação de tração.

Depois que sua solicitação de tração for enviada, um mantenedor revisará suas alterações e fornecerá feedback. Se tudo parecer bom, sua solicitação de tração será mesclada e suas alterações se tornarão parte do projeto.

Para obter mais informações sobre como contribuir com nossos projetos, consulte o arquivo CONTRIBUTING.md .