Skip to main content

Check out Port for yourself ➜ 

Text

Text is a basic input for textual information.

Common usage

The text input type can be used for:

  • Service names
  • Version tags
  • Commit SHAs
  • Configuration values
  • Custom messages

Definition

{
"serviceName": {
"title": "Service Name",
"description": "The name of the service",
"type": "string",
"default": "my-service"
}
}

Properties

PropertyTypeDescription
type"string"Required. Must be "string"
format"none" | "multi-line"Optional format. Use "multi-line" for textarea input
defaultstringDefault value
enumstring[]List of allowed values (creates a dropdown)
enumColorsobjectColors for enum values (e.g., {"value": "blue"})

Dynamic default

Use a JQ expression to set a dynamic default:

{
"serviceName": {
"title": "Service Name",
"type": "string",
"default": {
"jqQuery": ".inputs.prefix + \"-service\""
},
"dependsOn": ["prefix"]
}
}