Skip to content

ComponentChild

Source code in docs_src/capo_amplifyuibuilder/types/component_child.py
class ComponentChild(TypedDict, closed=True):
    component_type: "str"
    """<p>The type of the child component. </p>"""
    name: "str"
    """<p>The name of the child component.</p>"""
    properties: "capo_amplifyuibuilder.types.component_properties.ComponentProperties"
    """<p>Describes the properties of the child component. You can't specify <code>tags</code> as a valid property for <code>properties</code>.</p>"""
    children: NotRequired[
        "capo_amplifyuibuilder.types.component_child_list.ComponentChildList"
    ]
    """<p>The list of <code>ComponentChild</code> instances for this component.</p>"""
    events: NotRequired["capo_amplifyuibuilder.types.component_events.ComponentEvents"]
    """<p>Describes the events that can be raised on the child component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.</p>"""
    source_id: NotRequired["str"]
    """<p>The unique ID of the child component in its original source system, such as Figma.</p>"""

children instance-attribute

children: NotRequired[ComponentChildList]

The list of ComponentChild instances for this component.

component_type instance-attribute

component_type: str

The type of the child component.

events instance-attribute

events: NotRequired[ComponentEvents]

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

name instance-attribute

name: str

The name of the child component.

properties instance-attribute

properties: ComponentProperties

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

source_id instance-attribute

source_id: NotRequired[str]

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