Sobre o projeto

Existem muitas bibliotecas de componentes excelentes disponíveis no GitHub; no entanto, não encontrei uma que realmente atendesse às minhas necessidades, então criei esta aprimorada. Acho que é isso.

Aqui está o porquê:

• Facilidade no uso de máscaras em inputs de texto;
• Fácil customização, pois o componente é entregue o mais nativo possível;
• Leve e performático;

Obviamente, essa solução não atenderá a todos os projetos, pois suas necessidades podem ser diferentes. Então estarei adicionando mais funcionalidades no futuro próximo. Você também pode sugerir alterações bifurcando este repositório e criando uma pull request ou abrindo uma issue.

Construído com

Esse projeto foi desenvolvido utilizando as versões mais recentes das seguintes bibliotecas:

Começando

Para colocar uma cópia local em funcionamento, siga estas etapas simples.

Pre-requisitos

Por ser um projeto desenvolvido utilizando tecnologias do ecossistema react, assumi-se que você tenha uma aplicação web desenvolvida com base no mesmo.

Instalação

Por ser tratar de uma biblioteca de componente, sua instalação e utilização se da de forma bem simples.

1. Instalando

   npm install @ubli/ui

Uso

Por ser tratar de um componente de input o mais puro possível, seu uso se da de forma simples e direta, podendo ser customizado a depender do seu caso de uso.

   import { TextInput } from '@ubli/ui';

   function Component() {
    return (
      <TextInput maskType="phone" />
    )
   }

Para mais exemplos, por favor consulte a documentação Documentação

Roteiro

• [x] Desenvolvimento do componente TextInput;
• [x] Suporte a máscaras;
• [x] Funções auxiliadoras;
• [x] Criação do storybook para documentação de uso;
• [ ] Suporte a Server Component;
• [ ] Utilização de uma máscara customizada;

Contribuindo

As contribuições são o que torna a comunidade de código aberto um lugar incrível para aprender, inspirar e criar. Quaisquer contribuições que você fizer são muito apreciadas.

Se você tiver uma sugestão de melhora, bifurque o repositório e crie uma pull request. Você também pode simplesmente abrir uma issue com a tag "feature". Não se esqueça de dar uma estrela ao projeto! Obrigado novamente!

1. Bifurque o projeto
2. Crie uma branch para o seu recurso (git checkout -b feature/AmazingFeature)
3. Commit suas modificações (git commit -m 'Add some AmazingFeature')
4. Envie sua branch (git push origin feature/AmazingFeature)
5. Abra um Pull Request

Licença

Distribuído sob a licença MIT

Contato

Pedro H. - [email protected]

Project Link: https://github.com/pedrolgcs/ubli