# @comms-id/sign-in-react 中文文档

规范地址：https://npmcn.com/package/%40comms-id/sign-in-react/

版本：0\.1\.0
npm 元数据更新时间：2026-10-31T19:47:05.980Z
中文译文更新时间：2026-10-31T20:36:04.096Z
软件包许可：SEE LICENSE IN LICENSE

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

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

弃用说明：Removed\. Comms\.ID products are served live, nothing to install: https://islands\.relyingparty\.app/authenticate/embed\.js

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

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

## 中文简介

React钩子和按钮Sign in with Comms。ID：链接到你的应用自己的登录路由，也呈现在服务器上

## 安装

```sh
npm install @comms-id/sign-in-react
```

也可以使用：`pnpm add @comms-id/sign-in-react`、`yarn add @comms-id/sign-in-react`、`bun add @comms-id/sign-in-react`

## README

# @通信id/登录响应

使用通讯登录。React的ID按钮：指向应用自己的登录路由的链接。您的服务器运行登录 [`@comms-id/sign-in/flow`](https://npmcn.com/package/%40comms-id/sign-in/README.md);这个按钮没有键，也不叫任何东西。

```tsx
import { SignInButton } from "@comms-id/sign-in-react";

<SignInButton start="/auth/sign-in" signInClass="team" returnTo="/account" />;
// <a href="/auth/sign-in?class=team&return_to=%2Faccount">Sign in with Comms.ID</a>
```

-   `start`：你的起始路由，一个路径或一个https URL在页面自己的起源(`/auth/sign-in` 默认情况下)。任何可能离开原点的内容都会被拒绝，并且该按钮没有任何链接(`onInvalid`， `console.error` 默认情况下)。
-   `signInClass`： `person` （默认）或 `team`. `returnTo`：应用程序的路径。 `label`：文本。
-   它也在服务器上呈现链接，启动一次（第二次按下不做任何事情），并在从向后缓存恢复的页面上再次准备好。
-   `useSignIn(options)` 给了 `state` 和 `getButtonProps()` 为您自己的标记。
-   用 `--comms-id-*` 变量或 `comms-id-sign-in` 类。

## 常见问题

### @comms-id/sign-in-react 是什么？

React钩子和按钮Sign in with Comms。ID：链接到你的应用自己的登录路由，也呈现在服务器上注意：该包已被作者标记为弃用——Removed\. Comms\.ID products are served live, nothing to install: https://islands\.relyingparty\.app/authenticate/embed\.js

### 如何安装 @comms-id/sign-in-react？

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

### @comms-id/sign-in-react 支持 TypeScript 吗？

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

### @comms-id/sign-in-react 支持 ESM 还是 CommonJS？

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

### @comms-id/sign-in-react 可以商用吗？

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

### @comms-id/sign-in-react 还在维护吗？

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