{
  "type": "numericalInput",
  "name": "price",
  "label": "Product Price",
  "prepend": "$",
  "required": true,
  "help": "Enter the price in USD",
  "dependencies": [
    {
      "field": "enable_pricing",
      "value": true
    }
  ]
}
{
  "settings": {
    "price": "99.99",
    "weight": "2.5"
  }
}
The numerical input allows creators to enter numeric values in a dedicated field with optional currency or unit indicators. It’s perfect for collecting prices, quantities, measurements, or any numeric data that benefits from contextual prefixes or suffixes. The input provides a clean interface optimized for numerical data entry. example numerical input

Compatibility

Plugin typeAvailabilityAdditional notes
Content blocks
Media source

Properties

type
string
required
numericalInput - the type of the component
name
string
required
A unique internal-only identifier that is posted to an app’s plugin server to share values inputted by the creator
label
string
required
Creator-facing identifier that is shown in the plugin environment
prepend
string
Text or symbol displayed before the input field (e.g., ”$” for currency). Maximum 5 characters. Cannot be used with append.
append
string
Text or symbol displayed after the input field (e.g., “lbs” for weight). Maximum 5 characters. Cannot be used with prepend.
required
boolean
Determines whether the creator must enter a value before proceeding
help
string
Brief creator-facing explanation that clarifies the component’s purpose and usage. Maximum 64 characters.
dependencies
object array
Allows for the field to be shown conditionally. dependent on other fields. See dependencies page for more details.

Important Notes

  • Either prepend or append must be provided, but not both
  • The placeholder is automatically set to “0” and cannot be customized
  • Input accepts decimal numbers and automatically validates numeric format
{
  "type": "numericalInput",
  "name": "price",
  "label": "Product Price",
  "prepend": "$",
  "required": true,
  "help": "Enter the price in USD",
  "dependencies": [
    {
      "field": "enable_pricing",
      "value": true
    }
  ]
}
{
  "settings": {
    "price": "99.99",
    "weight": "2.5"
  }
}