# @coveo/atomic-hosted-page 中文文档

规范地址：https://npmcn.com/package/%40coveo/atomic-hosted-page/

版本：1\.2\.64
npm 元数据更新时间：2026-11-02T20:41:32.208Z
中文译文更新时间：2026-11-10T21:15:56.026Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40coveo/atomic-hosted-page
原文对照：https://npmcn.com/package/%40coveo/atomic-hosted-page/?lang=original
源码仓库：https://github.com/coveo/ui-kit

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

- 包体积（解压后）：28 kB，16 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：^20\.9\.0 \|\| ^22\.11\.0 \|\| ^24\.11\.0
- 运行依赖：3 个
- 首次发布：2023-02-15T16:55:22.561Z
- 最新版本发布：2026-11-02T20:41:31.817Z
- 近 30 天下载量：6028（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：3429（近 12 个月 43 个）

## 中文简介

Web 组件用于在 DOM 中注入 Coveo 主机搜索页面 .

## 安装

```sh
npm install @coveo/atomic-hosted-page
```

也可以使用：`pnpm add @coveo/atomic-hosted-page`、`yarn add @coveo/atomic-hosted-page`、`bun add @coveo/atomic-hosted-page`

## README

# 原子主机页面

这个 **原子主机页面** 软件包提供了一个 Web 组件, `<atomic-hosted-ui>`,将 Coveo 主机搜索页面整合到您的网络应用程序中。 这个部分利用 [搜索接口 API](https://platform.cloud.coveo.com/docs?urls.primaryName=Search%20Interface%20Service#/)。 。 。 .

* * *

## 安装

### 通过 npm

用来使用 `<atomic-hosted-ui>` 组件,通过 npm 安装:

```bash
npm install @coveo/atomic-hosted-page
```

### 维娅 CDN

或者,您可以从CDN直接使用组件:

```html
<script
  type="module"
  src="https://static.cloud.coveo.com/atomic-hosted-page/v1/atomic-hosted-page/atomic-hosted-page.esm.js"
></script>
```

* * *

## 使用量

### 在 JavaScript 中导入和使用

1.  将组件导入您的应用程序 :
    
    ```javascript
    import '@coveo/atomic-hosted-page/dist/components/atomic-hosted-ui/atomic-hosted-ui.js';
    ```
    
2.  将组件添加到您的 HTML 中并初始化, 并使用所需的选项 :
    
    ```html
    <atomic-hosted-ui hosted-type="code"></atomic-hosted-ui>
    ```
    
    ```javascript
    const hostedUI = document.querySelector('atomic-hosted-ui');
    hostedUI.initialize({
      pageId: 'your-hosted-page-id',
      organizationId: 'your-organization-id',
      accessToken: 'your-access-token',
    });
    ```
    

### 使用 CDN 软件

1.  从 CDN 添加组件脚本到您的 HTML :
    
    ```html
    <script
      type="module"
      src="https://static.cloud.coveo.com/atomic-hosted-page/v1/atomic-hosted-page/atomic-hosted-page.esm.js"
    ></script>
    ```
    
2.  在您的 HTML 中包含组件并初始化 :
    
    ```html
    <atomic-hosted-ui hosted-type="builder"></atomic-hosted-ui>
    <script>
      const hostedUI = document.querySelector('atomic-hosted-ui');
      hostedUI.initialize({
        pageId: 'example-page-id',
        organizationId: 'my-organization-id',
        accessToken: 'your-api-key',
      });
    </script>
    ```
    

* * *

## 属性

### `hosted-type`

-   **类型 :** `'trial' | 'builder' | 'code'`
-   **默认 :** `'code'`
-   **说明 :** 指定要装入的主机搜索页面的类型 :
    -   `trial`:装入试页.
    -   `builder`:装入构建器页面.
    -   `code`:装入自定义代码页.

* * *

## 初始化选项

这个 `initialize()` 方法需要以下选项:

| 选项 | 类型 | 需求 | 说明 |
| --- | --- | --- | --- |
| `pageId` | 字符串 | 对 | 主机搜索页面的独特标识符 . |
| `organizationId` | 字符串 | 对 | 科维奥组织ID. |
| `accessToken` | 字符串 | 对 | 用于授权的API密钥或令牌. |
| `platformUrl` | 字符串 | 没有 | 科维奥平台的URL. 默认为 `https://platform.cloud.coveo.com`。 。 。 . |

* * *

## 示例

### 基本示例

```html
<!DOCTYPE html>
<html lang="en">
  <head>
    <title>Atomic Hosted Page Example</title>
    <script
      type="module"
      src="https://static.cloud.coveo.com/atomic-hosted-page/v1/atomic-hosted-page/atomic-hosted-page.esm.js"
    ></script>
  </head>
  <body>
    <atomic-hosted-ui hosted-type="builder"></atomic-hosted-ui>
    <script>
      const hostedUI = document.querySelector('atomic-hosted-ui');
      hostedUI.initialize({
        pageId: 'example-page-id',
        organizationId: 'my-organization-id',
        accessToken: 'your-api-key',
      });
    </script>
  </body>
</html>
```

* * *

## 许可证

本项目根据以下规定获得许可证: [Apache 2.0 许可证](https://npmcn.com/package/%40coveo/atomic-hosted-page/LICENSE)。 。 。 .

## 常见问题

### @coveo/atomic-hosted-page 是什么？

Web 组件用于在 DOM 中注入 Coveo 主机搜索页面 \.

### 如何安装 @coveo/atomic-hosted-page？

在项目目录运行 npm install @coveo/atomic-hosted-page，或使用 pnpm add / yarn add / bun add。

### @coveo/atomic-hosted-page 支持 TypeScript 吗？

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

### @coveo/atomic-hosted-page 支持 ESM 还是 CommonJS？

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

### @coveo/atomic-hosted-page 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js ^20\.9\.0 \|\| ^22\.11\.0 \|\| ^24\.11\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @coveo/atomic-hosted-page 可以商用吗？

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

### @coveo/atomic-hosted-page 的下载量有多少？

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

### @coveo/atomic-hosted-page 还在维护吗？

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