Criar e visualizar um formulário headless usando um aplicativo React introduction
O kit inicial ajuda você a começar a usar rapidamente um aplicativo React. Você pode desenvolver e usar formulários adaptáveis headless em um Angular, Vanilla JS e outros ambientes de desenvolvimento de sua escolha.
Começar com formulários adaptáveis headless é muito fácil e rápido. Clonar o projeto React pronto, instalar as dependências e executar o projeto. Você tem um formulário adaptável headless integrado em um aplicativo React em funcionamento. Você pode usar o projeto de amostra do react para criar e testar formulários adaptáveis headless antes de implantá-lo em um ambiente de produção.
Vamos começar:
Antes de começar pre-requisites
Para criar e executar um aplicativo React, você deve ter o seguinte instalado em seu computador:
-
Instale a última versão do Git. Se você é novo no Git, consulte Instalando o Git.
-
Instalar o Node.js 16.13.0 ou posterior.
Introdução
Depois de atender aos requisitos, execute as seguintes etapas para começar:
1. Configurar o kit inicial de formulários adaptáveis headless install
O kit inicial é um aplicativo React com um exemplo de formulário adaptável headless e bibliotecas correspondentes. Use o kit para desenvolver e testar seus formulários adaptáveis headless e os componentes correspondentes do React. Execute os seguintes comandos para configurar o kit inicial dos formulários adaptáveis headless:
-
Abra o prompt de comando e execute o seguinte comando:
code language-shell git clone https://github.com/adobe/react-starter-kit-aem-headless-forms
O comando cria um diretório chamado react-starter-kit-aem-headless-forms em seu local atual e clona o aplicativo headless Adaptive forms React starter nele. Juntamente com as configurações e a lista de dependências necessárias para renderizar o formulário, o diretório inclui o seguinte conteúdo importante:
- Formulário de exemplo: o kit inicial inclui um formulário de aplicativo de empréstimo de exemplo. Para exibir o formulário (definição de formulário) incluído no aplicativo, abra o arquivo
/react-starter-kit-aem-headless-forms/form-definations/form-model.json
. - Exemplos de componentes do React: o kit inicial inclui exemplos de componentes do React para Rich Text e Slider. Este guia ajuda você a criar seus próprios componentes personalizados usando esses componentes Rich text e Slider.
- Mappings.ts: o arquivo mappings.ts ajuda a mapear componentes personalizados com campos de formulário. Por exemplo, mapeie um campo de passo numérico com um componente de classificações.
- Configurações de ambiente: as configurações de ambiente permitem renderizar um formulário incluído no kit inicial ou buscar um formulário de um AEM Forms Server.
note note NOTE Exemplos em documentos são baseados em VSCode. Você pode usar qualquer editor de código de texto simples. - Formulário de exemplo: o kit inicial inclui um formulário de aplicativo de empréstimo de exemplo. Para exibir o formulário (definição de formulário) incluído no aplicativo, abra o arquivo
-
Navegue até o diretório react-starter-kit-aem-headless-forms e execute o seguinte comando para instalar as dependências:
code language-shell npm install
O comando baixa todos os pacotes e bibliotecas necessários para criar e executar o aplicativo, incluindo as bibliotecas de formulários adaptáveis headless (@aemforms/af-response-renderer, @aemforms/af-response-components, @adobe/react-spectrum). Em seguida, ele executa validações e mantém dados para cada instância de formulário.
2. Visualizar o formulário adaptável headless preview
Depois de configurar o kit inicial, é possível visualizar o formulário adaptável headless de amostra, substituí-lo pelo seu próprio formulário personalizado. Você também pode configurar o kit inicial para recuperar um formulário de um servidor do AEM Forms. Para visualizar o formulário
-
Renomeie o arquivo
env_template
para o arquivo.env
. Além disso, verifique se a opção USE_LOCAL_JSON está definida como true. -
Use o seguinte comando para executar o aplicativo:
code language-shell npm start
Esse comando inicia um servidor de desenvolvimento local e abre o formulário adaptável headless de amostra, incluído no aplicativo inicial, no navegador da Web padrão.
Tudo pronto! Você está pronto para começar a desenvolver um formulário adaptável headless personalizado.
3. Crie e renderize seu próprio formulário adaptável headless custom
Um formulário adaptável headless representa o formulário e seus componentes, como campos e botões, no formato JSON (JavaScript Object Notation). A vantagem de usar o formato JSON é que ele pode ser facilmente analisado e usado por várias linguagens de programação, tornando-se uma maneira conveniente de trocar dados de formulário entre sistemas. Para exibir o exemplo de formulário adaptável headless incluído no aplicativo, abra o arquivo /react-starter-kit-aem-headless-forms/form-definations/form-model.json
.
Vamos criar um formulário Contact Us
com quatro campos: "Nome", "Email", "Número de Contato" e "Mensagem". Os campos são definidos como objetos (itens) no JSON, com cada objeto (item) tendo propriedades como tipo, rótulo, nome e obrigatório. O formulário também tem um botão do tipo "enviar". Este é o JSON para o formulário.
{
"afModelDefinition": {
"adaptiveform": "0.10.0",
"items": [
{
"fieldType": "text-input",
"label": {
"value": "Name"
},
"name": "name"
},
{
"fieldType": "text-input",
"format": "email",
"label": {
"value": "Email"
},
"name": "email"
},
{
"fieldType": "text-input",
"format": "phone",
"pattern": "[0-9]{10}",
"label": {
"value": "Contact Number"
},
"name": "Phone"
},
{
"fieldType": "multiline-input",
"label": {
"value":"Message"
},
"name": "message"
},
{
"fieldType": "button",
"label":{
"value": "Submit"
},
"name":"submit",
"events":{
"click": "submitForm()"
}
}
],
"action": "https://eozrmb1rwsmofct.m.pipedream.net",
"description": "Contact Us",
"title": "Contact Us",
"metadata": {
"grammar": "json-formula-1.0.0",
"version": "1.0.0"
}
}
}
- O atributo "afModelDefinition" é necessário apenas para aplicativos React e não faz parte da definição do formulário.
- Você pode criar o formulário JSON manualmente ou usar o editor de formulários adaptáveis do AEM (editor de formulários adaptáveis do WYSIWYG) para criar e entregar o formulário JSON. Em um ambiente de produção, você usa o AEM Forms para fornecer o formulário JSON, mais informações sobre ele posteriormente.
- O tutorial usa o https://pipedream.com/ para testar os envios de formulários. Você usa endpoints próprios ou de terceiros aprovados pela organização para receber os dados de um formulário adaptável headless.
Para renderizar o formulário, substitua o formulário adaptável headless de amostra JSON /react-starter-kit-aem-headless-forms/form-definations/form-model.json
pelo JSON acima, salve o arquivo, aguarde o kit inicial compilar e atualize o formulário.
Você renderizou com sucesso o formulário adaptável headless.
Bônus
Vamos definir o título da página da Web que hospeda o formulário como Contact Us | WKND Adventures and Travel
. Para alterar o título, abra o arquivo react-starter-kit-aem-headless-forms/public/index.html para edição e defina o título.
Próxima etapa
Por padrão, o kit inicial usa os componentes Espectro da Adobe para renderizar o formulário. Você pode criar e usar seus próprios componentes ou componentes de terceiros. Por exemplo, usando a Google Material UI ou a Chakra UI.
Vamos usar a Interface do Usuário do Material do Google para renderizar o formulário Contact Us
.