ant-design-vue/components/vc-tree-select/src/util.js

426 lines
10 KiB
JavaScript

import warning from 'warning';
import omit from 'omit.js';
import {
convertDataToTree as vcConvertDataToTree,
convertTreeToEntities as vcConvertTreeToEntities,
conductCheck as rcConductCheck,
} from '../../vc-tree/src/util';
import SelectNode from './SelectNode';
import { SHOW_CHILD, SHOW_PARENT } from './strategies';
import { getSlots, getPropsData, isEmptyElement } from '../../_util/props-util';
let warnDeprecatedLabel = false;
// =================== MISC ====================
export function toTitle(title) {
if (typeof title === 'string') {
return title;
}
return null;
}
export function toArray(data) {
if (data === undefined || data === null) return [];
return Array.isArray(data) ? data : [data];
}
export function createRef() {
const func = function setRef(node) {
func.current = node;
};
return func;
}
// =============== Legacy ===============
export const UNSELECTABLE_STYLE = {
userSelect: 'none',
WebkitUserSelect: 'none',
};
export const UNSELECTABLE_ATTRIBUTE = {
unselectable: 'unselectable',
};
/**
* Convert position list to hierarchy structure.
* This is little hack since use '-' to split the position.
*/
export function flatToHierarchy(positionList) {
if (!positionList.length) {
return [];
}
const entrances = {};
// Prepare the position map
const posMap = {};
const parsedList = positionList.slice().map(entity => {
const clone = {
...entity,
fields: entity.pos.split('-'),
};
delete clone.children;
return clone;
});
parsedList.forEach(entity => {
posMap[entity.pos] = entity;
});
parsedList.sort((a, b) => {
return a.fields.length - b.fields.length;
});
// Create the hierarchy
parsedList.forEach(entity => {
const parentPos = entity.fields.slice(0, -1).join('-');
const parentEntity = posMap[parentPos];
if (!parentEntity) {
entrances[entity.pos] = entity;
} else {
parentEntity.children = parentEntity.children || [];
parentEntity.children.push(entity);
}
// Some time position list provide `key`, we don't need it
delete entity.key;
delete entity.fields;
});
return Object.keys(entrances).map(key => entrances[key]);
}
// =============== Accessibility ===============
let ariaId = 0;
export function resetAriaId() {
ariaId = 0;
}
export function generateAriaId(prefix) {
ariaId += 1;
return `${prefix}_${ariaId}`;
}
export function isLabelInValue(props) {
const { treeCheckable, treeCheckStrictly, labelInValue } = props;
if (treeCheckable && treeCheckStrictly) {
return true;
}
return labelInValue || false;
}
// =================== Tree ====================
export function parseSimpleTreeData(treeData, { id, pId, rootPId }) {
const keyNodes = {};
const rootNodeList = [];
// Fill in the map
const nodeList = treeData.map(node => {
const clone = { ...node };
const key = clone[id];
keyNodes[key] = clone;
clone.key = clone.key || key;
return clone;
});
// Connect tree
nodeList.forEach(node => {
const parentKey = node[pId];
const parent = keyNodes[parentKey];
// Fill parent
if (parent) {
parent.children = parent.children || [];
parent.children.push(node);
}
// Fill root tree node
if (parentKey === rootPId || (!parent && rootPId === null)) {
rootNodeList.push(node);
}
});
return rootNodeList;
}
/**
* Detect if position has relation.
* e.g. 1-2 related with 1-2-3
* e.g. 1-3-2 related with 1
* e.g. 1-2 not related with 1-21
*/
export function isPosRelated(pos1, pos2) {
const fields1 = pos1.split('-');
const fields2 = pos2.split('-');
const minLen = Math.min(fields1.length, fields2.length);
for (let i = 0; i < minLen; i += 1) {
if (fields1[i] !== fields2[i]) {
return false;
}
}
return true;
}
/**
* This function is only used on treeNode check (none treeCheckStrictly but has searchInput).
* We convert entity to { node, pos, children } format.
* This is legacy bug but we still need to do with it.
* @param entity
*/
export function cleanEntity({ node, pos, children }) {
const instance = {
node,
pos,
};
if (children) {
instance.children = children.map(cleanEntity);
}
return instance;
}
/**
* Get a filtered TreeNode list by provided treeNodes.
* [Legacy] Since `Tree` use `key` as map but `key` will changed by React,
* we have to convert `treeNodes > data > treeNodes` to keep the key.
* Such performance hungry!
*/
export function getFilterTree(h, treeNodes, searchValue, filterFunc, valueEntities) {
if (!searchValue) {
return null;
}
function mapFilteredNodeToData(node) {
if (!node || isEmptyElement(node)) return null;
let match = false;
if (filterFunc(searchValue, node)) {
match = true;
}
let children = getSlots(node).default;
children = ((typeof children === 'function' ? children() : children) || [])
.map(mapFilteredNodeToData)
.filter(n => n);
if (children.length || match) {
return (
<SelectNode {...node.data} key={valueEntities[getPropsData(node).value].key}>
{children}
</SelectNode>
);
}
return null;
}
return treeNodes.map(mapFilteredNodeToData).filter(node => node);
}
// =================== Value ===================
/**
* Convert value to array format to make logic simplify.
*/
export function formatInternalValue(value, props) {
const valueList = toArray(value);
// Parse label in value
if (isLabelInValue(props)) {
return valueList.map(val => {
if (typeof val !== 'object' || !val) {
return {
value: '',
label: '',
};
}
return val;
});
}
return valueList.map(val => ({
value: val,
}));
}
export function getLabel(wrappedValue, entity, treeNodeLabelProp) {
if (wrappedValue.label) {
return wrappedValue.label;
}
if (entity) {
const props = getPropsData(entity.node);
if (Object.keys(props).length) {
return props[treeNodeLabelProp];
}
}
// Since value without entity will be in missValueList.
// This code will never reached, but we still need this in case.
return wrappedValue.value;
}
/**
* Convert internal state `valueList` to user needed value list.
* This will return an array list. You need check if is not multiple when return.
*
* `allCheckedNodes` is used for `treeCheckStrictly`
*/
export function formatSelectorValue(valueList, props, valueEntities) {
const { treeNodeLabelProp, treeCheckable, treeCheckStrictly, showCheckedStrategy } = props;
// Will hide some value if `showCheckedStrategy` is set
if (treeCheckable && !treeCheckStrictly) {
const values = {};
valueList.forEach(wrappedValue => {
values[wrappedValue.value] = wrappedValue;
});
const hierarchyList = flatToHierarchy(valueList.map(({ value }) => valueEntities[value]));
if (showCheckedStrategy === SHOW_PARENT) {
// Only get the parent checked value
return hierarchyList.map(({ node }) => {
const value = getPropsData(node).value;
return {
label: getLabel(values[value], valueEntities[value], treeNodeLabelProp),
value,
};
});
}
if (showCheckedStrategy === SHOW_CHILD) {
// Only get the children checked value
const targetValueList = [];
// Find the leaf children
const traverse = ({ node, children }) => {
const value = getPropsData(node).value;
if (!children || children.length === 0) {
targetValueList.push({
label: getLabel(values[value], valueEntities[value], treeNodeLabelProp),
value,
});
return;
}
children.forEach(entity => {
traverse(entity);
});
};
hierarchyList.forEach(entity => {
traverse(entity);
});
return targetValueList;
}
}
return valueList.map(wrappedValue => ({
label: getLabel(wrappedValue, valueEntities[wrappedValue.value], treeNodeLabelProp),
value: wrappedValue.value,
}));
}
/**
* Use `rc-tree` convertDataToTree to convert treeData to TreeNodes.
* This will change the label to title value
*/
function processProps(props) {
const { title, label, value, class: cls, style, on = {} } = props;
let key = props.key;
if (!key && (key === undefined || key === null)) {
key = value;
}
const p = {
props: omit(props, ['on', 'key', 'class', 'className', 'style']),
on,
class: cls || props.className,
style: style,
key,
};
// Warning user not to use deprecated label prop.
if (label && !title) {
if (!warnDeprecatedLabel) {
warning(false, "'label' in treeData is deprecated. Please use 'title' instead.");
warnDeprecatedLabel = true;
}
p.props.title = label;
}
return p;
}
export function convertDataToTree(h, treeData) {
return vcConvertDataToTree(h, treeData, { processProps });
}
/**
* Use `rc-tree` convertTreeToEntities for entities calculation.
* We have additional entities of `valueEntities`
*/
function initWrapper(wrapper) {
return {
...wrapper,
valueEntities: {},
};
}
function processEntity(entity, wrapper) {
const value = getPropsData(entity.node).value;
entity.value = value;
// This should be empty, or will get error message.
const currentEntity = wrapper.valueEntities[value];
if (currentEntity) {
warning(
false,
`Conflict! value of node '${entity.key}' (${value}) has already used by node '${currentEntity.key}'.`,
);
}
wrapper.valueEntities[value] = entity;
}
export function convertTreeToEntities(treeNodes) {
return vcConvertTreeToEntities(treeNodes, {
initWrapper,
processEntity,
});
}
/**
* https://github.com/ant-design/ant-design/issues/13328
* We need calculate the half check key when searchValue is set.
*/
// TODO: This logic may better move to rc-tree
export function getHalfCheckedKeys(valueList, valueEntities) {
const values = {};
// Fill checked keys
valueList.forEach(({ value }) => {
values[value] = false;
});
// Fill half checked keys
valueList.forEach(({ value }) => {
let current = valueEntities[value];
while (current && current.parent) {
const parentValue = current.parent.value;
if (parentValue in values) break;
values[parentValue] = true;
current = current.parent;
}
});
// Get half keys
return Object.keys(values)
.filter(value => values[value])
.map(value => valueEntities[value].key);
}
export const conductCheck = rcConductCheck;