HTML Input

Description

An HTML input for user interaction

OPTIONS

  • Title (String)
    • The title displayed within widget container
  • Input Type (Option)
    • Available types listed below
  • Value
    • Incoming parser specified the value of input
    • Update datasource with value on input submission
    • See expected value type for relevant input below
  • Relevant Attributes
    • Expected {object}
    • See expected attributes for relevant input below
  • Size (Options)
    • Pre-defined block sizes

Available Inputs

Below are all of the available widgets, along with expected value inputs attributes(if supported), and the type of data each returns. It is recommended that validation for inputs is included in the outgoing parser. Note that a return of “value”, is the value from your options.value datasource.

Button

  • Expected Value: string
  • Attributes: none
  • Returns: value

Checkbox

  • Expected Value: any
  • Attributes:
{"checked": string(boolean)} // Example: {"checked" : "true"} 
  • Returns: value

Color

  • Expected Value: string(HEX)
  • Attributes: none
  • Returns : string(HEX)

Date

  • Expected Value: string(yyyy-mm-dd)
  • Attributes: none
  • Returns : string(yyyy-mm-dd)

Datetime-local

  • Expected Value: string(yyyy-mm-ddT00:00)
  • Attributes: none
  • Returns : string(yyyy-mm-ddT00:00)

Email

  • Expected Value: string
  • Attributes: none
  • Returns: string

Month

  • Expected Value: string(yyyy-mm)
  • Attributes: none
  • Returns: string(yyyy-mm)

Number

  • Expected Value: number
  • Attributes:
{"min": number, "max": number} // Example: {"min" : 10, "max": 300} 
  • Returns: number

Password

  • Expected Value: string // Recommend returning “” with incoming parser
  • Attributes: none
  • Returns: string

Range

  • Expected Value: number
  • Attributes:
{ "min" : number , "max" : number, "step": number }// Example: {"min" : 10, "max": 300, "step": 5} 
  • Returns: number
  • Expected Value: string
  • Attributes: none
  • Returns: string

Select

  • Expected Value: number
  • Attributes:
{ "options" : [ "String" ] }  // Expected : options as strings

{ "options" : [ "String" ], "selected" : "String" }  // Optionally set a static default choice 

{ "options" : [ "red", "green", "blue" ], "selected" : "blue" } // Example
  • Returns: string (of selected value)

Telephone

  • Expected Value: number / string
  • Attributes: none
  • Returns: number / string

Text

  • Expected Value: string
  • Attributes: none
  • Returns: string

Textarea

  • Expected Value: string
  • Attributes: none
  • Returns: string

Time

  • Expected Value: string(HH:MM)
  • Attributes: none
  • Returns: string(HH:MM)

Url

  • Expected Value: string
  • Attributes: none
  • Returns: string

Week

  • Expected Value: string(YYYY-W##)
  • Attributes: none
  • Returns: string(YYYY-W##)