Core API Overview > @adpt/core > AdaptElement
AdaptElement interface
An Adapt Element is an instance of an Adapt component.
Signature:
export interface AdaptElement<P extends object = AnyProps>
Remarks
The Adapt DOM is composed of Elements.
Properties
Property | Type | Description |
---|---|---|
componentName | string | The name of the class or function in AdaptElement.componentType, as returned by componentType.name or, the string "anonymous" if no name is available. |
componentType | ComponentType <P> | The type of component that is associated with this element. |
displayName | string | The name that a component author (optionally) associated with the component using the displayName static property. If not set on a component, defaults to AdaptElement.componentName. |
props | P & BuiltinProps | A copy of the props that the element was instantiated with |
Methods
Method | Description |
---|---|
addDependency(dependencies) | Adds a dependency for this Element. This Element will wait to deploy until all dependencies have completed deployment. |