Skip to main content

CodeInputField

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

Defines attributes of a CodeInputField.

Hierarchy

Index

Properties

Properties

Optional clean

clean? : InputCleanFunction‹this["default"]

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

Clean function


Optional collection

collection? : InputFieldCollection

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

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

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.


language

language: "css" | "graphql" | "handlebars" | "hcl" | "html" | "javascript" | "json" | "liquid" | "markdown" | "mysql" | "pgsql" | "plaintext" | "sql" | "typescript" | "xml" | "yaml"

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

Code language for syntax highlighting. For no syntax highlighting, choose "plaintext"


Optional model

model? : InputFieldChoice[]

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

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

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

Data type the InputField will collect.