Class: PropertyAnnotation
@react-form-builder/core.PropertyAnnotation
Metadata for the component property for the form builder.
Hierarchy
↳
PropertyAnnotation
Constructors
constructor
• new PropertyAnnotation(key, name)
Creates metadata for a React component property.
Parameters
| Name | Type | Description |
|---|---|---|
key | string | the property name. |
name | string | the human-readable property name. |
Inherited from
Properties
calculable
• Readonly calculable: boolean = true
True if the property value can be a calculated property, false otherwise.
Inherited from
data
• data: LabeledValue[]
Possible values for the property.
default
• Optional Readonly default: any
The default property value.
Inherited from
editor
• Readonly editor: string
The name of the component's property editor.
Inherited from
editorProps
• Optional Readonly editorProps: any
Additional properties for the component property editor.
Inherited from
errorMap
• Optional Readonly errorMap: ErrorMap
Message and/or error code for the validation function.
Inherited from
hint
• Optional Readonly 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
• Optional Readonly slotConditionBuilder: (props: any) => string
Type declaration
▸ (props): string
A function that returns a string containing the source code of the function to bind child components.
Parameters
| Name | Type | Description |
|---|---|---|
props | any | the properties of the component, which are available only inside Form Builder Designer. |
Returns
string
Inherited from
Annotation.slotConditionBuilder
type
• Optional Readonly type: keyof SchemaTypeMap
The data type for the value of the property.
Inherited from
validator
• Optional Readonly 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.