docs: Prefect README and md files

katavii · Dec 27, 2023 · 72b004c · 72b004c
2 parents dcf24cc + 03c3134
commit 72b004c
Show file tree

Hide file tree

Showing 73 changed files with 2,841 additions and 2,417 deletions.
diff --git a/LICENSE.md b/LICENSE.md
@@ -1,4 +1,4 @@
-The MIT License (MIT) Copyright © 2023 <copyright holders>
+The MIT License (MIT) Copyright © 2023 <copyright holders>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

diff --git a/README.en-US.md b/README.en-US.md
diff --git a/README.es-PR.md b/README.es-PR.md
diff --git a/README.md b/README.md
diff --git a/README.zh-CN.md b/README.zh-CN.md
diff --git a/docs/changelog.en-US.md b/docs/changelog.en-US.md
diff --git a/docs/changelog.md b/docs/changelog.md
diff --git a/docs/components/schema.en-US.md b/docs/components/schema.en-US.md
@@ -1,4 +1,4 @@
-<!-----
+<!-----
 title: Universal Configuration Overview order
 order: 1
 ----->
@@ -7,27 +7,27 @@ order: 1
 
 In the `ProComponents`, we have used the same definition as tables for components, while also extending some fields to meet additional requirements, allowing them to fulfill more needs.
 
-| Field Name | Type | Description |
-| --- | --- | --- |
-| `key` | `React.key` | Determines the unique value of this column, commonly used for cases where dataIndex is duplicated |
-| `dataIndex` | `React.key` \| `React.key[]` | Key mapped to an entity, and arrays will be transformed into `[a,b] => Entity.a.b` |
-| `valueType` | `ProFieldValueType` | The rendering method of the data. We provide some built-in options, and you can also customize the valueType |
-| `title` | `ReactNode` \|`(props,type,dom)=> ReactNode` | Content of the title, which serves as the label in a form |
-| `tooltip` | `string` | Shows an icon next to the title, and displays the tooltip when the mouse hovers over it |
-| `valueEnum` | `(Entity)=> ValueEnum` \| `ValueEnum` | Supports objects and maps, where maps can use other basic types as keys |
-| `fieldProps` | `(form,config)=>fieldProps`\| `fieldProps` | Props passed to the rendering component. They are also passed when customizing |
-| `formItemProps` | `(form,config)=>formItemProps` \| `formItemProps` | Configuration passed to Form.Item |
-| `renderText` | `(text: any, record: Entity, index: number, action: ProCoreActionType) => any` | The modified data is consumed by the rendering component defined by valueType |
-| `render` | `(dom,entity,index, action, schema) => React.ReactNode` | Custom DOM for read-only mode. The `render` method only manages read-only mode, while the editing mode should use `renderFormItem` |
-| `renderFormItem` | `(schema,config,form) => React.ReactNode` | Custom editing mode that returns a ReactNode, automatically wrapping value and onChange |
-| `request` | `(params,props) => Promise<{label,value}[]>` | Requests network data remotely, usually used for selection-type components |
-| `params` | `Record<string, any>` | Additional parameters passed to `request`. The component does not process them, but changes will trigger a new data request in `request` |
-| `hideInForm` | `boolean` | Hidden in the form |
-| `hideInTable` | `boolean` | Hidden in the table |
-| `hideInSearch` | `boolean` | Hidden in the search form of the table |
-| `hideInDescriptions` | `boolean` | Hidden in the descriptions |
-| `rowProps` | [RowProps](https://ant.design/components/grid/#Row) | Passed to the Row when the `grid` mode is enabled, only effective in `ProFormGroup`, `ProFormList`, `ProFormFieldSet` |
-| `colProps` | [ColProps](https://ant.design/components/grid/#Col) | Passed to the Col when the `grid` mode is enabled |
+| Field Name           | Type                                                                           | Description                                                                                                                              |
+| -------------------- | ------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- |
+| `key`                | `React.key`                                                                    | Determines the unique value of this column, commonly used for cases where dataIndex is duplicated                                        |
+| `dataIndex`          | `React.key` \| `React.key[]`                                                   | Key mapped to an entity, and arrays will be transformed into `[a,b] => Entity.a.b`                                                       |
+| `valueType`          | `ProFieldValueType`                                                            | The rendering method of the data. We provide some built-in options, and you can also customize the valueType                             |
+| `title`              | `ReactNode` \|`(props,type,dom)=> ReactNode`                                   | Content of the title, which serves as the label in a form                                                                                |
+| `tooltip`            | `string`                                                                       | Shows an icon next to the title, and displays the tooltip when the mouse hovers over it                                                  |
+| `valueEnum`          | `(Entity)=> ValueEnum` \| `ValueEnum`                                          | Supports objects and maps, where maps can use other basic types as keys                                                                  |
+| `fieldProps`         | `(form,config)=>fieldProps`\| `fieldProps`                                     | Props passed to the rendering component. They are also passed when customizing                                                           |
+| `formItemProps`      | `(form,config)=>formItemProps` \| `formItemProps`                              | Configuration passed to Form.Item                                                                                                        |
+| `renderText`         | `(text: any, record: Entity, index: number, action: ProCoreActionType) => any` | The modified data is consumed by the rendering component defined by valueType                                                            |
+| `render`             | `(dom,entity,index, action, schema) => React.ReactNode`                        | Custom DOM for read-only mode. The `render` method only manages read-only mode, while the editing mode should use `renderFormItem`       |
+| `renderFormItem`     | `(schema,config,form) => React.ReactNode`                                      | Custom editing mode that returns a ReactNode, automatically wrapping value and onChange                                                  |
+| `request`            | `(params,props) => Promise<{label,value}[]>`                                   | Requests network data remotely, usually used for selection-type components                                                               |
+| `params`             | `Record<string, any>`                                                          | Additional parameters passed to `request`. The component does not process them, but changes will trigger a new data request in `request` |
+| `hideInForm`         | `boolean`                                                                      | Hidden in the form                                                                                                                       |
+| `hideInTable`        | `boolean`                                                                      | Hidden in the table                                                                                                                      |
+| `hideInSearch`       | `boolean`                                                                      | Hidden in the search form of the table                                                                                                   |
+| `hideInDescriptions` | `boolean`                                                                      | Hidden in the descriptions                                                                                                               |
+| `rowProps`           | [RowProps](https://ant.design/components/grid/#Row)                            | Passed to the Row when the `grid` mode is enabled, only effective in `ProFormGroup`, `ProFormList`, `ProFormFieldSet`                    |
+| `colProps`           | [ColProps](https://ant.design/components/grid/#Col)                            | Passed to the Col when the `grid` mode is enabled                                                                                        |
 
 ## Definition to TypeScript