docs: add explanation for formkit select fieldSelectorKey property (#409)

#### 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
```
This commit is contained in:
Takagi
2024-09-18 10:46:49 +08:00
committed by GitHub
parent a2b7fe2828
commit d449d7c676
2 changed files with 16 additions and 2 deletions

View File

@@ -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` 解析。