Class: Meta
Component metadata for the form builder.
Constructors
Constructor
new Meta(
type,properties,css,wrapperCss,modules,customPreview?,valuedAn?,initialJson?,eventListeners?,icon?,insertRestriction?):Meta
Creates the component metadata for the form builder.
Parameters
type
string
the component type name.
properties
the component's properties metadata.
css
the component's CSS metadata.
wrapperCss
the component's wrapper CSS metadata.
modules
common metadata for the component.
customPreview?
ReactNode
the custom ReactNode to be drawn on the toolbar.
valuedAn?
the metadata for the component value.
initialJson?
string
the JSON source for the component (instance of ComponentStore class serialised to JSON).
eventListeners?
ComponentMetadataEventListeners
the component metadata event listeners.
icon?
the component icon or the icon name.
string | ComponentType
insertRestriction?
the function that restricts the insertion of a component into another component.
Returns
Meta
Properties
css
readonlycss:Annotation[]
the component's CSS metadata.
customPreview?
readonlyoptionalcustomPreview:ReactNode
Deprecated
The custom ReactNode to be drawn on the toolbar.
eventListeners?
readonlyoptionaleventListeners:ComponentMetadataEventListeners
the component metadata event listeners.
icon?
readonlyoptionalicon:string|ComponentType
the component icon or the icon name.
initialJson?
readonlyoptionalinitialJson:string
the JSON source for the component (instance of ComponentStore class serialised to JSON).
insertRestriction?
readonlyoptionalinsertRestriction:InsertRestrictionFn
the function that restricts the insertion of a component into another component.
modules
readonlymodules:Annotation[]
common metadata for the component.
properties
readonlyproperties:Annotation[]
the component's properties metadata.
type
readonlytype:string
the component type name.
valuedAn?
readonlyoptionalvaluedAn:Annotation
the metadata for the component value.
wrapperCss
readonlywrapperCss:Annotation[]
the component's wrapper CSS metadata.