Amazonka.AmplifyUiBuilder.Types.Component

Documentation

data Component

Contains the configuration settings for a user interface (UI) element for an Amplify app. A component is configured as a primary, stand-alone UI element. Use ComponentChild to configure an instance of a Component. A ComponentChild instance inherits the configuration of the main Component.

See: newComponent smart constructor.

Constructors

Component'

Fields

• children :: Maybe [ComponentChild]

  A list of the component's ComponentChild instances.

• collectionProperties :: Maybe (HashMap Text ComponentDataConfiguration)

  The data binding configuration for the component's properties. Use this for a collection component. You can't specify tags as a valid property for collectionProperties.

• events :: Maybe (HashMap Text ComponentEvent)

  Describes the events that can be raised on the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.

• modifiedAt :: Maybe ISO8601

  The time that the component was modified.

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

• appId :: Text

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

• bindingProperties :: HashMap Text ComponentBindingPropertiesValue

  The information to connect a component's properties to data at runtime. You can't specify tags as a valid property for bindingProperties.

• componentType :: Text

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

• createdAt :: ISO8601

  The time that the component was created.

• environmentName :: Text

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

• id :: Text

  The unique ID of the component.

• name :: Text

  The name of the component.

• overrides :: HashMap Text (HashMap Text Text)

  Describes the component's properties that can be overriden in a customized instance of the component. You can't specify tags as a valid property for overrides.

• properties :: HashMap Text ComponentProperty

  Describes the component's properties. You can't specify tags as a valid property for properties.

• variants :: [ComponentVariant]

  A list of the component's variants. A variant is a unique style configuration of a main component.

Instances

FromJSON Component

Defined in Amazonka.AmplifyUiBuilder.Types.Component

Methods

parseJSON :: Value -> Parser Component

parseJSONList :: Value -> Parser [Component]

Generic Component

Defined in Amazonka.AmplifyUiBuilder.Types.Component

Associated Types

type Rep Component :: Type -> Type

Methods

from :: Component -> Rep Component x

to :: Rep Component x -> Component

Read Component

Defined in Amazonka.AmplifyUiBuilder.Types.Component

Methods

readsPrec :: Int -> ReadS Component

readList :: ReadS [Component]

readPrec :: ReadPrec Component

readListPrec :: ReadPrec [Component]

Show Component

Defined in Amazonka.AmplifyUiBuilder.Types.Component

Methods

showsPrec :: Int -> Component -> ShowS

show :: Component -> String

showList :: [Component] -> ShowS

NFData Component

Defined in Amazonka.AmplifyUiBuilder.Types.Component

Methods

rnf :: Component -> ()

Eq Component

Defined in Amazonka.AmplifyUiBuilder.Types.Component

Methods

(==) :: Component -> Component -> Bool

(/=) :: Component -> Component -> Bool

Hashable Component

Defined in Amazonka.AmplifyUiBuilder.Types.Component

Methods

hashWithSalt :: Int -> Component -> Int

hash :: Component -> Int

type Rep Component

Defined in Amazonka.AmplifyUiBuilder.Types.Component

type Rep Component = D1 ('MetaData "Component" "Amazonka.AmplifyUiBuilder.Types.Component" "amazonka-amplifyuibuilder-2.0-KN0MRaPu7dZCAXr3ruBTcC" 'False) (C1 ('MetaCons "Component'" '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 "modifiedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)))) :*: ((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 "appId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) :*: (((S1 ('MetaSel ('Just "bindingProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text ComponentBindingPropertiesValue)) :*: S1 ('MetaSel ('Just "componentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601) :*: S1 ('MetaSel ('Just "environmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: ((S1 ('MetaSel ('Just "id") '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])))))))

newComponent

Arguments

:: Text

$sel:appId:Component'

-> Text

Component

-> UTCTime

$sel:createdAt:Component'

-> Text

$sel:environmentName:Component'

-> Text

$sel:id:Component'

-> Text

Component

-> Component

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

Component, component_children - A list of the component's ComponentChild instances.

$sel:collectionProperties:Component', component_collectionProperties - The data binding configuration for the component's properties. Use this for a collection component. You can't specify tags as a valid property for collectionProperties.

Component, component_events - Describes the events that can be raised on the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.

$sel:modifiedAt:Component', component_modifiedAt - The time that the component was modified.

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

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

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

$sel:appId:Component', component_appId - The unique ID of the Amplify app associated with the component.

Component, component_bindingProperties - The information to connect a component's properties to data at runtime. You can't specify tags as a valid property for bindingProperties.

Component, component_componentType - The type of the component. This can be an Amplify custom UI component or another custom component.

$sel:createdAt:Component', component_createdAt - The time that the component was created.

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

$sel:id:Component', component_id - The unique ID of the component.

Component, component_name - The name of the component.

Component, component_overrides - Describes the component's properties that can be overriden in a customized instance of the component. You can't specify tags as a valid property for overrides.

Component, component_properties - Describes the component's properties. You can't specify tags as a valid property for properties.

$sel:variants:Component', component_variants - A list of the component's variants. A variant is a unique style configuration of a main component.

component_children :: Lens' Component (Maybe [ComponentChild])

A list of the component's ComponentChild instances.

component_collectionProperties :: Lens' Component (Maybe (HashMap Text ComponentDataConfiguration))

The data binding configuration for the component's properties. Use this for a collection component. You can't specify tags as a valid property for collectionProperties.

component_events :: Lens' Component (Maybe (HashMap Text ComponentEvent))

Describes the events that can be raised on the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.

component_modifiedAt :: Lens' Component (Maybe UTCTime)

The time that the component was modified.

component_schemaVersion :: Lens' Component (Maybe Text)

The schema version of the component when it was imported.

component_sourceId :: Lens' Component (Maybe Text)

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

component_tags :: Lens' Component (Maybe (HashMap Text Text))

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

component_appId :: Lens' Component Text

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

component_bindingProperties :: Lens' Component (HashMap Text ComponentBindingPropertiesValue)

The information to connect a component's properties to data at runtime. You can't specify tags as a valid property for bindingProperties.

component_componentType :: Lens' Component Text

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

component_createdAt :: Lens' Component UTCTime

The time that the component was created.

component_environmentName :: Lens' Component Text

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

component_id :: Lens' Component Text

The unique ID of the component.

component_name :: Lens' Component Text

The name of the component.

component_overrides :: Lens' Component (HashMap Text (HashMap Text Text))

Describes the component's properties that can be overriden in a customized instance of the component. You can't specify tags as a valid property for overrides.

component_properties :: Lens' Component (HashMap Text ComponentProperty)

Describes the component's properties. You can't specify tags as a valid property for properties.

component_variants :: Lens' Component [ComponentVariant]

A list of the component's variants. A variant is a unique style configuration of a main component.