Documentation

Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.

See: newComponentProperty smart constructor.

Create a value of ComponentProperty 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:bindingProperties:ComponentProperty', componentProperty_bindingProperties - The information to bind the component property to data at runtime.

$sel:bindings:ComponentProperty', componentProperty_bindings - The information to bind the component property to form data.

$sel:collectionBindingProperties:ComponentProperty', componentProperty_collectionBindingProperties - The information to bind the component property to data at runtime. Use this for collection components.

$sel:componentName:ComponentProperty', componentProperty_componentName - The name of the component that is affected by an event.

$sel:concat:ComponentProperty', componentProperty_concat - A list of component properties to concatenate to create the value to assign to this component property.

$sel:condition:ComponentProperty', componentProperty_condition - The conditional expression to use to assign a value to the component property.

$sel:configured:ComponentProperty', componentProperty_configured - Specifies whether the user configured the property in Amplify Studio after importing it.

$sel:defaultValue:ComponentProperty', componentProperty_defaultValue - The default value to assign to the component property.

$sel:event:ComponentProperty', componentProperty_event - An event that occurs in your app. Use this for workflow data binding.

$sel:importedValue:ComponentProperty', componentProperty_importedValue - The default value assigned to the property when the component is imported into an app.

$sel:model:ComponentProperty', componentProperty_model - The data model to use to assign a value to the component property.

FormBindingElement, componentProperty_property - The name of the component's property that is affected by an event.

$sel:type':ComponentProperty', componentProperty_type - The component type.

$sel:userAttribute:ComponentProperty', componentProperty_userAttribute - An authenticated user attribute to use to assign a value to the component property.

$sel:value:ComponentProperty', componentProperty_value - The value to assign to the component property.

The information to bind the component property to data at runtime.

The information to bind the component property to form data.

The information to bind the component property to data at runtime. Use this for collection components.

The name of the component that is affected by an event.

A list of component properties to concatenate to create the value to assign to this component property.

The conditional expression to use to assign a value to the component property.

Specifies whether the user configured the property in Amplify Studio after importing it.

The default value to assign to the component property.

An event that occurs in your app. Use this for workflow data binding.

The default value assigned to the property when the component is imported into an app.

The data model to use to assign a value to the component property.

The name of the component's property that is affected by an event.

The component type.

An authenticated user attribute to use to assign a value to the component property.

The value to assign to the component property.