Class: TypedBuilder<T>

The builder class to define the metadata property of the form builder component. Used for properties where the property value can be validated.

Extends

• BaseBuilder<T>

Extended by

• ArrayBuilder
• QuantifierBuilder

Type Parameters

• T

the property type.

Constructors

new TypedBuilder()

new TypedBuilder<T>(): TypedBuilder<T>

Returns

TypedBuilder<T>

Inherited from

BaseBuilder.constructor

Properties

annotation

annotation: PreAnnotation

Partial metadata for a component property.

Inherited from

BaseBuilder.annotation

---

options

options: BuilderOptions

Options for building an annotation.

Inherited from

BaseBuilder.options

Accessors

localize

get localize(): this

Returns

this

the component property that can be localized.

Inherited from

BaseBuilder.localize

---

notLocalize

get notLocalize(): this

Returns

this

the non-localizable component property.

Inherited from

BaseBuilder.notLocalize

---

required

get required(): TypedBuilder<NonNullable<T>>

Marks the component property as required.

Returns

TypedBuilder<NonNullable<T>>

the modified instance of the builder.

---

valued

get valued(): this

Returns

this

the main component property that is used as form data and for validation rules.

Inherited from

BaseBuilder.valued

Methods

build()

build(key): Annotation

Creates component property metadata for the form builder.

Parameters

• key: string

the unique key of the component property.

Returns

Annotation

the instance of the component property metadata for the form builder.

Inherited from

BaseBuilder.build

---

calculable()

calculable(calculable): TypedBuilder<T>

Marks the component property as calculable.

Parameters

• calculable: boolean

true if the property is calculable.

Returns

TypedBuilder<T>

the modified instance of the builder.

Inherited from

BaseBuilder.calculable

---

clone()

clone(): this

Clones the instance of the builder.

Returns

this

the cloned instance of the builder.

Inherited from

BaseBuilder.clone

---

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.

---

getName()

protected getName(key): string

Returns the annotation name.

Parameters

• key: string

the property name

Returns

string

the annotation name.

Inherited from

BaseBuilder.getName

---

hideEditor()

hideEditor(): this

Hides the component property editor.

Returns

this

the modified instance of the builder.

Inherited from

BaseBuilder.hideEditor

---

hinted()

hinted(hint): TypedBuilder<T>

Adds the hint to the property name of the component.

Parameters

• hint: ReactNode

the hint.

Returns

TypedBuilder<T>

the modified instance of the builder.

Inherited from

BaseBuilder.hinted

---

named()

named(name): TypedBuilder<T>

Specifies the name of the component property.

Parameters

• name: string

the property name.

Returns

TypedBuilder<T>

the modified instance of the builder.

Inherited from

BaseBuilder.named

---

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

BaseBuilder.setup

---

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.

---

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.

Inherited from

BaseBuilder.withEditorProps