ant-design-vue/components/_util/props-util.js

423 lines
11 KiB
JavaScript
Raw Normal View History

2019-01-12 03:33:27 +00:00
import isPlainObject from 'lodash/isPlainObject';
import classNames from 'classnames';
import { isVNode, Fragment, Comment, Text } from 'vue';
2020-06-12 10:27:07 +00:00
import { camelize, hyphenate, isOn, resolvePropValue } from './util';
2020-07-01 16:24:44 +00:00
import isValid from './isValid';
2020-05-27 15:56:00 +00:00
// function getType(fn) {
// const match = fn && fn.toString().match(/^\s*function (\w+)/);
// return match ? match[1] : '';
// }
2018-05-06 13:50:05 +00:00
2020-05-28 11:45:50 +00:00
const splitAttrs = attrs => {
const allAttrs = Object.keys(attrs);
2020-06-10 10:21:16 +00:00
const eventAttrs = {};
const onEvents = {};
const extraAttrs = {};
2020-05-28 11:45:50 +00:00
for (let i = 0, l = allAttrs.length; i < l; i++) {
const key = allAttrs[i];
if (isOn(key)) {
2020-06-10 10:21:16 +00:00
eventAttrs[key[2].toLowerCase() + key.slice(3)] = attrs[key];
onEvents[key] = attrs[key];
2020-05-28 11:45:50 +00:00
} else {
2020-06-10 10:21:16 +00:00
extraAttrs[key] = attrs[key];
2020-05-28 11:45:50 +00:00
}
}
2020-06-10 10:21:16 +00:00
return { onEvents, events: eventAttrs, extraAttrs };
2020-05-28 11:45:50 +00:00
};
2018-03-08 05:55:49 +00:00
const parseStyleText = (cssText = '', camel) => {
2019-01-12 03:33:27 +00:00
const res = {};
const listDelimiter = /;(?![^(]*\))/g;
const propertyDelimiter = /:(.+)/;
cssText.split(listDelimiter).forEach(function(item) {
2018-03-01 11:09:45 +00:00
if (item) {
2019-01-12 03:33:27 +00:00
const tmp = item.split(propertyDelimiter);
2018-03-08 05:55:49 +00:00
if (tmp.length > 1) {
2019-01-12 03:33:27 +00:00
const k = camel ? camelize(tmp[0].trim()) : tmp[0].trim();
res[k] = tmp[1].trim();
2018-03-08 05:55:49 +00:00
}
2018-03-01 11:09:45 +00:00
}
2019-01-12 03:33:27 +00:00
});
return res;
};
2018-03-01 11:09:45 +00:00
2018-01-12 08:10:41 +00:00
const hasProp = (instance, prop) => {
2020-06-08 10:26:25 +00:00
return prop in getOptionProps(instance);
2019-01-12 03:33:27 +00:00
};
2020-06-08 10:26:25 +00:00
// 重构后直接使用 hasProp 替换
2018-02-07 10:56:58 +00:00
const slotHasProp = (slot, prop) => {
2020-06-08 10:26:25 +00:00
return hasProp(slot, prop);
2019-01-12 03:33:27 +00:00
};
2019-08-07 13:56:30 +00:00
const getScopedSlots = ele => {
return (ele.data && ele.data.scopedSlots) || {};
};
2019-01-12 03:33:27 +00:00
const getSlots = ele => {
let componentOptions = ele.componentOptions || {};
2018-03-29 10:18:41 +00:00
if (ele.$vnode) {
2019-01-12 03:33:27 +00:00
componentOptions = ele.$vnode.componentOptions || {};
2018-03-29 10:18:41 +00:00
}
2019-01-12 03:33:27 +00:00
const children = ele.children || componentOptions.children || [];
const slots = {};
2018-03-29 10:18:41 +00:00
children.forEach(child => {
2019-01-04 15:00:09 +00:00
if (!isEmptyElement(child)) {
2019-01-12 03:33:27 +00:00
const name = (child.data && child.data.slot) || 'default';
slots[name] = slots[name] || [];
slots[name].push(child);
2019-01-04 15:00:09 +00:00
}
2019-01-12 03:33:27 +00:00
});
2019-08-07 13:56:30 +00:00
return { ...slots, ...getScopedSlots(ele) };
2019-01-12 03:33:27 +00:00
};
2020-06-30 10:31:58 +00:00
const flattenChildren = (children = [], filterEmpty = true) => {
const temp = Array.isArray(children) ? children : [children];
const res = [];
temp.forEach(child => {
if (Array.isArray(child)) {
res.push(...flattenChildren(child, filterEmpty));
} else if (child && child.type === Fragment) {
res.push(...flattenChildren(child.children, filterEmpty));
} else if (child && isVNode(child)) {
if (filterEmpty && !isEmptyElement(child)) {
res.push(child);
} else if (!filterEmpty) {
res.push(child);
}
2020-07-01 16:24:44 +00:00
} else if (isValid(child)) {
res.push(child);
2020-06-30 10:31:58 +00:00
}
});
return res;
};
2019-02-13 14:11:27 +00:00
const getSlot = (self, name = 'default', options = {}) => {
2020-06-30 10:31:58 +00:00
if (isVNode(self)) {
if (self.type === Fragment) {
return name === 'default' ? flattenChildren(self.children) : [];
} else if (self.children && self.children[name]) {
return flattenChildren(self.children[name](options));
} else {
return [];
}
} else {
let res = self.$slots[name] && self.$slots[name](options);
return flattenChildren(res);
}
2019-02-13 14:11:27 +00:00
};
2019-08-07 13:56:30 +00:00
2019-01-12 03:33:27 +00:00
const getAllChildren = ele => {
let componentOptions = ele.componentOptions || {};
if (ele.$vnode) {
2019-01-12 03:33:27 +00:00
componentOptions = ele.$vnode.componentOptions || {};
}
2019-01-12 03:33:27 +00:00
return ele.children || componentOptions.children || [];
};
const getSlotOptions = ele => {
if (ele.fnOptions) {
// 函数式组件
return ele.fnOptions;
2018-06-16 13:30:41 +00:00
}
2019-01-12 03:33:27 +00:00
let componentOptions = ele.componentOptions;
2018-02-07 15:03:47 +00:00
if (ele.$vnode) {
2019-01-12 03:33:27 +00:00
componentOptions = ele.$vnode.componentOptions;
2018-02-07 15:03:47 +00:00
}
2019-01-12 03:33:27 +00:00
return componentOptions ? componentOptions.Ctor.options || {} : {};
};
2020-06-18 10:51:56 +00:00
const findDOMNode = instance => {
let node = instance.$el;
2020-06-29 10:43:43 +00:00
while (node && !node.tagName) {
2020-06-18 10:51:56 +00:00
node = node.nextSibling;
}
return node;
};
2019-01-12 03:33:27 +00:00
const getOptionProps = instance => {
2020-06-10 15:06:43 +00:00
const res = {};
if (instance.$ && instance.$.vnode) {
const props = instance.$.vnode.props || {};
Object.keys(instance.$props).forEach(k => {
const v = instance.$props[k];
2020-06-12 10:27:07 +00:00
const hyphenateKey = hyphenate(k);
if (v !== undefined || hyphenateKey in props) {
res[k] = v; // 直接取 $props[k]
2020-06-10 15:06:43 +00:00
}
});
} else if (isVNode(instance) && typeof instance.type === 'object') {
2020-06-17 16:19:14 +00:00
const originProps = instance.props || {};
const props = {};
Object.keys(originProps).forEach(key => {
props[camelize(key)] = originProps[key];
});
2020-06-12 10:27:07 +00:00
const options = instance.type.props;
Object.keys(options).forEach(k => {
2020-06-17 16:19:14 +00:00
const v = resolvePropValue(options, props, k, props[k]);
if (v !== undefined || k in props) {
2020-06-12 10:27:07 +00:00
res[k] = v;
2020-06-10 15:06:43 +00:00
}
});
}
return res;
2019-01-12 03:33:27 +00:00
};
const getComponent = (instance, prop = 'default', options = instance, execute = true) => {
2020-06-30 10:31:58 +00:00
let com = undefined;
2020-06-16 14:55:02 +00:00
if (instance.$) {
const temp = instance[prop];
if (temp !== undefined) {
return typeof temp === 'function' && execute ? temp(options) : temp;
} else {
2020-06-30 10:31:58 +00:00
com = instance.$slots[prop];
2020-06-16 14:55:02 +00:00
com = execute && com ? com(options) : com;
}
} else if (isVNode(instance)) {
const temp = instance.props && instance.props[prop];
2020-06-30 10:31:58 +00:00
if (temp !== undefined && instance.props !== null) {
2020-06-16 14:55:02 +00:00
return typeof temp === 'function' && execute ? temp(options) : temp;
2020-06-30 10:31:58 +00:00
} else if (instance.type === Fragment) {
com = instance.children;
2020-06-24 08:07:03 +00:00
} else if (instance.children && instance.children[prop]) {
2020-06-30 10:31:58 +00:00
com = instance.children[prop];
2020-06-16 14:55:02 +00:00
com = execute && com ? com(options) : com;
}
2020-06-02 15:21:24 +00:00
}
2020-06-30 10:31:58 +00:00
if (Array.isArray(com)) {
com = flattenChildren(com);
com = com.length === 1 ? com[0] : com;
com = com.length === 0 ? undefined : com;
}
return com;
2020-06-02 15:21:24 +00:00
};
const getComponentFromProp = (instance, prop, options = instance, execute = true) => {
2018-02-24 10:12:24 +00:00
if (instance.$createElement) {
2019-01-12 03:33:27 +00:00
const h = instance.$createElement;
const temp = instance[prop];
2018-02-24 10:12:24 +00:00
if (temp !== undefined) {
2019-01-12 03:33:27 +00:00
return typeof temp === 'function' && execute ? temp(h, options) : temp;
2018-02-24 10:12:24 +00:00
}
2019-01-12 03:33:27 +00:00
return (
(instance.$scopedSlots[prop] && execute && instance.$scopedSlots[prop](options)) ||
instance.$scopedSlots[prop] ||
2019-02-13 14:11:27 +00:00
instance.$slots[prop] ||
2019-01-12 03:33:27 +00:00
undefined
);
2018-02-24 10:12:24 +00:00
} else {
2019-01-12 03:33:27 +00:00
const h = instance.context.$createElement;
const temp = getPropsData(instance)[prop];
2018-02-24 10:12:24 +00:00
if (temp !== undefined) {
2019-01-12 03:33:27 +00:00
return typeof temp === 'function' && execute ? temp(h, options) : temp;
2018-02-24 10:12:24 +00:00
}
2019-10-09 11:07:35 +00:00
const slotScope = getScopedSlots(instance)[prop];
if (slotScope !== undefined) {
return typeof slotScope === 'function' && execute ? slotScope(h, options) : slotScope;
}
2019-01-12 03:33:27 +00:00
const slotsProp = [];
2018-02-24 10:12:24 +00:00
const componentOptions = instance.componentOptions || {};
2019-01-12 03:33:27 +00:00
(componentOptions.children || []).forEach(child => {
2018-02-24 10:12:24 +00:00
if (child.data && child.data.slot === prop) {
if (child.data.attrs) {
delete child.data.attrs.slot;
}
2018-03-10 12:46:57 +00:00
if (child.tag === 'template') {
2019-01-12 03:33:27 +00:00
slotsProp.push(child.children);
2018-03-10 12:46:57 +00:00
} else {
2019-01-12 03:33:27 +00:00
slotsProp.push(child);
2018-03-10 12:46:57 +00:00
}
2018-02-24 10:12:24 +00:00
}
2019-01-12 03:33:27 +00:00
});
return slotsProp.length ? slotsProp : undefined;
2018-01-12 11:04:42 +00:00
}
2019-01-12 03:33:27 +00:00
};
2018-01-12 11:04:42 +00:00
2019-01-12 03:33:27 +00:00
const getAllProps = ele => {
2020-06-16 14:55:02 +00:00
let props = getOptionProps(ele);
if (ele.$) {
props = { ...props, ...this.$attrs };
} else {
2020-06-20 07:14:51 +00:00
props = { ...ele.props, ...props };
2018-07-11 09:51:20 +00:00
}
2020-06-16 14:55:02 +00:00
return props;
2019-01-12 03:33:27 +00:00
};
2018-07-11 09:51:20 +00:00
2020-06-29 10:43:43 +00:00
const getPropsData = ins => {
const vnode = ins.$ ? ins.$ : ins;
2020-06-20 07:14:51 +00:00
const res = {};
const originProps = vnode.props || {};
const props = {};
Object.keys(originProps).forEach(key => {
props[camelize(key)] = originProps[key];
});
2020-06-21 14:45:30 +00:00
const options = isPlainObject(vnode.type) ? vnode.type.props : {};
2020-06-20 07:14:51 +00:00
Object.keys(options).forEach(k => {
const v = resolvePropValue(options, props, k, props[k]);
if (k in props) {
// 仅包含 props不包含默认值
res[k] = v;
}
});
2020-06-22 08:26:10 +00:00
return { ...props, ...res }; // 合并事件、未声明属性等
2019-01-12 03:33:27 +00:00
};
2018-02-24 10:12:24 +00:00
const getValueByProp = (ele, prop) => {
2019-01-12 03:33:27 +00:00
return getPropsData(ele)[prop];
};
2018-02-12 10:10:51 +00:00
2019-01-12 03:33:27 +00:00
const getAttrs = ele => {
let data = ele.data;
2018-02-12 10:10:51 +00:00
if (ele.$vnode) {
2019-01-12 03:33:27 +00:00
data = ele.$vnode.data;
2018-02-12 10:10:51 +00:00
}
2019-01-12 03:33:27 +00:00
return data ? data.attrs || {} : {};
};
2018-02-12 10:10:51 +00:00
2019-01-12 03:33:27 +00:00
const getKey = ele => {
let key = ele.key;
return key;
};
2018-02-24 10:12:24 +00:00
2020-06-18 10:51:56 +00:00
export function getEvents(ele, on = true) {
let props = {};
if (ele.$) {
props = { ...props, ...ele.$attrs };
} else {
props = { ...props, ...ele.props };
}
return splitAttrs(props)[on ? 'onEvents' : 'events'];
2018-02-24 10:12:24 +00:00
}
2020-06-18 10:51:56 +00:00
2020-06-02 15:21:24 +00:00
export function getEvent(child, event) {
return child.props && child.props[event];
}
2020-01-18 08:14:42 +00:00
2020-05-14 14:30:46 +00:00
// 获取 xxx.native 或者 原生标签 事件
export function getDataEvents(child) {
let events = {};
if (child.data && child.data.on) {
events = child.data.on;
}
return { ...events };
}
2020-01-18 08:14:42 +00:00
// use getListeners instead this.$listeners
// https://github.com/vueComponent/ant-design-vue/issues/1705
export function getListeners(context) {
2020-01-18 13:34:23 +00:00
return (context.$vnode ? context.$vnode.componentOptions.listeners : context.$listeners) || {};
2020-01-18 08:14:42 +00:00
}
2019-01-12 03:33:27 +00:00
export function getClass(ele) {
2020-06-10 10:21:16 +00:00
const props = (isVNode(ele) ? ele.props : ele.$attrs) || {};
let tempCls = props.class || {};
2019-01-12 03:33:27 +00:00
let cls = {};
2018-03-06 14:53:32 +00:00
if (typeof tempCls === 'string') {
2019-01-12 03:33:27 +00:00
tempCls.split(' ').forEach(c => {
cls[c.trim()] = true;
});
} else if (Array.isArray(tempCls)) {
2019-01-12 03:33:27 +00:00
classNames(tempCls)
.split(' ')
.forEach(c => {
cls[c.trim()] = true;
});
2018-03-06 14:53:32 +00:00
} else {
2019-01-12 03:33:27 +00:00
cls = { ...cls, ...tempCls };
2018-03-06 11:14:41 +00:00
}
2019-01-12 03:33:27 +00:00
return cls;
2018-02-24 10:12:24 +00:00
}
2019-01-12 03:33:27 +00:00
export function getStyle(ele, camel) {
2020-06-10 10:21:16 +00:00
const props = (isVNode(ele) ? ele.props : ele.$attrs) || {};
let style = props.style || {};
2018-03-07 13:36:15 +00:00
if (typeof style === 'string') {
2019-01-12 03:33:27 +00:00
style = parseStyleText(style, camel);
} else if (camel && style) {
// 驼峰化
const res = {};
Object.keys(style).forEach(k => (res[camelize(k)] = style[k]));
return res;
2018-03-07 13:36:15 +00:00
}
2019-01-12 03:33:27 +00:00
return style;
2018-02-24 10:12:24 +00:00
}
2019-01-12 03:33:27 +00:00
export function getComponentName(opts) {
return opts && (opts.Ctor.options.name || opts.tag);
2018-02-24 10:12:24 +00:00
}
export function isFragment(c) {
return c.length === 1 && c[0].type === Fragment;
}
2019-01-12 03:33:27 +00:00
export function isEmptyElement(c) {
2020-06-29 14:22:25 +00:00
return (
c.type === Comment ||
(c.type === Fragment && c.children.length === 0) ||
(c.type === Text && c.children.trim() === '')
);
2018-02-24 10:12:24 +00:00
}
Feat 1.5.0 (#1853) * feat: add Result component * fix: update md template tag html>tpl - fix `result` typo - update jest `result` snapshots * refactor: svg file to functional component icon - update jest snapshot * feat: add result * Feat descriptions (#1251) * feat: add descriptions * fix: add descriptions types and fix docs * fix: lint change code * fix: demo warning * fix: update demo, snapshot and remove classnames * test: add descriptions test * fix: descriptions demo (#1498) * feat: add page header (#1250) * feat: add page-header component * update site: page-header * ts definition update: page-header * get page-header props with getComponentFromProp func * optimize page-header * doc: add page-header actions.md responsive.md * breadcrumb itemRender add pure function support * style: format code * feat: update style to 3.23.6 from 2.13.6 * feat: update style to 3.26.8 from 3.23.6 * chore: update util * chore: update util * feat: update affix * feat: update alert * feat: update anchor * feat: update auto-complete * feat: update avatar * feat: update back-top * feat: update badge * feat: update button * feat: update breadcrumb * feat: update ts * docs: update doc * feat: update calendat * feat: update card * feat: update carousel * feat: update carousel * feat: update checkbox * feat: update comment * feat: update config-provider * docs: update doc * feat: update collapse * feat: update locale * feat: update date-picker * feat: update divider * feat: update drawer * feat: update dropdown * feat: update rc-trigger * feat: update dropdown * feat: update empty * test: add empty test * feat: update form * feat: update form * feat: update spin * feat: update grid * docs: update grid doc * feat: update icon * feat: update slider * feat: update textarea * feat: update input-number * feat: update layout * feat: update list * feat: update menu * feat: meaage add key for update content * feat: modal add closeIcon support * feat: update notification * feat: add pagination disabled support * feat: popconfirm add disabled support * test: update popover * feat: progress support custom line-gradiend * feat: update radio * test: update radio test * docs: update rate demo * feat: skeleton add avatar support number type * test: add switch test * test: update statistic test * fix: input clear icon event * feat: steps add type、 v-model、subTitle * feat: delete typography component * feat: delete Typography style * perf: update select * feat: add download transformFile previewFile actio * docs: update upload * feat: update tree-select * docs: update tree-select * feat: tree add blockNode selectable * docs: add tree demo * test: update snap * docs: updatedoc * feat: update tag * docs: update ad doc * feat: update tooltip * feat: update timeline * feat: time-picker add clearIcon * docs: update tabs * feat: transfer support custom children * test: update transfer test * feat: update table * test: update table test * test: update test * feat: calendar update locale * test: update test snap * feat: add mentions (#1790) * feat: mentions style * feat: theme default * feat: add mentions component * feat: mentions API * feat: add unit test for mentions * feat: update mentions demo * perf: model and inheritAttrs for mentions * perf: use getComponentFromProp instead of this.$props * perf: mentions rm defaultProps * feat: rm rows in mentionsProps * fix: mentions keyDown didn't work * docs: update mentions api * perf: mentions code * feat: update mentions * bump 1.5.0-alpha.1 * feat: pageheader add ghost prop * docs: update descriptions demo * chore: page-header add ghost type * fix: color error * feat: update to 3.26.12 * fix: some prop default value * fix(typo): form, carousel, upload. duplicate identifier (#1848) * Add Mentions Type (#1845) * feat: add mentions type * feat: add mentions in ant-design-vue.d.ts * docs: update doc * docs: add changelog * fix: mentions getPopupCotainer value (#1850) * docs: update doc * docs: uptate demo * docs: update demo * docs: delete demo * docs: delete doc * test: update snapshots * style: format code * chore: update travis * docs: update demo Co-authored-by: Sendya <18x@loacg.com> Co-authored-by: zkwolf <chenhao5866@gmail.com> Co-authored-by: drafish <xwlyy1991@163.com> Co-authored-by: Amour1688 <31695475+Amour1688@users.noreply.github.com>
2020-03-07 11:45:13 +00:00
export function isStringElement(c) {
return !c.tag;
}
2019-01-12 03:33:27 +00:00
export function filterEmpty(children = []) {
2020-06-29 14:22:25 +00:00
const res = [];
children.forEach(child => {
if (Array.isArray(child)) {
res.push(...child);
} else if (child.type === Fragment) {
res.push(...child.children);
} else {
res.push(child);
}
});
return res.filter(c => !isEmptyElement(c));
2018-02-24 10:12:24 +00:00
}
2018-03-06 11:14:41 +00:00
const initDefaultProps = (propTypes, defaultProps) => {
2018-03-17 13:38:29 +00:00
Object.keys(defaultProps).forEach(k => {
if (propTypes[k]) {
2019-01-12 03:33:27 +00:00
propTypes[k].def && (propTypes[k] = propTypes[k].def(defaultProps[k]));
2018-03-17 13:38:29 +00:00
} else {
2019-01-12 03:33:27 +00:00
throw new Error(`not have ${k} prop`);
2018-03-17 13:38:29 +00:00
}
2019-01-12 03:33:27 +00:00
});
return propTypes;
};
2018-03-12 14:13:59 +00:00
2019-01-12 03:33:27 +00:00
export function mergeProps() {
const args = [].slice.call(arguments, 0);
const props = {};
2019-02-01 09:23:00 +00:00
args.forEach((p = {}) => {
2018-03-12 14:13:59 +00:00
for (const [k, v] of Object.entries(p)) {
2019-01-12 03:33:27 +00:00
props[k] = props[k] || {};
2018-03-17 13:38:29 +00:00
if (isPlainObject(v)) {
2019-01-12 03:33:27 +00:00
Object.assign(props[k], v);
2018-03-17 13:38:29 +00:00
} else {
2019-01-12 03:33:27 +00:00
props[k] = v;
2018-03-17 13:38:29 +00:00
}
2018-03-12 14:13:59 +00:00
}
2019-01-12 03:33:27 +00:00
});
return props;
2018-03-12 14:13:59 +00:00
}
2018-03-17 13:38:29 +00:00
2019-01-12 03:33:27 +00:00
function isValidElement(element) {
2020-06-10 10:21:16 +00:00
return element && element.__v_isVNode && typeof element.type !== 'symbol'; // remove text node
2018-03-25 14:23:04 +00:00
}
2018-02-12 10:10:51 +00:00
export {
2020-05-28 11:45:50 +00:00
splitAttrs,
2018-02-12 10:10:51 +00:00
hasProp,
getOptionProps,
2020-06-02 15:21:24 +00:00
getComponent,
2018-02-12 10:10:51 +00:00
getComponentFromProp,
getSlotOptions,
slotHasProp,
getPropsData,
getKey,
getAttrs,
2018-02-24 10:12:24 +00:00
getValueByProp,
2018-03-03 11:14:03 +00:00
parseStyleText,
2018-03-06 11:14:41 +00:00
initDefaultProps,
2018-03-25 14:23:04 +00:00
isValidElement,
2018-03-29 10:18:41 +00:00
camelize,
getSlots,
2019-02-13 14:11:27 +00:00
getSlot,
2018-07-11 09:51:20 +00:00
getAllProps,
getAllChildren,
2020-06-18 10:51:56 +00:00
findDOMNode,
2020-06-30 10:31:58 +00:00
flattenChildren,
2019-01-12 03:33:27 +00:00
};
export default hasProp;