ConditionalInputField

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

Defines attributes of a ConditionalInputField.

Hierarchy

• BaseInputField

  ↳ ConditionalInputField

Index

Properties

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

Properties

Optional clean

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

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

Clean function

---

collection

• collection: InputFieldCollection

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

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? : ConditionalExpression

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

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 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: "conditional"

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

Data type the InputField will collect.