API 总览

项目的公开 API 按包划分。根据接入方式选择对应文档即可。

@org-tree/core

框架无关的核心包，导出 SDK、类型、默认常量和扁平数据转换函数。

import {
  DEFAULT_FIELD_MAP,
  DEFAULT_IS_LEAF,
  DEFAULT_NODE_SIZE,
  OrgTreeCore,
  UpdateType,
  listToTree,
} from '@org-tree/core'

import type {
  DataSource,
  FieldMap,
  LayoutConfig,
  NodeStatus,
  OrgTreeApi,
  OrgTreeConfig,
  PositionedNode,
  TreeDirection,
} from '@org-tree/core'

• OrgTreeCore：构造、加载、布局、状态和事件
• 类型与常量：全部公开配置和数据类型

@org-tree/vue

Vue 3 渲染层，导出组件和高级集成所需的注入键。

import {
  ORG_TREE_LOCATE_KEY,
  ORG_TREE_SDK_KEY,
  ORG_TREE_STATUS_KEY,
  OrgTree,
  OrgTreeProvider,
} from '@org-tree/vue'

详见 Vue 组件 API。

@org-tree/standalone

浏览器独立产物，主要入口是 createOrgTree()：

const tree = OrgTree.createOrgTree('#tree', options)

详见 Standalone API。

API 稳定性约定

包根入口导出的类、函数、类型和组件视为公开 API。src/core/、布局算法文件、Vue 内部 hooks 和样式类属于实现细节，不建议业务代码直接引用源码路径。

当前包版本为 1.0.0。修改公开类型、方法签名或数据语义时，应同步更新本目录文档和迁移说明。