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.CreateComponentData

Description

Synopsis

data CreateComponentData = CreateComponentData' {
- children :: Maybe [ComponentChild]
- collectionProperties :: Maybe (HashMap Text ComponentDataConfiguration)
- events :: Maybe (HashMap Text ComponentEvent)
- schemaVersion :: Maybe Text
- sourceId :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- bindingProperties :: HashMap Text ComponentBindingPropertiesValue
- componentType :: Text
- name :: Text
- overrides :: HashMap Text (HashMap Text Text)
- properties :: HashMap Text ComponentProperty
- variants :: [ComponentVariant]
}
newCreateComponentData :: Text -> Text -> CreateComponentData
createComponentData_children :: Lens' CreateComponentData (Maybe [ComponentChild])
createComponentData_collectionProperties :: Lens' CreateComponentData (Maybe (HashMap Text ComponentDataConfiguration))
createComponentData_events :: Lens' CreateComponentData (Maybe (HashMap Text ComponentEvent))
createComponentData_schemaVersion :: Lens' CreateComponentData (Maybe Text)
createComponentData_sourceId :: Lens' CreateComponentData (Maybe Text)
createComponentData_tags :: Lens' CreateComponentData (Maybe (HashMap Text Text))
createComponentData_bindingProperties :: Lens' CreateComponentData (HashMap Text ComponentBindingPropertiesValue)
createComponentData_componentType :: Lens' CreateComponentData Text
createComponentData_name :: Lens' CreateComponentData Text
createComponentData_overrides :: Lens' CreateComponentData (HashMap Text (HashMap Text Text))
createComponentData_properties :: Lens' CreateComponentData (HashMap Text ComponentProperty)
createComponentData_variants :: Lens' CreateComponentData [ComponentVariant]

Documentation

data CreateComponentData Source #

Represents all of the information that is required to create a component.

See: newCreateComponentData smart constructor.

Constructors

CreateComponentData'

Fields

children :: Maybe [ComponentChild]
A list of child components that are instances of the main component.
collectionProperties :: Maybe (HashMap Text ComponentDataConfiguration)
The data binding configuration for customizing a component's properties. Use this for a collection component.
events :: Maybe (HashMap Text ComponentEvent)
The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
schemaVersion :: Maybe Text
The schema version of the component when it was imported.
sourceId :: Maybe Text
The unique ID of the component in its original source system, such as Figma.
tags :: Maybe (HashMap Text Text)
One or more key-value pairs to use when tagging the component data.
bindingProperties :: HashMap Text ComponentBindingPropertiesValue
The data binding information for the component's properties.
componentType :: Text
The component type. This can be an Amplify custom UI component or another custom component.
name :: Text
The name of the component
overrides :: HashMap Text (HashMap Text Text)
Describes the component properties that can be overriden to customize an instance of the component.
properties :: HashMap Text ComponentProperty
Describes the component's properties.
variants :: [ComponentVariant]
A list of the unique variants of this component.

Instances

Instances details

