# @coveo/quantic 中文文档

规范地址：https://npmcn.com/package/%40coveo/quantic/

版本：3\.45\.7
npm 元数据更新时间：2026-11-09T14:23:12.562Z
中文译文更新时间：2026-11-10T21:25:06.594Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：5.7 MB，1694 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- Node.js 要求：^20\.9\.0 \|\| ^22\.11\.0 \|\| ^24\.11\.0
- 运行依赖：5 个
- 首次发布：2022-06-13T21:20:12.525Z
- 最新版本发布：2026-11-09T14:23:12.164Z
- 近 30 天下载量：5053（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：3654（近 12 个月 58 个）

## 中文简介

一个销售力量闪电网络组件(LWC)库,用于建设现代UIs与Coveo平台的接口

## 安装

```sh
npm install @coveo/quantic
```

也可以使用：`pnpm add @coveo/quantic`、`yarn add @coveo/quantic`、`bun add @coveo/quantic`

## README

# 库维奥量子

## 使用图书馆

[如何使用 Coveo 量子图书馆](https://docs.coveo.com/en/quantic/latest/)

[安装 Coveo Quantic 作为销售力量解锁软件包](https://docs.coveo.com/en/quantic/latest/usage/#install-quantic)

## 捐款

### 创建销售力量开发组织

-   [报名](https://developer.salesforce.com/signup)
-   使用您的@ coveo.com 电子邮件账户 。 用户名可以是任何东西.

### 设置 SFDX CLI

[销售力cli](https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_setup_install_cli.htm#sfdx_setup_install_cli_npm)

-   运行 `pnpm add --global @salesforce/cli@2.x`
-   可选 : [设置 CLI 自动完成](https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_dev_cli_autocomplete.htm)

### 更新 SFDX CLI 插件

-   运行 `sf plugins update`

### 安装 VSCode 扩展

可选安装 [VSCode 销售力扩展包](https://marketplace.visualstudio.com/items?itemName=salesforce.salesforcedx-vscode) 如果您不想使用等效软件 `Salesforce cli` 命令来设置.

**说明** 确保您打开根部的 quntic 工程(`/packages/quantic/`)在vscode中,以使扩展正常工作.

### 在您的销售力组织中启用 Dev Hub

-   连接您的销售力量开发者组织 [登录](http://login.salesforce.com/)
-   从Setup开始,进入快取框中的Dev Hub,并选择Dev Hub.
-   要启用Dev Hub,请单击启用

### 授权您的 Dev 枢纽

-   在VS代码中,按下命令+Shift P,输入sfdx,并选择SFDX:授权一个Dev Hub.
-   您也可以从命令行运行此命令 . `sf org login web --set-default-dev-hub --alias LWC-Hub`
-   运行此命令会打开浏览器到 Salesforce 登录页面 。 输入您的销售力量用户名和密码 。 只授权一次,不是每次你工作的时候.

### 单一命令运行

-   确定你是根 的 `packages/quantic`。 。 。 .
    
-   运行 `pnpm run setup:examples`。 。 。 .
    

此命令将为您创建两个抓角 :

-   1 有闪电网络安全(LWS)启用. (阿利亚斯: `Quantic__LWS_enabled`(中文(简体) )
    
-   一个LWS已禁用,锁定服务已启用. (阿利亚斯: `Quantic__LWS_disabled`(中文(简体) )
    

每个刮伤角将包括:

-   全体 **量子组件**
-   这个 **示例组件**
-   一个 **实例 定量社区** 专题:
    -   🧪 **构成部分操场**
    -   💡 **解决方案实例**

要访问创建的社区链接, 请检查生成的 `.env` 脚本完成后的文件.

或者你可以运行下面的单个命令.

### 游戏地块组件和解决方案示例

Quantic 有两个单独的文件夹,例如组件,每个文件夹服务于不同的目的,在添加示例组件时使用以下规则:

-   **`force-app/playgroundComponents`** 包含用于构建"量子实例"社区游乐场和支持Playwright端到端测试的组件. 在此添加一个组件,当它显示单个量性组件,暴露其可配置的实验特性,或者提供该组件的测试范围.
-   **`force-app/solutionExamples`** 包含真实世界的参考执行,显示如何将量子组件组合起来,以解决更广泛的销售力使用案例。 实例包括 `exampleInsightPanel`, (中文(简体) ), `exampleRelevantGenerativeAnswering`, (中文(简体) ), `examplePageViewTracker` 还有更多 在此添加一个组件, 当它显示一个整合或可重复使用的解决方案模式而不是单个组件游乐场时 .

两个文件夹均由 `pnpm run deploy:examples`。 。 。 .

#### 创建默认切换符

-   确保你在 `packages/quantic` 根文件夹.
-   运行此命令以创建默认抓取值 . `pnpm run scratch:create`。 。 。 .
-   在 VS 代码中,按下命令+ Shift P,输入 sfdx,并选择 SFDX:创建默认切入 Org.
-   您也可以从命令行运行此命令 . `sf org create scratch --set-default --definition-file config/lws-enabled-scratch-def.json --alias Quantic__LWS_enabled`
-   `Quantic__LWS_enabled` 是一个用于刮痕的别名,可以用于其他 Salesforce CLI 命令。 你可以创建任何你喜欢的别名.

#### 部署量子代码

-   从命令行运行此命令 . `sf project deploy start --source-dir force-app/main`。 。 。 .

## 测试

### 部署量化实例社区

实例组件作为 Salesforce 社区(Digital Experiences)提供,允许您在两个不同的环境中对量子组件进行实验:一个是启用了闪电网络安全(LWS),另一个是禁用LWS.

将两个社区划为划角区,运行:

```bash
pnpm run setup:examples
```

此脚本创建、配置和部署在 **两个刮角**数字 :

-   与 **LWS 已启用**。 。 。 .
-   与 **LWS 已禁用**。 。 。 .

在脚本结尾处,提供两个社区的URL,例如:

```

The 'Quantic Examples' community (LWS enabled) is ready, you can access it at the following URL:
https://your-salesforce-lws-enabled-scratch-org-instance.force.com/examples

The 'Quantic Examples' community (LWS disabled) is ready, you can access it at the following URL:
https://your-salesforce-lws-disabled-scratch-org-instance.force.com/examples

```

一旦社区部署完毕,你可以部署 `main` 或者说 `example` 仅在通过运行相应命令而需要时,将组件切入到特定命令中:

```bash
pnpm run deploy:main Quantic__LWS_enabled
pnpm run deploy:examples Quantic__LWS_enabled
```

您可以用您的目标值化名取代 Quantic LWS 启用 。 例如:

```bash
pnpm run deploy:main MyCustomOrg
pnpm run deploy:examples MyCustomOrg
```

### 运行 Quantic 组件的播放机

**说明** 在试图逃跑之前 [剧作家](https://playwright.dev/) 测试,确保 `Quantic Examples` 如上一节所述,社区在两个字段中都得到部署,一个是启用LWS的,另一个是禁用.

**说明** 关于如何增加测试的更多信息,请参见我们 [量子测试战略](https://github.com/coveo/ui-kit/blob/main/packages/quantic/decisions/0001-testing-strategy.md),它为测试量子组件提供了详细的指南.

要运行 Playwright 测试, 请运行 :

```bash
pnpm run e2e:pre-provisioned
```

要运行 Playwright 测试, 仅针对 LWS 启用的抓取值, 请运行 :

```bash
pnpm run e2e:pre-provisioned:lws-enabled
```

要运行 Playwright 测试, 只针对 LWS 已禁用 的抓取 Og , 请运行 :

```bash
pnpm run e2e:pre-provisioned:lws-disabled
```

### 运行定量组件 LWC 单元测试

要在控制台上直接运行 LWC 单元测试,运行:

```bash
pnpm run test:unit
```

要在控制台直接运行特定文件/组件 LWC 单元测试,请运行:

```bash
pnpm run test:unit -p force-app/main/default/lwc/nameOfComponent/
```

## 从源头使用量

在您克隆了仓库并运行之后 `pnpm install`,运行以下命令:

-   `pnpm run build`
-   `sf project deploy start --source-dir force-app/main/default`

## 其他有用的命令

-   `sf project deploy start --metadata LightningComponentBundle`
-   `--metadata LightningComponentBundle` 对于不同类型的"资源",可以更改. 要知道哪个名字, 请检查相关的 `meta.xml` 每个资源类型的文件.
-   创建新的网络组件 。 在VS代码中,按下命令+Shift P,输入 sfdx,并选择 SFDX:创建闪电网络组件.

## 学习 LWC

-   [lwc.dev (英语)](https://lwc.dev/)
-   [组成部分参考](https://developer.salesforce.com/docs/component-library/overview/components),确保您留在"光线网络组件"部分. 奥拉不适用. 奥拉是老一辈的UI图书馆,被"销售力量"(Salesforce)贬值.
-   [闪电设计系统](https://www.lightningdesignsystem.com/)用于样式、CSS公用事业、图标等等的参考文献.

## 常见问题

### @coveo/quantic 是什么？

一个销售力量闪电网络组件\(LWC\)库,用于建设现代UIs与Coveo平台的接口

### 如何安装 @coveo/quantic？

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

### @coveo/quantic 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/coveo\_\_quantic 是否存在。

### @coveo/quantic 支持 ESM 还是 CommonJS？

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

### @coveo/quantic 需要什么版本的 Node\.js？

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

### @coveo/quantic 可以商用吗？

@coveo/quantic 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @coveo/quantic 的下载量有多少？

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

### @coveo/quantic 还在维护吗？

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