Een headless-formulier maken en voorvertonen met een React-app introduction
Met de startkit kunt u snel aan de slag met een React-app. U kunt Headless Adaptive-formulieren ontwikkelen en gebruiken in een Angular, Vanilla JS en andere ontwikkelomgevingen van uw keuze.
Vanaf Headless Adaptive Forms is dit heel eenvoudig en snel. Kloon het kant-en-klare React project, installeer de gebiedsdelen, en stel het project in werking. U hebt een Headless Adaptive-formulier dat in een React-app is geïntegreerd. U kunt het steekproefreactieproject gebruiken om Zwaartepunt te bouwen en te testen - adaptieve vormen alvorens het in een productiemilieu op te stellen.
Laten we beginnen:
Voordat u begint pre-requisites
Als u een React-app wilt maken en uitvoeren, moet het volgende op uw computer zijn geïnstalleerd:
-
Installeer de recentste versie van Git. Als u aan Git nieuw bent, zie Installerend Git.
-
Installeer Node.js 16.13.0 of later.
Aan de slag
Wanneer u aan de vereisten voldoet, voert u de volgende stappen uit om aan de slag te gaan:
1. Startkit voor Zwaarloze adaptieve formulieren instellen install
De startkit is een React-app met een voorbeeld van een adaptief formulier zonder koptekst en de bijbehorende bibliotheken. Gebruik de kit om uw Headless Adaptive-formulieren en bijbehorende React-componenten te ontwikkelen en te testen. Voer de volgende opdrachten uit om de startkit voor Zoogloze adaptieve formulieren in te stellen:
-
Opdrachtprompt openen en de volgende opdracht uitvoeren:
code language-shell git clone https://github.com/adobe/react-starter-kit-aem-headless-forms
Het bevel leidt tot een folder genoemd reactie-starter-kit-a-headless-vormen in uw huidige plaats en klonen de Zwaarloze Aangepaste vormen Reageer eerste app in het. Naast de configuraties en lijst met afhankelijkheden die zijn vereist om het formulier te genereren, bevat de map de volgende belangrijke inhoud:
- Vorm van de Steekproef: De starteruitrusting omvat een vorm van de de toepassingstoepassing van de steekproeflening. Open het bestand
/react-starter-kit-aem-headless-forms/form-definations/form-model.json
als u het formulier (formulierdefinitie) dat bij de app is opgenomen, wilt weergeven. - Reageer componenten van de Steekproef: De aanzetuitrusting omvat steekproef reactiecomponenten voor RTF- en Slider. Deze gids helpt u uw eigen douanecomponenten tot stand brengen gebruikend deze Rijke tekst en componenten van de Schuifregelaar.
- Mappings.ts: Het mappings.ts- dossier helpt u douanecomponenten met vormgebieden in kaart brengen. Wijs bijvoorbeeld een numeriek staperveld toe met een classificatiecomponent.
- configuraties van het Milieu: De configuraties van het milieu laten u verkiezen om een vorm terug te geven inbegrepen in de starterkit of een vorm van een Server van AEM Forms te halen.
note note NOTE De voorbeelden in documenten zijn gebaseerd op VSCode. U kunt geen code-editor voor normale tekst gebruiken. - Vorm van de Steekproef: De starteruitrusting omvat een vorm van de de toepassingstoepassing van de steekproeflening. Open het bestand
-
Navigeer aan de reactie-starter-kit-a-headless-vormen folder en stel het volgende bevel in werking om de gebiedsdelen te installeren:
code language-shell npm install
Met deze opdracht downloadt u elk pakket en elke bibliotheek die nodig zijn om de app te maken en uit te voeren, inclusief de bibliotheken voor onbewerkte formulieren (@aemforms/af-response-renderer, @aemforms/af-response-components, @adobe/response-spectrum). Vervolgens worden validaties uitgevoerd en worden de gegevens voor elk formulierexemplaar voortgezet.
2. Geef een voorvertoning weer van het adaptieve formulier zonder koptekst preview
Nadat u de startkit hebt ingesteld, kunt u een voorbeeld van het blokloze adaptieve formulier weergeven en dit vervangen door uw eigen aangepaste formulier. U kunt ook de startkit configureren om een formulier op te halen van een AEM Forms-server. Een voorbeeld van het formulier bekijken
-
Wijzig de naam van het bestand
env_template
in.env
. Zorg er ook voor dat de optie USE_LOCAL_JSON is ingesteld op true. -
Gebruik de volgende opdracht om de app uit te voeren:
code language-shell npm start
Met deze opdracht start u een lokale ontwikkelingsserver en opent u het voorbeeldformulier Headless Adaptive, dat in de starttoepassing is opgenomen, in uw standaardwebbrowser.
Alles klaar! U kunt beginnen met het ontwikkelen van een aangepast, adaptief formulier zonder koptekst.
3. Maak en geef uw eigen Zwaarloze Adaptieve vorm custom
Een koploos adaptief formulier vertegenwoordigt het formulier en de componenten ervan, zoals velden en knoppen, in de indeling JSON (JavaScript Object Notation). Het voordeel van de JSON-indeling is dat deze eenvoudig kan worden geparseerd en gebruikt door verschillende programmeertalen, waardoor het een handige manier is om formuliergegevens uit te wisselen tussen systemen. Open het /react-starter-kit-aem-headless-forms/form-definations/form-model.json
-bestand als u het voorbeeldformulier Koploos adaptief wilt weergeven dat bij de app wordt geleverd.
Maak een Contact Us
-formulier met vier velden: "Naam", "E-mail", "Contactnummer" en "Bericht". De velden worden gedefinieerd als objecten (items) in de JSON, waarbij elk object (item) eigenschappen heeft zoals type, label, naam en vereiste waarden. Het formulier heeft ook een knop van het type "submit". Hier is de JSON voor het formulier.
{
"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"
}
}
}
- Het kenmerk "afModelDefinition" is alleen nodig voor React-toepassingen en maakt geen deel uit van de formulierdefinitie.
- U kunt de vormJSON manueel-ambachtelijk of de AEM adaptieve vormenredacteur (de adaptieve redacteur van vormenWYSIWYG)gebruiken om vormJSON tot stand te brengen en te leveren. In een productieomgeving gebruikt u AEM Forms om het formulier JSON later meer te leveren.
- De zelfstudie gebruikt de map https://pipedream.com/ om formulierverzendingen te testen. U gebruikt uw eigen eindpunten of eindpunten van derden die door uw organisatie zijn goedgekeurd om de gegevens van een Zwaartepunt-adaptief formulier te ontvangen.
Als u het formulier wilt genereren, vervangt u het voorbeeld Koploos adaptief formulier JSON /react-starter-kit-aem-headless-forms/form-definations/form-model.json
door de bovenstaande JSON, slaat u het bestand op, wacht u tot de startkit het formulier heeft gecompileerd en vernieuwt u het.
U hebt met succes het Headless Adaptive-formulier gegenereerd.
Bonus
Stel de titel van de webpagina waarop het formulier zich bevindt in op Contact Us | WKND Adventures and Travel
. Om de titel te veranderen, open het react-starter-kit-aem-headless-forms/public/index.html dossier voor het uitgeven en plaats de titel.
Volgende stap
Door gebrek, gebruikt de aanzetuitrusting Adobecomponenten van het Spectrum om de vorm terug te geven. U kunt uw eigen componenten of componenten van derden maken en gebruiken. Bijvoorbeeld met Google Material UI of Chakra UI.
Laten wij materiaal UI van Googlegebruiken om de Contact Us
vorm terug te geven.