Form

import type { Form } from "https://aws-api.deno.dev/v0.4/services/amplifyuibuilder.ts?docs=full";

Contains the configuration settings for a Form user interface (UI) element for an Amplify app. A form is a component you can add to your project by specifying a data source as the default configuration for the form.

interface Form {

appId: string;

cta?: FormCTA | null;

dataType: FormDataTypeConfig;

environmentName: string;

fields: {

[key: string]: FieldConfig | null | undefined;

};

formActionType: FormActionType;

id: string;

name: string;

schemaVersion: string;

sectionalElements: {

[key: string]: SectionalElement | null | undefined;

};

style: FormStyle;

tags?: {

[key: string]: string | null | undefined;

} | null;

}

§Properties

appId: string

[src]

The unique ID of the Amplify app associated with the form.

cta?: FormCTA | null

[src]

Stores the call to action configuration for the form.

dataType: FormDataTypeConfig

[src]

The type of data source to use to create the form.

environmentName: string

[src]

The name of the backend environment that is a part of the Amplify app.

fields: {

[key: string]: FieldConfig | null | undefined;

}

[src]

Stores the information about the form's fields.

formActionType: FormActionType

[src]

The operation to perform on the specified form.

id: string

[src]

The unique ID of the form.

name: string

[src]

The name of the form.

schemaVersion: string

[src]

The schema version of the form when it was imported.

sectionalElements: {

[key: string]: SectionalElement | null | undefined;

}

[src]

Stores the visual helper elements for the form that are not associated with any data.

style: FormStyle

[src]

Stores the configuration for the form's style.

tags?: {

[key: string]: string | null | undefined;

} | null

[src]

One or more key-value pairs to use when tagging the form.