Skip to content

ComponentProperty

Source code in docs_src/capo_amplifyuibuilder/types/component_property.py
class ComponentProperty(TypedDict, closed=True):
    value: NotRequired["str"]
    """<p>The value to assign to the component property.</p>"""
    binding_properties: NotRequired[
        "capo_amplifyuibuilder.types.component_property_binding_properties.ComponentPropertyBindingProperties"
    ]
    """<p>The information to bind the component property to data at runtime.</p>"""
    collection_binding_properties: NotRequired[
        "capo_amplifyuibuilder.types.component_property_binding_properties.ComponentPropertyBindingProperties"
    ]
    """<p>The information to bind the component property to data at runtime. Use this for collection components.</p>"""
    default_value: NotRequired["str"]
    """<p>The default value to assign to the component property.</p>"""
    model: NotRequired["str"]
    """<p>The data model to use to assign a value to the component property.</p>"""
    bindings: NotRequired["capo_amplifyuibuilder.types.form_bindings.FormBindings"]
    """<p>The information to bind the component property to form data.</p>"""
    event: NotRequired["str"]
    """<p>An event that occurs in your app. Use this for workflow data binding.</p>"""
    user_attribute: NotRequired["str"]
    """<p>An authenticated user attribute to use to assign a value to the component property.</p>"""
    concat: NotRequired[
        "capo_amplifyuibuilder.types.component_property_list.ComponentPropertyList"
    ]
    """<p>A list of component properties to concatenate to create the value to assign to this component property.</p>"""
    condition: NotRequired[
        "capo_amplifyuibuilder.types.component_condition_property.ComponentConditionProperty"
    ]
    """<p>The conditional expression to use to assign a value to the component property.</p>"""
    configured: NotRequired["bool"]
    """<p>Specifies whether the user configured the property in Amplify Studio after importing it.</p>"""
    type: NotRequired["str"]
    """<p>The component type.</p>"""
    imported_value: NotRequired["str"]
    """<p>The default value assigned to the property when the component is imported into an app.</p>"""
    component_name: NotRequired["str"]
    """<p>The name of the component that is affected by an event.</p>"""
    property: NotRequired["str"]
    """<p>The name of the component's property that is affected by an event.</p>"""

binding_properties instance-attribute

binding_properties: NotRequired[ComponentPropertyBindingProperties]

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

bindings instance-attribute

bindings: NotRequired[FormBindings]

The information to bind the component property to form data.

collection_binding_properties instance-attribute

collection_binding_properties: NotRequired[ComponentPropertyBindingProperties]

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

component_name instance-attribute

component_name: NotRequired[str]

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

concat instance-attribute

concat: NotRequired[ComponentPropertyList]

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

condition instance-attribute

condition: NotRequired[ComponentConditionProperty]

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

configured instance-attribute

configured: NotRequired[bool]

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

default_value instance-attribute

default_value: NotRequired[str]

The default value to assign to the component property.

event instance-attribute

event: NotRequired[str]

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

imported_value instance-attribute

imported_value: NotRequired[str]

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

model instance-attribute

model: NotRequired[str]

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

property instance-attribute

property: NotRequired[str]

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

type instance-attribute

type: NotRequired[str]

The component type.

user_attribute instance-attribute

user_attribute: NotRequired[str]

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

value instance-attribute

value: NotRequired[str]

The value to assign to the component property.