CreateComponentData
import type { CreateComponentData } from "https://aws-api.deno.dev/v0.3/services/amplifyuibuilder.ts?docs=full";
Represents all of the information that is required to create a component.
interface CreateComponentData {
bindingProperties: {};
[key: string]: ComponentBindingPropertiesValue | null | undefined;
children?: ComponentChild[] | null;
collectionProperties?: {} | null;
[key: string]: ComponentDataConfiguration | null | undefined;
componentType: string;
name: string;
overrides: {};
[key: string]: {} | null | undefined;
[key: string]: string | null | undefined;
properties: {};
[key: string]: ComponentProperty | null | undefined;
sourceId?: string | null;
tags?: {} | null;
[key: string]: string | null | undefined;
variants: ComponentVariant[];
}§Properties
§
bindingProperties: {}
[src][key: string]: ComponentBindingPropertiesValue | null | undefined;
The data binding information for the component's properties.
§
children?: ComponentChild[] | null
[src]A list of child components that are instances of the main component.
§
collectionProperties?: {} | null
[src][key: string]: ComponentDataConfiguration | null | undefined;
The data binding configuration for customizing a component's properties. Use this for a collection component.
§
componentType: string
[src]The component type. This can be an Amplify custom UI component or another custom component.
§
overrides: {}
[src][key: string]: {} | null | undefined;
[key: string]: string | null | undefined;
Describes the component properties that can be overriden to customize an instance of the component.
§
properties: {}
[src][key: string]: ComponentProperty | null | undefined;
Describes the component's properties.
§
sourceId?: string | null
[src]The unique ID of the component in its original source system, such as Figma.
§
tags?: {} | null
[src][key: string]: string | null | undefined;
One or more key-value pairs to use when tagging the component data.
§
variants: ComponentVariant[]
[src]A list of the unique variants of this component.