For AI agents: the complete documentation index is available at /rspress-russian/llms.txt, the full documentation bundle is available at /rspress-russian/llms-full.txt, and this page is available as Markdown at /rspress-russian/ui/layout-components/overview-group.md.
close

OverviewGroup

OverviewGroup отображает сгруппированные карточки на страницах обзора, показывая список страниц и их якоря заголовков.

Использование

index.mdx
import { OverviewGroup } from '@rspress/core/theme';

const group = {
  name: 'Начало работы',
  items: [
    {
      text: 'Введение',
      link: '/guide/introduction',
      headers: [
        { id: 'what-is-rspress', text: 'Что такое Rspress' },
        { id: 'features', text: 'Возможности' },
      ],
    },
    {
      text: 'Установка',
      link: '/guide/installation',
    },
  ],
};

<OverviewGroup group={group} />;
Совет

Этот компонент обычно используется автоматически Rspress на страницах с overview: true в метаданных и не требует ручного вызова.

Пропсы

group

  • Тип: Group
  • Обязательный: Да
interface GroupItem {
  /** Заголовок элемента */
  text: string;
  /** Ссылка на элемент */
  link: string;
  /** Список якорей заголовков на странице */
  headers?: Header[];
  /** Список пользовательских подэлементов */
  items?: { text: string; link: string }[];
}

interface Group {
  /** Имя группы */
  name: string;
  /** Список элементов в группе */
  items: GroupItem[];
}

interface Header {
  id: string;
  text: string;
  depth: number;
}
  • name — заголовок группы, отображаемый как заголовок h2
  • items — список страниц в группе
  • headers — якоря заголовков на каждой странице; при клике выполняется переход к соответствующему месту
  • items (внутри GroupItem) — пользовательские подэлементы для замены автоматически извлечённых заголовков