docs(docs): 更新文档

lljj-x · Oct 5, 2023 · d883f8b · d883f8b
1 parent 7a15c42
commit d883f8b
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 1 deletion.
diff --git a/packages/docs/docs/zh/guide/README.md b/packages/docs/docs/zh/guide/README.md
@@ -57,6 +57,11 @@
 * umd script 标签形式引入暴露全局变量 `window.vue3FormAnt`，`window.vue3FormAnt.default` 暴露组件
 * [playground](https://form.lljj.me/v3/#/demo?type=Simple&ui=VueAntForm)
 
+::: warning antd 4x 版本注意：
+* v4版本请使用，import { JsonSchemaFormAntdV4 } from "@lljj/vue3-form-ant";
+* v3版本还是建议使用 default export
+:::
+
 #### vue3 ant、naiveUi v-model 特殊处理
 例如 `a-input` 组件，ant vue3需要使用 `v-model:value`，但在整个框架内部 `v-model` 都是使用 `modelValue`，所以这里就需要对不一致的props通过中间组件组做转换。
 

diff --git a/packages/docs/docs/zh/guide/basic-config.md b/packages/docs/docs/zh/guide/basic-config.md
@@ -104,6 +104,16 @@ export default {
 
 用于配置表单展示样式，普通json数据，非 `JSON Schema` 规范
 
+#### fui:xxx function配置
+* `1.9.0` 版本之后，所有ui配置支持通过 `fui:xxx` 使用函数形式的配置，可接受 `parentFormData`、`rootFormData`、 `prop` 三个参数。
+```js
+// 例如配置一个动态的 placeholder 属性
+'fui:placeholder': (parent, root, prop) => {
+    console.log(parent, root, prop);
+    return parent.txtColor;
+}
+```
+
 
 #### ui-schema 表达式
 * `0.2` 版本之后，所有 `ui:xxx` 形式的配置都支持表达式（ui:options内不支持表达式以便区分）
@@ -139,6 +149,24 @@ uiSchema = {
     // 覆盖schema description
     'ui:description': '覆盖schema description描述信息',
 
+    // 通过 fui:xxx  配置function 来计算当前的ui options
+    'fui:placeholder': (parent, root, prop) => {
+        console.log(parent, root, prop);
+        return parent.txtColor;
+    },
+
+    // 针对单个字段配置是否需要 required，优先级高于schema的配置'
+    // bool 类型， 'ui:required': true,
+    // 默认 undefined
+    'ui:required': true,
+
+    // 针对数组项的操作回调
+    // 默认 undefined
+    // command 枚举值 moveUp | moveDown | remove | add | batchPush | setNewTarget
+    'ui:afterArrayOperate': (formData, command, payload) => {
+        debugger;
+    },
+
     // 表单元素输入为空时的值，默认 undefined
     'ui:emptyValue': undefined,
 

diff --git a/packages/docs/docs/zh/rules/array.md b/packages/docs/docs/zh/rules/array.md
@@ -256,6 +256,7 @@
 ## 其它配置
 * 支持通过配置 `ui-schema` 中的 `ui:addable`、`ui:sortable`、`ui:removable` 配置数组是否可添加/排序/移除
 * 支持通过配置 `ui-schema` 中的 `ui:showIndexNumber` 配置是否显示数组item序号
+* 支持通过配置 `ui-schema` 中的 `ui:afterArrayOperate` 来回调数组的相关操作
 * 参见 [ui-schema 配置](https://form.lljj.me/#/demo?type=Arrays)
 
 如：
@@ -265,7 +266,10 @@ uiSchema = {
         addable: false,
         sortable: false,
         removable: false,
-        showIndexNumber: true
+        showIndexNumber: true,
+        'ui:afterArrayOperate': (formData, command, payload) => {
+            debugger;
+        },
     }
 }
 ```