ToggleField.md

sapi-pro

---

sapi-pro / ToggleField

Class: ToggleField

开关

Extends

• ValueField<boolean>

Constructors

Constructor

new ToggleField(label, defaultValue?, tooltip?): ToggleField

Parameters

label

TextType

defaultValue?

boolean = false

tooltip?

TextType

Returns

ToggleField

Overrides

ValueField.constructor

Properties

__optional

protected __optional: boolean = false

Inherited from

ValueField.__optional

---

_key?

protected optional _key?: string

Inherited from

ValueField._key

---

isValueField

readonly isValueField: true = true

Inherited from

ValueField.isValueField

---

validators

protected validators: FieldValidator<boolean>[] = []

Inherited from

ValueField.validators

Accessors

isOptional

Get Signature

get isOptional(): boolean

Returns

boolean

Inherited from

ValueField.isOptional

Methods

build()

build(form, t): void

Parameters

form

ModalFormData

t

UniversalTranslator

Returns

void

Overrides

ValueField.build

---

getKey()

getKey(): string | undefined

Returns

string | undefined

Inherited from

ValueField.getKey

---

key()

key(key): this

Parameters

key

string

Returns

this

Inherited from

ValueField.key

---

optional()

optional(): ToggleField & object

Returns

ToggleField & object

Inherited from

ValueField.optional

---

parse()

parse(raw): boolean

将 UI 原始值解析为目标类型。

• 如果是基础类型错误（如期待数字却得到布尔），抛出对应类型的 ParseError。
• 如果是数值格式错误（如 TextField 输入了非数字），抛出格式 ParseError。

Parameters

raw

ValueType

Returns

boolean

Overrides

ValueField.parse

---

validate()

validate(value): string | LangText | undefined

执行校验链。

• isEmpty 判定：undefined 或空字符串。
• 如果必填且为空，返回 Field_Empty 错误。

Parameters

value

boolean | undefined

Returns

string | LangText | undefined

Inherited from

ValueField.validate

---

validator()

validator(...v): ToggleField

Parameters

v

...FieldValidator<boolean>[]

Returns

ToggleField

Inherited from

ValueField.validator