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.
Inheritance Hierarchy
Namespace: Amazon.AmplifyUIBuilder.Model
Assembly: AWSSDK.AmplifyUIBuilder.dll
Version: 3.x.y.z
Syntax
public class Component
The Component type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
Component() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
AppId | System.String |
Gets and sets the property AppId. The unique ID of the Amplify app associated with the component. |
|
|
BindingProperties | System.Collections.Generic.Dictionary<System.String, Amazon.AmplifyUIBuilder.Model.ComponentBindingPropertiesValue> |
Gets and sets the property BindingProperties.
The information to connect a component's properties to data at runtime. You can't
specify |
|
|
Children | System.Collections.Generic.List<Amazon.AmplifyUIBuilder.Model.ComponentChild> |
Gets and sets the property Children.
A list of the component's |
|
|
CollectionProperties | System.Collections.Generic.Dictionary<System.String, Amazon.AmplifyUIBuilder.Model.ComponentDataConfiguration> |
Gets and sets the property CollectionProperties.
The data binding configuration for the component's properties. Use this for a collection
component. You can't specify |
|
|
ComponentType | System.String |
Gets and sets the property ComponentType. The type of the component. This can be an Amplify custom UI component or another custom component. |
|
|
CreatedAt | System.DateTime |
Gets and sets the property CreatedAt. The time that the component was created. |
|
|
EnvironmentName | System.String |
Gets and sets the property EnvironmentName. The name of the backend environment that is a part of the Amplify app. |
|
|
Events | System.Collections.Generic.Dictionary<System.String, Amazon.AmplifyUIBuilder.Model.ComponentEvent> |
Gets and sets the property 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. |
|
|
Id | System.String |
Gets and sets the property Id. The unique ID of the component. |
|
|
ModifiedAt | System.DateTime |
Gets and sets the property ModifiedAt. The time that the component was modified. |
|
|
Name | System.String |
Gets and sets the property Name. The name of the component. |
|
|
Overrides | System.Collections.Generic.Dictionary<System.String, System.Collections.Generic.Dictionary<System.String, System.String>> |
Gets and sets the property Overrides.
Describes the component's properties that can be overriden in a customized instance
of the component. You can't specify |
|
|
Properties | System.Collections.Generic.Dictionary<System.String, Amazon.AmplifyUIBuilder.Model.ComponentProperty> |
Gets and sets the property Properties.
Describes the component's properties. You can't specify |
|
|
SchemaVersion | System.String |
Gets and sets the property SchemaVersion. The schema version of the component when it was imported. |
|
|
SourceId | System.String |
Gets and sets the property SourceId. The unique ID of the component in its original source system, such as Figma. |
|
|
Tags | System.Collections.Generic.Dictionary<System.String, System.String> |
Gets and sets the property Tags. One or more key-value pairs to use when tagging the component. |
|
|
Variants | System.Collections.Generic.List<Amazon.AmplifyUIBuilder.Model.ComponentVariant> |
Gets and sets the property Variants. A list of the component's variants. A variant is a unique style configuration of a main component. |
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5