zeev-form

Zeev Form

Biblioteca não-oficial para construção de formulários no Zeev com uso de simples objetos de configuração.

Adicione eventos, execute funções de callback, vincule condições e task aliases, oculte e exiba outras campos e muito mais. Tudo isso com um simples schema!

Instalação | Como Utilizar | Configuração | Funções | Roadmap

Instalação

Usar via NPM

npm install zeev-form

# ou com yarn

yarn add zeev-form

Usar via CDN

Apenas adicione a script tag ao cabeçalho do processo e consuma as funções através do namespace ZeevForm.

<script src="https://cdn.jsdelivr.net/gh/pedbernardo/zeev-form@latest/dist/zeev-form.js"></script>

<!-- ou minificado -->

<script src="https://cdn.jsdelivr.net/gh/pedbernardo/zeev-form@latest/dist/zeev-form.min.js"></script>

Como Utilizar

// importe todas as funções com namespace
import ZeevForm from 'zeev-form'

ZeevForm.useField({
  field: 'idDoCampo1',
  when: {
    'Sim': {
      show: ['idDoCampo2', 'idDoCampo3']
    }
  }
})

// importe as funções separadamente
import { useField, useFields } from 'zeev-form'

// utilize o `useFields` para configurar múltiplos
// campos de uma vez só
useFields([
  {
    field: 'idDoCampoA',
    triggers: ['change', 'keyup'],
    when: {
      'Não': {
        show: ['idDoCampoC', 'idDoCampoD'],
        container: 'tr'
      }
    }
  },
  {
    field: 'idDoCampoB',
    callback: value => console.log(`executo no trigger, valores do campo: ${value}`)
  }
])

Utilizando via script tag e CDN

// todas as funções estarão disponíveis através do namespace `ZeevForm`
// globalmente, você inclusive pode testar as funções diretamente
// no console do seu navegador

Utils.ZeevForm({
  field: 'idDoCampo',
  callback: value => console.log(`executo no trigger, valores do campo: ${value}`)
})

Configuração

em breve

Funções

em breve

Roadmap

Versão 1.0.0

• Atualizar definição de tipos de JSDocs e migrar para TypeScript
• Revisar funcionalidades para versão 1 e parâmetros de configuração de useField
• Adicionar 100% de cobertura de testes para funções públicas
• Construir documentação utilizando Vitepress (mockups finalizados)
• Automatizar build com uso de Github Actions