TextInputItem.json

{
  "$id" : "https://sage-bionetworks.github.io/mobile-client-json/schemas/v2/TextInputItem.json",
  "$schema" : "http://json-schema.org/draft-07/schema#",
  "type" : "object",
  "title" : "TextInputItem",
  "description" : "A `TextInputItem` describes input entry that is freeform with ranges and validation. Typically, this is presented as a text field, but depending upon the requirements of the survey designer, it may use a slider, Likert scale, date picker, or other custom UI/UX to allow for validation of the entered value.",
  "definitions" : {
    "DoubleFormatOptions" : {
      "$id" : "#DoubleFormatOptions",
      "type" : "object",
      "title" : "DoubleFormatOptions",
      "description" : "",
      "properties" : {
        "numberStyle" : {
          "$ref" : "#/definitions/NumberFormatStyle"
        },
        "usesGroupingSeparator" : {
          "type" : "boolean"
        },
        "maximumFractionDigits" : {
          "type" : "integer"
        },
        "minimumValue" : {
          "type" : "number"
        },
        "maximumValue" : {
          "type" : "number"
        },
        "stepInterval" : {
          "type" : "number"
        },
        "minInvalidMessage" : {
          "type" : "string"
        },
        "maxInvalidMessage" : {
          "type" : "string"
        },
        "invalidMessage" : {
          "type" : "string"
        },
        "minimumLabel" : {
          "type" : "string"
        },
        "maximumLabel" : {
          "type" : "string"
        }
      },
      "examples" : [
        {

        },
        {
          "numberStyle" : "currency",
          "usesGroupingSeparator" : false,
          "maximumFractionDigits" : 2,
          "minimumValue" : 0,
          "maximumValue" : 200,
          "stepInterval" : 0.01,
          "minInvalidMessage" : "Minimum value is zero",
          "maxInvalidMessage" : "Maximum value is $200",
          "invalidMessage" : "This number is not valid"
        }
      ]
    },
    "DoubleTextInputItemObject" : {
      "$id" : "#DoubleTextInputItemObject",
      "type" : "object",
      "title" : "DoubleTextInputItemObject",
      "description" : "",
      "properties" : {
        "type" : {
          "const" : "number"
        },
        "formatOptions" : {
          "$ref" : "#/definitions/DoubleFormatOptions",
          "description" : "The formatting and range options to use with input item."
        }
      },
      "required" : [
        "type"
      ],
      "allOf" : [
        {
          "$ref" : "#"
        }
      ],
      "examples" : [
        {
          "type" : "number"
        }
      ]
    },
    "DurationTextInputItemObject" : {
      "$id" : "#DurationTextInputItemObject",
      "type" : "object",
      "title" : "DurationTextInputItemObject",
      "description" : "",
      "properties" : {
        "type" : {
          "const" : "number"
        },
        "displayUnits" : {
          "type" : "array",
          "description" : "The display units to show for duration.",
          "items" : {
            "$ref" : "AnswerType.json#DurationUnit"
          }
        }
      },
      "required" : [
        "type"
      ],
      "allOf" : [
        {
          "$ref" : "#"
        }
      ],
      "examples" : [
        {
          "type" : "duration"
        }
      ]
    },
    "IntegerFormatOptions" : {
      "$id" : "#IntegerFormatOptions",
      "type" : "object",
      "title" : "IntegerFormatOptions",
      "description" : "",
      "properties" : {
        "numberStyle" : {
          "$ref" : "#/definitions/NumberFormatStyle"
        },
        "usesGroupingSeparator" : {
          "type" : "boolean"
        },
        "minimumValue" : {
          "type" : "integer"
        },
        "maximumValue" : {
          "type" : "integer"
        },
        "stepInterval" : {
          "type" : "integer"
        },
        "minInvalidMessage" : {
          "type" : "string"
        },
        "maxInvalidMessage" : {
          "type" : "string"
        },
        "invalidMessage" : {
          "type" : "string"
        },
        "minimumLabel" : {
          "type" : "string"
        },
        "maximumLabel" : {
          "type" : "string"
        }
      },
      "examples" : [
        {

        },
        {
          "numberStyle" : "currency",
          "usesGroupingSeparator" : false,
          "minimumValue" : 0,
          "maximumValue" : 200,
          "stepInterval" : 5,
          "minInvalidMessage" : "Minimum value is zero",
          "maxInvalidMessage" : "Maximum value is $200",
          "invalidMessage" : "This number is not valid"
        }
      ]
    },
    "IntegerTextInputItemObject" : {
      "$id" : "#IntegerTextInputItemObject",
      "type" : "object",
      "title" : "IntegerTextInputItemObject",
      "description" : "",
      "properties" : {
        "type" : {
          "const" : "integer"
        },
        "formatOptions" : {
          "$ref" : "#/definitions/IntegerFormatOptions",
          "description" : "The formatting and range options to use with input item."
        }
      },
      "required" : [
        "type"
      ],
      "allOf" : [
        {
          "$ref" : "#"
        }
      ],
      "examples" : [
        {
          "type" : "integer"
        }
      ]
    },
    "KeyboardOptionsObject" : {
      "$id" : "#KeyboardOptionsObject",
      "type" : "object",
      "title" : "KeyboardOptionsObject",
      "description" : "",
      "properties" : {
        "isSecureTextEntry" : {
          "type" : "boolean",
          "default" : false
        },
        "autocapitalizationType" : {
          "$ref" : "#/definitions/TextAutoCapitalizationType"
        },
        "autocorrectionType" : {
          "$ref" : "#/definitions/TextAutoCorrectionType"
        },
        "spellCheckingType" : {
          "$ref" : "#/definitions/TextSpellCheckingType"
        },
        "keyboardType" : {
          "$ref" : "#/definitions/KeyboardType"
        }
      },
      "examples" : [
        {

        },
        {
          "isSecureTextEntry" : false,
          "autocapitalizationType" : "none",
          "autocorrectionType" : "no",
          "spellCheckingType" : "no",
          "keyboardType" : "decimalPad"
        }
      ]
    },
    "KeyboardType" : {
      "$id" : "#KeyboardType",
      "type" : "string",
      "title" : "KeyboardType",
      "description" : "",
      "enum" : [
        "default",
        "asciiCapable",
        "numbersAndPunctuation",
        "URL",
        "numberPad",
        "phonePad",
        "namePhonePad",
        "emailAddress",
        "decimalPad",
        "twitter",
        "webSearch",
        "asciiCapableNumberPad"
      ]
    },
    "NumberFormatStyle" : {
      "$id" : "#NumberFormatStyle",
      "type" : "string",
      "title" : "NumberFormatStyle",
      "description" : "",
      "enum" : [
        "none",
        "decimal",
        "currency",
        "percent",
        "scientific",
        "spellOut",
        "ordinal"
      ]
    },
    "RegExValidator" : {
      "$id" : "#RegExValidator",
      "type" : "object",
      "title" : "RegExValidator",
      "description" : "",
      "properties" : {
        "pattern" : {
          "type" : "string",
          "description" : "The string value must be a valid a regex pattern."
        },
        "invalidMessage" : {
          "type" : "string",
          "description" : "The invalid message is the localized message to display to the participant if the text entered is invalid."
        }
      },
      "required" : [
        "pattern",
        "invalidMessage"
      ],
      "examples" : [
        {
          "pattern" : "^[0-9]*$",
          "invalidMessage" : "Only entering numbers is allowed."
        }
      ]
    },
    "StringTextInputItemObject" : {
      "$id" : "#StringTextInputItemObject",
      "type" : "object",
      "title" : "StringTextInputItemObject",
      "description" : "",
      "properties" : {
        "type" : {
          "const" : "string"
        },
        "keyboardOptions" : {
          "$ref" : "#/definitions/KeyboardOptionsObject",
          "description" : "The keyboard options to use with this text field."
        },
        "regExValidator" : {
          "$ref" : "#/definitions/RegExValidator",
          "description" : "The regex validator to use to validate this text field."
        },
        "characterLimit" : {
          "type" : "integer",
          "description" : "The character limit for text entry."
        }
      },
      "required" : [
        "type"
      ],
      "allOf" : [
        {
          "$ref" : "#"
        }
      ],
      "examples" : [
        {
          "type" : "string"
        }
      ]
    },
    "TextAutoCapitalizationType" : {
      "$id" : "#TextAutoCapitalizationType",
      "type" : "string",
      "title" : "TextAutoCapitalizationType",
      "description" : "",
      "enum" : [
        "none",
        "words",
        "sentences",
        "allCharacters"
      ]
    },
    "TextAutoCorrectionType" : {
      "$id" : "#TextAutoCorrectionType",
      "type" : "string",
      "title" : "TextAutoCorrectionType",
      "description" : "",
      "enum" : [
        "default",
        "no",
        "yes"
      ]
    },
    "TextInputType" : {
      "$id" : "#TextInputType",
      "type" : "string",
      "title" : "TextInputType",
      "description" : "",
      "enum" : [
        "number",
        "integer",
        "string",
        "year",
        "duration",
        "time"
      ]
    },
    "TextSpellCheckingType" : {
      "$id" : "#TextSpellCheckingType",
      "type" : "string",
      "title" : "TextSpellCheckingType",
      "description" : "",
      "enum" : [
        "default",
        "no",
        "yes"
      ]
    },
    "TimeFormatOptions" : {
      "$id" : "#TimeFormatOptions",
      "type" : "object",
      "title" : "TimeFormatOptions",
      "description" : "",
      "properties" : {
        "allowFuture" : {
          "type" : "boolean",
          "description" : "Should this time range allow times that occur in the future? (ie. later today)"
        },
        "allowPast" : {
          "type" : "boolean",
          "description" : "Should this time range allow times that occured in the past? (ie. earlier today)"
        },
        "minimumValue" : {
          "type" : "string",
          "description" : "Should this time range be timeboxed to have a minimum time of day?",
          "format" : "time"
        },
        "maximumValue" : {
          "type" : "string",
          "description" : "Should this time range be timeboxed to have a maximum time of day?",
          "format" : "time"
        }
      },
      "examples" : [
        {

        },
        {
          "allowFuture" : false
        },
        {
          "allowPast" : false
        },
        {
          "minimumValue" : "06:00:00.000",
          "maximumValue" : "10:30:00.000"
        }
      ]
    },
    "TimeTextInputItemObject" : {
      "$id" : "#TimeTextInputItemObject",
      "type" : "object",
      "title" : "TimeTextInputItemObject",
      "description" : "",
      "properties" : {
        "type" : {
          "const" : "year"
        },
        "formatOptions" : {
          "$ref" : "#/definitions/TimeFormatOptions",
          "description" : "The formatting and range options to use with input item."
        }
      },
      "required" : [
        "type"
      ],
      "allOf" : [
        {
          "$ref" : "#"
        }
      ],
      "examples" : [
        {
          "type" : "time"
        }
      ]
    },
    "YearFormatOptions" : {
      "$id" : "#YearFormatOptions",
      "type" : "object",
      "title" : "YearFormatOptions",
      "description" : "",
      "properties" : {
        "allowFuture" : {
          "type" : "boolean"
        },
        "allowPast" : {
          "type" : "boolean"
        },
        "minimumYear" : {
          "type" : "integer"
        },
        "maximumYear" : {
          "type" : "integer"
        },
        "minInvalidMessage" : {
          "type" : "string"
        },
        "maxInvalidMessage" : {
          "type" : "string"
        },
        "invalidMessage" : {
          "type" : "string"
        }
      },
      "examples" : [
        {

        },
        {
          "allowPast" : false,
          "maximumYear" : 2030
        },
        {
          "allowFuture" : false,
          "minimumYear" : 1900
        }
      ]
    },
    "YearTextInputItemObject" : {
      "$id" : "#YearTextInputItemObject",
      "type" : "object",
      "title" : "YearTextInputItemObject",
      "description" : "",
      "properties" : {
        "type" : {
          "const" : "year"
        },
        "formatOptions" : {
          "$ref" : "#/definitions/YearFormatOptions",
          "description" : "The formatting and range options to use with input item."
        }
      },
      "required" : [
        "type"
      ],
      "allOf" : [
        {
          "$ref" : "#"
        }
      ],
      "examples" : [
        {
          "type" : "year",
          "placeholder" : "YYYY"
        }
      ]
    }
  },
  "properties" : {
    "type" : {
      "$ref" : "#/definitions/TextInputType"
    },
    "identifier" : {
      "type" : "string",
      "description" : "The result identifier is an optional value that can be used to help in building the serializable answer result from this ``InputItem``. If null, then it is assumed that the ``Question`` that holds this ``InputItem`` has some custom serialization strategy or only contains a single field and this property can be ignored."
    },
    "fieldLabel" : {
      "type" : "string",
      "description" : "A localized string that displays a short text offering a hint to the user of the data to be entered for this field."
    },
    "placeholder" : {
      "type" : "string",
      "description" : "A localized string that displays placeholder information for the ``InputItem``."
    }
  },
  "required" : [
    "type",
    "identifier",
    "fieldLabel",
    "placeholder"
  ]
}