Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.AmplifyUiBuilder.Types.Form

Description

Synopsis

data Form = Form' {
- cta :: Maybe FormCTA
- tags :: Maybe (HashMap Text Text)
- appId :: Text
- dataType :: FormDataTypeConfig
- environmentName :: Text
- fields :: HashMap Text FieldConfig
- formActionType :: FormActionType
- id :: Text
- name :: Text
- schemaVersion :: Text
- sectionalElements :: HashMap Text SectionalElement
- style :: FormStyle
}
newForm :: Text -> FormDataTypeConfig -> Text -> FormActionType -> Text -> Text -> Text -> FormStyle -> Form
form_cta :: Lens' Form (Maybe FormCTA)
form_tags :: Lens' Form (Maybe (HashMap Text Text))
form_appId :: Lens' Form Text
form_dataType :: Lens' Form FormDataTypeConfig
form_environmentName :: Lens' Form Text
form_fields :: Lens' Form (HashMap Text FieldConfig)
form_formActionType :: Lens' Form FormActionType
form_id :: Lens' Form Text
form_name :: Lens' Form Text
form_schemaVersion :: Lens' Form Text
form_sectionalElements :: Lens' Form (HashMap Text SectionalElement)
form_style :: Lens' Form FormStyle

Documentation

data Form Source #

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.

See: newForm smart constructor.

Constructors

Form'

Fields

cta :: Maybe FormCTA
Stores the call to action configuration for the form.
tags :: Maybe (HashMap Text Text)
One or more key-value pairs to use when tagging the form.
appId :: Text
The unique ID of the Amplify app associated with the form.
dataType :: FormDataTypeConfig
The type of data source to use to create the form.
environmentName :: Text
The name of the backend environment that is a part of the Amplify app.
fields :: HashMap Text FieldConfig
Stores the information about the form's fields.
formActionType :: FormActionType
The operation to perform on the specified form.
id :: Text
The unique ID of the form.
name :: Text
The name of the form.
schemaVersion :: Text
The schema version of the form when it was imported.
sectionalElements :: HashMap Text SectionalElement
Stores the visual helper elements for the form that are not associated with any data.
style :: FormStyle
Stores the configuration for the form's style.

Instances

Instances details

FromJSON Form Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.Types.Form Methods parseJSON :: Value -> Parser Form # parseJSONList :: Value -> Parser [Form] #
Generic Form Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.Types.Form Associated Types type Rep Form :: Type -> Type # Methods from :: Form -> Rep Form x # to :: Rep Form x -> Form #
Read Form Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.Types.Form Methods readsPrec :: Int -> ReadS Form # readList :: ReadS [Form] # readPrec :: ReadPrec Form # readListPrec :: ReadPrec [Form] #
Show Form Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.Types.Form Methods showsPrec :: Int -> Form -> ShowS # show :: Form -> String # showList :: [Form] -> ShowS #
NFData Form Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.Types.Form Methods rnf :: Form -> () #
Eq Form Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.Types.Form Methods (==) :: Form -> Form -> Bool # (/=) :: Form -> Form -> Bool #
Hashable Form Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.Types.Form Methods hashWithSalt :: Int -> Form -> Int # hash :: Form -> Int #
type Rep Form Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.Types.Form type Rep Form = D1 ('MetaData "Form" "Amazonka.AmplifyUiBuilder.Types.Form" "amazonka-amplifyuibuilder-2.0-KN0MRaPu7dZCAXr3ruBTcC" 'False) (C1 ('MetaCons "Form'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cta") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FormCTA)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "appId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "dataType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FormDataTypeConfig) :: (S1 ('MetaSel ('Just "environmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "fields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text FieldConfig))))) :: ((S1 ('MetaSel ('Just "formActionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FormActionType) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "schemaVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "sectionalElements") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text SectionalElement)) :*: S1 ('MetaSel ('Just "style") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FormStyle))))))

newForm Source #

Arguments

:: Text	`$sel:appId:Form'`
-> FormDataTypeConfig	`$sel:dataType:Form'`
-> Text	`$sel:environmentName:Form'`
-> FormActionType	`$sel:formActionType:Form'`
-> Text	`$sel:id:Form'`
-> Text	`$sel:name:Form'`
-> Text	`$sel:schemaVersion:Form'`
-> FormStyle	`$sel:style:Form'`
-> Form

Create a value of Form with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:cta:Form', form_cta - Stores the call to action configuration for the form.

$sel:tags:Form', form_tags - One or more key-value pairs to use when tagging the form.

$sel:appId:Form', form_appId - The unique ID of the Amplify app associated with the form.

$sel:dataType:Form', form_dataType - The type of data source to use to create the form.

$sel:environmentName:Form', form_environmentName - The name of the backend environment that is a part of the Amplify app.

$sel:fields:Form', form_fields - Stores the information about the form's fields.

$sel:formActionType:Form', form_formActionType - The operation to perform on the specified form.

$sel:id:Form', form_id - The unique ID of the form.

$sel:name:Form', form_name - The name of the form.

$sel:schemaVersion:Form', form_schemaVersion - The schema version of the form when it was imported.

$sel:sectionalElements:Form', form_sectionalElements - Stores the visual helper elements for the form that are not associated with any data.

$sel:style:Form', form_style - Stores the configuration for the form's style.

form_cta :: Lens' Form (Maybe FormCTA) Source #

Stores the call to action configuration for the form.

form_tags :: Lens' Form (Maybe (HashMap Text Text)) Source #

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

form_appId :: Lens' Form Text Source #

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

form_dataType :: Lens' Form FormDataTypeConfig Source #

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

form_environmentName :: Lens' Form Text Source #

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

form_fields :: Lens' Form (HashMap Text FieldConfig) Source #

Stores the information about the form's fields.

form_formActionType :: Lens' Form FormActionType Source #

The operation to perform on the specified form.

form_id :: Lens' Form Text Source #

The unique ID of the form.

form_name :: Lens' Form Text Source #

The name of the form.

form_schemaVersion :: Lens' Form Text Source #

The schema version of the form when it was imported.

form_sectionalElements :: Lens' Form (HashMap Text SectionalElement) Source #

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

form_style :: Lens' Form FormStyle Source #

Stores the configuration for the form's style.