ToJSON CreateComponentData Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.Types.CreateComponentData Methods toJSON :: CreateComponentData -> Value # toEncoding :: CreateComponentData -> Encoding # toJSONList :: [CreateComponentData] -> Value # toEncodingList :: [CreateComponentData] -> Encoding #
Generic CreateComponentData Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.Types.CreateComponentData Associated Types type Rep CreateComponentData :: Type -> Type # Methods from :: CreateComponentData -> Rep CreateComponentData x # to :: Rep CreateComponentData x -> CreateComponentData #
Read CreateComponentData Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.Types.CreateComponentData Methods readsPrec :: Int -> ReadS CreateComponentData # readList :: ReadS [CreateComponentData] # readPrec :: ReadPrec CreateComponentData # readListPrec :: ReadPrec [CreateComponentData] #
Show CreateComponentData Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.Types.CreateComponentData Methods showsPrec :: Int -> CreateComponentData -> ShowS # show :: CreateComponentData -> String # showList :: [CreateComponentData] -> ShowS #
NFData CreateComponentData Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.Types.CreateComponentData Methods rnf :: CreateComponentData -> () #
Eq CreateComponentData Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.Types.CreateComponentData Methods (==) :: CreateComponentData -> CreateComponentData -> Bool # (/=) :: CreateComponentData -> CreateComponentData -> Bool #
Hashable CreateComponentData Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.Types.CreateComponentData Methods hashWithSalt :: Int -> CreateComponentData -> Int # hash :: CreateComponentData -> Int #
type Rep CreateComponentData Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.Types.CreateComponentData type Rep CreateComponentData = D1 ('MetaData "CreateComponentData" "Amazonka.AmplifyUiBuilder.Types.CreateComponentData" "amazonka-amplifyuibuilder-2.0-KN0MRaPu7dZCAXr3ruBTcC" 'False) (C1 ('MetaCons "CreateComponentData'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "children") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ComponentChild])) :: (S1 ('MetaSel ('Just "collectionProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text ComponentDataConfiguration))) :: S1 ('MetaSel ('Just "events") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text ComponentEvent))))) :: (S1 ('MetaSel ('Just "schemaVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "sourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))) :: ((S1 ('MetaSel ('Just "bindingProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text ComponentBindingPropertiesValue)) :: (S1 ('MetaSel ('Just "componentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "overrides") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text (HashMap Text Text))) :: (S1 ('MetaSel ('Just "properties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text ComponentProperty)) :*: S1 ('MetaSel ('Just "variants") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ComponentVariant]))))))

newCreateComponentData Source #

Arguments

:: Text	`CreateComponentData`
-> Text	`CreateComponentData`
-> CreateComponentData

Create a value of CreateComponentData 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:

CreateComponentData, createComponentData_children - A list of child components that are instances of the main component.

$sel:collectionProperties:CreateComponentData', createComponentData_collectionProperties - The data binding configuration for customizing a component's properties. Use this for a collection component.

CreateComponentData, createComponentData_events - The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.

$sel:schemaVersion:CreateComponentData', createComponentData_schemaVersion - The schema version of the component when it was imported.

CreateComponentData, createComponentData_sourceId - The unique ID of the component in its original source system, such as Figma.

$sel:tags:CreateComponentData', createComponentData_tags - One or more key-value pairs to use when tagging the component data.

CreateComponentData, createComponentData_bindingProperties - The data binding information for the component's properties.

CreateComponentData, createComponentData_componentType - The component type. This can be an Amplify custom UI component or another custom component.

CreateComponentData, createComponentData_name - The name of the component

CreateComponentData, createComponentData_overrides - Describes the component properties that can be overriden to customize an instance of the component.

CreateComponentData, createComponentData_properties - Describes the component's properties.

$sel:variants:CreateComponentData', createComponentData_variants - A list of the unique variants of this component.

createComponentData_children :: Lens' CreateComponentData (Maybe [ComponentChild]) Source #

A list of child components that are instances of the main component.

createComponentData_collectionProperties :: Lens' CreateComponentData (Maybe (HashMap Text ComponentDataConfiguration)) Source #

The data binding configuration for customizing a component's properties. Use this for a collection component.

createComponentData_events :: Lens' CreateComponentData (Maybe (HashMap Text ComponentEvent)) Source #

The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.

createComponentData_schemaVersion :: Lens' CreateComponentData (Maybe Text) Source #

The schema version of the component when it was imported.

createComponentData_sourceId :: Lens' CreateComponentData (Maybe Text) Source #

The unique ID of the component in its original source system, such as Figma.

createComponentData_tags :: Lens' CreateComponentData (Maybe (HashMap Text Text)) Source #

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

createComponentData_bindingProperties :: Lens' CreateComponentData (HashMap Text ComponentBindingPropertiesValue) Source #

The data binding information for the component's properties.

createComponentData_componentType :: Lens' CreateComponentData Text Source #

The component type. This can be an Amplify custom UI component or another custom component.

createComponentData_name :: Lens' CreateComponentData Text Source #

The name of the component

createComponentData_overrides :: Lens' CreateComponentData (HashMap Text (HashMap Text Text)) Source #

Describes the component properties that can be overriden to customize an instance of the component.

createComponentData_properties :: Lens' CreateComponentData (HashMap Text ComponentProperty) Source #

Describes the component's properties.

createComponentData_variants :: Lens' CreateComponentData [ComponentVariant] Source #

A list of the unique variants of this component.