devextreme
Version:
HTML5 JavaScript Component Suite for Responsive Web Development
223 lines (217 loc) • 11.3 kB
JavaScript
/**
* DevExtreme (cjs/ui/form/components/field_item.js)
* Version: 22.1.9
* Build date: Tue Apr 18 2023
*
* Copyright (c) 2012 - 2023 Developer Express Inc. ALL RIGHTS RESERVED
* Read about DevExtreme licensing here: https://js.devexpress.com/Licensing/
*/
"use strict";
exports.TOGGLE_CONTROLS_PADDING_CLASS = exports.LABEL_VERTICAL_ALIGNMENT_CLASS = exports.LABEL_HORIZONTAL_ALIGNMENT_CLASS = exports.FLEX_LAYOUT_CLASS = exports.FIELD_ITEM_REQUIRED_CLASS = exports.FIELD_ITEM_OPTIONAL_CLASS = exports.FIELD_ITEM_LABEL_ALIGN_CLASS = exports.FIELD_ITEM_HELP_TEXT_CLASS = exports.FIELD_ITEM_CONTENT_WRAPPER_CLASS = exports.FIELD_ITEM_CONTENT_LOCATION_CLASS = void 0;
exports.renderFieldItem = renderFieldItem;
var _renderer = _interopRequireDefault(require("../../../core/renderer"));
var _events_engine = _interopRequireDefault(require("../../../events/core/events_engine"));
var _click = require("../../../events/click");
var _element = require("../../../core/element");
var _inflector = require("../../../core/utils/inflector");
var _string = require("../../../core/utils/string");
var _themes = require("../../themes");
var _ui = _interopRequireDefault(require("../../widget/ui.errors"));
var _validator = _interopRequireDefault(require("../../validator"));
var _constants = require("../constants");
var _label = require("./label");
function _interopRequireDefault(obj) {
return obj && obj.__esModule ? obj : {
default: obj
}
}
var FLEX_LAYOUT_CLASS = "dx-flex-layout";
exports.FLEX_LAYOUT_CLASS = FLEX_LAYOUT_CLASS;
var FIELD_ITEM_OPTIONAL_CLASS = "dx-field-item-optional";
exports.FIELD_ITEM_OPTIONAL_CLASS = FIELD_ITEM_OPTIONAL_CLASS;
var FIELD_ITEM_REQUIRED_CLASS = "dx-field-item-required";
exports.FIELD_ITEM_REQUIRED_CLASS = FIELD_ITEM_REQUIRED_CLASS;
var FIELD_ITEM_CONTENT_WRAPPER_CLASS = "dx-field-item-content-wrapper";
exports.FIELD_ITEM_CONTENT_WRAPPER_CLASS = FIELD_ITEM_CONTENT_WRAPPER_CLASS;
var FIELD_ITEM_CONTENT_LOCATION_CLASS = "dx-field-item-content-location-";
exports.FIELD_ITEM_CONTENT_LOCATION_CLASS = FIELD_ITEM_CONTENT_LOCATION_CLASS;
var FIELD_ITEM_LABEL_ALIGN_CLASS = "dx-field-item-label-align";
exports.FIELD_ITEM_LABEL_ALIGN_CLASS = FIELD_ITEM_LABEL_ALIGN_CLASS;
var FIELD_ITEM_HELP_TEXT_CLASS = "dx-field-item-help-text";
exports.FIELD_ITEM_HELP_TEXT_CLASS = FIELD_ITEM_HELP_TEXT_CLASS;
var LABEL_VERTICAL_ALIGNMENT_CLASS = "dx-label-v-align";
exports.LABEL_VERTICAL_ALIGNMENT_CLASS = LABEL_VERTICAL_ALIGNMENT_CLASS;
var LABEL_HORIZONTAL_ALIGNMENT_CLASS = "dx-label-h-align";
exports.LABEL_HORIZONTAL_ALIGNMENT_CLASS = LABEL_HORIZONTAL_ALIGNMENT_CLASS;
var TOGGLE_CONTROLS_PADDING_CLASS = "dx-toggle-controls-paddings";
exports.TOGGLE_CONTROLS_PADDING_CLASS = TOGGLE_CONTROLS_PADDING_CLASS;
var TEMPLATE_WRAPPER_CLASS = "dx-template-wrapper";
var VALIDATION_TARGET_CLASS = "dx-validation-target";
var INVALID_CLASS = "dx-invalid";
function renderFieldItem(_ref) {
var $parent = _ref.$parent,
rootElementCssClassList = _ref.rootElementCssClassList,
formOrLayoutManager = _ref.formOrLayoutManager,
createComponentCallback = _ref.createComponentCallback,
useFlexLayout = _ref.useFlexLayout,
labelOptions = _ref.labelOptions,
labelNeedBaselineAlign = _ref.labelNeedBaselineAlign,
labelLocation = _ref.labelLocation,
needRenderLabel = _ref.needRenderLabel,
formLabelLocation = _ref.formLabelLocation,
item = _ref.item,
editorOptions = _ref.editorOptions,
isSimpleItem = _ref.isSimpleItem,
isRequired = _ref.isRequired,
template = _ref.template,
helpID = _ref.helpID,
labelID = _ref.labelID,
name = _ref.name,
helpText = _ref.helpText,
requiredMessageTemplate = _ref.requiredMessageTemplate,
validationGroup = _ref.validationGroup;
var $rootElement = (0, _renderer.default)("<div>").addClass(rootElementCssClassList.join(" ")).appendTo($parent);
$rootElement.addClass(isRequired ? FIELD_ITEM_REQUIRED_CLASS : FIELD_ITEM_OPTIONAL_CLASS);
if (isSimpleItem && useFlexLayout) {
$rootElement.addClass(FLEX_LAYOUT_CLASS)
}
if (isSimpleItem && labelNeedBaselineAlign) {
$rootElement.addClass(FIELD_ITEM_LABEL_ALIGN_CLASS)
}
var $fieldEditorContainer = (0, _renderer.default)("<div>");
$fieldEditorContainer.data("dx-form-item", item);
$fieldEditorContainer.addClass(_constants.FIELD_ITEM_CONTENT_CLASS).addClass(FIELD_ITEM_CONTENT_LOCATION_CLASS + {
right: "left",
left: "right",
top: "bottom"
} [formLabelLocation]);
var $label = needRenderLabel ? (0, _label.renderLabel)(labelOptions) : null;
if ($label) {
var editorType = item.editorType;
$rootElement.append($label);
if ("top" === labelLocation || "left" === labelLocation) {
$rootElement.append($fieldEditorContainer)
}
if ("right" === labelLocation) {
$rootElement.prepend($fieldEditorContainer)
}
if ("top" === labelLocation) {
$rootElement.addClass(LABEL_VERTICAL_ALIGNMENT_CLASS)
} else {
$rootElement.addClass(LABEL_HORIZONTAL_ALIGNMENT_CLASS)
}
if ("dxCheckBox" === editorType || "dxSwitch" === editorType) {
_events_engine.default.on($label, _click.name, (function() {
_events_engine.default.trigger($fieldEditorContainer.children(), _click.name)
}))
}
var isToggleControls = ["dxCheckBox", "dxSwitch", "dxRadioGroup"].includes(editorType);
var labelAlignment = labelOptions.alignment;
var isLabelAlignmentLeft = "left" === labelAlignment || !labelAlignment;
var hasNotTemplate = !template;
var isLabelOnTop = "top" === labelLocation;
if (hasNotTemplate && isToggleControls && isLabelOnTop && isLabelAlignmentLeft) {
$fieldEditorContainer.addClass(TOGGLE_CONTROLS_PADDING_CLASS)
}
} else {
$rootElement.append($fieldEditorContainer)
}
var widgetInstance;
if (template) {
template.render({
container: (0, _element.getPublicElement)($fieldEditorContainer),
model: {
dataField: item.dataField,
editorType: item.editorType,
editorOptions: editorOptions,
component: formOrLayoutManager,
name: item.name
},
onRendered: function() {
var $validationTarget = getValidationTarget($fieldEditorContainer);
var validationTargetInstance = tryGetValidationTargetInstance($validationTarget);
subscribeWrapperInvalidClassToggle(validationTargetInstance)
}
})
} else {
var $div = (0, _renderer.default)("<div>").appendTo($fieldEditorContainer);
try {
widgetInstance = createComponentCallback($div, item.editorType, editorOptions);
widgetInstance.setAria("describedby", helpID);
if (labelID) {
widgetInstance.setAria("labelledby", labelID)
}
widgetInstance.setAria("required", isRequired)
} catch (e) {
_ui.default.log("E1035", e.message)
}
}
var $validationTarget = getValidationTarget($fieldEditorContainer);
var validationTargetInstance = $validationTarget && $validationTarget.data(VALIDATION_TARGET_CLASS);
if (validationTargetInstance) {
var isItemHaveCustomLabel = item.label && item.label.text;
var itemName = isItemHaveCustomLabel ? null : name;
var fieldName = isItemHaveCustomLabel ? item.label.text : itemName && (0, _inflector.captionize)(itemName);
var validationRules;
if (isSimpleItem) {
if (item.validationRules) {
validationRules = item.validationRules
} else {
var requiredMessage = (0, _string.format)(requiredMessageTemplate, fieldName || "");
validationRules = item.isRequired ? [{
type: "required",
message: requiredMessage
}] : null
}
}
if (Array.isArray(validationRules) && validationRules.length) {
createComponentCallback($validationTarget, _validator.default, {
validationRules: validationRules,
validationGroup: validationGroup,
dataGetter: function() {
return {
formItem: item
}
}
})
}
subscribeWrapperInvalidClassToggle(validationTargetInstance)
}
if (helpText && isSimpleItem) {
var $editorParent = $fieldEditorContainer.parent();
$editorParent.append((0, _renderer.default)("<div>").addClass(FIELD_ITEM_CONTENT_WRAPPER_CLASS).append($fieldEditorContainer).append((0, _renderer.default)("<div>").addClass(FIELD_ITEM_HELP_TEXT_CLASS).attr("id", helpID).text(helpText)))
}
return {
$fieldEditorContainer: $fieldEditorContainer,
$rootElement: $rootElement,
widgetInstance: widgetInstance
}
}
function getValidationTarget($fieldEditorContainer) {
var $editor = $fieldEditorContainer.children().first();
return $editor.hasClass(TEMPLATE_WRAPPER_CLASS) ? $editor.children().first() : $editor
}
function tryGetValidationTargetInstance($validationTarget) {
var _$validationTarget$pa, _$validationTarget$pa2;
return (null === $validationTarget || void 0 === $validationTarget ? void 0 : $validationTarget.data(VALIDATION_TARGET_CLASS)) || (null === $validationTarget || void 0 === $validationTarget ? void 0 : null === (_$validationTarget$pa = $validationTarget.parent) || void 0 === _$validationTarget$pa ? void 0 : null === (_$validationTarget$pa2 = _$validationTarget$pa.call($validationTarget)) || void 0 === _$validationTarget$pa2 ? void 0 : _$validationTarget$pa2.data(VALIDATION_TARGET_CLASS))
}
function subscribeWrapperInvalidClassToggle(validationTargetInstance) {
if (validationTargetInstance && (0, _themes.isMaterial)()) {
var wrapperClass = ".".concat(FIELD_ITEM_CONTENT_WRAPPER_CLASS);
var toggleInvalidClass = function(_ref2) {
var element = _ref2.element,
component = _ref2.component;
var _component$option = component.option(),
isValid = _component$option.isValid,
validationMessageMode = _component$option.validationMessageMode;
(0, _renderer.default)(element).parents(wrapperClass).toggleClass(INVALID_CLASS, false === isValid && (component._isFocused() || "always" === validationMessageMode))
};
validationTargetInstance.on("optionChanged", (function(e) {
if ("isValid" !== e.name) {
return
}
toggleInvalidClass(e)
}));
validationTargetInstance.on("focusIn", toggleInvalidClass).on("focusOut", toggleInvalidClass).on("enterKey", toggleInvalidClass)
}
}