get-form-data
Version:
Gets form data via form.elements
198 lines (157 loc) • 5.54 kB
JavaScript
function _extends() { _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
var NODE_LIST_CLASSES = {
'[object HTMLCollection]': true,
'[object NodeList]': true,
'[object RadioNodeList]': true
}; // .type values for elements which can appear in .elements and should be ignored
var IGNORED_ELEMENT_TYPES = {
'button': true,
'fieldset': true,
'reset': true,
'submit': true
};
var CHECKED_INPUT_TYPES = {
'checkbox': true,
'radio': true
};
var TRIM_RE = /^\s+|\s+$/g;
var slice = Array.prototype.slice;
var toString = Object.prototype.toString;
/**
* @param {HTMLFormElement} form
* @param {Object} [options]
* @return {Object.<string,boolean|string|string[]>} an object containing
* submittable value(s) held in the form's .elements collection, with
* properties named as per element names or ids.
*/
export default function getFormData(form, options) {
if (!form) {
throw new Error("A form is required by getFormData, was given form=" + form);
}
options = _extends({
includeDisabled: false,
trim: false
}, options);
var data = {};
var elementName;
var elementNames = [];
var elementNameLookup = {}; // Get unique submittable element names for the form
for (var i = 0, l = form.elements.length; i < l; i++) {
var element = form.elements[i];
if (IGNORED_ELEMENT_TYPES[element.type] || element.disabled && !options.includeDisabled) {
continue;
}
elementName = element.name || element.id;
if (elementName && !elementNameLookup[elementName]) {
elementNames.push(elementName);
elementNameLookup[elementName] = true;
}
} // Extract element data name-by-name for consistent handling of special cases
// around elements which contain multiple inputs.
for (var _i = 0, _l = elementNames.length; _i < _l; _i++) {
elementName = elementNames[_i];
var value = getFieldData(form, elementName, options);
if (value != null) {
data[elementName] = value;
}
}
return data;
}
/**
* @param {HTMLFormElement} form
* @param {string} fieldName
* @param {Object} [options]
* @return {?(boolean|string|string[]|File|File[])} submittable value(s) in the
* form for a named element from its .elements collection, or null if there
* was no element with that name, or the element had no submittable value(s).
*/
export function getFieldData(form, fieldName, options) {
if (!form) {
throw new Error("A form is required by getFieldData, was given form=" + form);
}
if (!fieldName && toString.call(fieldName) !== '[object String]') {
throw new Error("A field name is required by getFieldData, was given fieldName=" + fieldName);
}
options = _extends({
includeDisabled: false,
trim: false
}, options);
var element = form.elements[fieldName];
if (!element || element.disabled && !options.includeDisabled) {
return null;
}
if (!NODE_LIST_CLASSES[toString.call(element)]) {
return getFormElementValue(element, options.trim);
} // Deal with multiple form controls which have the same name
var data = [];
var allRadios = true;
for (var i = 0, l = element.length; i < l; i++) {
if (element[i].disabled && !options.includeDisabled) {
continue;
}
if (allRadios && element[i].type !== 'radio') {
allRadios = false;
}
var value = getFormElementValue(element[i], options.trim);
if (value != null) {
data = data.concat(value);
}
} // Special case for an element with multiple same-named inputs which were all
// radio buttons: if there was a selected value, only return the value.
if (allRadios && data.length === 1) {
return data[0];
}
return data.length > 0 ? data : null;
}
/**
* @param {HTMLElement} element a form element.
* @param {boolean} [trim] should values for text entry inputs be trimmed?
* @return {?(boolean|string|string[]|File|File[])} the element's submittable
* value(s), or null if it had none.
*/
function getFormElementValue(element, trim) {
var value = null;
var type = element.type;
if (type === 'select-one') {
if (element.options.length) {
value = element.options[element.selectedIndex].value;
}
return value;
}
if (type === 'select-multiple') {
value = [];
for (var i = 0, l = element.options.length; i < l; i++) {
if (element.options[i].selected) {
value.push(element.options[i].value);
}
}
if (value.length === 0) {
value = null;
}
return value;
} // If a file input doesn't have a files attribute, fall through to using its
// value attribute.
if (type === 'file' && 'files' in element) {
if (element.multiple) {
value = slice.call(element.files);
if (value.length === 0) {
value = null;
}
} else {
// Should be null if not present, according to the spec
value = element.files[0];
}
return value;
}
if (!CHECKED_INPUT_TYPES[type]) {
value = trim ? element.value.replace(TRIM_RE, '') : element.value;
} else if (element.checked) {
if (type === 'checkbox' && !element.hasAttribute('value')) {
value = true;
} else {
value = element.value;
}
}
return value;
} // For UMD build access to getFieldData
getFormData.getFieldData = getFieldData;