---
title: TagGroup 标签组
description: 可聚焦的标签列表，支持键盘导航、选择与移除。
links:
  rac: TagGroup
  source: tag-group/tag-group.tsx
  styles: tag-group.css
  storybook: Components/Collections/TagGroup
---

## 用法

```tsx
import { TagGroup } from '@heroui/react';
```

<ComponentPreview
  name="tag-group-basic"
/>

## 组件结构

```tsx
import { TagGroup, Tag, Label, Description, ErrorMessage } from '@heroui/react';

export default () => (
  <TagGroup>
    <Label />
    <TagGroup.List>
      <Tag>
        <Tag.RemoveButton />
      </Tag>
    </TagGroup.List>
    <Description />
    <ErrorMessage />
  </TagGroup>
)
```

## 示例

### 尺寸

<ComponentPreview
  name="tag-group-sizes"
/>

### 变体

<ComponentPreview
  name="tag-group-variants"
/>

### 禁用

<ComponentPreview
  name="tag-group-disabled"
/>

### 选择模式

<ComponentPreview
  name="tag-group-selection-modes"
/>

### 受控组件

<ComponentPreview
  name="tag-group-controlled"
/>

### 带错误信息

<ComponentPreview
  name="tag-group-with-error-message"
/>

### 带列表数据

<ComponentPreview
  name="tag-group-with-list-data"
/>

### 带前缀

<ComponentPreview
  name="tag-group-with-prefix"
/>

### 带移除按钮

<ComponentPreview
  name="tag-group-with-remove-button"
/>

### 渲染函数

<ComponentPreview
  name="tag-group-render-function"
/>

## 自定义样式

### Tailwind CSS

<ComponentPreview name="tag-group-custom-styles" />

### 全局 CSS

