Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Component

Contains the configuration settings for a user interface (UI) element for an Amplify app. A component is configured as a primary, stand-alone UI element. Use ComponentChild to configure an instance of a Component. A ComponentChild instance inherits the configuration of the main Component.

Hierarchy

  • Component

Index

Properties

appId

appId: string | undefined

The unique ID of the Amplify app associated with the component.

bindingProperties

bindingProperties: Record<string, ComponentBindingPropertiesValue> | undefined

The information to connect a component's properties to data at runtime. You can't specify tags as a valid property for bindingProperties.

Optional children

children: ComponentChild[]

A list of the component's ComponentChild instances.

Optional collectionProperties

collectionProperties: Record<string, ComponentDataConfiguration>

The data binding configuration for the component's properties. Use this for a collection component. You can't specify tags as a valid property for collectionProperties.

componentType

componentType: string | undefined

The type of the component. This can be an Amplify custom UI component or another custom component.

createdAt

createdAt: Date | undefined

The time that the component was created.

environmentName

environmentName: string | undefined

The name of the backend environment that is a part of the Amplify app.

Optional events

events: Record<string, ComponentEvent>

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

id

id: string | undefined

The unique ID of the component.

Optional modifiedAt

modifiedAt: Date

The time that the component was modified.

name

name: string | undefined

The name of the component.

overrides

overrides: Record<string, Record<string, string>> | undefined

Describes the component's properties that can be overriden in a customized instance of the component. You can't specify tags as a valid property for overrides.

properties

properties: Record<string, ComponentProperty> | undefined

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

Optional schemaVersion

schemaVersion: undefined | string

The schema version of the component when it was imported.

Optional sourceId

sourceId: undefined | string

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

Optional tags

tags: Record<string, string>

One or more key-value pairs to use when tagging the component.

variants

variants: ComponentVariant[] | undefined

A list of the component's variants. A variant is a unique style configuration of a main component.