Componente de fragmento de formulário adaptável form-fragment-component-adaptive-forms-core-component

Os formulários adaptáveis oferecem uma maneira conveniente de criar segmentos de formulário, como painéis ou grupos de campos, para que possam ser reutilizados em diferentes formulários adaptáveis. Esses segmentos reutilizáveis e independentes são chamados de Fragmentos de formulários adaptáveis.

Você pode adicionar um fragmento várias vezes a um documento e usar as propriedades de vinculação de dados de seus componentes para vinculá-los a diferentes fontes de dados ou esquemas. Por exemplo, você pode usar o mesmo fragmento de endereço para os endereços permanente, para contato e de faturamento, e conectá-lo a diferentes campos de uma fonte de dados ou esquema.

exemplo

É possível usar a opção de repetição para duplicar o componente fragmento de formulário e seus subcomponentes, definir uma contagem de repetição mínima e máxima, e facilitar a replicação de seções semelhantes dentro de um formulário.

NOTE
Você pode criar um fragmento de formulário adaptável do zero ou salvar um painel em um formulário adaptável já existente como fragmento.

Uso usage

  • Capacidade de reutilização: a capacidade de reutilizar fragmentos de formulários em vários formulários adaptáveis é a principal vantagem de usar fragmentos de formulários. Ela ajuda a manter a consistência do design e da funcionalidade, já que as alterações feitas em um fragmento são refletidas em todas as instâncias em que ele é usado.

  • Experiência do usuário consistente: o uso de fragmentos de formulários para elementos comuns, como, por exemplo, cabeçalhos ou rodapés, garante uma experiência do usuário consistente e coesa.

  • Fácil manutenção: as alterações ou modificações feitas em um fragmento de formulário são refletidas em todas as instâncias em que ele é usado. Isso simplifica a manutenção e reduz as chances de erros.

  • Eficiência: designers e desenvolvedores economizam tempo ao criar e testar fragmentos de formulários apenas uma vez. Os fragmentos de formulários podem ser facilmente incorporados a vários formulários adaptáveis sem a necessidade de trabalho redundante.

Versão e compatibilidade version-and-compatibility

O componente principal fragmentos de formulários adaptáveis foi lançado como parte dos componentes principais 2.0.50 do Cloud Service e dos componentes principais 1.1.28 dos formulários do AEM 6.5.16.0 ou posterior. Esta é uma tabela que mostra todas as versões compatíveis, a compatibilidade do AEM e os links para a documentação correspondente:

Versão do componente
AEM as a Cloud Service
AEM 6.5.16.0 Forms ou posterior
v1
Compatível com a
versão 2.0.50 e posteriores
Compatível com a
versão 1.1.26 e posteriores, mas anteriores à 2.0.0.

Para obter informações sobre as versões dos Componentes principais, consulte o documento Versões dos Componentes principais.

Detalhes técnicos technical-details

Obtenha as informações mais recentes sobre o componente principal fragmentos de formulários adaptáveis na documentação técnica, encontrada no GitHub. Para obter mais informações sobre o desenvolvimento dos Componentes principais, consulte a documentação do desenvolvedor dos Componentes principais.

Caixa de diálogo de configuração configure-dialog

É possível personalizar facilmente a experiência com os fragmentos para visitantes com a caixa de diálogo “Configurar”. Você também pode definir as propriedades dos fragmentos com facilidade para uma experiência do usuário suave.

Guia Básico basic-tab

