Skip to content

FieldInputConfig

Source code in docs_src/capo_amplifyuibuilder/types/field_input_config.py
class FieldInputConfig(TypedDict, closed=True):
    type: "str"
    """<p>The input type for the field. </p>"""
    required: NotRequired["bool"]
    """<p>Specifies a field that requires input.</p>"""
    read_only: NotRequired["bool"]
    """<p>Specifies a read only field.</p>"""
    placeholder: NotRequired["str"]
    """<p>The text to display as a placeholder for the field.</p>"""
    default_value: NotRequired["str"]
    """<p>The default value for the field.</p>"""
    descriptive_text: NotRequired["str"]
    """<p>The text to display to describe the field.</p>"""
    default_checked: NotRequired["bool"]
    """<p>Specifies whether a field has a default value.</p>"""
    default_country_code: NotRequired["str"]
    """<p>The default country code for a phone number.</p>"""
    value_mappings: NotRequired[
        "capo_amplifyuibuilder.types.value_mappings.ValueMappings"
    ]
    """<p>The information to use to customize the input fields with data at runtime.</p>"""
    name: NotRequired["str"]
    """<p>The name of the field.</p>"""
    min_value: NotRequired["float"]
    """<p>The minimum value to display for the field.</p>"""
    max_value: NotRequired["float"]
    """<p>The maximum value to display for the field.</p>"""
    step: NotRequired["float"]
    """<p>The stepping increment for a numeric value in a field.</p>"""
    value: NotRequired["str"]
    """<p>The value for the field.</p>"""
    is_array: NotRequired["bool"]
    """<p>Specifies whether to render the field as an array. This property is ignored if the <code>dataSourceType</code> for the form is a Data Store.</p>"""
    file_uploader_config: NotRequired[
        "capo_amplifyuibuilder.types.file_uploader_field_config.FileUploaderFieldConfig"
    ]
    """<p>The configuration for the file uploader field.</p>"""

default_checked instance-attribute

default_checked: NotRequired[bool]

Specifies whether a field has a default value.

default_country_code instance-attribute

default_country_code: NotRequired[str]

The default country code for a phone number.

default_value instance-attribute

default_value: NotRequired[str]

The default value for the field.

descriptive_text instance-attribute

descriptive_text: NotRequired[str]

The text to display to describe the field.

file_uploader_config instance-attribute

file_uploader_config: NotRequired[FileUploaderFieldConfig]

The configuration for the file uploader field.

is_array instance-attribute

is_array: NotRequired[bool]

Specifies whether to render the field as an array. This property is ignored if the dataSourceType for the form is a Data Store.

max_value instance-attribute

max_value: NotRequired[float]

The maximum value to display for the field.

min_value instance-attribute

min_value: NotRequired[float]

The minimum value to display for the field.

name instance-attribute

name: NotRequired[str]

The name of the field.

placeholder instance-attribute

placeholder: NotRequired[str]

The text to display as a placeholder for the field.

read_only instance-attribute

read_only: NotRequired[bool]

Specifies a read only field.

required instance-attribute

required: NotRequired[bool]

Specifies a field that requires input.

step instance-attribute

step: NotRequired[float]

The stepping increment for a numeric value in a field.

type instance-attribute

type: str

The input type for the field.

value instance-attribute

value: NotRequired[str]

The value for the field.

value_mappings instance-attribute

value_mappings: NotRequired[ValueMappings]

The information to use to customize the input fields with data at runtime.