ant-design-vue
Version:
An enterprise-class UI design language and Vue-based implementation
394 lines • 14.4 kB
JavaScript
import _defineProperty from "@babel/runtime/helpers/esm/defineProperty";
import _objectSpread from "@babel/runtime/helpers/esm/objectSpread2";
import { resolveDirective as _resolveDirective, createVNode as _createVNode, Fragment as _Fragment } from "vue";
import { watch, defineComponent, computed, nextTick, ref, watchEffect, onBeforeUnmount, toRaw } from 'vue';
import cloneDeep from 'lodash-es/cloneDeep';
import PropTypes from '../_util/vue-types';
import Row from '../grid/Row';
import { filterEmpty } from '../_util/props-util';
import { validateRules as validateRulesUtil } from './utils/validateUtil';
import { getNamePath } from './utils/valueUtil';
import { toArray } from './utils/typeUtil';
import { warning } from '../vc-util/warning';
import find from 'lodash-es/find';
import { tuple } from '../_util/type';
import useConfigInject from '../_util/hooks/useConfigInject';
import { useInjectForm } from './context';
import FormItemLabel from './FormItemLabel';
import FormItemInput from './FormItemInput';
import { useProvideFormItemContext } from './FormItemContext';
import useDebounce from './utils/useDebounce';
var ValidateStatuses = tuple('success', 'warning', 'error', 'validating', '');
function getPropByPath(obj, namePathList, strict) {
var tempObj = obj;
var keyArr = namePathList;
var i = 0;
try {
for (var len = keyArr.length; i < len - 1; ++i) {
if (!tempObj && !strict) break;
var key = keyArr[i];
if (key in tempObj) {
tempObj = tempObj[key];
} else {
if (strict) {
throw Error('please transfer a valid name path to form item!');
}
break;
}
}
if (strict && !tempObj) {
throw Error('please transfer a valid name path to form item!');
}
} catch (error) {
console.error('please transfer a valid name path to form item!');
}
return {
o: tempObj,
k: keyArr[i],
v: tempObj ? tempObj[keyArr[i]] : undefined
};
}
export var formItemProps = function formItemProps() {
return {
htmlFor: String,
prefixCls: String,
label: PropTypes.any,
help: PropTypes.any,
extra: PropTypes.any,
labelCol: {
type: Object
},
wrapperCol: {
type: Object
},
hasFeedback: {
type: Boolean,
default: false
},
colon: {
type: Boolean,
default: undefined
},
labelAlign: String,
prop: {
type: [String, Number, Array]
},
name: {
type: [String, Number, Array]
},
rules: [Array, Object],
autoLink: {
type: Boolean,
default: true
},
required: {
type: Boolean,
default: undefined
},
validateFirst: {
type: Boolean,
default: undefined
},
validateStatus: PropTypes.oneOf(tuple('', 'success', 'warning', 'error', 'validating')),
validateTrigger: {
type: [String, Array]
},
messageVariables: {
type: Object
},
hidden: Boolean,
noStyle: Boolean
};
};
var indexGuid = 0;
// default form item id prefix.
var defaultItemNamePrefixCls = 'form_item';
export default defineComponent({
compatConfig: {
MODE: 3
},
name: 'AFormItem',
inheritAttrs: false,
__ANT_NEW_FORM_ITEM: true,
props: formItemProps(),
slots: ['help', 'label', 'extra'],
setup: function setup(props, _ref) {
var slots = _ref.slots,
attrs = _ref.attrs,
expose = _ref.expose;
warning(props.prop === undefined, "`prop` is deprecated. Please use `name` instead.");
var eventKey = "form-item-".concat(++indexGuid);
var _useConfigInject = useConfigInject('form', props),
prefixCls = _useConfigInject.prefixCls;
var formContext = useInjectForm();
var fieldName = computed(function () {
return props.name || props.prop;
});
var errors = ref([]);
var validateDisabled = ref(false);
var inputRef = ref();
var namePath = computed(function () {
var val = fieldName.value;
return getNamePath(val);
});
var fieldId = computed(function () {
if (!namePath.value.length) {
return undefined;
} else {
var formName = formContext.name.value;
var mergedId = namePath.value.join('_');
return formName ? "".concat(formName, "_").concat(mergedId) : "".concat(defaultItemNamePrefixCls, "_").concat(mergedId);
}
});
var getNewFieldValue = function getNewFieldValue() {
var model = formContext.model.value;
if (!model || !fieldName.value) {
return;
} else {
return getPropByPath(model, namePath.value, true).v;
}
};
var fieldValue = computed(function () {
return getNewFieldValue();
});
var initialValue = ref(cloneDeep(fieldValue.value));
var mergedValidateTrigger = computed(function () {
var validateTrigger = props.validateTrigger !== undefined ? props.validateTrigger : formContext.validateTrigger.value;
validateTrigger = validateTrigger === undefined ? 'change' : validateTrigger;
return toArray(validateTrigger);
});
var rulesRef = computed(function () {
var formRules = formContext.rules.value;
var selfRules = props.rules;
var requiredRule = props.required !== undefined ? {
required: !!props.required,
trigger: mergedValidateTrigger.value
} : [];
var prop = getPropByPath(formRules, namePath.value);
formRules = formRules ? prop.o[prop.k] || prop.v : [];
var rules = [].concat(selfRules || formRules || []);
if (find(rules, function (rule) {
return rule.required;
})) {
return rules;
} else {
return rules.concat(requiredRule);
}
});
var isRequired = computed(function () {
var rules = rulesRef.value;
var isRequired = false;
if (rules && rules.length) {
rules.every(function (rule) {
if (rule.required) {
isRequired = true;
return false;
}
return true;
});
}
return isRequired || props.required;
});
var validateState = ref();
watchEffect(function () {
validateState.value = props.validateStatus;
});
var messageVariables = computed(function () {
var variables = {};
if (typeof props.label === 'string') {
variables.label = props.label;
} else if (props.name) {
variables.label = String(props.name);
}
if (props.messageVariables) {
variables = _objectSpread(_objectSpread({}, variables), props.messageVariables);
}
return variables;
});
var validateRules = function validateRules(options) {
// no name, no value, so the validate result is incorrect
if (namePath.value.length === 0) {
return;
}
var _props$validateFirst = props.validateFirst,
validateFirst = _props$validateFirst === void 0 ? false : _props$validateFirst;
var _ref2 = options || {},
triggerName = _ref2.triggerName;
var filteredRules = rulesRef.value;
if (triggerName) {
filteredRules = filteredRules.filter(function (rule) {
var trigger = rule.trigger;
if (!trigger && !mergedValidateTrigger.value.length) {
return true;
}
var triggerList = toArray(trigger || mergedValidateTrigger.value);
return triggerList.includes(triggerName);
});
}
if (!filteredRules.length) {
return Promise.resolve();
}
var promise = validateRulesUtil(namePath.value, fieldValue.value, filteredRules, _objectSpread({
validateMessages: formContext.validateMessages.value
}, options), validateFirst, messageVariables.value);
validateState.value = 'validating';
errors.value = [];
promise.catch(function (e) {
return e;
}).then(function () {
var results = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
if (validateState.value === 'validating') {
var res = results.filter(function (result) {
return result && result.errors.length;
});
validateState.value = res.length ? 'error' : 'success';
errors.value = res.map(function (r) {
return r.errors;
});
formContext.onValidate(fieldName.value, !errors.value.length, errors.value.length ? toRaw(errors.value[0]) : null);
}
});
return promise;
};
var _onFieldBlur = function onFieldBlur() {
validateRules({
triggerName: 'blur'
});
};
var _onFieldChange = function onFieldChange() {
if (validateDisabled.value) {
validateDisabled.value = false;
return;
}
validateRules({
triggerName: 'change'
});
};
var clearValidate = function clearValidate() {
validateState.value = props.validateStatus;
validateDisabled.value = false;
errors.value = [];
};
var resetField = function resetField() {
validateState.value = props.validateStatus;
validateDisabled.value = true;
errors.value = [];
var model = formContext.model.value || {};
var value = fieldValue.value;
var prop = getPropByPath(model, namePath.value, true);
if (Array.isArray(value)) {
prop.o[prop.k] = [].concat(initialValue.value);
} else {
prop.o[prop.k] = initialValue.value;
}
// reset validateDisabled after onFieldChange triggered
nextTick(function () {
validateDisabled.value = false;
});
};
var htmlFor = computed(function () {
return props.htmlFor === undefined ? fieldId.value : props.htmlFor;
});
var onLabelClick = function onLabelClick() {
var id = htmlFor.value;
if (!id || !inputRef.value) {
return;
}
var control = inputRef.value.$el.querySelector("[id=\"".concat(id, "\"]"));
if (control && control.focus) {
control.focus();
}
};
expose({
onFieldBlur: _onFieldBlur,
onFieldChange: _onFieldChange,
clearValidate: clearValidate,
resetField: resetField
});
useProvideFormItemContext({
id: fieldId,
onFieldBlur: function onFieldBlur() {
if (props.autoLink) {
_onFieldBlur();
}
},
onFieldChange: function onFieldChange() {
if (props.autoLink) {
_onFieldChange();
}
},
clearValidate: clearValidate
}, computed(function () {
return !!(props.autoLink && formContext.model.value && fieldName.value);
}));
var registered = false;
watch(fieldName, function (val) {
if (val) {
if (!registered) {
registered = true;
formContext.addField(eventKey, {
fieldValue: fieldValue,
fieldId: fieldId,
fieldName: fieldName,
resetField: resetField,
clearValidate: clearValidate,
namePath: namePath,
validateRules: validateRules,
rules: rulesRef
});
}
} else {
registered = false;
formContext.removeField(eventKey);
}
}, {
immediate: true
});
onBeforeUnmount(function () {
formContext.removeField(eventKey);
});
var debounceErrors = useDebounce(errors);
var mergedValidateStatus = computed(function () {
if (props.validateStatus !== undefined) {
return props.validateStatus;
} else if (debounceErrors.value.length) {
return 'error';
}
return validateState.value;
});
var itemClassName = computed(function () {
var _ref3;
return _ref3 = {}, _defineProperty(_ref3, "".concat(prefixCls.value, "-item"), true), _defineProperty(_ref3, "".concat(prefixCls.value, "-item-has-feedback"), mergedValidateStatus.value && props.hasFeedback), _defineProperty(_ref3, "".concat(prefixCls.value, "-item-has-success"), mergedValidateStatus.value === 'success'), _defineProperty(_ref3, "".concat(prefixCls.value, "-item-has-warning"), mergedValidateStatus.value === 'warning'), _defineProperty(_ref3, "".concat(prefixCls.value, "-item-has-error"), mergedValidateStatus.value === 'error'), _defineProperty(_ref3, "".concat(prefixCls.value, "-item-is-validating"), mergedValidateStatus.value === 'validating'), _defineProperty(_ref3, "".concat(prefixCls.value, "-item-hidden"), props.hidden), _ref3;
});
return function () {
var _slots$default, _props$help;
if (props.noStyle) return (_slots$default = slots.default) === null || _slots$default === void 0 ? void 0 : _slots$default.call(slots);
var help = (_props$help = props.help) !== null && _props$help !== void 0 ? _props$help : slots.help ? filterEmpty(slots.help()) : null;
return _createVNode(Row, _objectSpread(_objectSpread({}, attrs), {}, {
"class": [itemClassName.value, help !== undefined && help !== null || debounceErrors.value.length ? "".concat(prefixCls.value, "-item-with-help") : '', attrs.class],
"key": "row"
}), {
default: function _default() {
var _props$label, _slots$label, _props$extra, _slots$extra;
return _createVNode(_Fragment, null, [_createVNode(FormItemLabel, _objectSpread(_objectSpread({}, props), {}, {
"htmlFor": htmlFor.value,
"required": isRequired.value,
"requiredMark": formContext.requiredMark.value,
"prefixCls": prefixCls.value,
"onClick": onLabelClick,
"label": (_props$label = props.label) !== null && _props$label !== void 0 ? _props$label : (_slots$label = slots.label) === null || _slots$label === void 0 ? void 0 : _slots$label.call(slots)
}), null), _createVNode(FormItemInput, _objectSpread(_objectSpread({}, props), {}, {
"errors": help !== undefined && help !== null ? toArray(help) : debounceErrors.value,
"prefixCls": prefixCls.value,
"status": mergedValidateStatus.value,
"ref": inputRef,
"help": help,
"extra": (_props$extra = props.extra) !== null && _props$extra !== void 0 ? _props$extra : (_slots$extra = slots.extra) === null || _slots$extra === void 0 ? void 0 : _slots$extra.call(slots)
}), {
default: slots.default
})]);
}
});
};
}
});