Guia Básico

  • Nome: é possível identificar um componente de formulário facilmente com seu nome exclusivo no formulário e no editor de regras, mas o nome não pode conter espaços ou caracteres especiais.

  • Título: o título permite identificar facilmente um componente em um formulário; por padrão, ele aparece na parte superior do componente. Se um título não for adicionado, o nome do componente será exibido em vez do texto do título.

  • Permitir rich text para título: esse recurso permite formatar títulos de texto simples, incorporando recursos como negrito, itálico, texto sublinhado, várias fontes, tamanhos de fonte, cores e uma opção adicional para aprimorar a apresentação visual e a personalização. Ele oferece maior flexibilidade e controle criativo para que os títulos se destaquem em documentos, sites ou aplicativos.
    Ao marcar a caixa de seleção Permitir rich text para título, as opções de formatação se tornam visíveis para estilizar o título do componente. Para acessar todas as opções de formatação disponíveis, clique no Ícone de tela cheia .

    Suporte a rich text

  • Ocultar título: selecione essa opção para ocultar o título do componente.

  • Agrupar dados de componentes secundários no envio do formulário (vincular dados no objeto): quando essa opção é selecionada, os dados dos componentes secundários são aninhados no objeto JSON do componente principal. No entanto, se a opção não estiver selecionada, os dados JSON enviados terão uma estrutura simples, sem qualquer objeto para o componente principal. Por exemplo:

    • Quando a opção é selecionada, os dados dos componentes secundários (por exemplo, Rua, Cidade e CEP) são aninhados no componente principal (Endereço) como um objeto JSON. Isso cria uma estrutura hierárquica e os dados são organizados no componente principal.

      Estrutura dos dados enviados:

      code language-json
      { "Address":
      
      { "Street": "123 Main Street", "City": "New York", "Zip Code": "12345" }
      
      }
      
    • Quando a opção não está selecionada, os dados JSON enviados têm uma estrutura simples sem qualquer objeto para o componente principal (Endereço). Todos os dados estão no mesmo nível, sem qualquer organização hierárquica.

      Estrutura dos dados enviados:

      code language-json
         { "Street": "123 Main Street", "City": "New York", "Zip Code": "12345" }
      
  • Referência de fragmento: uma referência de fragmento é uma referência a um fragmento de formulário armazenado em uma fonte de dados externa e usado em um formulário. A referência de fragmento permite vincular dinamicamente o fragmento de formulário a um formulário.

  • Referência de vínculo: uma referência de vínculo é uma referência a um elemento de dados armazenado em uma fonte de dados externa e usado em um formulário. A referência de vínculo permite vincular dinamicamente os dados a campos de formulário, de modo que o formulário possa exibir os dados mais atualizados da fonte de dados. Por exemplo, uma referência de vínculo pode ser usada para exibir o nome e o endereço de um cliente em um formulário, com base na ID do cliente inserida no formulário. A referência de vínculo também pode ser usada para atualizar a fonte de dados com os dados inseridos no formulário. Dessa forma, o AEM Forms permite criar formulários que interagem com fontes de dados externas, fornecendo uma experiência do usuário perfeita para coletar e gerenciar dados.

  • Ocultar componente: selecione essa opção para ocultar o componente do formulário. O componente permanece acessível para outros fins, como usá-lo para cálculos no Editor de regras. Isso é útil quando você precisa armazenar informações que não precisam ser vistas ou alteradas diretamente pelo usuário.

  • Desativar Componente: selecione essa opção para desativar o componente. O componente desativado não está ativo nem editável pelo usuário final. O usuário pode ver o valor do campo, mas não pode modificá-lo. O componente permanece acessível para outros fins, como usá-lo para cálculos no Editor de regras.

  • Somente leitura: selecione essa opção para tornar o componente não editável. O usuário pode ver o valor do campo, mas não pode modificá-lo. O componente permanece acessível para outros fins, como usá-lo para cálculos no Editor de regras.

Guia Repetição de fragmentos repeat-tab

Guia Repetição de fragmentos

  • Permitir a repetição dos fragmentos: um recurso que permite habilitar ou desabilitar a funcionalidade de repetição.
  • Repetições mínimas: estabelece o número mínimo de vezes que o componente fragmento pode ser repetido. Um valor igual a zero e indica que o componente fragmento não é repetido; o valor padrão é zero.
  • Repetições máximas: define o número máximo de vezes que o componente fragmento pode ser repetido. Por padrão, esse valor é ilimitado.

Guia Conteúdo de ajuda help-content

Guia Conteúdo de ajuda

  • Descrição curta: uma descrição curta é uma breve explicação em texto que fornece informações adicionais ou esclarecimentos sobre a finalidade de um campo de formulário específico. Ela ajuda o usuário a entender qual tipo de dados deve ser inserido no campo e pode fornecer diretrizes ou exemplos para ajudar a garantir que as informações inseridas sejam válidas e atendam aos critérios desejados. Por padrão, as descrições curtas permanecem ocultas. Ative a opção Sempre mostrar descrição curta para exibi-la abaixo do componente.

  • Sempre mostrar descrição curta: ative essa opção para exibir a descrição curta abaixo do componente.

  • Texto de ajuda: o texto de ajuda refere-se às informações adicionais ou orientações fornecidas ao usuário para auxiliá-lo no preenchimento correto de um campo de formulário. Ele é exibido quando o usuário clica no ícone de ajuda (i) colocado ao lado do componente. O texto de ajuda fornece informações mais detalhadas do que o rótulo do campo de formulário ou o texto do espaço reservado e foi desenvolvido para ajudar o usuário a entender os requisitos ou restrições do campo. Ele também pode oferecer sugestões ou exemplos para tornar o preenchimento do formulário mais fácil e preciso.

