HexagonJS
Form Builder Changelog
2.5.0
hx.Form
addTextoptionsObject
options
autoCompleteDataData / Function
Deprecated
This option has been replaced with the lowercase variant autocompleteData
hx.Form
addTextoptionsObject
options
autoCompleteOptions
Deprecated
This option has been replaced with the lowercase variant autocompleteOptions
2.4.0
hx.Form
addTextoptionsObject
options
autoCompleteDataData / Function
Deprecated
This option has been replaced with the lowercase variant autocompleteData
hx.Form
addTextoptionsObject
options
autoCompleteOptions
Deprecated
This option has been replaced with the lowercase variant autocompleteOptions
2.3.1
hx.FormextendsEventEmitter
Bugfix
Resolved an issue where the buttons were moved to the top of the form
hx.Form
addTextoptionsObject
options
autoCompleteDataData / Function
Deprecated
This option has been replaced with the lowercase variant autocompleteData
hx.Form
addTextoptionsObject
options
autoCompleteOptions
Deprecated
This option has been replaced with the lowercase variant autocompleteOptions
2.3.0
hx.Form
addTextoptionsObject
options
autoCompleteDataData / Function
Deprecated
This option has been replaced with the lowercase variant autocompleteData
hx.Form
addTextoptionsObject
options
autoCompleteOptions
Deprecated
This option has been replaced with the lowercase variant autocompleteOptions
2.2.0
hx.FormextendsEventEmitter
Bugfix
Resolved an issue where elements added with addButton could not be retrieved with .node(...)
hx.Form
Removed
Added options argument to constructor
hx.Form
Added
Added options argument to constructor
hx.Form
addTextoptionsObject
options
autoCompleteDataData / Function
Deprecated
This option has been replaced with the lowercase variant autocompleteData
hx.Form
addTextoptionsObject
options
autoCompleteOptions
Deprecated
This option has been replaced with the lowercase variant autocompleteOptions
2.1.0
hx.Form
addTextoptionsObject
options
autoCompleteDataData / Function
Deprecated
This option has been replaced with the lowercase variant autocompleteData
hx.Form
addTextoptionsObject
options
autoCompleteOptions
Deprecated
This option has been replaced with the lowercase variant autocompleteOptions
2.0.3
hx.Form
addTextoptionsObject
options
autoCompleteDataData / Function
Deprecated
This option has been replaced with the lowercase variant autocompleteData
hx.Form
addTextoptionsObject
options
autoCompleteOptions
Deprecated
This option has been replaced with the lowercase variant autocompleteOptions
2.0.2
hx.FormextendsEventEmitter
Bugfix
Resolved an issue where a text field with an autocompelete was incorrectly wrapped with a div, breaking the alignment of the form.
hx.Form
addTextoptionsObject
options
autoCompleteDataData / Function
Deprecated
This option has been replaced with the lowercase variant autocompleteData
hx.Form
addTextoptionsObject
options
autoCompleteOptions
Deprecated
This option has been replaced with the lowercase variant autocompleteOptions
2.0.1
hx.Form
addTextForm
Bugfix
Fixed an issue where the autocomplete data and options were incorrectly removed instead of deprecated
hx.Form
addTextoptionsObject
options
autoCompleteDataData / Function
Bugfix
Added the deprecated warning and fallback in to handle the deprecation
Deprecated
This option has been replaced with the lowercase variant autocompleteData
hx.Form
addTextoptionsObject
options
autoCompleteOptions
Bugfix
Added the deprecated warning and fallback in to handle the deprecation
Deprecated
This option has been replaced with the lowercase variant autocompleteOptions
hx.Form
addTextoptionsObject
options
autocompleteDataData / Function
Bugfix
Added the deprecated warning and fallback in to handle the deprecation
hx.Form
addTextoptionsObject
options
autocompleteOptions
Bugfix
Added the deprecated warning and fallback in to handle the deprecation
2.0.0
hx.Form
addTextForm
Updated
hx.Form
addTextoptionsObject
options
autoCompleteDataData / Function
Deprecated
This option has been replaced with the lowercase variant autocompleteData
hx.Form
addTextoptionsObject
options
autoCompleteOptions
Deprecated
This option has been replaced with the lowercase variant autocompleteOptions
hx.Form
addTextoptionsObject
options
autocompleteDataData / Function
Added
The data to use for auto complete suggestions. Can be either an array of data or a function that returns data. For a more detailed explanation, see the Autocomplete.
hx.Form
addTextoptionsObject
options
autocompleteOptions
Added
The options to use for the auto complete. For a more detailed explanation, see the Autocomplete page.
1.17.0
hx.Form
addTagInputoptionsObject
options
requiredBoolean
Added
#238
Added the ability to have 'required' tag inputs where at least one value must be entered
hx.Form
addSubmitForm
Removed
hx.Form
addSubmitForm
Added
#395
Added the options argument to allow the button to be hidden or disabled when it is added to the form
hx.Form
addButtonForm
Added
#395
Added the ability to add multiple buttons to the bottom of a form
1.16.0
hx.Form
addToggle
Added
#444
New method for adding a Toggle
1.14.0
hx.Form
addTextoptionsObject
options
valueAny
Added
#387
Added the ability to initialise fields with a value
hx.Form
addEmailoptionsObject
options
valueAny
Added
#387
Added the ability to initialise fields with a value
hx.Form
addNumberoptionsObject
options
valueAny
Added
#387
Added the ability to initialise fields with a value
hx.Form
addPasswordoptionsObject
options
valueAny
Added
#387
Added the ability to initialise fields with a value
hx.Form
addUrloptionsObject
options
valueAny
Added
#387
Added the ability to initialise fields with a value
hx.Form
addCheckboxoptionsObject
options
valueAny
Added
#387
Added the ability to initialise fields with a value
hx.Form
addRadiooptionsObject
options
valueAny
Added
#387
Added the ability to initialise fields with a value
hx.Form
addTextAreaoptionsObject
options
valueAny
Added
#387
Added the ability to initialise fields with a value
hx.Form
addPickerForm
Bugfix
#304
Resolved an issue with validation when un-setting picker values
hx.Form
addAutocompletePickerForm
Bugfix
#304
Resolved an issue with validation when un-setting picker values
1.10.0
hx.FormextendsEventEmitter
Bugfix
#359
Resolved an issue when attempting to add fields that are disabled/hidden as their initial state
Bugfix
#368
Resolved an issue where disabled form fields would not return their value when using the value or data method.
1.4.0
hx.FormextendsEventEmitter
Updated
#211
Updated the error text to use the user facing text module
hx.Form
addTagInputoptionsObject
options
placeholderString
Added
#211
The placeholder text for the tag input
hx.Form
addAutocompletePickerForm
Added
#17
Adds an autocomplete picker to the form.
1.3.0
hx.Form
addFileInput
Added
#25
New method for adding a FileInput
hx.Form
dataForm
Bugfix
#178
Fix to make the data method circular for tag input fields
1.2.0
hx.FormextendsEventEmitter
Bugfix
Updated the hidden/disabled state for properties so they can be hidden/disabled when added using the options and also using the hidden/disabled methods after they have been added.
hx.Form
addTextoptionsObject
options
hiddenBoolean
Added
Whether the property should be hidden as it's initial state. This can also be toggled with the hidden(property, hidden) method.
hx.Form
addEmailoptionsObject
options
hiddenBoolean
Added
Whether the property should be hidden as it's initial state. This can also be toggled with the hidden(property, hidden) method.
hx.Form
addNumberoptionsObject
options
hiddenBoolean
Added
Whether the property should be hidden as it's initial state. This can also be toggled with the hidden(property, hidden) method.
hx.Form
addPasswordoptionsObject
options
hiddenBoolean
Added
Whether the property should be hidden as it's initial state. This can also be toggled with the hidden(property, hidden) method.
hx.Form
addUrloptionsObject
options
hiddenBoolean
Added
Whether the property should be hidden as it's initial state. This can also be toggled with the hidden(property, hidden) method.
hx.Form
addCheckboxoptionsObject
options
hiddenBoolean
Added
Whether the property should be hidden as it's initial state. This can also be toggled with the hidden(property, hidden) method.
hx.Form
addRadiooptionsObject
options
hiddenBoolean
Added
Whether the property should be hidden as it's initial state. This can also be toggled with the hidden(property, hidden) method.
hx.Form
addTagInputoptionsObject
options
disabledBoolean
Added
Whether the property should be disabled as it's initial state. This can also be toggled with the disabled(property, disabled) method.
hx.Form
addTagInputoptionsObject
options
hiddenBoolean
Added
Whether the property should be hidden as it's initial state. This can also be toggled with the hidden(property, hidden) method.
hx.Form
addDatePickeroptionsObject
options
hiddenBoolean
Added
Whether the property should be hidden as it's initial state. This can also be toggled with the hidden(property, hidden) method.
hx.Form
addTimePickeroptionsObject
options
hiddenBoolean
Added
Whether the property should be hidden as it's initial state. This can also be toggled with the hidden(property, hidden) method.
hx.Form
addDateTimePickeroptionsObject
options
hiddenBoolean
Added
Whether the property should be hidden as it's initial state. This can also be toggled with the hidden(property, hidden) method.
hx.Form
addTextAreaoptionsObject
options
hiddenBoolean
Added
Whether the property should be hidden as it's initial state. This can also be toggled with the hidden(property, hidden) method.
hx.Form
addPickeroptionsObject
options
hiddenBoolean
Added
Whether the property should be hidden as it's initial state. This can also be toggled with the hidden(property, hidden) method.
hx.Form
disabledBoolean
Added
A method for getting the disabled state of a property in a form.
hx.Form
disabledArray[Boolean]
Added
A method for getting the disabled state for an array of properties in a form.
hx.Form
disabledForm
Added
A method for setting the disabled state for a property in a form.
hx.Form
disabledForm
Added
A method for setting the disabled state for an array of properties in a form.
0.15.2
hx.Form
addSubmitForm
Removed
Replaced with addSubmit(text, icon, submitAction)
hx.Form
addSubmitForm
Added
Adds a submit button to the form
hx.Form
valueAny
Added
A method for getting the value for a single property in a form.
hx.Form
valueForm
Added
A method for setting the value for a single property in a form.
hx.Form
hiddenBoolean
Added
A method getting the hidden state for a form property. Hidden properties will be visually hidden and their values will not be present in the form data.
hx.Form
hiddenForm
Added
A method setting the hidden state for a form property. Hidden properties will be visually hidden and their values will not be present in the form data.
hx.Form
hiddenArray[Boolean]
Added
A method getting the hidden state for a set of form properties. Hidden properties will be visually hidden and their values will not be present in the form data.
hx.Form
hiddenForm
Added
A method setting the hidden state for a set of form properties. Hidden properties will be visually hidden and their values will not be present in the form data.
hx.Form
nodeHTMLElement
Added
A method for getting the node for a form property
hx.Form
errorMessageForm
Added
A method for setting custom error messages for form fields. If the message is set to anything other than an empty string, the form input will be classed as invalid and show a validation message.
form.errorMessage('Text', 'Please enter something sensible') // Form will not validate with message 'Please enter something sensible'
form.errorMessage('Text', undefined) // Clears validation message.
hx.Form
errorMessageString
Added
A method for getting the error message for a form field. This will include messages set with the errorMessage method as well as inbuilt errors, such as those shown for required fields.
0.15.0
hx.Form
addSelectForm
Removed
Use addPicker instead. options.selectOptions has also be renamed to options.pickerOptions.
hx.Form
addSelectForm
Removed
Use addPicker instead. options.selectOptions has also be renamed to options.pickerOptions.
hx.Form
addPickerForm
Added
Adds a picker to the form.
0.14.0
hx.Form
addTagInputoptionsObject
options
classifier
Removed
Use tagInputOptions instead.
hx.Form
addTagInputoptionsObject
options
validator
Removed
Use tagInputOptions instead.
hx.Form
addDatePickeroptionsObject
options
typeString
Removed
Use datePickerOptions instead.
hx.Form
addDatePickeroptionsObject
options
closeOnSelectBoolean
Removed
Use datePickerOptions instead.
hx.Form
addDatePickeroptionsObject
options
selectRangeBoolean
Removed
Use datePickerOptions instead.
hx.Form
addTimePickeroptionsObject
options
showSecondsBoolean
Removed
Use timePickerOptions instead.
hx.Form
addTimePickeroptionsObject
options
buttonClassString
Removed
Use timePickerOptions instead.
hx.Form
addDateTimePickeroptionsObject
options
showSecondsBoolean
Removed
Use dateTimePickerOptions instead.
hx.Form
addDateTimePickeroptionsObject
options
typeString
Removed
Use dateTimePickerOptions instead.
hx.Form
addTextAreaForm
Added
Adds a textarea field to the form.
0.13.0
hx.Form
addSelectoptionsObject
options
selectOptions
Added
The options to use for the select component. See the select constructor for the available options.
hx.Form
addTagInputoptionsObject
options
classifier
Deprecated
Use tagInputOptions instead.
hx.Form
addTagInputoptionsObject
options
validator
Deprecated
Use tagInputOptions instead.
hx.Form
addTagInputoptionsObject
options
tagInputOptions
Added
The options to use for the tg input component. See the tag input constructor for the available options.
hx.Form
addSelectoptionsObject
options
selectOptions
Added
The options to use for the select component. See the select constructor for the available options.
hx.Form
addDatePickeroptionsObject
options
typeString
Deprecated
Use datePickerOptions instead.
hx.Form
addDatePickeroptionsObject
options
closeOnSelectBoolean
Deprecated
Use datePickerOptions instead.
hx.Form
addDatePickeroptionsObject
options
selectRangeBoolean
Deprecated
Use datePickerOptions instead.
hx.Form
addDatePickeroptionsObject
options
datePickerOptionsObjec
Added
The options to use for the date picker component. See the Date Picker constructor for the available options.
hx.Form
addTimePickeroptionsObject
options
showSecondsBoolean
Deprecated
Use timePickerOptions instead.
hx.Form
addTimePickeroptionsObject
options
buttonClassString
Deprecated
Use timePickerOptions instead.
hx.Form
addTimePickeroptionsObject
options
timePickerOptions
Added
The options to use for the time picker component. See the Time Picker constructor for the available options.
hx.Form
addDateTimePickeroptionsObject
options
showSecondsBoolean
Deprecated
Use dateTimePickerOptions instead.
hx.Form
addDateTimePickeroptionsObject
options
typeString
Added
Deprecated
Use dateTimePickerOptions instead.
hx.Form
addDateTimePickeroptionsObject
options
dateTimePickerOptions
Added
The options to use for the time picker component. See the Date Time Picker constructor for the available options.
0.12.4
hx.Form
componentObject
Added
Added the component method to replace form.properties.get('Name of Property').extras.<componentType> as the way to get the component for a form element.
The component types have also been removed from the properties and should be accesed with form.component('Name of Property') instead.
0.12.0
hx.Form
getData
Removed
hx.Form
fill
Removed
hx.Form
addSelectoptionsObject
options
disabledBoolean
Added
Whether the field should have the disabled attribute.
hx.Form
addSelectoptionsObject
options
disabledBoolean
Added
Whether the field should have the disabled attribute.
hx.Form
addDatePickeroptionsObject
options
validStartDate
Added
The valid start date for the date picker. The user will not be able to select dates before this date.
hx.Form
addDatePickeroptionsObject
options
validEndDate
Added
The valid end date for the date picker. The user will not be able to select dates after this date.
0.11.0
hx.Form
getData
Deprecated
Use data() instead.
hx.Form
fill
Deprecated
Use data(data) instead.
hx.Form
addSelectForm
Updated
Updated the form builder to use the new hx.Select element.
hx.Form
addSelectForm
Updated
Updated the form builder to use the new hx.Select element.
hx.Form
addDatePickerForm
Added
Adds a date picker to the form.
hx.Form
addTimePickerForm
Added
Adds a time picker to the form.
hx.Form
addDateTimePickerForm
Added
Adds a date time picker to the form.
hx.Form
dataForm
Added
Fill the form with some data.
hx.Form
dataObject
Added
Returns the data in the form as an object containing key/value pairs.
If no keys are provided in the options, the name of each field will be used as the key.
0.10.0
hx.Form
addSelectForm
Added
Adds a dropdown select input to the form. There is an alternative overload that accepts an array of strings as the values.
var values = [
  { text: 'Hue', value: 'hue' } ,
  { text: 'Saturation', value: 'saturation'},
  { text: 'Lightness', value: 'lightness'}
];
form.addSelect('Select', values, {required: true})