From d449d7c676c5d84a846bd3b0c122a9f62a06d017 Mon Sep 17 00:00:00 2001
From: Takagi <1103069291@qq.com>
Date: Wed, 18 Sep 2024 10:46:49 +0800
Subject: [PATCH] docs: add explanation for formkit select fieldSelectorKey
 property (#409)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

#### What this PR does / why we need it:

为 formkit select 组件的远程搜索，增加 `fieldSelectorKey` 字段的使用说明。

see https://github.com/halo-dev/halo/pull/6591

#### Does this PR introduce a user-facing change?
```release-note
None
```
---
 docs/developer-guide/form-schema.md                    |  8 +++++++-
 .../version-2.19/developer-guide/form-schema.md        | 10 +++++++++-
 2 files changed, 16 insertions(+), 2 deletions(-)

diff --git a/docs/developer-guide/form-schema.md b/docs/developer-guide/form-schema.md
index 0804828..25de0b4 100644
--- a/docs/developer-guide/form-schema.md
+++ b/docs/developer-guide/form-schema.md
@@ -130,6 +130,11 @@ spec:
      * 从 items 中解析出 value 的字段名，默认为 `value`。
      */
     valueField?: PropertyPath;
+
+    /**
+     * 使用 value 查询详细信息时，fieldSelector 的查询参数 key，默认为 `metadata.name`。
+     */
+    fieldSelectorKey?: PropertyPath;
   };
   remoteOptimize?: boolean;
   allowCreate?: boolean;
@@ -187,13 +192,14 @@ spec:
     itemsField: items
     labelField: post.spec.title
     valueField: post.metadata.name
+    fieldSelectorKey: metadata.name
 ```
 
 :::tip
 当远程数据具有分页时，可能会出现默认选项不在第一页的情况，此时 Select 组件将会发送另一个查询请求，以获取默认选项的数据。此接口会携带如下参数：
 
 ```ts
-fieldSelector: `${requestOption.valueField}=(value1,value2,value3)`
+fieldSelector: `${requestOption.fieldSelectorKey}=(value1,value2,value3)`
 ```
 
 其中，value1, value2, value3 为默认选项的值。返回值与查询一致，通过 `requestOption` 解析。
diff --git a/versioned_docs/version-2.19/developer-guide/form-schema.md b/versioned_docs/version-2.19/developer-guide/form-schema.md
index 5cdb9b8..bd61d4e 100644
--- a/versioned_docs/version-2.19/developer-guide/form-schema.md
+++ b/versioned_docs/version-2.19/developer-guide/form-schema.md
@@ -130,6 +130,13 @@ spec:
      * 从 items 中解析出 value 的字段名，默认为 `value`。
      */
     valueField?: PropertyPath;
+
+    /**
+     * 使用 value 查询详细信息时，fieldSelector 的查询参数 key，默认为 `metadata.name`。 
+     * 
+     * 需要 Halo 版本 >= 2.19.2。
+     */
+    fieldSelectorKey?: PropertyPath;
   };
   remoteOptimize?: boolean;
   allowCreate?: boolean;
@@ -187,13 +194,14 @@ spec:
     itemsField: items
     labelField: post.spec.title
     valueField: post.metadata.name
+    fieldSelectorKey: metadata.name
 ```
 
 :::tip
 当远程数据具有分页时，可能会出现默认选项不在第一页的情况，此时 Select 组件将会发送另一个查询请求，以获取默认选项的数据。此接口会携带如下参数：
 
 ```ts
-fieldSelector: `${requestOption.valueField}=(value1,value2,value3)`
+fieldSelector: `${requestOption.fieldSelectorKey}=(value1,value2,value3)`
 ```
 
 其中，value1, value2, value3 为默认选项的值。返回值与查询一致，通过 `requestOption` 解析。