diff --git a/docs/crud_tabular.md b/docs/crud_tabular.md new file mode 100644 index 0000000..94ca2d3 --- /dev/null +++ b/docs/crud_tabular.md @@ -0,0 +1,44 @@ +# 表格结构的数据crud +当一张表不是树形结构的就时表形结构的crud + +## 表形机构表的crud +json格式的数据 +{ + "tblname" # 表名 + "alias" # 别名,当需多个crud界面时,可用alias来生成份不同的功能 + "title" # 标题,如果不给定,使用数据表定义中的表标题 + "params":{ # crud 的参数 + "sortby" # 指定排序字段,可以多个字段,用["a desc", "b"]形式给出按照多个字段排序,"desc“表示倒排,不给定就是正排 + "editor":{ # 给定编辑时form初始化参数 + # 需要参考bricks的Form控件 + "binds":[ # 比如添加事件处理 + { + "wid":"province_id", # 指定form的事件名 + "event":"changed", # 事件,比如数据变化 + "actiontype":"script", # 事件处理类型 + "target":"city_id", # 目标控件 + "script": # 脚本内容,规定用js脚本 + } + ] + }, + "browserfields": { # 列表显示的参数 + "exclouded": ["id"], # 不显示的字段列表 + "alters": { # 需要改变的字段 + "field1":{ # 字段名为field1的字段的改变 + "opt1" # bricksform可输入类型的初始化参数中的任何项 + } + } + }, + "editexclouded": [ # 编辑时不包含的字段列表 + ], + "subtables":[ # 可选,外键清单(表中存在字段指向本表主键记录) + { + "field" # 外键表字段 + "title" # 可选,不选用外键表的表标题 + "url" # 当alias定义时需要,用{{entire_url(...)方式定义指向表的url + "subtable" # 外键表名称 + } + ] + } +} + diff --git a/docs/crud_tree.md b/docs/crud_tree.md new file mode 100644 index 0000000..813bdfc --- /dev/null +++ b/docs/crud_tree.md @@ -0,0 +1,27 @@ +# 树形结构的数据crud +当一张数据表中存在一个父节点的字段指向本表中另条记录的主键id,那么这个表就是一个树形结构的表 + +## 树形机构表的crud +json格式的数据 +{ + "tblname" # 表名 + "alias" # 别名,当需多个crud界面时,可用alias来生成份不同的功能 + "uitype": "tree"# 给定uitype为"tree"指定用树状结构数据crud + "title" # 标题,如果不给定,使用数据表定义中的表标题 + "params":{ # crud 的参数 + "idField": # 必须,指定树节点的id字段 + "textField" # 指定树节点显示内容字段 + "sortby" # 指定排序字段,可以多个字段,用[a desc, b]形式给出按照多个字段排序,"desc“表示倒排,不给定就是正排 + "editable" # true代表可编辑,false表示不可编辑,通常给定true + "edit_exclouded_fields" # 设置不参与编辑(新增和修改)字段,数组 + "parentField" # 父节点字段 + "subtables":[ # 外键清单(表中存在字段指向本表主键记录) + { + "field" # 外键表字段 + "title" # 可选,不选用外键表的表标题 + "url" # 当alias定义时需要,用{{entire_url(...)方式定义指向表的url + "subtable" # 外键表名称 + } + ], + } +}