Module Values.ComponentSource

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.

Sourcetype nonrec t = {
  1. appId : String_.t option;
    (*

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

    *)
  2. environmentName : String_.t option;
    (*

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

    *)
  3. sourceId : String_.t option;
    (*

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

    *)
  4. id : Uuid.t option;
    (*

    The unique ID of the component.

    *)
  5. name : ComponentName.t option;
    (*

    The name of the component.

    *)
  6. componentType : ComponentType.t option;
    (*

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

    *)
  7. properties : ComponentProperties.t option;
    (*

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

    *)
  8. children : ComponentChildList.t option;
    (*

    A list of the component's ComponentChild instances.

    *)
  9. variants : ComponentVariants.t option;
    (*

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

    *)
  10. overrides : ComponentOverrides.t option;
    (*

    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.

    *)
  11. bindingProperties : ComponentBindingProperties.t option;
    (*

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

    *)
  12. collectionProperties : ComponentCollectionProperties.t option;
    (*

    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.

    *)
  13. createdAt : SyntheticTimestamp_date_time.t option;
    (*

    The time that the component was created.

    *)
  14. modifiedAt : SyntheticTimestamp_date_time.t option;
    (*

    The time that the component was modified.

    *)
  15. tags : Tags.t option;
    (*

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

    *)
  16. events : ComponentEvents.t option;
    (*

    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.

    *)
  17. schemaVersion : String_.t option;
    (*

    The schema version of the component when it was imported.

    *)
}
Sourceval make : ?appId:??? -> ?environmentName:??? -> ?sourceId:??? -> ?id:??? -> ?name:??? -> ?componentType:??? -> ?properties:??? -> ?children:??? -> ?variants:??? -> ?overrides:??? -> ?bindingProperties:??? -> ?collectionProperties:??? -> ?createdAt:??? -> ?modifiedAt:??? -> ?tags:??? -> ?events:??? -> ?schemaVersion:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * Awso.Botodata.value) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t