Files
2026-05-18 09:28:15 +08:00

191 lines
7.4 KiB
Markdown

# JNPF 控件使用文档
## 文档概述
本目录收录 JNPF 低代码平台全部控件的使用文档,包含快速查询、详细配置说明、示例参考等内容。
## 文档索引
### 入门
| 文档 | 说明 |
|------|------|
| [01-quick-ref.md](01-quick-ref.md) | **控件快速使用速查** - 表格形式速查所有控件 |
| [控件完整清单](#控件完整清单) | 按类别整理的控件速查表 |
### 控件详细文档
| 文档 | 说明 | 包含控件 |
|------|------|----------|
| [02-input-controls.md](02-input-controls.md) | 输入类控件 | input, textarea, inputNumber |
| [03-select-controls.md](03-select-controls.md) | 选择类控件 | select, radio, checkbox, cascader, treeSelect, organizeSelect, userSelect |
| [04-date-controls.md](04-date-controls.md) | 日期时间控件 | date, datetime, time |
| [05-upload-controls.md](05-upload-controls.md) | 上传控件 | uploadImg, uploadFile |
| [06-popup-controls.md](06-popup-controls.md) | 弹窗控件 | popupTable, popupSelect, popupAttr, relationForm |
| [07-table-controls.md](07-table-controls.md) | 子表格控件 | table, tableGrid |
| [08-special-controls.md](08-special-controls.md) | 特殊控件 | switch, rate, colorPicker, sign, qrcode, divider, groupTitle, tab, carousel, billRule, calculate, autoComplete |
| [09-chart-controls.md](09-chart-controls.md) | 图表控件 | 10种 ECharts 图表 |
| [13-mobile-controls.md](13-mobile-controls.md) | 移动端控件 | 55个移动端组件, f_app_column_data |
### 高级模式
| 文档 | 说明 |
|------|------|
| [10-table-patterns.md](10-table-patterns.md) | **表格高级模式** - 13种表格模式详解 |
| [11-form-patterns.md](11-form-patterns.md) | **表单高级模式** - 验证规则、字段联动、打印模板 |
### 示例参考
| 文档 | 说明 |
|------|------|
| [12-examples/workSystem-examples.md](12-examples/workSystem-examples.md) | **workSystem 示例** - 60个表单完整索引 |
| [12-examples/extend-examples.md](12-examples/extend-examples.md) | **extend 示例** - 代码示例完整索引 |
---
## 控件完整清单
### 输入类 (3)
| 控件 | jnpfKey | 文档 |
|------|---------|------|
| 单行文本 | `input` | [02-input-controls.md](02-input-controls.md) |
| 多行文本 | `textarea` | [02-input-controls.md](02-input-controls.md) |
| 数字输入 | `inputNumber` | [02-input-controls.md](02-input-controls.md) |
### 选择类 (7)
| 控件 | jnpfKey | 文档 |
|------|---------|------|
| 下拉选择 | `select` | [03-select-controls.md](03-select-controls.md) |
| 单选组 | `radio` | [03-select-controls.md](03-select-controls.md) |
| 多选组 | `checkbox` | [03-select-controls.md](03-select-controls.md) |
| 级联选择 | `cascader` | [03-select-controls.md](03-select-controls.md) |
| 树形选择 | `treeSelect` | [03-select-controls.md](03-select-controls.md) |
| 组织选择 | `organizeSelect` | [03-select-controls.md](03-select-controls.md) |
| 用户选择 | `userSelect` | [03-select-controls.md](03-select-controls.md) |
### 日期时间类 (3)
| 控件 | jnpfKey | 文档 |
|------|---------|------|
| 日期选择 | `date` | [04-date-controls.md](04-date-controls.md) |
| 日期时间 | `datetime` | [04-date-controls.md](04-date-controls.md) |
| 时间选择 | `time` | [04-date-controls.md](04-date-controls.md) |
### 上传类 (2)
| 控件 | jnpfKey | 文档 |
|------|---------|------|
| 图片上传 | `uploadImg` | [05-upload-controls.md](05-upload-controls.md) |
| 文件上传 | `uploadFile` | [05-upload-controls.md](05-upload-controls.md) |
### 弹窗类 (4)
| 控件 | jnpfKey | 文档 |
|------|---------|------|
| 弹窗表格 | `popupTable` | [06-popup-controls.md](06-popup-controls.md) |
| 弹窗选择 | `popupSelect` | [06-popup-controls.md](06-popup-controls.md) |
| 弹窗属性 | `popupAttr` | [06-popup-controls.md](06-popup-controls.md) |
| 关联表单 | `relationForm` | [06-popup-controls.md](06-popup-controls.md) |
### 布局类 (6)
| 控件 | jnpfKey | 文档 |
|------|---------|------|
| 分隔线 | `divider` | [08-special-controls.md](08-special-controls.md) |
| 分组标题 | `groupTitle` | [08-special-controls.md](08-special-controls.md) |
| 页签 | `tab` | [08-special-controls.md](08-special-controls.md) |
| 轮播 | `carousel` | [08-special-controls.md](08-special-controls.md) |
| 子表格 | `table` | [07-table-controls.md](07-table-controls.md) |
| 表格网格 | `tableGrid` | [07-table-controls.md](07-table-controls.md) |
### 特殊功能类 (12)
| 控件 | jnpfKey | 文档 |
|------|---------|------|
| 开关 | `switch` | [08-special-controls.md](08-special-controls.md) |
| 评分 | `rate` | [08-special-controls.md](08-special-controls.md) |
| 颜色选择 | `colorPicker` | [08-special-controls.md](08-special-controls.md) |
| 二维码 | `qrcode` | [08-special-controls.md](08-special-controls.md) |
| 签章 | `sign` | [08-special-controls.md](08-special-controls.md) |
| 单据规则 | `billRule` | [08-special-controls.md](08-special-controls.md) |
| 计算 | `calculate` | [08-special-controls.md](08-special-controls.md) |
| 自动完成 | `autoComplete` | [08-special-controls.md](08-special-controls.md) |
| 创建用户 | `createUser` | [08-special-controls.md](08-special-controls.md) |
| 创建时间 | `createTime` | [08-special-controls.md](08-special-controls.md) |
| 修改时间 | `modifyTime` | [08-special-controls.md](08-special-controls.md) |
| 区域选择 | `areaSelect` | [08-special-controls.md](08-special-controls.md) |
### 图表类 (10)
| 图表 | 类型 | 文档 |
|------|------|------|
| 柱状图 | Bar | [09-chart-controls.md](09-chart-controls.md) |
| 横向柱状图 | BarAcross | [09-chart-controls.md](09-chart-controls.md) |
| 折线面积图 | LineArea | [09-chart-controls.md](09-chart-controls.md) |
| 折线柱状图 | LineBar | [09-chart-controls.md](09-chart-controls.md) |
| 饼图 | Pie | [09-chart-controls.md](09-chart-controls.md) |
| 散点图 | Scatter | [09-chart-controls.md](09-chart-controls.md) |
| K线图 | Candlestick | [09-chart-controls.md](09-chart-controls.md) |
| 漏斗图 | Funnel | [09-chart-controls.md](09-chart-controls.md) |
| 仪表盘 | Gauge | [09-chart-controls.md](09-chart-controls.md) |
| 树图 | Tree | [09-chart-controls.md](09-chart-controls.md) |
---
## AIBridge 支持
AIBridge 提供 `build_field_model()` 和 `build_table_field_model()` 方法快速构建控件配置:
```python
from aibridge.builders.field_model import build_field_model
# 文本输入
field = build_field_model(
field_name="客户名称",
field_vmodel="f_customer_name",
jnpf_key="input",
required=True
)
# 下拉选择 (注意 options 格式)
field = build_field_model(
field_name="状态",
field_vmodel="f_status",
jnpf_key="select",
options=[
{"fullName": "启用", "id": "1"},
{"fullName": "禁用", "id": "0"},
]
)
```
详见 [AIBridge 文档](../README.md) 和 [快速入门](../docs/quickstart.md)。
---
## 示例系统
### workSystem (示例系统)
| 属性 | 值 |
|------|-----|
| App-Code | workSystem |
| System-ID | 664077319056394182 |
| 表单数量 | 60 |
| 特点 | 包含几乎所有控件类型的完整示例 |
详见 [workSystem-examples.md](12-examples/workSystem-examples.md)
### extend (代码示例)
| 目录 | 说明 |
|------|------|
| tableDemo/ | 13种表格模式 |
| formDemo/ | 8种表单模式 |
| graphDemo/ | 10种图表示例 |
| 其他 | barCode, bigData, email, map 等 |
详见 [extend-examples.md](12-examples/extend-examples.md)