CreateComponentData ¶

class CreateComponentData(TypedDict, closed=True):
    name: "capo_amplifyuibuilder.types.component_name.ComponentName"
    """<p>The name of the component</p>"""
    source_id: NotRequired["str"]
    """<p>The unique ID of the component in its original source system, such as Figma.</p>"""
    component_type: "capo_amplifyuibuilder.types.component_type.ComponentType"
    """<p>The component type. This can be an Amplify custom UI component or another custom component.</p>"""
    properties: "capo_amplifyuibuilder.types.component_properties.ComponentProperties"
    """<p>Describes the component's properties.</p>"""
    children: NotRequired[
        "capo_amplifyuibuilder.types.component_child_list.ComponentChildList"
    ]
    """<p>A list of child components that are instances of the main component.</p>"""
    variants: "capo_amplifyuibuilder.types.component_variants.ComponentVariants"
    """<p>A list of the unique variants of this component.</p>"""
    overrides: "capo_amplifyuibuilder.types.component_overrides.ComponentOverrides"
    """<p>Describes the component properties that can be overriden to customize an instance of the component.</p>"""
    binding_properties: "capo_amplifyuibuilder.types.component_binding_properties.ComponentBindingProperties"
    """<p>The data binding information for the component's properties.</p>"""
    collection_properties: NotRequired[
        "capo_amplifyuibuilder.types.component_collection_properties.ComponentCollectionProperties"
    ]
    """<p>The data binding configuration for customizing a component's properties. Use this for a collection component.</p>"""
    tags: NotRequired["capo_amplifyuibuilder.types.tags.Tags"]
    """<p>One or more key-value pairs to use when tagging the component data.</p>"""
    events: NotRequired["capo_amplifyuibuilder.types.component_events.ComponentEvents"]
    """<p>The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.</p>"""
    schema_version: NotRequired["str"]
    """<p>The schema version of the component when it was imported.</p>"""