@vttforge/core / StringFieldOptions

Interface: StringFieldOptions

Properties shared by every Foundry data field option object.

Mirrors the base DataFieldOptions interface documented at https://foundryvtt.com/api/classes/foundry.data.fields.DataField.html.

Extends

• DataFieldOptions

Extended by

• FilePathFieldOptions

Properties

blank?

readonly optional blank?: boolean

---

choices?

readonly optional choices?: readonly string[] | Record<string, string>

---

gmOnly?

readonly optional gmOnly?: boolean

Inherited from

DataFieldOptions.gmOnly

---

hint?

readonly optional hint?: string

Inherited from

DataFieldOptions.hint

---

initial?

readonly optional initial?: unknown

Inherited from

DataFieldOptions.initial

---

label?

readonly optional label?: string

Inherited from

DataFieldOptions.label

---

nullable?

readonly optional nullable?: boolean

Inherited from

DataFieldOptions.nullable

---

readonly?

readonly optional readonly?: boolean

Inherited from

DataFieldOptions.readonly

---

required?

readonly optional required?: boolean

Inherited from

DataFieldOptions.required

---

textSearch?

readonly optional textSearch?: boolean

---

trim?

readonly optional trim?: boolean

---

validate?

readonly optional validate?: (value) => boolean | undefined

Parameters

value

unknown

Returns

boolean | undefined

Inherited from

DataFieldOptions.validate

---

validationError?

readonly optional validationError?: string

Inherited from

DataFieldOptions.validationError