A biblioteca oficial do núcleo FormKit. Este pacote é responsável pela maior parte da funcionalidade interna do FormKit. Você pode ler a documentação especificamente sobre como ele funciona em formkit.com.
Você pode adicionar este pacote usando npm install @formkit/core ou yarn add @formkit/core.
O objeto Node do FormKit produzido pelo createNode(). Cada entrada <FormKit /> tem 1 FormKitNode ("nó central") associado a ela. Todas as entradas, formulários e grupos são instâncias de nós. Leia mais sobre nós centrais na documentação de arquitetura.
Adicione um filho a um nó. O nó deve ser um grupo ou lista.
add: (node: FormKitNode, index?: number) => FormKitNode
O FormKitNode adicionado.
O endereço do nó atual a partir da raiz da árvore.
address: FormKitAddress
Um FormKitAddress.
Adiciona props ao nó dado, removendo-os de node.props.attrs e movendo-os para o objeto node.props de nível superior.
addProps: (props: string[]) => FormKitNode
props — Uma matriz de strings para serem adicionadas como chaves para props.O FormKitNode.
Obtém um nó em outro endereço. Os endereços são caminhos de sintaxe de ponto (ou matrizes) de nomes de nós. Por exemplo: form.users.0.first_name. Existem também alguns tokens de travessia "especiais":
$root — Seleciona o nó raiz.$parent — Seleciona o nó pai.$self — Seleciona o nó atual.at: (address: FormKitAddress | string) => FormKitNode | undefined
address — Uma string válida ou FormKitAddress.O FormKitNode encontrado ou undefined.
Uma matriz de nós filhos (grupos e listas).
children: Array<FormKitNode>
Uma matriz de FormKitNode.
Limpa os erros do nó, e opcionalmente todos os filhos.
clearErrors: (clearChildren?: boolean, sourceKey?: string) => FormKitNode
clearChildren opcional — Se deve limpar os filhos.sourceKey opcional — Uma chave de origem para usar para resetar.O FormKitNode.
Um objeto de FormKitConfig que é compartilhado em toda a árvore com várias opções de configuração que devem ser aplicadas a toda a árvore.
config: FormKitConfig
Um FormKitConfig.
Define o tipo de biblioteca de entrada atual, incluindo tipo de nó, esquema e props.
define: (definition: FormKitTypeDefinition) => void
definition — Uma FormKitTypeDefinition.Remove o nó do registro global, de seu pai, e emite o evento 'destroying'.
destroy: () => void
Executa o callback fornecido em cada um dos filhos do nó dado.
each: (callback: FormKitChildCallback) => void
callback — Um FormKitChildCallback a ser chamado para cada filho.Emite um evento do nó para que possa ser ouvido por on.
emit: (event: string, payload?: any, bubble?: boolean, meta: Record<string, unknown>) => FormKitNode
event — O nome do evento a ser emitido.payload opcional — Um valor a ser passado junto com o evento.bubble opcional — Se o evento deve subir para o pai.O FormKitNode.
Estende um FormKitNode adicionando propriedades arbitrárias que são acessíveis via node.{property}().
extend: (property: string, trap: FormKitTrap) => FormKitNode
property — A propriedade para adicionar ao nó principal (node.{property}).trap — Um objeto com uma propriedade get e set.O FormKitNode.
Dentro de uma determinada árvore, encontra um nó que corresponda a um determinado seletor. Os seletores podem ser strings simples ou uma função.
find: (
selector: string,
searcher?: keyof FormKitNode | FormKitSearchFunction
) => FormKitNode | undefined