Files
aibridge/docs/control/12-examples/extend-examples.md
T
2026-05-18 09:28:15 +08:00

218 lines
5.4 KiB
Markdown

# extend 代码示例索引
## 源码位置
```
$ccWorkDir/web/apps/jnpf-web-apps-main/src/views/extend/
```
---
## 表格模式 (tableDemo)
| 目录 | 说明 | 关键特性 |
|------|------|----------|
| commonTable | 通用表格 | useVxeTable, formConfig, actionColumn |
| treeTable | 树形表格 | BasicLeftTree, searchInfo, immediate |
| groupingTable | 分组表格 | isTreeTable, afterFetch, 父子结构 |
| mergeTable | 合并单元格 | spanMethod, rowspan/colspan |
| lockTable | 锁定列 | fixed: 'left'/'right', minWidth |
| postilTable | 批注表格 | postilCount, 批注弹窗 |
| redactTable | 行内编辑 | tabClickId, 动态组件 |
| signTable | 标记表格 | 颜色标记, a-dropdown |
| printTable | 打印表格 | printJS, printable |
| statisticsTable | 统计表格 | showFooter, footerMethod |
| extension | 扩展表格 | expandConfig, lazy, VxeGrid |
| complexHeader | 复杂表头 | children, 多层表头 |
| tableTree | 表格树 | isTreeTable, 字典数据 |
---
## 表单模式 (formDemo)
| 目录 | 说明 | 关键特性 |
|------|------|----------|
| fieldForm1 | 文本数字 | a-input, a-input-number, jnpf-date-picker |
| fieldForm2 | 选择树 | radio, checkbox, jnpf-select, jnpf-tree-select, cascader |
| fieldForm3 | 上传 | jnpf-upload-file, jnpf-upload-img |
| fieldForm4 | 字段联动 | watch, computed |
| fieldForm5 | 字段联动 | 联动场景 |
| fieldForm6 | 字段联动 | 联动场景 |
| verifyForm | 验证规则 | dataRule, pattern, validator |
| verifyForm1 | 验证规则 | 更多验证示例 |
---
## 图表模式 (graphDemo)
| 目录 | 说明 | 关键特性 |
|------|------|----------|
| echartsBar | 柱状图 | markPoint, markLine, magicType |
| echartsBarAcross | 横向柱状图 | horizontal bar |
| echartsLineArea | 折线面积图 | areaStyle, stack |
| echartsLineBar | 折线柱状图 | yAxis[], 多系列 |
| echartsPie | 饼图 | radius, center, label |
| echartsScatter | 散点图 | symbolSize, scale |
| echartsCandlestick | K线图 | candlestick data |
| echartsFunnel | 漏斗图 | funnel series |
| echartsGauge | 仪表盘 | gauge, progress, timer |
| echartsTree | 树图 | tree data, orient |
---
## 功能扩展
| 目录 | 说明 | 关键特性 |
|------|------|----------|
| barCode | 条码/二维码 | JsBarcode, qrcode, canvas |
| bigData | 大数据表格 | 10000+数据, VxeTable |
| documentPreview | 文档预览 | 本地/在线预览切换 |
| email | 邮件系统 | useVxeTable, useModal, usePopup |
| importAndExport | 导入导出 | openExportModal, openImportModal |
| map | 地图 | AMapLoader, AMap |
| order | 订单管理 | FlowParser, expandConfig, lazy |
| projectGantt | 项目甘特图 | 进度展示, avatar |
| saleOrder | 销售订单 | 主从表, rowClick |
| signature | 电子签章 | ESign, generate |
| signet | 可拖拽印章 | Vue3DraggableResizable |
---
## 关键组件索引
### 表格组件
| 组件 | 用途 |
|------|------|
| BasicVxeTable | 增强表格 |
| BasicLeftTree | 左侧树 |
| TableAction | 表格操作按钮 |
| VxeGrid | 嵌套表格 |
### 表单组件
| 组件 | 用途 |
|------|------|
| BasicForm | 增强表单 |
| useForm | 表单 Hook |
### 弹窗组件
| 组件 | 用途 |
|------|------|
| useModal | 模态框 |
| usePopup | 弹出框 |
### 图表组件
| 组件 | 用途 |
|------|------|
| EchartsUI | ECharts 封装 |
| useEcharts | ECharts Hook |
### 特殊组件
| 组件 | 用途 |
|------|------|
| ESign | 电子签章 |
| Vue3DraggableResizable | 可拖拽容器 |
| ScrollContainer | 滚动容器 |
---
## 常用 API 模式
### HTTP 请求
```typescript
import { defHttp } from '@/api/request';
enum Api {
Prefix = '/api/extend/ResourceName'
}
export function getList(data) {
return defHttp.get({ url: Api.Prefix, data });
}
export function create(data) {
return defHttp.post({ url: Api.Prefix, data });
}
export function update(data) {
return defHttp.put({ url: `${Api.Prefix}/${data.id}`, data });
}
export function del(id) {
return defHttp.delete({ url: `${Api.Prefix}/${id}` });
}
```
### 数据字典
```typescript
import { useBaseStore } from '@/store';
const baseStore = useBaseStore();
const options = (await baseStore.getDictionaryData('DictionaryCode')) as any[];
```
---
## 通用类型定义
### 表格列
```typescript
interface BasicColumn {
title: string; // 列标题
dataIndex: string; // 数据字段
width?: number; // 固定宽度
minWidth?: number; // 最小宽度
fixed?: 'left' | 'right'; // 锁定列
align?: 'center' | 'left' | 'right';
type?: 'seq' | 'checkbox' | 'radio';
format?: string; // 格式化
slots?: { default?: string }; // 插槽
children?: BasicColumn[]; // 复杂表头
}
```
---
## 快速参考
### 创建通用表格
```typescript
const [registerTable, { reload, deleteTableDataRecord }] = useVxeTable({
api: getList,
columns,
useSearchForm: true,
formConfig: { schemas: searchSchemas },
actionColumn: { width: 100, title: '操作', dataIndex: 'action' }
});
```
### 创建图表
```typescript
const chartRef = ref<EchartsUIType>();
const { renderEcharts } = useEcharts(chartRef);
onMounted(() => {
renderEcharts(options);
});
```
### 创建验证规则
```typescript
const dataRule = {
field: [
{ required: true, message: '不能为空', trigger: 'blur' },
{ pattern: /正则/, message: '格式错误', trigger: 'blur' }
]
};
```