Class: BaseBuilder<T>
The base builder class to define the metadata property of the form builder component.
Extended by
Type Parameters
• T
the property type.
Constructors
new BaseBuilder()
new BaseBuilder<
T>():BaseBuilder<T>
Returns
BaseBuilder<T>
Properties
annotation
annotation:
PreAnnotation
Partial metadata for a component property.
options
options:
BuilderOptions
Options for building an annotation.
Accessors
localize
Get Signature
get localize():
this
Returns
this
the component property that can be localized.
notLocalize
Get Signature
get notLocalize():
this
Returns
this
the non-localizable component property.
valued
Get Signature
get valued():
this
Returns
this
the main component property that is used as form data and for validation rules.
Methods
build()
build(
key):Annotation
Creates component property metadata for the form builder.
Parameters
• key: string
the unique key of the component property.
Returns
the instance of the component property metadata for the form builder.
calculable()
calculable(
calculable):BaseBuilder<T>
Marks the component property as calculable.
Parameters
• calculable: boolean
true if the property is calculable.
Returns
BaseBuilder<T>
the modified instance of the builder.
clone()
clone():
this
Clones the instance of the builder.
Returns
this
the cloned instance of the builder.
getName()
protectedgetName(key):string
Returns the annotation name.
Parameters
• key: string
the property name
Returns
string
the annotation name.
hideEditor()
hideEditor():
this
Hides the component property editor.
Returns
this
the modified instance of the builder.
hinted()
hinted(
hint):BaseBuilder<T>
Adds the hint to the property name of the component.
Parameters
• hint: ReactNode
the hint.
Returns
BaseBuilder<T>
the modified instance of the builder.
named()
named(
name):BaseBuilder<T>
Specifies the name of the component property.
Parameters
• name: string
the property name.
Returns
BaseBuilder<T>
the modified instance of the builder.
setup()
setup(
options):this
Modifies the component property metadata builder with custom options.
Parameters
• options: Partial<Partial<Omit<Annotation, "key">> & Pick<Annotation, "editor"> & BuilderOptions>
the custom options.
Returns
this
the modified instance of the builder.
withEditorProps()
withEditorProps(
props):this
Sets custom properties for the component's property editor.
Parameters
• props: any
the custom properties
Returns
this
the modified instance of the builder.