Class: ContainerAnnotation
Metadata for the component container property for the form builder. The Container property of a component can contain other React components.
Extends
Constructors
Constructor
new ContainerAnnotation(
key
,name
):ContainerAnnotation
Creates metadata for a React component property.
Parameters
key
string
the property name.
name
string
the human-readable property name.
Returns
ContainerAnnotation
Inherited from
Properties
bindingType?
readonly
optional
bindingType:ComponentPropertyBindType
The component property binding type.
Inherited from
calculable
readonly
calculable:boolean
=true
True if the property value can be a calculated property, false otherwise.
Inherited from
dataBindingType
readonly
dataBindingType:DataBindingType
='none'
The type of component data binding.
Inherited from
default?
readonly
optional
default:any
The default property value.
Inherited from
defaultEditor?
optional
defaultEditor:NodeEditorType
The default editor.
disabled
readonly
disabled:boolean
=false
True if the property value controls a disabled flag, false otherwise.
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
insertPredicate()?
optional
insertPredicate: (self
,child
) =>boolean
The function that checks whether a child component can be inserted into a parent component.
Parameters
self
child
Returns
boolean
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
readOnly
readonly
readOnly:boolean
=false
True if the property value controls a read-only flag, false otherwise.
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
uncontrolledValue?
readonly
optional
uncontrolledValue:unknown
The property value for the uncontrolled state.
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.
Inherited from
getNodeEditorType()
getNodeEditorType(
componentProperty?
):NodeEditorType
Returns the node editor type for the component property.
Parameters
componentProperty?
ComponentProperty
<any
>
the component property.
Returns
the node editor type for the component property.