getDataDefinitions()

Retrieves the data field definitions declared in the selected component's manifest.

Each key in the result is a valid dataItemKey for getData(), setData(), and getResolvedData().

Syntax

Copy

Returns

Promise<ElementDataDefinitions>

An object mapping each data field's key to its definition. Each definition can include:

PropertyTypeDescription
dataTypestringThe data type declared in the manifest, such as 'text', 'image', or 'booleanValue'.
displayNamestringThe label for the field in auto panels.
defaultValueanyThe default value declared in the manifest for this field.

Example

Copy

See also

Last updated: 8 September 2026

Did this help?