The number field.


TitleNumber Field
DescriptionField for float numbers.
JSON Schema Type(s)number
Field Typenumber
Base Field Typetext


defaultanyThe default value to be assigned for this property. If the data for the field is empty or not provided, this default value will be plugged in for you. Specify a default value when you want to pre-populate the field's value ahead of time.
dependenciesarrayList of property dependencies.
descriptionstringDetailed description of the property.
disallowarrayList of disallowed values for the property.
enumarrayList of specific values for this property
exclusiveMaximumbooleanProperty value can not equal the number defined by the maximum schema property.
exclusiveMinimumbooleanProperty value can not equal the number defined by the minimum schema property.
formatstringData format of the property.
maxLengthnumberMaximum length of the property value.
maximumnumberMaximum value of the property.
minLengthnumberMinimal length of the property value.
minimumnumberMinimum value of the property.
multipleOfnumberProperty value must be a multiple of the multipleOf schema property such that division by this value yields an interger (mod zero).
patternstringRegular expression for the property value.
readonlybooleanIndicates that the field is read-only. A read-only field cannot have it's value changed. Read-only fields render in a grayed-out or disabled control. If the field is rendered using a view with the displayReadonly attribute set to false, the read-only field will not appear.
requiredbooleanIndicates whether the field's value is required. If set to true, the field must take on a valid value and cannnot be left empty or unassigned.
titlestringShort description of the property.
typestringnumberData type of the property.


allowOptionalEmptyAllows this non-required field to validate when the value is empty
autocompletestringAllows you to specify the autocomplete attribute for the underlying input control whether or not field should have autocomplete enabled.
dataobjectAllows you to specify a key/value map of data attributes that will be added as DOM attribuets for the underlying input control. The data attributes will be added as data-{name}='{value}'.
disabledbooleanField will be disabled if true.
disallowEmptySpacesbooleanWhether to disallow the entry of empty spaces in the text
disallowOnlyEmptySpacesbooleanWhether to disallow the entry of only empty spaces in the text
fieldClassstringSpecifies one or more CSS classes that should be applied to the dom element for this field once it is rendered. Supports a single value, comma-delimited values, space-delimited values or values passed in as an array.
focuscheckboxtrueIf true, the initial focus for the form will be set to the first child element (usually the first field in the form). If a field name or path is provided, then the specified child field will receive focus. For example, you might set focus to 'name' (selecting the 'name' field) or you might set it to 'client/name' which picks the 'name' field on the 'client' object.
formobjectOptions for rendering the FORM tag.
helperstringField help message.
helpersarrayAn array of field help messages. Each message will be displayed on it's own line.
hiddenbooleanField will be hidden if true.
hideInitValidationErrorbooleanHide initial validation errors if true.
idstringUnique field id. Auto-generated if not provided.
inputTypestringAllows for the override of the underlying HTML5 input type. If not specified, an assumed value is provided based on the kind of input control (i.e. 'text', 'date', 'email' and so forth)
labelstringField label.
maskStringstringExpression for the field mask. Field masking will be enabled if not empty.
namestringField Name.
numericEntrybooleanWhether to constrain data entry key presses to numeric values (0-9)
optionLabelsarrayAn array of string labels for items in the enum array
placeholderstringField placeholder.
readonlybooleanField will be readonly if true.
showMessagesbooleantrueDisplay validation messages if true.
sizenumber40Field size.
sortfunctionDefines an f(a,b) sort function for the array of enumerated values [{text, value}]. This is used to sort enum and optionLabels as well as results that come back from any data sources (for select and radio controls). By default the items are sorted alphabetically. Don't apply any sorting if false.
typestringnumberField type.
typeaheadProvides configuration for the $.typeahead plugin if it is available. For full configuration options, see:
validatebooleantrueField validation is required if true.
viewstringAllows for this field to be rendered with a different view (such as 'display' or 'create')

Example 1

Number field with only data parameter.

Example 2

Number field with value range defined by minimum and maximum schema property.

Example 3

Number field with exclusiveMinimum and exclusiveMaximum schema property.

Example 4

Number field with rendered in display-only mode.

Example 5

Form using number fields to represent geolocation latitude and longitude.

© 2016 Gitana Software, Inc.

Alpaca is sponsored by