Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Component

import type { Component } from "https://aws-api.deno.dev/v0.3/services/amplifyuibuilder.ts?docs=full";

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.

interface Component {

appId: string;

bindingProperties: {

[key: string]: ComponentBindingPropertiesValue | null | undefined;

};

children?: ComponentChild[] | null;

collectionProperties?: {

[key: string]: ComponentDataConfiguration | null | undefined;

} | null;

componentType: string;

createdAt: Date | number;

environmentName: string;

id: string;

modifiedAt?: Date | number | null;

name: string;

overrides: {

[key: string]: {

[key: string]: string | null | undefined;

} | null | undefined;

};

properties: {

[key: string]: ComponentProperty | null | undefined;

};

sourceId?: string | null;

tags?: {

[key: string]: string | null | undefined;

} | null;

variants: ComponentVariant[];

}

§Properties

appId: string

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

bindingProperties: {

[key: string]: ComponentBindingPropertiesValue | null | undefined;

}

The information to connect a component's properties to data at runtime.

children?: ComponentChild[] | null

A list of the component's ComponentChild instances.

collectionProperties?: {

[key: string]: ComponentDataConfiguration | null | undefined;

} | null

The data binding configuration for the component's properties. Use this for a collection component.

componentType: string

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

createdAt: Date | number

The time that the component was created.

environmentName: string

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

id: string

The unique ID of the component.

modifiedAt?: Date | number | null

The time that the component was modified.

name: string

The name of the component.

overrides: {

[key: string]: {

[key: string]: string | null | undefined;

} | null | undefined;

}

Describes the component's properties that can be overriden in a customized instance of the component.

properties: {

[key: string]: ComponentProperty | null | undefined;

}

Describes the component's properties.

sourceId?: string | null

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

tags?: {

[key: string]: string | null | undefined;

} | null

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

variants: ComponentVariant[]

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