若要自定义组件类，可使用 `@layer components` 指令。[了解更多](https://tailwindcss.com/docs/adding-custom-styles#adding-component-classes)。

```css
@layer components {
  .tag-group {
    @apply flex flex-col gap-2;
  }

  .tag-group__list {
    @apply flex flex-wrap gap-2;
  }

  .tag {
    @apply rounded-full px-3 py-1;
  }

  .tag__remove-button {
    @apply ml-1;
  }
}
```

## 样式参考

HeroUI 遵循 [BEM](https://getbem.com/) 方法论，确保组件变体与状态可复用且易于自定义。

### CSS 类

TagGroup 组件使用以下 CSS 类（[查看源码样式](https://github.com/heroui-inc/heroui/blob/v3/packages/styles/components/tag-group.css) 与 [tag.css](https://github.com/heroui-inc/heroui/blob/v3/packages/styles/components/tag.css)）：

#### 基础类 [!toc]
- `.tag-group` - TagGroup 根容器
- `.tag-group__list` - 标签列表容器
- `.tag` - 标签基础样式
- `.tag__remove-button` - 移除按钮触发器

#### 插槽类 [!toc]
- `.tag-group [slot="description"]` - Description 插槽样式
- `.tag-group [slot="errorMessage"]` - ErrorMessage 插槽样式

#### 尺寸类 [!toc]
- `.tag--sm` - 小尺寸标签
- `.tag--md` - 中尺寸标签（默认）
- `.tag--lg` - 大尺寸标签

#### 变体类 [!toc]
- `.tag--default` - 默认变体
- `.tag--surface` - 带 Surface 背景的变体

#### 状态类 [!toc]
- `.tag[data-selected="true"]` - 选中状态
- `.tag[data-disabled="true"]` - 禁用状态
- `.tag[data-hovered="true"]` - 悬停状态
- `.tag[data-pressed="true"]` - 按下状态
- `.tag[data-focus-visible="true"]` - 聚焦状态（键盘焦点）

### 交互状态

该组件同时支持 CSS 伪类与 data 属性：

- **悬停**：标签上 `:hover` 或 `[data-hovered="true"]`
- **聚焦**：标签上 `:focus-visible` 或 `[data-focus-visible="true"]`
- **按下**：标签上 `:active` 或 `[data-pressed="true"]`
- **已选中**：标签上 `[data-selected="true"]` 或 `[aria-selected="true"]`
- **禁用**：标签上 `:disabled` 或 `[data-disabled="true"]`

## API 参考

### TagGroup
| Prop | 类型 | 默认值 | 描述 |
|------|------|--------|------|
| `selectionMode` | `"none" \| "single" \| "multiple"` | `"none"` | 允许的选择类型。 |
| `selectedKeys` | `Selection` | - | 当前选中的 key（受控）。 |
| `defaultSelectedKeys` | `Selection` | - | 初始选中的 key（非受控）。 |
| `onSelectionChange` | `(keys: Selection) => void` | - | 选中变化时调用的事件处理函数。 |
| `disabledKeys` | `Iterable<Key>` | - | 禁用标签的 key。 |
| `isDisabled` | `boolean` | - | 是否禁用整个 TagGroup。 |
| `onRemove` | `(keys: Set<Key>) => void` | - | 移除标签时调用的事件处理函数。 |
| `size` | `"sm" \| "md" \| "lg"` | `"md"` | 组内标签尺寸。 |
| `variant` | `"default" \| "surface"` | `"default"` | 标签视觉变体。 |
| `className` | `string` | - | 额外的 Tailwind CSS 类。 |
| `children` | `ReactNode \| RenderFunction` | - | TagGroup 内容或渲染函数。 |
| `render` | `DOMRenderFunction<keyof React.JSX.IntrinsicElements, undefined>` | - | 使用自定义渲染函数覆盖默认 DOM 元素。|

### TagGroup.List
| Prop | 类型 | 默认值 | 描述 |
|------|------|--------|------|
| `items` | `Iterable<T>` | - | 标签列表要展示的数据项。 |
| `renderEmptyState` | `() => ReactNode` | - | 列表为空时的渲染函数。 |
| `className` | `string` | - | 额外的 Tailwind CSS 类。 |
| `children` | `ReactNode \| RenderFunction` | - | 标签列表内容或渲染函数。 |
| `render` | `DOMRenderFunction<keyof React.JSX.IntrinsicElements, TagListRenderProps>` | - | 使用自定义渲染函数覆盖默认 DOM 元素。|

### Tag
| Prop | 类型 | 默认值 | 描述 |
|------|------|--------|------|
| `id` | `Key` | - | 标签唯一标识。 |
| `textValue` | `string` | - | 标签内容的字符串表示，用于无障碍。 |
| `isDisabled` | `boolean` | - | 是否禁用该标签。 |
| `className` | `string` | - | 额外的 Tailwind CSS 类。 |
| `children` | `ReactNode \| RenderFunction` | - | 标签内容或渲染函数。 |
| `render` | `DOMRenderFunction<keyof React.JSX.IntrinsicElements, TagRenderProps>` | - | 使用自定义渲染函数覆盖默认 DOM 元素。|

**提示：** `size`、`variant` 由父级 `TagGroup` 继承，无法在单个 `Tag` 上直接设置。

### Tag.RemoveButton
| Prop | 类型 | 默认值 | 描述 |
|------|------|--------|------|
| `className` | `string` | - | 额外的 Tailwind CSS 类。 |
| `children` | `ReactNode` | - | 自定义移除按钮内容（默认为关闭图标）。 |

**提示：** `Tag.RemoveButton` 支持类似 `SearchField.ClearButton` 的定制方式。当为 `TagGroup` 提供 `onRemove` 时：

- **自动渲染**：若 `Tag` 的子节点中未包含自定义 `Tag.RemoveButton`，会自动渲染默认移除按钮。
- **自定义按钮**：若在 `Tag` 下提供了自定义 `Tag.RemoveButton`，将替换自动渲染的按钮。
- **自定义图标**：可向 `Tag.RemoveButton` 传入自定义子内容（如图标）以改变外观。

**示例 — 自动渲染（默认）**：
```tsx
<TagGroup onRemove={handleRemove}>
  <TagGroup.List>
    <Tag id="news">News</Tag>
    {/* Remove button is automatically rendered */}
  </TagGroup.List>
</TagGroup>
```

**示例 — 自定义 RemoveButton（带图标）**：
```tsx
<TagGroup onRemove={handleRemove}>
  <TagGroup.List>
    <Tag id="news">
      News
      <Tag.RemoveButton>
        <CustomIcon />
      </Tag.RemoveButton>
    </Tag>
  </TagGroup.List>
</TagGroup>
```

**示例 — 在 render props 中使用自定义 RemoveButton**：
```tsx
<Tag id="news">
  {(renderProps) => (
    <>
      News
      {!!renderProps.allowsRemoving && (
        <Tag.RemoveButton>
          <CustomIcon />
        </Tag.RemoveButton>
      )}
    </>
  )}
</Tag>
```

### RenderProps

在 TagGroup.List 中使用渲染函数时，会传入以下值：

| Prop | 类型 | 描述 |
|------|------|------|
| `isSelected` | `boolean` | 标签是否选中。 |
| `isDisabled` | `boolean` | 标签是否禁用。 |
| `isHovered` | `boolean` | 标签是否悬停。 |
| `isPressed` | `boolean` | 标签是否按下。 |
| `isFocused` | `boolean` | 标签是否聚焦。 |
| `isFocusVisible` | `boolean` | 标签是否为可见键盘焦点。 |

## 相关组件

<RelatedComponents component="taggroup" />