# @comms-id/dfat-sanctions-consolidated-list-react 中文文档

规范地址：https://npmcn.com/package/%40comms-id/dfat-sanctions-consolidated-list-react/

版本：0\.2\.2
npm 元数据更新时间：2026-10-31T19:46:54.652Z
中文译文更新时间：2026-10-31T20:38:02.217Z
软件包许可：SEE LICENSE IN LICENSE

本文由上游 README 机器翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40comms-id/dfat-sanctions-consolidated-list-react
原文对照：https://npmcn.com/package/%40comms-id/dfat-sanctions-consolidated-list-react/?lang=original
项目主页：https://comms.id/
源码仓库：https://github.com/comms-id/platform

弃用说明：Removed\. Comms\.ID products are served live, nothing to install: https://cdn\.comms\.id/dfat-sanctions-consolidated-list/latest\.js

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：21.2 kB，11 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：react \>=18
- 首次发布：2026-10-21T19:02:36.919Z
- 最新版本发布：2026-10-21T19:05:51.886Z
- 已发布版本数：2（近 12 个月 2 个）

## 中文简介

用于通信的React钩子和组件。ID制裁字段：制裁筛选，可访问，无布局移位，具有数据属性

## 安装

```sh
npm install @comms-id/dfat-sanctions-consolidated-list-react
```

也可以使用：`pnpm add @comms-id/dfat-sanctions-consolidated-list-react`、`yarn add @comms-id/dfat-sanctions-consolidated-list-react`、`bun add @comms-id/dfat-sanctions-consolidated-list-react`

## README

# @comms-id / dfat-sanctions-consolidated-list-react

一个React钩子和一个用于通信的成品组件。ID制裁筛选表：根据澳大利亚制裁综合名单（DFAT）筛选个人、实体或船只。可访问，始终显示数据归属。React 18或更高版本；这取决于 `@comms-id/dfat-sanctions-consolidated-list` 没有别的了。 **继电器只有:** 筛选永远不会向没有凭据的浏览器打开。

```tsx
import { createDfatSanctionsConsolidatedListBrowserClient } from "@comms-id/dfat-sanctions-consolidated-list/browser";
import { DfatSanctionsConsolidatedListScreen } from "@comms-id/dfat-sanctions-consolidated-list-react";

const client = createDfatSanctionsConsolidatedListBrowserClient({ relayUrl: "/api/comms-id/dfat-sanctions-consolidated-list" });

export const Review = () => (
  <DfatSanctionsConsolidatedListScreen client={client} onResult={(record, timing) => console.log(record.candidates.length, `${timing.ms} ms`)} />
);
```

`relayUrl` 您自己的服务器路由，设置与 `@comms-id/relay`您的服务器将调用签名为您注册的应用程序，因此浏览器不持有凭据。

## 表单的作用是什么

-   **表单，而不是搜索框；** 姓名、种类（个人、实体或船舶），以及可选的出生日期（年月日）和出生地点。用户键入时不会发送任何内容：在提交表单时发送筛选。更改值会删除答案，因此答案永远不会显示在不适合它的值旁边。
-   **无效值** （没有名称，日期不是真正的日历日期）在浏览器中被拒绝；字段说明了原因，但没有发送任何内容。
-   **答案** 列出所有可能的匹配及其证据（姓名、种类、参考、出生日期和地点，以及姓名、日期和地点是否匹配），并注明列表的生成和检查时间。“不可能匹配”是关于某一代列表的确切名称和别名的声明，表格是这样说的：它不是清除。
-   “制裁筛选不可用”（列表不可用，或者列表过期，服务拒绝对其进行筛选）永远不会显示为“无可能匹配”；它提供“再试一次”。
-   **继电器。** 筛选从来不是一个公众访客操作：没有 `pk` 模式时，元素不提供交换代码，并且浏览器不持有凭据。

## 您自己的标记： `useDfatSanctionsConsolidatedList`

```tsx
const screen = useDfatSanctionsConsolidatedList({ client, onResult });
return (
  <form {...screen.getFormProps()}>
    {fields.map((field) => <input key={field.name} {...screen.getFieldProps(field)} />)}
    <button type="submit">Screen</button>
    <p {...screen.getStatusProps()}>{screen.state.announcement}</p>
    <div {...screen.getResultProps("Result")}>{screen.state.result?.view.headline}</div>
  </form>
);
```

道具获取器携带表单的可访问性契约：ids， `aria-invalid`， `aria-describedby` （暗示和信息）， `aria-required`是一个有礼貌的居住地区。当你使用钩子的时候，你可以自己呈现属性：是的 `screen.state.attribution`.

## 组件

道具: `client` (需要), `legend` （默认为“制裁筛选”）， `submitLabel`， `onResult`， `values` （按字段名起始值）， `idPrefix`， `disabled`， `className`， `showTiming` (真正的), `renderItem`.

使用自定义属性对其进行样式化 `--comms-id-text`， `--comms-id-surface`， `--comms-id-border`， `--comms-id-active-strong`， `--comms-id-button-text`， `--comms-id-error`， `--comms-id-radius` 或者是 `comms-id-dfat-sanctions-consolidated-list__*` 类名。它不需要样式表。

-   答案区有一个保留的高度。放映失败说明了原因，并建议“再试一次”；它永远不会显示为“不可能匹配”。
-   它在服务器上以相同的结构呈现，并在StrictMode下工作。

## 数据属性

资料来源：澳大利亚外交和贸易部制裁综合清单。组件总是显示归属。不要隐藏它。

`LICENSE` 是消费者客户牌照。 `src/` 是由 `@comms-id/forge-transformers` 而且从来没有手工编辑过。

## 常见问题

### @comms-id/dfat-sanctions-consolidated-list-react 是什么？

用于通信的React钩子和组件。ID制裁字段：制裁筛选，可访问，无布局移位，具有数据属性注意：该包已被作者标记为弃用——Removed\. Comms\.ID products are served live, nothing to install: https://cdn\.comms\.id/dfat-sanctions-consolidated-list/latest\.js

### 如何安装 @comms-id/dfat-sanctions-consolidated-list-react？

在项目目录运行 npm install @comms-id/dfat-sanctions-consolidated-list-react，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\>=18）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @comms-id/dfat-sanctions-consolidated-list-react 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @comms-id/dfat-sanctions-consolidated-list-react 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @comms-id/dfat-sanctions-consolidated-list-react 可以商用吗？

@comms-id/dfat-sanctions-consolidated-list-react 使用 SEE LICENSE IN LICENSE 许可。许可条款写在包内的独立文件中，请阅读该文件确认可否商用。以上为概括，不构成法律意见，请以许可原文为准。

### @comms-id/dfat-sanctions-consolidated-list-react 还在维护吗？

最新版本 0\.2\.2 发布于 2026/10/22（12 天前）；至今共发布 2 个版本，其中过去 12 个月发布了 2 个；首次发布于 2026/10/22。作者已将其标记为弃用，新项目建议寻找替代方案。