JSONFormInputField
@prismatic-io/spectral › "types/Inputs" › JSONFormInputField
Defines attributes of a JSONFormInputField.
Hierarchy
↳ JSONFormInputField
Index
Properties
Properties
Optional
clean
• clean? : InputCleanFunction‹this["default"]›
Defined in packages/spectral/src/types/Inputs.ts:305
Clean function
Optional
collection
• collection? : InputFieldCollection
Defined in packages/spectral/src/types/Inputs.ts:301
Collection type of the InputField
Optional
comments
• comments? : undefined | string
Inherited from BaseInputField.comments
Defined in packages/spectral/src/types/Inputs.ts:125
Additional text to give guidance to the user configuring the InputField.
Optional
default
• default? : JSONForm
Defined in packages/spectral/src/types/Inputs.ts:303
Default value for this field.
Optional
example
• example? : undefined | string
Inherited from BaseInputField.example
Defined in packages/spectral/src/types/Inputs.ts:127
Example valid input for this InputField.
label
• label: object | string
Inherited from BaseInputField.label
Defined in packages/spectral/src/types/Inputs.ts:121
Interface label of the InputField.
Optional
placeholder
• placeholder? : undefined | string
Inherited from BaseInputField.placeholder
Defined in packages/spectral/src/types/Inputs.ts:123
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:129
Indicate if this InputField is required.
type
• type: "jsonForm"
Defined in packages/spectral/src/types/Inputs.ts:299
Data type the InputField will collect.