# Tree
對 `antv` 的 tree 組件進行封裝
## Usage
```vue
<template>
<BasicTree :treeData="treeData" />
</template>
<script lang="ts">
import { defineComponent } from 'vue';
import { BasicTree } from '/@/components/Tree/index';
import { treeData } from './data';
import { CollapseContainer } from '/@/components/Container/index';
import { TreeItem } from '/@/components/Tree/index';
export const treeData: TreeItem[] = [
{
title: 'parent 1',
key: '0-0',
icon: 'home|svg',
children: [
{ title: 'leaf', key: '0-0-0' },
{
title: 'leaf',
key: '0-0-1',
children: [
{ title: 'leaf', key: '0-0-0-0' },
{ title: 'leaf', key: '0-0-0-1' },
],
},
],
},
{
title: 'parent 2',
key: '1-1',
icon: 'home|svg',
children: [
{ title: 'leaf', key: '1-1-0' },
{ title: 'leaf', key: '1-1-1' },
],
},
{
title: 'parent 3',
key: '2-2',
icon: 'home|svg',
children: [
{ title: 'leaf', key: '2-2-0' },
{ title: 'leaf', key: '2-2-1' },
],
},
];
export default defineComponent({
components: { BasicTree, CollapseContainer },
setup() {
return { treeData };
},
});
</script>
```
## Props
::: tip 溫馨提醒
除以下參數外,官方文檔內的 props 也都支持,具體可以參考 [antv tree](https://2x.antdv.com/components/tree-cn/#Tree-props)
:::
| 屬性 | 類型 | 默認值 | 可選值 | 說明 | 版本 |
| ---------------- | ------------------------- | ------ | ------ | ---------------------------- | - |
| treeData | `TreeItem[]` | - | - | 樹組件數據 | |
| rightMenuList | `ContextMenuItem[]` | - | - | 右鍵菜單列表 | |
| checkedKeys | `string[]` | - | - | 勾選的節點 | |
| selectedKeys | `string[]` | - | - | 選中的節點 | |
| expandedKeys | `string[]` | - | - | 展開的節點 | |
| actionList | `ActionItem[]` | - | - | 鼠標移動上去右邊操作按鈕列表 | |
| title | `string` | - | - | 定制標題字符串 | |
| toolbar | `boolean` | - | - | 是否顯示工具欄 | |
| search | `boolean` | - | - | 顯示搜索框 | |
| clickRowToExpand | `boolean` | - | - | 是否在點擊行時自動展開 | |
| beforeRightClick | `(node, event)=>ContextMenuItem[]` | - | - | 右鍵點擊回調,可返回右鍵菜單列表數據來生成右鍵菜單 | |
| rightMenuList | `ContextMenuItem[]` | - | - | 右鍵菜單列表數據 | |
| defaultExpandLevel | `string | number` | - | - | 初次渲染后默認展開的層級 | 2.4.1 |
| defaultExpandAll | `boolean` | `false` | `true/false` | 初次渲染后默認全部 | 2.4.1 |
| searchValue(v-model) | `string` | - | - | 當前搜索詞 | 2.7.1 |
::: tip 注意
`defaultExpandLevel`、`defaultExpandAll` 僅在**初次渲染**時生效。如果`basicTree`是在創建完畢之后才設置的`treeData`(如異步數據),需要在更新后自己調用`basicTree`提供的`expandAll`、`filterByLevel`來執行展開
:::
**ActionItem**
```ts
{
// 渲染的圖標
render: (record: any) => any;
// 是否顯示
show?: boolean | ((record: Recordable) => boolean);
}
```
**ContextMenuItem**
```ts
{
// 文本
label: string;
// 圖標
icon?: string;
// 是否禁用
disabled?: boolean;
// 事件
handler?: (...arg) => any;
// 是否顯示分隔線
divider?: boolean;
// 子級菜單數據
children?: ContextMenuItem[];
}
```
## Slots
::: tip 溫馨提醒
官方文檔內的 slot 都支持,具體可以參考 [antv tree](https://2x.antdv.com/components/tree-cn/#Tree-props)
:::
## Methods
| 名稱 | 回調參數 | 說明 |
| --------------- | ---------------------------------------------------- | ---------------------- |
| checkAll | `(checkAll: boolean) => void` | 選擇所有 |
| expandAll | `(expandAll: boolean) => void` | 展開所有 |
| setExpandedKeys | `(keys: Keys) => void` | 設置展開節點 |
| getExpandedKeys | `() => Keys` | 獲取展開節點 |
| setSelectedKeys | `(keys: Keys) => void` | 設置選中節點 |
| getSelectedKeys | `() => Keys` | 獲取選中節點 |
| setCheckedKeys | `(keys: CheckKeys) => void` | 設置勾選節點 |
| getCheckedKeys | `() => CheckKeys` | 獲取勾選節點 |
| filterByLevel | `(level: number) => void` | 顯示指定等級 |
| insertNodeByKey | `(opt: InsertNodeParams) => void` | 插入子節點到指定節點內 |
| deleteNodeByKey | `(key: string) => void` | 根據 key 刪除節點 |
| updateNodeByKey | `(key: string, node: Omit<TreeItem, 'key'>) => void` | 根據 key 更新節點 |
| setSearchValue | `(value: string) => void` | 設置當前搜索詞(v2.7.1) |
| getSearchValue | `() => string` | 獲取當前搜索詞(v2.7.1) |
- 項目介紹
- 常見問題
- 開發環境準備
- 環境準備
- 啟動項目
- 切換Vue3路由
- 項目配置詳細說明
- 上線部署
- 快速構建&部署
- Docker鏡像啟動
- 項目配置
- 菜單配置
- 菜單緩存
- 積木報表菜單配置
- 首頁配置
- 國際化
- 菜單國際化
- 組件注冊
- 項目規范
- 跨域處理
- 樣式庫
- 圖標生成
- package依賴介紹
- 菜單TAB風格
- 備份文檔
- 詳細構建和配置
- 構建部署1.0
- 切換Mock接口
- 原生路由(作廢)
- 原生菜單(作廢)
- 頁面開啟緩存(作廢)
- 環境準備1.0
- 數據 mock&聯調
- UI組件
- Form 表單組件
- Table 表格
- Modal 彈窗
- Drawer 抽屜組件
- Icon 圖標組件
- Button 按鈕
- 更多基礎組件
- JSelectUser選擇用戶 ?
- JSelectPosition崗位選擇 ?
- JSelectDept部門選擇 ?
- JCheckbox ?
- JImportModal 列表導入彈窗組件
- JInput特殊查詢組件 ?
- JPopup彈窗選擇組件 ?
- JTreeSelect樹形下拉框 (異步加載) ?
- JAreaSelect 省市縣級聯組件
- JDictSelectTag 字典標簽 ?
- JEllipsis 超長截取顯示組件 ?
- JUpload 上傳組件 ?
- JEasyCron 定時表達式選擇組件 ?
- JInputPopup 多行輸入窗口組件 ?
- JSwitch 開關選擇組件 ?
- JTreeDict 分類字典樹形下拉組件 ?
- JSelectInput 可輸入下拉框 ?
- JEditor 富文本編輯器 ?
- JMarkdownEditor Markdown編輯器 ?
- JSearchSelect 字典表的搜索組件 ?
- JSelectUserByDept 根據部門選擇用戶 ?
- JVxeTable
- 組件配置文檔
- 自定義組件
- 封裝自定義組件
- 自定義組件增強
- 多級聯動配置
- 使用示例
- 常見問題解答
- JAreaLinkage 省市縣聯動組件 ?
- JCategorySelect 分類字典樹 ?
- JImageUpload 圖片上傳 ?
- JSelectMultiple 下拉多選 ?
- JSelectRole 選擇角色 ?
- JFormContainer 表單組件禁用 ?
- SuperQuery 高級查詢
- UserSelect 高級用戶選擇組件
- Basic
- Page
- Authority
- PopConfirmButton
- CollapseContainer
- ScrollContainer
- LazyContainer
- CodeEditor
- JsonPreview
- CountDown
- ClickOutSide
- CountTo
- Cropper
- Description
- FlowChart
- Upload
- Tree
- Excel
- Qrcode
- Markdown
- Loading
- Tinymce
- Time
- StrengthMeter
- Verify
- Transition
- VirtualScroll
- ContextMenu
- Preview
- Loading
- 前端權限
- 表單權限
- 顯隱控制 ?
- 禁用控制 ?
- 列表權限
- 按鈕權限控制
- 列字段顯隱控制
- 行編輯組件權限
- 顯隱控制
- 禁用控制
- 代碼生成
- Online在線代碼生成
- GUI代碼生成
- 代碼生成模板介紹
- vue3和vue3Native詳細說明
- 深入開發
- 定義Form新組件
- 自定義列表查詢
- 自定義表單布局
- 開發筆記
- 組件權限控制
- 使用Antd Vue原生Form
- 自定義圖表組件
- 自定義渲染函數
- 如何編寫mock接口
- 緩存用法
- 精簡版代碼制作
- 微前端(qiankun)集成
- 前端小技巧
- 表單整體禁用
- 彈框內下拉框錯位
- 界面如何設置響應式
- 抽屜(Drawer)寬度自適應
- 生成菜單腳本
- Online表單
- Online常見問題
- Online表單配置
- 配置參數說明
- 系統標準字段
- 表單類型-主子表|樹表
- 自定義查詢配置
- Online表單風格
- Online表單刪除說明
- Online聯合查詢配置
- online表單視圖功能說明
- Online表單開啟評論
- Online表單控件介紹
- 常用基礎控件
- 高級關聯記錄
- Online表單控件配置
- 基本配置
- 控件擴展配置
- 默認值表達式
- 自定義查詢配置
- 字段href
- 默認值(填值規則)
- 導入導出自定義規則
- Online表單權限配置
- 字段權限配置與授權
- 按鈕權限配置與授權
- 數據權限配置與授權
- 聯合查詢數據權限規則說明
- 在線增強
- 自定義按鈕
- SQL增強
- JS增強
- 按鈕觸發JS增強
- 列表Api
- 列表操作列前置事件
- 表單Api
- beforeSubmit事件
- loaded事件
- 表單值改變事件【單表/主表】
- 表單值改變事件【從表】
- 表單值改變事件【從改主】
- 控制字段顯示與隱藏
- js增強實現下拉聯動
- js增強控制下拉樹數據
- JS增強 觸發彈窗
- JS增強 http請求
- JS增強 方法定義
- 對接表單設計器后需注意
- JAVA增強
- 快速開始
- Online java增強 導入
- Online java增強 導出
- Online java增強 查詢
- Online Java增強 http-api
- 表單類
- 列表類
- 其他功能示例
- 導入數據庫表支持排除表
- 通過字段Href實現三級聯動
- excel數據導入支持校驗
- Online報表
- Online報表配置
- 配置成菜單
- 其他功能
- 推送消息
- ISO 8601書寫格式
- 系統消息跳轉至詳情表單
- 菜單【批量申請(自定義)】功能說明
- Online自動化測試
- online AI自動化測試數據制作
- Online AI自動化測試數據制作
- Online AI模型測試用例功能詳情
- JAVA后臺功能
- saas多租戶切換
- 新功能實現saas租戶隔離
- 第三方集成
- 敲敲云集成釘釘