Skip to content

Latest commit

 

History

History
76 lines (48 loc) · 3.13 KB

README.md

File metadata and controls

76 lines (48 loc) · 3.13 KB

Neu UI

github issues shield releases github licence github commit activity shield twitter repository example

Crie protótipos e construa projetos mais rápido usando Neu UI - a biblioteca de componentes neumorfos React

Conteúdos

  • ❓ Sobre
  • 🚀 Começando
  • 📝 Documentação
  • 👏 Contribuindo
  • ⚖️ Licença

Sobre

Neu UI começou como um pequeno projeto paralelo explorando o design e o desenvolvimento de componentes de UI usando design neumórfico.

O estilo foi originalmente conceituado por Alexander Plyuto no final de 2019 e o termo "neumorfismo", uma mistura entre esqueumorfismo e material design, foi cunhado por Michal Malewicz logo depois.

Para obter mais informações sobre o design, vale a pena dar uma olhada no guia do Alexander Plyuto aqui.

Os componentes iniciais agora foram convertidos e estendidos para incluir todo um conjunto de formulários controlados e componentes de cartão em uma biblioteca React. É utilizado React por debaixo dos panos, Storybook como uma ferramenta para visualizar os componentes e Styled Components para definir o estilo dos componentes.

Estamos procurando qualquer pessoa interessada em contribuir, para maiores informações verifique a seção de contribuições abaixo.

Começando

Instalação

Instalando usando npm.

npm i ui-neu

Instalando usando yarn.

yarn add ui-neu

Importando um componente.

import { Card } from 'ui-neu'

Documentação

Documentos estão disponíveis e incluem informações sobre propriedades, como começar a contribuir e um guia de contribuição.

Veja a documentaçao aqui

Contribuindo

Se você estiver interessado em contribuir, então qualquer ajuda de documentação, correções de bugs e até mesmo novas melhorias de recursos seja muito bem-vindo!

  • Pull requests e ⭐ estrelas são bem vindas!
  • Leia o guia começando a contribuir para descobrir maneiras pelas quais você pode começar a contribuir
  • Se você está procurando informações mais detalhadas sobre como contribuir, dê uma olhada em nosso guia de contribuição

Procurando por uma primeira issue?

  • Procure pela label good first issue
  • Ainda não está pronto para fazer uma contribuição de código? Dê uma olhada na nossa label documentation
  • Precisa de suporte ou ajuda? Venha até mim, Dan no Twitter

Licença

Esse projeto está sob a licença MIT.