Type Alias: DefinerData<T>

DefinerData<T> = object

Definer class data.

Type Parameters

T

T extends object

React component property type.

Properties

actionsInitializer?

readonly optional actionsInitializer: ActionsInitializer

The function that initializes an actions on a component (for internal use only).

---

category?

optional category: string

The component category.

---

component

readonly component: ComponentType<T>

The React component.

---

cssObject?

optional cssObject: Annotations<CSSObject>

The component CSS metadata.

---

customPreview?

optional customPreview: ReactNode

Deprecated

The custom component to display in the component list (unused).

---

eventListeners?

optional eventListeners: ComponentMetadataEventListeners

The component metadata event listeners.

---

features?

optional features: ComponentFeatures

The set of component features.

---

icon?

optional icon: ComponentType | string

The component icon or the icon name.

---

initialJson?

optional initialJson: string

The JSON source for the component (instance of ComponentStore class serialised to JSON).

---

insertRestriction?

optional insertRestriction: InsertRestrictionFn

The function that restricts the insertion of a component into another component.

---

kind?

optional kind: ComponentKind

The component kind.

---

name?

optional name: string

The component name.

---

properties?

optional properties: Annotations<T>

The property metadata.

---

typeName?

optional typeName: string

The component type name.

---

wrapperCssObject?

optional wrapperCssObject: Annotations<CSSObject>

The wrapper CSS metadata.