@pipelinesolucoes/form
v1.3.3
Published
Biblioteca de **componentes de formulario para React**, desenvolvida para **padronização visual**, **reutilização** e **escalabilidade** em aplicações modernas e design systems.
Readme
@pipelinesolucoes/form
Biblioteca de componentes de formulario para React, desenvolvida para padronização visual, reutilização e escalabilidade em aplicações modernas e design systems.
Este pacote faz parte do ecossistema de componentes da Pipeline Soluções.
📦 Componentes disponíveis
A biblioteca inclui os seguintes componentes:
GoogleButton
Componente de botão que redireciona o usuário para um endpoint externo (ex: autenticação com Google). Durante o clique, o botão entra em estado de loading e, caso ocorra algum erro, exibe uma mensagem abaixo do botão.FormMessage Componente de formulário para envio de mensagem. Faz a validação do e-mail, telefone e exibe a mensagem retornada.
TextFieldPassword Componente de campo de senha baseado no TextField do Material UI, com botão para alternar entre mostrar/ocultar a senha. O componente:
- Retorna somente a senha digitada via
onPasswordChange - Valida obrigatório + formato (regex) e exibe mensagens de erro automaticamente
- Dispara um "evento" de validação via
onValidationChange
- Retorna somente a senha digitada via
TextFieldValidate
Componente de campo de texto com validação, baseado no TextField do Material UI. Permite personalização visual viastylede suporte a validações comuns (obrigatório, tamanho mínimo, regex) e validação customizada.TextFieldNumberValidate
Campo de texto numérico com suporte a validações comuns e customizadas, construído sobre o TextField do Material UI e estilizado via Design System da Pipeline.TextFieldBirthDateWithAge
Campo de data de nascimento com entrada somente numérica, máscaradd/mm/yyyy, validações comuns (required, min/maxLength, pattern) + validação customizada, e cálculo automático de idade exibido na label.TextFieldCPFValidate
Campo de CPF com entrada somente numérica, máscara000.000.000-00, validações comuns (required, min/maxLength, pattern) + validação customizada.NotificationSnackbar Componente que exibe uma notificação no topo da tela utilizando o Snackbar e Alert do Material UI.
✨ Características
- ✅ Pronto para produção
- 🎨 Integração com Material UI
- ♿ Foco em acessibilidade
- 🧩 Ideal para design systems
- 🔄 Reutilizável em múltiplos projetos
- 📦 Publicado no npm com versionamento semântico
- 🔐 Preparado para licenciamento por projeto
📥 Instalação
npm install @pipelinesolucoes/form
ou
yarn add @pipelinesolucoes/form
🧩 Uso em Design Systems
Este pacote foi projetado para:
- padronização de ações e navegação
- reutilização entre projetos
- evolução incremental de UI
- integração com temas e tokens de design
Pode ser utilizado de forma isolada ou como parte de um design system maior.
🔐 Licença de uso comercial
Este pacote é publicamente acessível no npm, porém:
O uso comercial é licenciado por projeto.
O que isso significa?
O pacote pode ser instalado e avaliado livremente.
Para uso em projetos comerciais, é necessária a aquisição de uma licença válida por projeto.
Definição de projeto
Projeto = 1 aplicação em produção (ex.: site institucional, sistema interno ou aplicação SaaS). Ambientes de desenvolvimento, staging e homologação estão incluídos no mesmo projeto.
📄 O que a licença inclui
✔ Uso em 1 projeto ✔ Atualizações enquanto a licença estiver ativa ✔ Correções de bugs ✔ Suporte básico ✔ Evolução contínua do pacote
⚙️ Configuração de licença (mock)
Após adquirir a licença, você receberá um Project ID e uma License Key.
No projeto, configure as variáveis de ambiente:
PIPESOL_PROJECT_ID=meu-projeto PIPESOL_form_LICENSE_KEY=SUA-LICENSE-KEY-AQUI
Atualmente, a validação é local e não bloqueante, servindo como preparação para automação futura.
🔁 Versionamento
Este projeto segue Semantic Versioning (SemVer):
1.0.1 – Correção de bugs
1.1.0 – Nova funcionalidade compatível
2.0.0 – Mudança incompatível
1.0.0-beta.x – Versões beta
Para listar as versões publicadas:
npm view @pipelinesolucoes/form versions --json🚀 Processo de publicação
Este pacote é publicado exclusivamente via CI/CD utilizando GitHub Actions.
Características do processo:
- Publicação apenas por tags Git (vX.Y.Z)
- Autenticação via Trusted Publishing (OIDC)
- Nenhum token npm armazenado
- Tokens clássicos desabilitados
- Autenticação em dois fatores (2FA) obrigatória
- Publicações seguras, rastreáveis e reprodutíveis
📬 Aquisição de licença e contato
Para adquirir uma licença comercial ou obter mais informações:
📧 [email protected] 🌐 https://www.pipelinesolucoes.com.br
📄 Licença
Copyright © Pipeline Soluções Este software está sujeito a licença comercial por projeto. Consulte o arquivo LICENSE para mais informações.
Se você quiser, eu também posso gerar agora o **arquivo `LICENSE`** (texto curto e claro) no mesmo padrão profissional pra você copiar e colar como `LICENSE` no repo.