@comms-id/asic-company-lookup-react

中文文档
1.0.0发布于 2026/10/22SEE LICENSE IN LICENSETypeScriptES Module

用于通信的React钩子和组件。ID公司字段:公司名称或ACN,可访问,无布局移位,具有数据属性

此软件包已被标记为弃用

Removed. Comms.ID products are served live, nothing to install: https://cdn.comms.id/asic-company-lookup/latest.js

中文使用文档
文档目录4 节
  1. 这个领域是做什么的
  2. 您自己的标记: useAsicCompanyLookup
  3. 组件
  4. 数据属性

@comms-id / company-react

一个React钩子和一个用于通信的成品组件。ID Company字段:用户键入公司名称,或9位ACN或ARBN。易于访问,没有布局变化,始终显示数据属性。React 18或更高版本;这取决于 @comms-id/asic-company-lookup 没有别的了。

import { createAsicCompanyLookupBrowserClient } from "@comms-id/asic-company-lookup/browser";
import { AsicCompanyLookupLookup } from "@comms-id/asic-company-lookup-react";

const client = createAsicCompanyLookupBrowserClient({ relayUrl: "/api/comms-id/company" });

export const Form = () => (
  <AsicCompanyLookupLookup
    client={client}
    onSelect={(record, timing) => console.log(record, `${timing.ms} ms`)}
  />
);

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

这个领域是做什么的

  • 一个名字: 用户暂停后,它会从ASIC注册快照中提示公司(名称,ACN或ARBN,状态)。搜索已经返回了每条完整的记录,因此选择一条记录不需要第二次调用。
  • ACN或ARBN: 一次查找9位数字(允许空格和连字符)。超过9位数字或错误的ASIC校验数字将在浏览器中被拒绝,并且不会发送任何内容。
  • 结果是固定注释行上的一个摘要行(名称,按其类型命名的数字,如“ACN 001 234 564”或“ARBN 001 234 591”,状态),因此页面永远不会移动。
  • “找不到公司”和“找不到公司”是不同的信息;故障提示“再试一次”。快照缺失并不能证明公司不在实时登记册上。

您自己的标记: useAsicCompanyLookup

const field = useAsicCompanyLookup({ client, onSelect });
return (
  <>
    <input {...field.getInputProps()} />
    <ul {...field.getListboxProps("Matches")} hidden={!field.state.open}>
      {field.state.suggestions.map((s, i) => (
        <li key={s.key} {...field.getOptionProps(i)}>{s.primary}</li>
      ))}
    </ul>
    <p {...field.getStatusProps()}>{field.state.announcement}</p>
  </>
);

道具获取者携带WAI-ARIA组合框合约:角色, aria-expanded, aria-controls, aria-activedescendant,键处理(箭头,Enter, Escape, Tab)和一个礼貌的生活区域。当你使用钩子的时候,你可以自己呈现属性:是的 field.state.attribution.

组件

道具: client (需要), label (默认为“公司名称、ACN或ARBN”), onSelect, minChars (3), debounceMs (400), limit (8), settings, status (在 settings), idPrefix, name, placeholder, disabled, required, className, listLabel, showTiming (真正的), renderOption.

使用自定义属性对其进行样式化 --comms-id-text, --comms-id-surface, --comms-id-border, --comms-id-active, --comms-id-radius 或者是 comms-id-asic-company-lookup__* 类名。它不需要样式表。

  • 列表在输入的下面浮动;打开它什么也不动。注线有一个预留高度。
  • 查找失败会说明原因并提示“再试一次”;它永远不会显示为“不匹配”。
  • 它在服务器上以相同的结构呈现,并在StrictMode下工作。

数据属性

公司数据来自ASIC的公共注册,通过data.gov. AU (CC BY 3.0 AU)。组件总是显示归属。不要隐藏它。

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

版本与发布记录

@comms-id/asic-company-lookup-react 共发布 2 个版本,首次发布于 2026/10/22;过去 12 个月发布了 2 个版本。

版本发布日期距今
1.0.0latest2026/10/2212 天前
0.0.0-stage2026/10/2212 天前

关于 @comms-id/asic-company-lookup-react 的常见问题

@comms-id/asic-company-lookup-react 是什么?

用于通信的React钩子和组件。ID公司字段:公司名称或ACN,可访问,无布局移位,具有数据属性注意:该包已被作者标记为弃用——Removed. Comms.ID products are served live, nothing to install: https://cdn.comms.id/asic-company-lookup/latest.js

如何安装 @comms-id/asic-company-lookup-react?

在项目目录运行 npm install @comms-id/asic-company-lookup-react,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(>=18)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@comms-id/asic-company-lookup-react 支持 TypeScript 吗?

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

@comms-id/asic-company-lookup-react 支持 ESM 还是 CommonJS?

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

@comms-id/asic-company-lookup-react 可以商用吗?

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

@comms-id/asic-company-lookup-react 还在维护吗?

最新版本 1.0.0 发布于 2026/10/22(12 天前);至今共发布 2 个版本,其中过去 12 个月发布了 2 个;首次发布于 2026/10/22。作者已将其标记为弃用,新项目建议寻找替代方案。