Class: ConfigFormBuilder

Helper class that provides a Builder-style interface for generating a UserConfigurable ConfigForm

Table of contents

Constructors

• constructor

Methods

• booleanField
• build
• numberField
• textField
• textarea

Constructors

constructor

• new ConfigFormBuilder()

Methods

booleanField

▸ booleanField(key, label, currentValue?): ConfigFormBuilder

Add a BOOLEAN parameter to the configuration

Parameters

Name	Type	Default value
key	string	undefined
label	string	undefined
currentValue	boolean	false

Returns

ConfigFormBuilder

---

build

▸ build(): ConfigForm

Returns the constructed ConfigForm

Returns

ConfigForm

---

numberField

▸ numberField(key, label, currentValue?): ConfigFormBuilder

Add a NUMBER parameter to the configuration

Parameters

Name	Type	Default value
key	string	undefined
label	string	undefined
currentValue	number	0

Returns

ConfigFormBuilder

---

textField

▸ textField(key, label, currentValue?): ConfigFormBuilder

Add a STRING parameter to the configuration (single-line string)

Parameters

Name	Type	Default value
key	string	undefined
label	string	undefined
currentValue	string	''

Returns

ConfigFormBuilder

---

textarea

▸ textarea(key, label, currentValue?): ConfigFormBuilder

Add a PARAGRAPH parameter to the configuration (multi-line string)

Parameters

Name	Type	Default value
key	string	undefined
label	string	undefined
currentValue	string	''

Returns

ConfigFormBuilder