# @atlasauth/react 中文文档

规范地址：https://npmcn.com/package/%40atlasauth/react/

版本：0\.38\.0
npm 元数据更新时间：2026-11-17T03:27:55.925Z
中文译文更新时间：2026-11-17T05:46:39.647Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40atlasauth/react
原文对照：https://npmcn.com/package/%40atlasauth/react/?lang=original

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

- 包体积（解压后）：1.5 MB，175 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：3 个
- peer 依赖：react \>=18，@atlasauth/js \>=0\.39\.0 \<1\.0\.0
- 首次发布：2026-09-13T21:19:15.847Z
- 最新版本发布：2026-11-17T03:27:55.669Z
- 近 30 天下载量：5963（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：89（近 12 个月 89 个）

## 中文简介

对Atlas进行反射组件和钩子.

## 安装

```sh
npm install @atlasauth/react
```

也可以使用：`pnpm add @atlasauth/react`、`yarn add @atlasauth/react`、`bun add @atlasauth/react`

## README

# @ atlasauth/ 反应

对Atlas进行反射组件和钩子.

## 与 Atlas (任何网站) 签约

让任何人用他们的阿特拉斯账户登录到任何网站。 没有 `<AtlasProvider>` 需要帮助.

```tsx
import { SignInWithAtlasButton, completeSignInWithAtlas } from '@atlasauth/react';

<SignInWithAtlasButton clientId="YOUR_CLIENT_ID" redirectUri="https://example.com/callback" />;

// On the redirect page:
const { idToken, claims } = await completeSignInWithAtlas();
```

将一个应用程序注册到账户 + 在仪表板上与Atlas 签名。 总是验证 `idToken` 在您的服务器上( 通过 JWKS 签名, `iss`, (中文(简体) ), `aud`, (中文(简体) ), `exp`)先信取之. 使用 `buildAtlasAuthorizeUrl()` 用于自定义按钮.

服务器应用程序(一个有客户端秘密)? 代码必须由您的服务器交换, 所以让 按钮向后端登录路径 , 而不是在浏览器中运行 PKCE :

```tsx
<SignInWithAtlasButton loginUri="/auth/atlas/login" />
```

`loginUri` 必须是同一来源路径或 `https://` URL (中文(简体) ).

## `<SignIn>` 编号 : `<SignUp>` 选项

```tsx
<SignIn
  layout={{ alternativeMethods: 'inside' }}
  initialValues={{ email: 'ada@example.com' }}
/>
```

-   `layout.alternativeMethods` 设置密码按钮和社交 /“ 继续使用 Atlas ” 按钮 `<SignIn>`数字 : `'inside'` 表格下的卡片, `'below'` 卡片(默认值, 与以前版本相同)或 `'above'` 这个. `<SignUp>` 已保留其选项 在卡片内。 密码按钮是次要按钮(`formButtonSecondary` 内 `appearance.elements`, (中文(简体) ), `.atlas-button-secondary`) (中文(简体) ).
-   `initialValues.email` 预填电子邮件字段(标识符在 `<SignIn>`) (中文(简体) ). 没有它,一个 `login_hint` 或者说 `email` 页面 URL 上的查询参数预填; `initialValues` 赢了.

## 常见问题

### @atlasauth/react 是什么？

对Atlas进行反射组件和钩子\.

### 如何安装 @atlasauth/react？

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

### @atlasauth/react 支持 TypeScript 吗？

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

### @atlasauth/react 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @atlasauth/react 可以商用吗？

@atlasauth/react 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @atlasauth/react 的下载量有多少？

根据 npm 官方下载统计，@atlasauth/react 在 2026/10/07 – 2026/11/05 这 30 天内被下载 5,963 次，日均约 199 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @atlasauth/react 还在维护吗？

最新版本 0\.38\.0 发布于 2026/11/17（今天）；至今共发布 89 个版本，其中过去 12 个月发布了 89 个；首次发布于 2026/09/14。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

