Class: ArrayBuilder<T>
The builder class to define the metadata property of the form builder component. Used for properties where the property value is an array.
Extends
TypedBuilder<T>
Type Parameters
• T
the property type.
Constructors
new ArrayBuilder()
new ArrayBuilder<
T>():ArrayBuilder<T>
Returns
ArrayBuilder<T>
Inherited from
Properties
annotation
annotation:
PreAnnotation
Partial metadata for a component property.
Inherited from
options
options:
BuilderOptions
Options for building an annotation.
Inherited from
subType?
optionalsubType: keyof SchemaTypeMap
Accessors
localize
Get Signature
get localize():
this
Returns
this
the component property that can be localized.
Inherited from
notLocalize
Get Signature
get notLocalize():
this
Returns
this
the non-localizable component property.
Inherited from
ofObject
Get Signature
get ofObject():
ArrayBuilder<undefined|object[]>
Sets the component's value type to an array of objects.
Returns
ArrayBuilder<undefined | object[]>
the modified instance of the builder.
ofString
Get Signature
get ofString():
ArrayBuilder<undefined|string[]>
Sets the component's value type to an array of strings.
Returns
ArrayBuilder<undefined | string[]>
the modified instance of the builder.
required
Get Signature
get required():
TypedBuilder<NonNullable<T>>
Marks the component property as required.
Returns
TypedBuilder<NonNullable<T>>
the modified instance of the builder.
Inherited from
valued
Get Signature
get valued():
this
Returns
this
the main component property that is used as form data and for validation rules.
Inherited from
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.
Inherited from
calculable()
calculable(
calculable):ArrayBuilder<T>
Marks the component property as calculable.
Parameters
• calculable: boolean
true if the property is calculable.
Returns
ArrayBuilder<T>
the modified instance of the builder.
Inherited from
clone()
clone():
this
Clones the instance of the builder.
Returns
this
the cloned instance of the builder.
Inherited from
default()
default(
value):this
Sets the default value for the component property.
Parameters
• value: T
the default value.
Returns
this
the modified instance of the builder.
Inherited from
getName()
protectedgetName(key):string
Returns the annotation name.
Parameters
• key: string
the property name
Returns
string
the annotation name.
Inherited from
hideEditor()
hideEditor():
this
Hides the component property editor.
Returns
this
the modified instance of the builder.
Inherited from
hinted()
hinted(
hint):ArrayBuilder<T>
Adds the hint to the property name of the component.
Parameters
• hint: ReactNode
the hint.
Returns
ArrayBuilder<T>
the modified instance of the builder.
Inherited from
named()
named(
name):ArrayBuilder<T>
Specifies the name of the component property.
Parameters
• name: string
the property name.
Returns
ArrayBuilder<T>
the modified instance of the builder.
Inherited from
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.
Inherited from
uncontrolledValue()
uncontrolledValue(
uncontrolledValue):ArrayBuilder<T>
Sets the value for the property that prevents uncontrolled state.
Parameters
• uncontrolledValue: unknown
the value for the uncontrolled state.
Returns
ArrayBuilder<T>
the modified instance of the builder.
Inherited from
TypedBuilder.uncontrolledValue
validated()
validated(
validator,errorMap):this
Modifies the component property metadata builder with validation properties.
Parameters
• validator: RuleValidator<T>
the validation function.
• errorMap: ErrorMap
the validation error settings.
Returns
this
the modified instance of the builder.
Inherited from
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.