Page updated Jan 31, 2024

Form Builder

Amplify Studio's Form Builder is a visual interface for creating React forms. You can configure validation logic, adjust theming, and customize presentation all within the console.

Forms are fully extensible, allowing lifecycle management, and supporting custom validation logic in code, including calling an external API or validating against another database.

Form Builder now supports data binding to GraphQL APIs without Conflict Resolution. Learn more about GraphQL and Conflict Resolution here.

Getting started

When you build a form with Form Builder, Amplify Studio generates a reusable React component based on your design. This component code can then be pulled into your project directory, imported, and rendered in your app with only a few lines of code.

To start with Form Builder in a Studio app...

  1. Log into your Studio application
  2. Select UI Library on the left-hand navigation bar
  3. Take one of the following paths:

If you have a data model deployed in your Amplify app, Studio will automatically generate default connected forms for you.

To use default forms:

  1. Log into Amplify Studio and deploy a Data model
  2. Navigate to the Studio Console > UI Library

Your forms will be listed on the left-hand navigation bar under the Forms header

Studio console showing auto-generated forms on the left-hand navigation bar

Default forms can be identified by the Amplify icon next to the form name

Form name showing the Amplify icon, indicating it is a default form

Missing a form? If you have a deployed data model but have no forms, automatic form generation may be disabled. In the upper right-hand corner of the UI Library, select UI Library settings, and enable Automatic form creation.

Default forms can be used as-is, or they can be customized. To customize a default form, select the form in the left-hand navigation bar, and click Configure in the upper right-hand corner. If you change your mind, you can delete your form, and a new default form will be generated.

After you are satisfied with your form, you can render it in your app.

To use connected forms, you first need a data model. Log into Amplify Studio and deploy a Data model.

To build a new connected form...

  1. Select UI Library
  2. In the Forms section of the left-hand nav bar, select New Red box around the "new" section of Form Builder
  3. Name your Form, and select Create or Update
  4. In the Data model dropdown, select which model your form should connect to
  5. Select Create form

Create new form screen with the Publisher data model highlighted in the Data model section

Form builder will generate a new form with input fields that match the fields of the connected data model. From here, you can customize your inputs, and after you are satisfied with your form, you can render it in your app.

Amplify Studio can generate an unconnected form based on the JSON object you'd like it to output. This is particularly useful if you are interfacing with another API - most API endpoints expect input data in JSON format, so you can quickly generate a form by pasting a sample payload.

To generate a form from JSON:

  1. In Amplify Studio Console, navigate to UI Library
  2. In the left-hand nav bar, next to the Forms header, select New Red box around the "new" section of Form Builder
  3. Give your form a name, and select Create or Update
  4. In the New Form page, select JSON object
  5. Paste your JSON into the code editor and click Create form

Form Builder will infer the input element type based on the value and can handle arrays and nested JSON values. For example, use this JSON sample:

{ "basics": { "firstName": "Wesley", "emailAddress": "wesley@example.com" }, "favoriteThings": { "animals": ["Cats", "Snakes", "Quokka"], "month": "December", "number": 17 }, "active": true, "enabled": false }
1{
2 "basics": {
3 "firstName": "Wesley",
4 "emailAddress": "wesley@example.com"
5 },
6 "favoriteThings": {
7 "animals": ["Cats", "Snakes", "Quokka"],
8 "month": "December",
9 "number": 17
10 },
11 "active": true,
12 "enabled": false
13}

This JSON will render the following form:

Form rendered from JSON showing headings and fields with types inferred from key pair values

From the JSON object, Amplify Studio can automatically...

  • ...set the correct types for Email address and Number
  • ...set Animals to receive multiple values
  • ...set Active and Enabled to switches

When you are satisfied with this form, you can convert it to a connected form by binding to a data model, or you can render it in your app.

Amplify Studio allows you to build unconnected forms completely from scratch with a visual interface. To generate a basic, brand-new form:

  1. In the Amplify Studio Console, navigate to UI Library
  2. In the left-hand nav bar, next to the Forms header, select New Red box around the "new" section of Form Builder
  3. Give your form a name, and select Create or Update
  4. Leave Black form selected, and click Create form

New form page, showing the options available when creating a new form

After clicking Create form, you will be directed to the Edit Form page. Select the plus sign, and select an input element to add to your form.

Image of the Form Creation page with the blue bar and plus sign indicating the ability to add input elements to the form

You can continue to customize your form inputs, and when you are satisfied, you can convert it to a connected form by binding to a data model, or you can render it in your app.

Alternatively, to get started without logging into AWS, you can build unconnected forms in the Amplify Sandbox.

Render React form in your app

Initial Project Setup

To use a form in your application, you first need to configure your project to use Amplify Studio generated components. To get started, create a new React App then,

  1. Navigate to your application's root directory and install the following npm dependencies
npm install -g @aws-amplify/cli
1npm install -g @aws-amplify/cli
npm install aws-amplify @aws-amplify/ui-react
1npm install aws-amplify @aws-amplify/ui-react
  1. In your application's entrypoint file (e.g. src/index.js for create-react-app or src/main.jsx for Vite), add the following imports and configuration
import '@aws-amplify/ui-react/styles.css'; import { Amplify } from 'aws-amplify'; import { ThemeProvider } from '@aws-amplify/ui-react'; import amplifyconfig from './amplifyconfiguration.json'; import studioTheme from './ui-components/studioTheme'; Amplify.configure(amplifyconfig);
1import '@aws-amplify/ui-react/styles.css';
2
3import { Amplify } from 'aws-amplify';
4import { ThemeProvider } from '@aws-amplify/ui-react';
5
6import amplifyconfig from './amplifyconfiguration.json';
7import studioTheme from './ui-components/studioTheme';
8
9Amplify.configure(amplifyconfig);
  1. In your application's entrypoint file (e.g. src/index.js for create-react-app or src/main.jsx for Vite), wrap the <App /> component with the following:
<ThemeProvider theme={studioTheme}> <App /> </ThemeProvider>
1<ThemeProvider theme={studioTheme}>
2 <App />
3</ThemeProvider>

Import and Render Your Form

Next, your forms need to be pulled from the Amplify cloud to your project, and imported into your code.

  1. Navigate to your application's root directory and run amplify pull
  2. Import your form by name. For a form named ProductCreateForm, you would use the following code:
import { ProductCreateForm } from './ui-components';
1import { ProductCreateForm } from './ui-components';
  1. Place your form in code. For a form named ProductCreateForm in a React project, you could use the following App code:
function App() { return <ProductCreateForm />; } export default App;
1function App() {
2 return <ProductCreateForm />;
3}
4
5export default App;