# @cludosearch/cludo-search-components 中文文档

规范地址：https://npmcn.com/package/%40cludosearch/cludo-search-components/

版本：1\.0\.160
npm 元数据更新时间：2026-11-06T10:50:11.131Z
中文译文更新时间：2026-11-10T03:39:12.783Z
软件包许可：ISC

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

原始 npm 页面：https://www.npmjs.com/package/%40cludosearch/cludo-search-components
原文对照：https://npmcn.com/package/%40cludosearch/cludo-search-components/?lang=original
项目主页：https://github.com/Cludo/cludo-search-components#readme
源码仓库：https://github.com/Cludo/cludo-search-components

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

- 包体积（解压后）：4 MB，364 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：4 个
- peer 依赖：react 16\.8\.0 - 19，react-dom 16\.8\.0 - 19
- 首次发布：2024-06-18T06:27:22.780Z
- 最新版本发布：2026-11-06T10:50:10.920Z
- 近 30 天下载量：4406（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：193（近 12 个月 158 个）

## 中文简介

反应中的 Cludo 搜索组件

## 安装

```sh
npm install @cludosearch/cludo-search-components
```

也可以使用：`pnpm add @cludosearch/cludo-search-components`、`yarn add @cludosearch/cludo-search-components`、`bun add @cludosearch/cludo-search-components`

## README

# cludo- 搜索组件

反应组件用于构建 Cludo 搜索体验 。 软件包作为 `@cludosearch/cludo-search-components` 与16.8.0至19反应公司合作.

## 安装

```bash
npm install @cludosearch/cludo-search-components
```

## 使用量

该套装有三个切入点. 根项用于客户端渲染, `/ssr` 用于 Next.js 和其他服务器渲染,以及 `/styles` 是样式表.

```tsx
// Client side rendering
import { initCludo, CludoWrapper } from "@cludosearch/cludo-search-components";

// Server side rendering (Next.js and similar)
import { CludoWrapper } from "@cludosearch/cludo-search-components/ssr";

// Stylesheet
import "@cludosearch/cludo-search-components/styles";
```

在大多数设置中导入样式表 。 根项仅在 `initCludo` 调用 `cssTheme`。 。 。 .

根项有 `import` 只有条件,所以装入无害环境管理 `import`。 。 。 . `require()` 不被支持.

## 文档

