Skip to main content

Introducing Workflow Engine, try for FREE workflowengine.io.

Class: PropertyAnnotation

@react-form-builder/core.PropertyAnnotation

Metadata for the component property for the form builder.

Hierarchy

Constructors

constructor

new PropertyAnnotation(key, name)

Creates metadata for a React component property.

Parameters

NameTypeDescription
keystringthe property name.
namestringthe human-readable property name.

Inherited from

Annotation.constructor

Properties

calculable

Readonly calculable: boolean = true

True if the property value can be a calculated property, false otherwise.

Inherited from

Annotation.calculable


data

data: LabeledValue[]

Possible values for the property.


default

Optional Readonly default: any

The default property value.

Inherited from

Annotation.default


editor

Readonly editor: string

The name of the component's property editor.

Inherited from

Annotation.editor


editorProps

Optional Readonly editorProps: any

Additional properties for the component property editor.

Inherited from

Annotation.editorProps


errorMap

Optional Readonly errorMap: ErrorMap

Message and/or error code for the validation function.

Inherited from

Annotation.errorMap


hint

Optional Readonly hint: ReactNode

The hint for the component property.

Inherited from

Annotation.hint


key

Readonly key: string

The component property key.

Inherited from

Annotation.key


localizable

Readonly localizable: boolean = false

True if the property value can be localized, false otherwise.

Inherited from

Annotation.localizable


name

Readonly name: string

The component property name.

Inherited from

Annotation.name


required

Readonly required: boolean = false

True if the component property is required, false otherwise.

Inherited from

Annotation.required


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
NameTypeDescription
propsanythe 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

Annotation.type


validator

Optional Readonly validator: RuleValidator

The function for validating the property value.

Inherited from

Annotation.validator


valued

Readonly valued: boolean = false

True if the property value is bound to form data, false otherwise.

Inherited from

Annotation.valued

Methods

clone

clone(): any

Returns

any

the metadata clone.

Inherited from

Annotation.clone