element-plus/packages/utils/vnode.ts
kooriookami f2e3dcb68e
feat(descriptions): add new feature for customized style (#2358)
* feat(descriptions): add new feature for customized style

add props: width, min-width, align, label-align, class-name, label-class-name

re #1976 #2353

* feat: update docs

* feat: update docs

* feat: update

* feat: separate type
2021-07-03 15:01:55 +08:00

121 lines
2.8 KiB
TypeScript

import { Fragment, Text, Comment, createBlock, openBlock, createCommentVNode, isVNode, camelize } from 'vue'
import type { VNode, VNodeTypes, VNodeChild } from 'vue'
import { hasOwn } from '@vue/shared'
import { warn } from './error'
type Children = VNodeTypes[] | VNodeTypes
const TEMPLATE = 'template'
export const SCOPE = 'VNode'
export enum PatchFlags {
TEXT = 1,
CLASS = 2,
STYLE = 4,
PROPS = 8,
FULL_PROPS = 16,
HYDRATE_EVENTS = 32,
STABLE_FRAGMENT = 64,
KEYED_FRAGMENT = 128,
UNKEYED_FRAGMENT = 256,
NEED_PATCH = 512,
DYNAMIC_SLOTS = 1024,
HOISTED = -1,
BAIL = -2,
}
export const isFragment = (node: VNodeChild) => (node as VNode).type === Fragment
export const isText = (node: VNodeChild) => (node as VNode).type === Text
export const isComment = (node: VNodeChild) => (node as VNode).type === Comment
export const isTemplate = (node: VNodeChild) => (node as VNode).type === TEMPLATE
/**
* get a valid child node (not fragment nor comment)
* @param node {VNode} node to be searched
* @param depth {number} depth to be searched
*/
function getChildren(node: VNode, depth: number): undefined | VNode {
if (isComment(node)) return
if (isFragment(node) || isTemplate(node)) {
return depth > 0
? getFirstValidNode(node.children as VNodeChild, depth - 1)
: undefined
}
return node
}
/**
* determine if the element is a valid element type rather than fragments and comment e.g. <template> v-if
* @param node {VNode} node to be tested
*/
export const isValidElementNode = (node: VNodeChild) =>
!(isFragment(node) || isComment(node))
export const getFirstValidNode = (
nodes: VNodeChild,
maxDepth = 3,
): ReturnType<typeof getChildren> => {
if (Array.isArray(nodes)) {
return getChildren(nodes[0] as VNode, maxDepth)
} else {
return getChildren(nodes as VNode, maxDepth)
}
}
export function renderIf(
condition: boolean,
node: VNodeTypes,
props: any,
children?: Children,
patchFlag?: number,
patchProps?: string[],
) {
return (
condition
? renderBlock(node, props, children, patchFlag, patchProps)
: createCommentVNode('v-if', true)
)
}
export function renderBlock(
node: VNodeTypes,
props: any,
children?: Children,
patchFlag?: number,
patchProps?: string[],
) {
return (openBlock(), createBlock(node, props, children, patchFlag, patchProps))
}
/**
* todo
* get normalized props from VNode
* @param node
*/
export const getNormalizedProps = (node: VNode) => {
if (!isVNode(node)) {
warn(SCOPE, 'value must be a VNode')
return
}
const raw = node.props || {}
const type = node.type?.props || {}
const props = {}
Object.keys(type).forEach(key => {
if (hasOwn(type[key], 'default')) {
props[key] = type[key].default
}
})
Object.keys(raw).forEach(key => {
props[camelize(key)] = raw[key]
})
return props
}