Skip to content

FieldConfig

Source code in docs_src/capo_amplifyuibuilder/types/field_config.py
class FieldConfig(TypedDict, closed=True):
    label: NotRequired["str"]
    """<p>The label for the field.</p>"""
    position: NotRequired["capo_amplifyuibuilder.types.field_position.FieldPosition"]
    """<p>Specifies the field position.</p>"""
    excluded: NotRequired["bool"]
    """<p>Specifies whether to hide a field.</p>"""
    input_type: NotRequired[
        "capo_amplifyuibuilder.types.field_input_config.FieldInputConfig"
    ]
    """<p>Describes the configuration for the default input value to display for a field.</p>"""
    validations: NotRequired[
        "capo_amplifyuibuilder.types.validations_list.ValidationsList"
    ]
    """<p>The validations to perform on the value in the field.</p>"""

excluded instance-attribute

excluded: NotRequired[bool]

Specifies whether to hide a field.

input_type instance-attribute

input_type: NotRequired[FieldInputConfig]

Describes the configuration for the default input value to display for a field.

label instance-attribute

label: NotRequired[str]

The label for the field.

position instance-attribute

position: NotRequired[FieldPosition]

Specifies the field position.

validations instance-attribute

validations: NotRequired[ValidationsList]

The validations to perform on the value in the field.