Class: Meta

Component metadata for the form builder.

Constructors

Constructor

new Meta(type, properties, css, wrapperCss, modules, customPreview?, valuedAn?, kind?, initialJson?, eventListeners?, icon?, insertRestriction?): Meta

Creates the component metadata for the form builder.

Parameters

type

string

the component type name.

properties

Annotation[]

the component's properties metadata.

css

Annotation[]

the component's CSS metadata.

wrapperCss

Annotation[]

the component's wrapper CSS metadata.

modules

Annotation[]

common metadata for the component.

customPreview?

ReactNode

the custom ReactNode to be drawn on the toolbar.

valuedAn?

Annotation

the metadata for the component value.

kind?

ComponentKind = 'component'

the component kind.

initialJson?

string

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

eventListeners?

ComponentMetadataEventListeners

the component metadata event listeners.

icon?

ComponentType

the component icon.

insertRestriction?

InsertRestrictionFn

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

Returns

Meta

Properties

css

readonly css: Annotation[]

the component's CSS metadata.

---

customPreview?

readonly optional customPreview: ReactNode

the custom ReactNode to be drawn on the toolbar.

---

eventListeners?

readonly optional eventListeners: ComponentMetadataEventListeners

the component metadata event listeners.

---

icon?

readonly optional icon: ComponentType

the component icon.

---

initialJson?

readonly optional initialJson: string

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

---

insertRestriction?

readonly optional insertRestriction: InsertRestrictionFn

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

---

kind

readonly kind: ComponentKind

Deprecated

the component kind. Use the Model.kind.

---

modules

readonly modules: Annotation[]

common metadata for the component.

---

properties

readonly properties: Annotation[]

the component's properties metadata.

---

type

readonly type: string

the component type name.

---

valuedAn?

readonly optional valuedAn: Annotation

the metadata for the component value.

---

wrapperCss

readonly wrapperCss: Annotation[]

the component's wrapper CSS metadata.