StringInputField

@prismatic-io/spectral › "types/Inputs" › StringInputField

Hierarchy

• BaseInputField

  ↳ StringInputField

Index

Properties

• clean
• collection
• comments
• default
• example
• label
• model
• placeholder
• required
• type

Properties

Optional clean

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

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

Clean function

---

Optional collection

• collection? : InputFieldCollection

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

Collection type of the InputField

---

Optional comments

• comments? : undefined | string

Inherited from BaseInputField.comments

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

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

---

Optional default

• default? : unknown

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

Default value for this field.

---

Optional example

• example? : undefined | string

Inherited from BaseInputField.example

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

Example valid input for this InputField.

---

label

• label: object | string

Inherited from BaseInputField.label

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

Interface label of the InputField.

---

Optional model

• model? : InputFieldChoice[]

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

Dictates possible choices for the input.

---

Optional placeholder

• placeholder? : undefined | string

Inherited from BaseInputField.placeholder

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

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:109

Indicate if this InputField is required.

---

type

• type: "string"

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

Data type the InputField will collect.