alibaba / formily

📱🚀 🧩 Cross Device & High Performance Normal Form/Dynamic(JSON Schema) Form/Form Builder -- Support React/React Native/Vue 2/Vue 3
https://formilyjs.org/
MIT License
11.36k stars 1.48k forks source link

[Bug Report] Schema联动协议文档对于dependencies字段的描述没有更新 #3936

Closed mya12321 closed 1 year ago

mya12321 commented 1 year ago

Reproduction link

Edit on CodeSandbox

Steps to reproduce

打开文档

What is expected?

希望看到最新的dependencies字段的描述, 在@formily/json-schema里看到的ts定义是

dependencies?:
        | Array<
            | string
            | {
                name?: string
                type?: string
                source?: string
                property?: string
              }
          >
        | Record<string, string>

但是实际文档上是

dependencies?: string[] | Record<string, string>

希望补充上当dependencies是对象数组时各个字段的实际含义.
另外, 对于该文档有两个小建议:

  1. x-reactions字段可以为数组, 但是在文档中没有比较明显的说明和示例, 只有如下ts类型:
    type SchemaReactions<Field = any> =
    | SchemaReaction<Field>
    | SchemaReaction<Field>[]

    建议增加描述性文字或者示例说明

  2. dependencies字段和target字段是FormPathPattern语法, 但是许多新人并不知道这个, 尤其是它的文档在@formily/core里, 并不好找, 建议增加文字描述或者文档链接

What is actually happening?

dependencies?: string[] | Record<string, string>

Package

@formily/react@2.2.29