-   组成部分文件和实例: [故事书](https://react.cludo.com/)。《故事手册》目前记录了遗产 `@cludo` 软件包。 这个 `@cludosearch` 文档尚未公布.
-   释放注释 : [变动情况](https://unpkg.com/@cludosearch/cludo-search-components@latest/CHANGELOG.md)包件内有变换日志.

## 从@cludo 升级

该软件包先前作为 `@cludo/cludo-search-components` 在 GitHub 软件包上。 该线路于1.0.63停运,不再更新. 新的版本只按 `@cludosearch` 在 npm 上,重新命名您的导入并安装新软件包。 第一节 [更改日志](https://unpkg.com/@cludosearch/cludo-search-components@latest/CHANGELOG.md) 是迁移指南.

## 对于 Cludo 开发者

### 向图书馆捐款

关于详细捐款准则,请参见我们 [交汇文件](https://cludosearch.atlassian.net/wiki/spaces/DEV/pages/3155558441/Contributing+to+the+React+component+library)。 。 。 .

### 重要说明

-   **@cludosearch vs @cludo (英语)**: 对于 @cludosearch 版本上的新功能(在 npm 上发布的版本),将您的分支打下 `npm-migration-updates`编辑 `main` 分支用于旧的@cludo版本.
-   **将您的工程从@cludo升级到@cludosearch?** 见 [移徙指南](https://cludosearch.atlassian.net/wiki/spaces/react/pages/4408573968/What+to+be+aware+of+when+updating+a+template+from+cludo+cludo-search-components+to+cludosearch+cludo-search-components) 提供重要信息和最佳做法.

### 地方发展

#### 与反应搜索控制器合作

##### 先决条件

-   克卢多的一个当地项目. 客户端模板仓库
-   [雅尔克语](https://github.com/wclr/yalc) 全球安装: `npm i yalc -g`

##### 设置步骤

1.  **克隆并创建分支**
    
    -   克隆 Cludo- 搜索组件仓库
    -   在命名会后创建新的特征分支 : `[f|h]/[JIRA-ID]-description`
        -   `f/` 为特性, `h/` 热补丁
        -   示例 `f/REACT-32-new-categorized-serp-component`
2.  **为地方发展准备图书馆**
    
    ```bash
    cd cludo-search-components
    npm install
    npm i yalc -g
    yalc publish
    ```
    
3.  **链接到您的本地项目**
    
    ```bash
    cd /path/to/your/customer-template
    yalc link @cludosearch/cludo-search-components
    cludosearch dev
    ```
    
4.  **开发和测试**
    
    -   更改 Cludo- search- 组件目录
    -   当准备测试更改时:
        
        ```bash
        npm run build
        yalc publish --push
        ```
        
    -   您的链接工程将自动与修改重编
    -   刷新浏览器以查看更新
5.  **完成后清理**
    
    ```bash
    yalc remove @cludosearch/cludo-search-components
    npm install @cludosearch/cludo-search-components
    ```
    

#### 与 React 搜索核心( Vite 工程) 合作

1.  **创建 Vite 工程**
    
    ```bash
    npm create vite@latest .
    ```
    
    提示时选择反应 + 类型脚本
    
2.  **初始化 React 搜索核心** 跟着 [文档](https://cludosearch.atlassian.net/wiki/spaces/DEV/pages/3155558441/Contributing+to+the+React+component+library) 设置 React 搜索核心
    
3.  **与雅尔克的链接** 遵循上面反应搜索控制器部分的第2-4个步骤
    
4.  **配置用于本地开发的 Vite** 添加到您的 `vite.config.ts`数字 :
    
    ```typescript
    optimizeDeps: {
      include: ["@cludosearch/cludo-search-components"],
    }
    ```
    
5.  **需要时清除 Vite 缓存** 如果变化没有出现:
    
    ```bash
    rm -rf node_modules/.vite && rm -rf node_modules/.cache/vite
    ```
    

### 出版新版本

#### 版本弹出

图书馆使用 [语义版本](https://semver.org/)数字 : `MAJOR.MINOR.PATCH`数字告诉消费者更新是否安全.

| 弹出 | 什么时候用 | 怎么办 |
| --- | --- | --- |
| **补丁** | 臭虫修复后没有给公共 API 更改 . | 没什么 这个 `update-version` 工作流程在每次拉出请求时都会撞击补丁版本. |
| **次要** | 保持现有代码工作的新特性. | 运行 `npm version minor --no-git-tag-version` 在你的树枝和推. |
| **少校** | 任何零用钱. | 运行 `npm version major --no-git-tag-version`,首先与团队商定解禁,并加入迁移笔记. |

当您的版本已经领先基础分支时, 工作流程会跳过它的补丁凸起 .

如果更改删除或重命名导出、 道具或类型、 制作所需的道具、 更改默认值或返回值、 更改模板样式或查询的标记或类名, 或更改 `peerDependencies`, (中文(简体) ), `exports` 或者说 `sideEffects`如果不确定,就当是断了 在一次小释放中折旧,然后在一次大释放中取出.

全向导 : [版本 React 组件库](https://cludosearch.atlassian.net/wiki/spaces/DEV/pages/5001281538/Versioning+the+React+component+library)。 。 。 .

#### 更改日志

每个小或主要释放都增加了一节 `CHANGELOG.md` (如果文件尚未存在,则创建该文件),最先更新的版本。 每个断开更改得到三行,然后是代码前/后示例:

-   **改变了什么:** 新旧行为 公关号码和Jira键.
-   **受影响者:** 一个具体的设置阅读器可以对照自己的代码检查.
-   **怎么办:** 修复它的行动.

在主要版本中,另增加一个故事书迁移页 `src/stories/`因为自我接待的顾客会读故事书 而不是回放.

这个 [`search-components-changelog`](https://github.com/Cludo/ai/blob/main/skills/search-components-changelog/SKILL.md) 人工智能技能 `Cludo/ai` repo将更改分类,设置凸起并起草条目. 请克洛德"为这个PR写更动日志条目".

#### 自动向国家预防机制发布

当拉动请求合并到 `npm-migration-updates` 分支,该软件包会使用 GitHub Actions 自动向 npm 公共登记册发布.

**重要内容:** 每次合并都会在 `package.json`,所以检查它是否符合您的更改需要(参见 [版本弹出](https://npmcn.com/package/%40cludosearch/cludo-search-components/#readme-version-bumping)在合并之前.

#### Beta 版本

要发布一个β版本供测试( 人工):

1.  附录 `-beta.0` 改为版本(例如, `1.0.75-beta.0`(中文(简体) )
2.  出版单位: `npm publish --tag beta`
3.  安装消耗项目 : `npm install @cludosearch/cludo-search-components@1.0.75-beta.0`

### 本地运行故事本

版本数 `0.18.3+` 包括故事书文件:

```bash
npm install
npm run storybook
```

## 常见问题

### @cludosearch/cludo-search-components 是什么？

反应中的 Cludo 搜索组件

### 如何安装 @cludosearch/cludo-search-components？

在项目目录运行 npm install @cludosearch/cludo-search-components，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（16\.8\.0 - 19）、react-dom（16\.8\.0 - 19）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @cludosearch/cludo-search-components 支持 TypeScript 吗？

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

### @cludosearch/cludo-search-components 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @cludosearch/cludo-search-components 可以商用吗？

@cludosearch/cludo-search-components 使用 ISC 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @cludosearch/cludo-search-components 的下载量有多少？

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

### @cludosearch/cludo-search-components 还在维护吗？

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