element-plus/packages/tree/src/tree.type.ts

A Component Library for Vue3.0

import { ComponentInternalInstance, VNode, h, SetupContext, Ref } from 'vue'
import Node from './model/node'
import TreeStore from './model/tree-store'

export interface RootTreeType {
    ctx: SetupContext<any>
    props: TreeComponentProps
    store: Ref<TreeStore>
    root: Ref<Node>
    currentNode: Ref<Node>
    instance: ComponentInternalInstance
  }

export declare type hType = typeof h
export declare type TreeData = TreeNodeData[]
export declare type TreeKey = string | number
export declare interface FakeNode {
    data: TreeNodeData
}
export declare interface TreeNodeData {
    [key: string]: any
}
export declare interface TreeNodeLoadedDefaultProps {
    checked?: boolean
}
export declare interface TreeNodeChildState {
    all: boolean
    none: boolean
    allWithoutDisable: boolean
    half: boolean
}
export declare interface TreeNodeOptions {
    data: TreeNodeData
    store: TreeStore
    parent?: Node
}
export declare interface TreeStoreNodesMap {
    [key: string]: Node
}
export declare interface TreeStoreOptions {
    key: TreeKey
    data: TreeData
    lazy: boolean
    props: TreeOptionProps
    load: LoadFunction
    currentNodeKey: TreeKey
    checkStrictly: boolean
    checkDescendants: boolean
    defaultCheckedKeys: TreeKey[]
    defaultExpandedKeys: TreeKey[]
    autoExpandParent: boolean
    defaultExpandAll: boolean
    filterNodeMethod: FilterNodeMethodFunction
}
export declare interface TreeOptionProps {
    children: string
    label: string
    disabled: string
    isLeaf?: boolean
}
export declare type RenderContentFunction = (h: hType, context: RenderContentContext) => (VNode | VNode[])
export declare interface RenderContentContext {
    _self: ComponentInternalInstance
    node: Node
    data: TreeNodeData
    store: TreeStore
}
export declare type AllowDragFunction = (node: Node) => boolean
export declare type DropType = 'inner' | 'prev' | 'next'
export declare type AllowDropFunction = (draggingNode: Node, dropNode: Node, type: DropType) => boolean
export declare type LoadFunction = (rootNode: Node, loadedCallback: (data: TreeData) => void) => void
export declare type FilterValue = any
export declare type FilterNodeMethodFunction = (value: FilterValue, data: TreeNodeData, child: Node) => boolean
export declare interface TreeComponentProps {
    data: TreeData
    emptyText: string
    renderAfterExpand: boolean
    nodeKey: string
    checkStrictly: boolean
    expandOnClickNode: boolean
    defaultExpandAll: boolean
    checkOnClickNode: boolean
    checkDescendants: boolean
    autoExpandParent: boolean
    defaultCheckedKeys: TreeKey[]
    defaultExpandedKeys: TreeKey[]
    currentNodeKey: TreeKey
    renderContent: RenderContentFunction
    showCheckbox: boolean
    draggable: boolean
    allowDrag: AllowDragFunction
    allowDrop: AllowDropFunction
    props: TreeOptionProps
    lazy: boolean
    highlightCurrent: boolean
    load: LoadFunction
    filterNodeMethod: FilterNodeMethodFunction
    accordion: boolean
    indent: number
    iconClass: string
}