> For AI agents: the complete documentation index is available at https://rspress.rs/llms.txt, the full documentation bundle is available at https://rspress.rs/llms-full.txt.

# OverviewGroup

`OverviewGroup` renders group cards in overview pages, displaying page lists and their heading anchors. It's part of the [Overview page](https://rspress.rs/guide/advanced/overview-page.md).

## Usage

You can modify the component's styles through [custom theme](https://rspress.rs/guide/basic/custom-theme.md), or use `OverviewGroup` freely for UI display without relying on Rspress's built-in Overview page, for example:

```mdx title="index.mdx"
import { OverviewGroup } from '@rspress/core/theme';

<OverviewGroup
  group={{
    name: 'Usage Test',
    items: [
      {
        text: 'Introduction',
        link: '/guide/introduction',
        headers: [
          { id: 'what-is-rspress', text: 'What is Rspress', depth: 2 },
          { id: 'features', text: 'Features', depth: 2 },
        ],
      },
      {
        text: 'Installation',
        link: '/guide/installation',
      },
    ],
  }}
/>
```


## Usage Test

### [Introduction](/guide/introduction.md)

- [What is Rspress](/guide/introduction.md#what-is-rspress)
- [Features](/guide/introduction.md#features)

### [Installation](/guide/installation.md)

## Props

### group

- **Type:** `Group`
- **Required:** Yes

```ts
interface GroupItem {
  /** Item title */
  text: string;
  /** Item link */
  link: string;
  /** List of heading anchors within the page */
  headers?: Header[];
  /** Custom sub-items list */
  items?: { text: string; link: string }[];
}

interface Group {
  /** Group name */
  name: string;
  /** List of items in the group */
  items: GroupItem[];
}

interface Header {
  id: string;
  text: string;
  depth: number;
}
```

- `name` - Group title, rendered as h2 heading
- `items` - List of pages in the group
- `headers` - Heading anchors within each page, clickable to jump to corresponding position
- `items` (within GroupItem) - Custom sub-items, used to replace auto-extracted headers