A entrada checkbox utiliza o checkbox input nativo do HTML. Ela pode exibir uma ou muitas opções para um usuário e é uma ótima maneira de permitir que os usuários selecionem vários itens de uma lista. O FormKit suporta tanto entradas de checkbox únicas quanto múltiplas.
Por padrão, o tipo checkbox renderizará um único checkbox e usa valores booleanos. Para que um único checkbox seja marcado — o valor atual da entrada deve corresponder ao on-value dessa entrada (por padrão, um único checkbox usa true como o on-value).
Para melhorar a consistência da API em todas as entradas do FormKit — o FormKit usa o value como o estado inicial da entrada. A propriedade/atributo checked não deve ser usado diretamente.
Para exibir múltiplos checkboxes com uma única entrada, use a propriedade options. As opções podem ser especificadas de 3 maneiras:
label e value (o mesmo que as entradas select e radio)O valor de uma entrada de checkbox com múltiplas options é um array dos valores selecionados.
A maneira mais simples de fornecer opções é um array de strings. As strings fornecidas serão usadas tanto para o rótulo quanto para o valor da opção.
Você também pode fornecer a propriedade options onde as chaves são valores e os valores de cada propriedade são rótulos.
A maneira mais flexível de definir opções é fornecendo um array de objetos. Os objetos devem incluir as propriedades value e label — mas também podem incluir uma propriedade help bem como um objeto attrs de atributos adicionais a serem aplicados a cada tag de entrada de checkbox.
| Prop | Type | Padrão | Descrição |
|---|---|---|---|
| decorator-icon | String | ’’ | Especifica um ícone para colocar na seção decoratorIcon. Aparece quando a caixa de seleção está marcada. O padrão é o ícone checkboxDecorator. |
| options | Array/Object | [] | Um objeto de pares valor/rótulo ou um array de strings, ou um array de objetos que devem conter uma propriedade de rótulo e valor. |
| on-value | any | true | O valor quando a caixa de seleção está marcada (apenas caixas de seleção únicas). |
| off-value | any | false | O valor quando a caixa de seleção está desmarcada (apenas caixas de seleção únicas). |
| Mostrar Universal props | |||
| config | Object | {} | Opções de configuração a serem fornecidas para o nó do input e qualquer nó descendente deste input. |
| delay | Number | 20 | Número de milissegundos para debounce do valor do input antes de despachar o commit hook. |
| dirtyBehavior | string | touched | Determina como o indicador "dirty" deste input é definido. Pode ser configurado como touched ou compare - touched (o padrão) é mais performático, mas não detectará quando o formulário corresponder novamente ao seu estado inicial. |
| errors | Array | [] | Array de strings para exibir como mensagens de erro neste campo. |
| help | String | '' | Texto para o texto de ajuda associado ao input. |
| id | String | input_{n} | O ID único do input. Fornecer um ID também permite acesso global ao nó do input. |
| ignore | Boolean | false | Impede que um input seja incluído em qualquer pai (grupo, lista, formulário etc). Útil ao usar inputs para a interface do usuário em vez de valores reais. |
| index | Number | undefined | Permite que um input seja inserido no índice fornecido, se o pai for uma lista. Se o valor do input for indefinido, ele herda o valor dessa posição de índice. Se ele tiver um valor, ele o insere nos valores da lista no índice fornecido. |
| label | String | '' | Texto para o elemento label associado ao input. |
| name | String | input_{n} | O nome do input como identificado no objeto de dados. Isso deve ser único dentro de um grupo de campos. |
| parent | FormKitNode | contextual | Por padrão, o pai é um grupo, lista ou formulário de envolvimento, mas essa prop permite a atribuição explícita do nó pai. |
| prefix-icon | String | '' | Especifica um ícone para colocar na seção prefixIcon. |
| preserve | boolean | false | Preserva o valor do input em um grupo pai, lista ou formulário quando o input é desmontado. |
| preserve-errors | boolean | false | Por padrão, os erros definidos em inputs usando setErrors são automaticamente limpos no input. Definir essa prop como true mantém o erro até que ele seja explicitamente limpo. |
| sections-schema | Object | {} | Um objeto de chaves de seção e valores parciais de esquema, em que cada esquema parcial é aplicado à seção respectiva. |
| suffix-icon | String | '' | Especifica um ícone para colocar na seção suffixIcon. |
| type | String | text | O tipo de input a ser renderizado pela biblioteca. |
| validation | String, Array | [] | As regras de validação a serem aplicadas ao input. |
| validation-visibility | String | blur | Determina quando mostrar as regras de validação com falha de um input. Os valores válidos são blur, dirty e live. |
| validation-label | String | {label prop} | Determina qual rótulo usar nas mensagens de erro de validação, por padrão, usa a propriedade label, se disponível, caso contrário, usa a propriedade name. |
| validation-rules | Object | {} | Regras de validação personalizadas adicionais para disponibilizar na propriedade de validação. |
| value | Any | undefined | Inicializa o valor do input e/ou de seus filhos. Não é reativo. Pode inicializar grupos inteiros (formulários) e listas.. |
A entrada de caixa de seleção tem uma construção diferente dependendo se é uma caixa de seleção única ou múltipla.
Você pode direcionar uma seção específica de uma entrada usando a "key" dessa seção, permitindo que você modifique as classes, HTML (por meio de :sections-schema ou o conteúdo (por meio de slots) dessa seção). Saiba mais sobre as seções aqui.
| Section-key | Descrição |
|---|---|
| decorator | Responsável pelo elemento imediatamente após o elemento de entrada — geralmente usado para estilizar caixas de seleção personalizadas. |
| decoratorIcon | Um elemento contendo o ícone do decorador. |
| legend | Responsável pelo elemento de legenda do fieldset. |
| fieldset | Responsável pelo fieldset quando várias opções estão disponíveis. |
| option | Responsável pelo wrapper em torno de cada item nas opções. |
| options | Responsável pelo elemento wrapper em torno de todos os itens de opção. |
| Mostrar Universal section keys | |
| outer | O elemento de envolvimento mais externo. |
| wrapper | Um invólucro ao redor do rótulo e do input. |
| label | O rótulo do input. |
| prefix | Por padrão, não gera saída, mas permite conteúdo diretamente antes de um elemento input. |
| prefixIcon | Um elemento para gerar um ícone antes da seção de prefixo. |
| inner | Um invólucro ao redor do próprio elemento input. |
| suffix | Por padrão, não gera saída, mas permite conteúdo diretamente após um elemento input. |
| suffixIcon | Um elemento para gerar um ícone após a seção de sufixo. |
| input | O próprio elemento input. |
| help | O elemento que contém o texto de ajuda. |
| messages | Um invólucro ao redor de todas as mensagens. |
| message | O elemento (ou muitos elementos) que contém uma mensagem - na maioria das vezes mensagens de validação e erros. |
Todos os campos de entrada do FormKit são projetados levando em consideração as seguintes considerações de acessibilidade. Ajude-nos a melhorar continuamente a acessibilidade para todos, relatando problemas de acessibilidade aqui:
| Chave de Seção | Atributo | Padrão | Descrição |
|---|---|---|---|
| decorator | aria-hidden | true | Oculta o decorador dos leitores de tela. |
| Mostrar Universal chave de seção | |||
| label | label | for | Associa isso a um elemento de entrada, aprimorando acessibilidade e experiência do usuário |
| input | input | disabled | Desabilita um elemento HTML, impedindo a interação do usuário e sinalizando um estado não interativo |
| aria-describedby | Aprimora a acessibilidade associando um elemento a uma descrição, auxiliando leitores de tela | ||
| aria-required | Adiciona o estado necessário quando a validação é exigida. | ||
| icon | icon | for | Sempre que um ícone é definido como rótulo, ele o vincula a um elemento de entrada, aprimorando acessibilidade e experiência do usuário |
| Chave de Seção | Atributo | Padrão | Descrição |
|---|---|---|---|
| fieldset | aria-describedby | Associa um elemento com uma descrição, auxiliando os leitores de tela. | |
| decorator | aria-hidden | true | Oculta o decorador dos leitores de tela. |
| Mostrar Universal chave de seção | |||
| label | label | for | Associa isso a um elemento de entrada, aprimorando acessibilidade e experiência do usuário |
| input | input | disabled | Desabilita um elemento HTML, impedindo a interação do usuário e sinalizando um estado não interativo |
| aria-describedby | Aprimora a acessibilidade associando um elemento a uma descrição, auxiliando leitores de tela | ||
| aria-required | Adiciona o estado necessário quando a validação é exigida. | ||
| icon | icon | for | Sempre que um ícone é definido como rótulo, ele o vincula a um elemento de entrada, aprimorando acessibilidade e experiência do usuário |
| Evento de Teclado | Descrição |
|---|---|
| Space | Permite alternar a caixa de seleção sempre que o campo de entrada estiver em foco. |
| Mostrar Universal evento de teclado | |
| Tab | Move o foco para a próxima entrada focalizável na página. |
| Shift + Tab | Move o foco para a entrada focalizável anterior na página. |