# instantsearch-tagsbox-react 中文文档

规范地址：https://npmcn.com/package/instantsearch-tagsbox-react/

版本：1\.2\.1
npm 元数据更新时间：2026-11-03T20:54:40.615Z
中文译文更新时间：2026-11-03T22:11:56.699Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/instantsearch-tagsbox-react
原文对照：https://npmcn.com/package/instantsearch-tagsbox-react/?lang=original
源码仓库：https://github.com/algolia/instantsearch-labs/tree/master/tagsbox/react-instantsearch

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

- 包体积（解压后）：29.3 kB，8 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：未声明
- 运行依赖：2 个
- 首次发布：2018-11-28T10:32:04.272Z
- 最新版本发布：2018-11-28T10:32:04.412Z
- 已发布版本数：1（近 12 个月 0 个）

## 中文简介

🎥 **[在CodeSandbox现场观看](https://codesandbox.io/s/vj5zo81ryy)**

## 安装

```sh
npm install instantsearch-tagsbox-react
```

也可以使用：`pnpm add instantsearch-tagsbox-react`、`yarn add instantsearch-tagsbox-react`、`bun add instantsearch-tagsbox-react`

## README

# TagsBox小部件

🎥 **[在CodeSandbox现场观看](https://codesandbox.io/s/vj5zo81ryy)**

## 演示

![Demo of TagsBox Widget](https://cl.ly/6ea705021fda/Screen%252520Recording%2525202018-10-26%252520at%25252001.35%252520PM.gif)

## 描述

这是 `TagsBox` 实验室小部件 [反应InstantSearch](https://community.algolia.com/react-instantsearch/)． 您可以使用这个小部件用Algolia搜索和选择标记，并在以后的任何目的中使用它们。

这个小部件显示一个输入，在用户输入时提供标记建议。然后可以单击标签以添加到输入中。

这有助于用户选择记录用于其他目的，而不是搜索它们，而是重用它们以完成以后的其他操作（例如，在创建博客文章时选择发送电子邮件的联系人或类别）。

**目录表**

-   [获取代码](https://npmcn.com/package/instantsearch-tagsbox-react/#readme-get-the-code)
    -   [JavaScript](https://npmcn.com/package/instantsearch-tagsbox-react/#readme-javascript)
    -   [CSS](https://npmcn.com/package/instantsearch-tagsbox-react/#readme-css)
-   [用法](https://npmcn.com/package/instantsearch-tagsbox-react/#readme-usage)
    -   [需求](https://npmcn.com/package/instantsearch-tagsbox-react/#readme-requirements)
-   [API](https://npmcn.com/package/instantsearch-tagsbox-react/#readme-api)
    -   [relevanceWidget(选择)](https://npmcn.com/package/instantsearch-tagsbox-react/#readme-relevancewidgetopts)
-   [例子](https://npmcn.com/package/instantsearch-tagsbox-react/#readme-examples)
-   [实现细节](https://npmcn.com/package/instantsearch-tagsbox-react/#readme-implementation-details)
-   [贡献](https://npmcn.com/package/instantsearch-tagsbox-react/#readme-contributing)

## 获取代码

这个小部件自带JavaScript，但也有预定义的CSS。

### JavaScript

您可以从存储库本身复制并粘贴JavaScript代码，在 [src / lib](https://npmcn.com/package/instantsearch-tagsbox-react/src/lib) 文件夹，并使用 `<Tag />` 组件。

### CSS

您可以从存储库本身复制并粘贴必要的CSS代码，将其抓取进来 [src / lib / Tags.css](https://npmcn.com/package/instantsearch-tagsbox-react/src/lib/Tags.css)。

## 用法

安装时使用 `yarn add instantsearch-tagsbox-react` 然后，简单地使用它：

```jsx
import { InstantSearch } from 'react-instantsearch-dom';
import TagsBox from 'instantsearch-tagsbox-react';

export const SelectedTagComponent = ({ hit }) => (
    <Fragment>
        {hit.lastname}
    </Fragment>
);

export const SuggestedTagComponent = ({ hit }) => (
    <Fragment>
        {hit.firstname} {hit.lastname}
    </Fragment>
);

<InstantSearch
    appId="..."
    apiKey="..."
    indexName="..."
>
    <TagsBox
        selectedTagComponent={SelectedTagComponent}
        suggestedTagComponent={SuggestedTagComponent}
        onUpdate={(newTags, previousTags) => console.log(newTags, previousTags)}
        translations={{ placeholder: "Search…", noResult: "…" }}
    />
</InstantSearch>
```

### 需求

您应该封装 `<TagsBox />` 组件 `<InstantSearch />` 一个。

要正常工作， **您需要为组件提供三个props**：

-   `selectedTagComponent` （component）：描述一个选定的标签应该如何显示
    -   收到一个 `hit` 作为参数（来自阿尔及利亚）
-   `suggestedTagComponent` （组件）：描述建议的标签应该如何显示
    -   收到一个 `hit` 作为参数（来自阿尔及利亚）
-   `onUpdate` （函数）：每次添加或删除标签时调用
    -   接收代表新标记和前一个标记的两个参数。它们都是数组，分别包含当前选择的标记和以前的标记

可以封装 `<TagBox />` 组件 `<Index />` 如果您希望针对来自同一InstantSearch实例的不同索引，请使用。

## 例子

-   使用 `connectAutoComplete()` 连接器: [CodeSandbox](https://codesandbox.io/s/vj5zo81ryy)

### 道具

| 名字 | 类型 | 使用 |
| --- | --- | --- |
| selectedTagComponent(必需) | 组件 | 描述一个选定的标签应该如何显示。 |
| suggestedTagComponent(必需) | 组件 | 描述建议的标签应该如何显示。 |
| NoResultComponent | 组件 | 描述一个不存在的标签应该如何显示（应该使用） `onAddTag` 道具)。 |
| onUpdate(必需) | 函数 | 每次添加或删除标签时调用。 |
| onAddTag | 函数 | 在添加标记以操作对象之前调用。要么取 `hit` （对象）或 `value` （string）作为参数，并且应该始终返回一个 `object` 与一个 `objectID` 价值。 |
| 翻译 | 对象 | 设置 `placeholder` 和 `noResult` 翻译。 |
| limitTo | 数量 | 限制要选择的标签数量。 |

## 实现细节

控件实现此小部件 [`connectAutoComplete()` 连接器](https://community.algolia.com/react-instantsearch/connectors/connectAutoComplete.html)． 要了解有关连接器的更多信息，可以阅读相关的 [指南](https://community.algolia.com/react-instantsearch/guide/Connectors.html)。

## 贡献

要对项目做出贡献，请克隆此存储库，然后运行：

```sh
yarn
yarn start
```

## 常见问题

### instantsearch-tagsbox-react 是什么？

🎥 在CodeSandbox现场观看

### 如何安装 instantsearch-tagsbox-react？

在项目目录运行 npm install instantsearch-tagsbox-react，或使用 pnpm add / yarn add / bun add。

### instantsearch-tagsbox-react 支持 TypeScript 吗？

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

### instantsearch-tagsbox-react 支持 ESM 还是 CommonJS？

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

### instantsearch-tagsbox-react 可以商用吗？

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

### instantsearch-tagsbox-react 还在维护吗？

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