Skip to main content

TextInputField

@prismatic-io/spectral"types/Inputs"TextInputField

Hierarchy#

Index#

Properties#

Properties#

Optional clean#

clean? : InputCleanFunction‹NonNullable‹this["default"]››

Defined in packages/spectral/src/types/Inputs.ts:134

Clean function


Optional collection#

collection? : InputFieldCollection

Defined in packages/spectral/src/types/Inputs.ts:128

Collection type of the InputField


Optional comments#

comments? : undefined | string

Inherited from BaseInputField.comments

Defined in packages/spectral/src/types/Inputs.ts:91

Additional text to give guidance to the user configuring the InputField.


Optional default#

default? : unknown

Defined in packages/spectral/src/types/Inputs.ts:130

Default value for this field.


Optional example#

example? : undefined | string

Inherited from BaseInputField.example

Defined in packages/spectral/src/types/Inputs.ts:93

Example valid input for this InputField.


label#

label: object | string

Inherited from BaseInputField.label

Defined in packages/spectral/src/types/Inputs.ts:87

Interface label of the InputField.


Optional model#

model? : InputFieldChoice[]

Defined in packages/spectral/src/types/Inputs.ts:132

Dictates possible choices for the input.


Optional placeholder#

placeholder? : undefined | string

Inherited from BaseInputField.placeholder

Defined in packages/spectral/src/types/Inputs.ts:89

Text to show as the InputField placeholder.


Optional required#

required? : undefined | false | true

Inherited from BaseInputField.required

Defined in packages/spectral/src/types/Inputs.ts:95

Indicate if this InputField is required.


type#

type: "text"

Defined in packages/spectral/src/types/Inputs.ts:126

Data type the InputField will collect.