📎 Orquestra Utils

Biblioteca utilitária de javascript para interagir com o Orquestra BPMS

Instalação

Utilizando package managers

npm install orquestra-utils

# ou com yarn

yarn add orquestra-utils

Utilizando CDN

<script src="https://cdn.jsdelivr.net/gh/pedbernardo/[email protected]/dist/orquestra-utils.js"></script>

<!-- ou minificado -->

<script src="https://cdn.jsdelivr.net/gh/pedbernardo/[email protected]/dist/orquestra-utils.min.js"></script>

Como Utilizar

// importe todas as funções com namespace
import Utils from 'orquestra-utils'

// importe as funções separadamente
import { getMonthName } from 'orquestra-utils'

Configuração

Configuração Padrão

const defaults = {
  container: 'tr',
  hideClass: 'hidden',
  requiredClass: 'execute-required',
  dataAttrRequired: 'data-was-required'
}

Construtor

Como modificar os parâmetros padrão?

Ao importar a biblioteca (seja através da CDN ou NPM) ela irá dispor das funções utilitárias com a configuração padrão acima. Embora os métodos permitam que a configuração seja redefinida nos parâmetros, você pode utilizar o construtor para criar uma nova instância com os parâmetros desejados.

setup

Cria uma nova instância de Utils com os parâmetros padrão que desejar

Utils.setup( Object )

Exemplo de uso

const UtilsForm = Utils.setup({
  container: '.form-group',
  hideClass: 'is-hidden',
  requiredClass: 'is-required',
})

UtilsForm.hideField(document.querySelector('[xname=inpfieldId]'))

Importante perceber que ao utilizar o construtor os métodos não irão suportar o objeto de configuração dos parâmetros, utilizando sempre a configuração do setup.

Métodos

showField

Oculta um campo de formulário, limpa o seu valor e remove sua obrigatoriedade (caso possua)

Utils.showField( string | HTMLElement | Node, Object [optional] )

Exemplo de uso

Utils.showField('fieldId')
Utils.showField(document.querySelector('[xname=inpfieldId]'), { container: '.group' })

hideField

Exibe um campo de formulário e recoloca sua obrigatoriedade (caso possua)

Utils.showField( string | HTMLElement | Node, Object [optional] )

Exemplo de uso

Utils.hideField('fieldId')
Utils.hideField(document.querySelector('[xname=inpfieldId]'), { container: '.group' })

addRequired

Adiciona obrigatoriedade a um campo de formulário

Utils.showField( string | HTMLElement | Node)

Exemplo de uso

Utils.addRequired('fieldId')
Utils.addRequired(document.querySelector('[xname=inpfieldId]'))

removeRequired

Remove obrigatoriedade de um campo de formulário

Utils.showField( string | HTMLElement | Node)

Exemplo de uso

Utils.removeRequired('fieldId')
Utils.removeRequired(document.querySelector('[xname=inpfieldId]'))

clearField

Limpa os valores de um campo de formulário

Utils.showField( string | HTMLElement | Node)

Exemplo de uso

Utils.clearField('fieldId')
Utils.clearField(document.querySelector('[xname=inpfieldId]'))

onFileChange

Trigger disparado quando um campo do tipo Arquivo é modificado

Utils.onFileChange( string | HTMLElement | Node, function [callback] )

Callbacks

Adição de Arquivo Callback( string [filepath], HTMLElement [delete button] ) Remoção de Arquivo Callback( null )

Exemplo de uso

Utils.onFileChange('fieldId', (filepath, deleteBtn) => {
  console.log({ filepath, deleteBtn })
})