Acessibilidade accessibility

Guia Acessibilidade

  • Texto para leitores de tela: o texto para leitores de tela refere-se ao texto adicional que é especificamente destinado a ser lido por tecnologias de acessibilidade, como leitores de tela, usadas por indivíduos com deficiências visuais. Esse texto fornece uma descrição de áudio da finalidade do campo de formulário e pode incluir informações sobre o título do campo, a descrição, o nome e quaisquer mensagens relevantes (texto personalizado). O texto do leitor de tela ajuda a garantir que o formulário seja acessível a todos os usuários, incluindo aqueles com deficiências visuais, e fornece a eles uma compreensão completa do campo de formulário e de seus requisitos.

    • Texto personalizado: selecione essa opção para usar o texto personalizado para rótulos de acessibilidade ARIA. Selecionar essa opção exibe a caixa de diálogo Texto personalizado. Você pode adicionar informações relevantes na caixa de diálogo Texto personalizado.
    • Descrição: selecione essa opção para usar a descrição para rótulos de acessibilidade ARIA.
    • Título: selecione essa opção para usar o título para rótulos de acessibilidade ARIA.
    • Nome: selecione essa opção para usar o nome para rótulos de acessibilidade ARIA.
    • Nenhum: selecione essa opção se não quiser adicionar nada aos rótulos de acessibilidade ARIA.
  • Função de HTML para anúncio do leitor de tela: a função HTML é um atributo usado para especificar a finalidade de um elemento HTML para tecnologias assistivas, como leitores de tela. O atributo de função é usado para fornecer contexto e significado semântico adicionais a um elemento, facilitando a interpretação e o anúncio do conteúdo pelos leitores de tela. Por exemplo, no AEM Forms, o rótulo de um campo de formulário pode ter a função de “rótulo” e seu campo de entrada pode ter a função de “caixa de texto”. Isso ajuda o leitor de tela a entender a relação entre o rótulo e o campo de entrada e anunciá-los corretamente ao usuário.

Caixa de diálogo Design design-dialog

A caixa de diálogo de design é usada para definir e gerenciar os estilos do CSS do componente fragmento de formulário.

Guia Estilos styles-tab

O componente principal fragmentos de formulários adaptáveis é compatível com o sistema de estilos do AEM.

Caixa de diálogo de design

  • Classes padrão do CSS: é possível fornecer uma classe padrão do CSS ao componente principal fragmentos de formulários adaptáveis.

  • Estilos permitidos: você pode definir estilos fornecendo um nome e a classe CSS que o representa. Por exemplo, você pode criar um estilo chamado “texto em negrito” e fornecer a classe CSS “font-weight: bold”. Você pode usar ou aplicar esses estilos a um formulário adaptável no editor de formulários adaptáveis. Para aplicar um estilo, no editor de formulários adaptáveis, selecione o componente ao qual deseja aplicar o estilo, navegue até a caixa de diálogo de propriedades e selecione o estilo desejado na lista suspensa Estilos. Se precisar atualizar ou modificar os estilos, simplesmente retorne à caixa de diálogo Design, atualize os estilos na guia estilos e salve as alterações.

Propriedades personalizadas

Caixa de diálogo Propriedades personalizadas

As propriedades personalizadas permitem associar atributos personalizados (pares de chave e valor) a um componente principal para formulários adaptáveis, usando o modelo de formulário. As propriedades personalizadas são refletidas na seção de propriedades da representação headless do componente. Isso permite criar um comportamento de formulário dinâmico que se adapta de acordo com os valores de atributos personalizados. Por exemplo, desenvolvedores(as) podem criar várias representações de um componente de formulário headless para plataformas móveis, de desktop ou da web, melhorando significativamente a experiência de usuário em uma grande variedade de dispositivos.

  • Nome do grupo: você pode fornecer um nome para identificar o grupo de propriedades personalizadas. É possível adicionar, excluir ou reorganizar vários grupos de propriedades personalizadas. Após adicionar o grupo de propriedades personalizadas, você verá as seguintes opções:

    • Pares de chave e valor: é possível adicionar vários nomes e valores de propriedades personalizadas clicando em Adicionar em cada grupo de propriedades personalizadas.

    • Excluir: toque ou clique para excluir o nome e o valor da propriedade personalizada.

    • Reordenar: toque ou clique e arraste para reordenar o nome e o valor da propriedade personalizada.

Artigos relacionados related-articles

Consulte também see-also

recommendation-more-help
d2be9096-a81e-404b-9952-d8925af7219c