Class: ModuleAnnotation
Metadata for a component property that is not a property of the component itself, but is supplied by the form builder.
Extends
Constructors
new ModuleAnnotation()
new ModuleAnnotation(
key
,name
):ModuleAnnotation
Creates metadata for a React component property.
Parameters
• key: string
the property name.
• name: string
the human-readable property name.
Returns
Inherited from
Properties
calculable
readonly
calculable:boolean
=true
True if the property value can be a calculated property, false otherwise.
Inherited from
default?
readonly
optional
default:any
The default property value.
Inherited from
editor
readonly
editor:string
The name of the component's property editor.
Inherited from
editorProps?
readonly
optional
editorProps:any
Additional properties for the component property editor.
Inherited from
errorMap?
readonly
optional
errorMap:ErrorMap
Message and/or error code for the validation function.
Inherited from
hint?
readonly
optional
hint:ReactNode
The hint for the component property.
Inherited from
key
readonly
key:string
The component property key.
Inherited from
localizable
readonly
localizable:boolean
=false
True if the property value can be localized, false otherwise.
Inherited from
name
readonly
name:string
The component property name.
Inherited from
required
readonly
required:boolean
=false
True if the component property is required, false otherwise.
Inherited from
slotConditionBuilder()?
readonly
optional
slotConditionBuilder: (props
) =>string
A function that returns a string containing the source code of the function to bind child components.
Parameters
• props: any
the properties of the component, which are available only inside Form Builder Designer.
Returns
string
Inherited from
Annotation
.slotConditionBuilder
type?
readonly
optional
type: keyof SchemaTypeMap
The data type for the value of the property.
Inherited from
validator?
readonly
optional
validator:RuleValidator
The function for validating the property value.
Inherited from
valued
readonly
valued:boolean
=false
True if the property value is bound to form data, false otherwise.
Inherited from
Methods
clone()
clone():
any
Returns
any
the metadata clone.