Navigation

Article Outline

Оглавление статьи стоит не сбоку, а над текстом: пункты пронумерованы, у активного номер заливается, а ряд прокручивается пальцем.

  • scrollspy
  • toc
  • article
  • navigation

Превью

1440pxHost theme

Использовать с AI

  1. 1. Скопируйте ссылку.
  2. 2. Напишите агенту своими словами и вставьте её в предложение.
  3. 3. Агент откроет ссылку и поставит компонент из registry.

размести это в шапке: https://vibeui.ru/c/scrollspy-002

Содержание

1 / 4

Зачем

Статья объясняет, почему оглавление на длинной странице перестаёт быть украшением: читатель приходит из поиска и попадает в середину текста.

Как устроено

Разделы помечены идентификаторами, ссылки — обычные якоря, а подсветку добавляет наблюдатель пересечений поверх уже работающей навигации.

На телефоне

Оглавление в строку прокручивается пальцем и не отнимает ширину у текста, поэтому его не приходится прятать за кнопкой.

Границы

Для оглавления из пятнадцати пунктов строка перестаёт работать: там нужен вложенный список или боковая колонка.

Показать полную инструкцию

То, что лежит по ссылке в развёрнутом виде. Нужна, если агент не может открыть ссылку — тогда вставьте этот текст целиком.

# Установка и размещение «scrollspy-002» (Article Outline) из VibeUI

## 1. Сначала установка — не пропускай, не пересоздавай
Выполни эту команду до того, как писать код:
npx shadcn@latest add https://vibeui.ru/r/scrollspy-002.json

Registry item: https://vibeui.ru/r/scrollspy-002.json
Ставится в: components/vibeui/scrollspy-002.tsx (точный путь следует алиасам components.json этого проекта).
npm-зависимости: нет.
Registry-зависимости: нет.

Ставь из реестра. Не пересоздавай по описанию, не подменяй похожим
компонентом из другой библиотеки и не переписывай под стиль проекта.

## 2. Что это
Оглавление статьи стоит не сбоку, а над текстом: пункты пронумерованы, у активного номер заливается, а ряд прокручивается пальцем.

Оглавление статьи в строку: якорные ссылки работают без JS, подсветку текущего раздела добавляет IntersectionObserver. Ноль зависимостей, один файл.

## 3. Как использовать
import { Scrollspy002 } from "@/components/vibeui/scrollspy-002"

<Scrollspy002
  title="Содержание"
  sections={[
    { id: "why", title: "Зачем", text: "Почему оглавление нужно длинной странице" },
    { id: "how", title: "Как устроено", text: "Якоря плюс наблюдатель пересечений" },
  ]}
/>

Полный список пропсов — в установленном файле.

## 4. Куда поставить
Это мелкий inline-компонент. Поставь его ровно туда, куда просил
пользователь, внутрь существующей разметки. Не создавай ради него
новую страницу, секцию или обёртку. Если на этом месте уже стоит похожий
контрол — замени его, а не добавляй второй.

Куда поставить: ___
(Эту строку заполняет пользователь. Если она осталась пустой — спроси,
а не угадывай.)

## 5. Сохранить как установлено
- локальную палитру --vibeui-scrollspy-002-* и не подменять её токенами вашей темы
- обычные якоря без preventDefault: без JS оглавление обязано остаться рабочим
- IntersectionObserver вместо обработчика scroll — иначе браузер считает раскладку на каждый пиксель
- rootMargin с отрицательным низом: без него активным становится раздел, уже ушедший вверх
- aria-current на активной ссылке: залитый номер скринридеру недоступен
- запас снизу у последнего раздела — иначе он не долистывается и никогда не подсвечивается

## 6. Можно менять
- заголовок оглавления через title
- разделы через sections: идентификатор, заголовок и текст
- цвет акцента через accent
- высоту области чтения в правиле height у [data-part="body"]

## 7. Правила
- Идентификаторы разделов должны быть уникальны на странице: два блока с одинаковыми id перебьют якоря.
- Оглавление в строку рассчитано на пять-шесть пунктов: длинный список превращается в бесконечную прокрутку.
- Область чтения здесь своя; для оглавления по всей странице уберите root у наблюдателя.
- Не выносите CSS-переменные в globals.css: компонент обязан оставаться одним файлом.

## 8. Проверка
- рендерится без ошибок в консоли;
- выглядит так же, как превью на странице VibeUI, откуда взята ссылка;
- если нет — ты изменил что-то из раздела 5, верни как было.

Для разработчика

npx shadcn@latest add https://vibeui.ru/r/scrollspy-002.json
https://vibeui.ru/r/scrollspy-002.json

Компонент самодостаточен: один файл, без зависимостей, палитра в локальных переменных --vibeui-scrollspy-002-*. Клиентский ("use client") — нужен IntersectionObserver. Наблюдатель следит за разделами внутри собственной области прокрутки: root — сам блок текста, rootMargin обрезает нижние 65%, поэтому активным становится раздел у верхней кромки, а не любой видимый. Ссылки — обычные якоря без preventDefault: без JS они по-прежнему доводят до раздела, наблюдатель добавляет только подсветку. Активный пункт помечен aria-current и залитым кружком номера: в горизонтальном ряду цвета текста мало.

Исходник компонента

Тот же файл, который поставит агент. Нужен, если вы предпочитаете скопировать код руками.

"use client"

import { useEffect, useRef, useState } from "react"
import type { ComponentPropsWithoutRef, CSSProperties } from "react"

export type Scrollspy002Section = {
  id: string
  title: string
  text?: string
}

export type Scrollspy002Props = Omit<
  ComponentPropsWithoutRef<"div">,
  "children"
> & {
  sections?: Scrollspy002Section[]
  title?: string
  accent?: string
}

// Идея компонента: оглавление статьи лежит не сбоку, а сверху — так оно
// работает и на телефоне, где боковой колонки просто нет. Пункты
// пронумерованы, у активного номер заливается: в горизонтальном ряду
// подсветка цветом текста теряется, а залитый кружок виден издалека.
// Слежение — IntersectionObserver: обработчик scroll на каждый пиксель
// заставил бы браузер считать раскладку в самый неподходящий момент.
const STYLES = `
:where([data-vibeui-block="scrollspy-002"]){
--vibeui-scrollspy-002-bg:oklch(1 0 0);
--vibeui-scrollspy-002-fg:oklch(0.23 0.014 265);
--vibeui-scrollspy-002-muted:oklch(0.56 0.014 265);
--vibeui-scrollspy-002-border:oklch(0.91 0.006 265);
--vibeui-scrollspy-002-accent:oklch(0.55 0.19 262);
--vibeui-scrollspy-002-font:ui-sans-serif,system-ui,-apple-system,"Segoe UI",Roboto,"Helvetica Neue",Arial,sans-serif;
}
[data-vibeui-block="scrollspy-002"]{
display:flex;flex-direction:column;gap:0.625rem;
width:100%;max-width:28rem;box-sizing:border-box;padding:0.9375rem;
background:var(--vibeui-scrollspy-002-bg);
border:1px solid var(--vibeui-scrollspy-002-border);border-radius:0.875rem;
font-family:var(--vibeui-scrollspy-002-font);color:var(--vibeui-scrollspy-002-fg);
}
[data-vibeui-block="scrollspy-002"] [data-part="head"]{display:flex;align-items:baseline;justify-content:space-between;gap:0.75rem}
[data-vibeui-block="scrollspy-002"] [data-part="title"]{margin:0;font-size:0.9375rem;font-weight:650}
[data-vibeui-block="scrollspy-002"] [data-part="counter"]{font-size:0.75rem;color:var(--vibeui-scrollspy-002-muted);font-variant-numeric:tabular-nums}
/* Оглавление в строку: на телефоне боковой колонки нет, а список нужен. */
[data-vibeui-block="scrollspy-002"] [data-part="toc"]{
display:flex;gap:0.375rem;margin:0;padding:0 0 0.25rem;list-style:none;
overflow-x:auto;overscroll-behavior-x:contain;scrollbar-width:thin;
}
[data-vibeui-block="scrollspy-002"] [data-part="link"]{
display:inline-flex;align-items:center;gap:0.375rem;flex:none;
padding:0.3125rem 0.5rem 0.3125rem 0.3125rem;border-radius:9999px;
border:1px solid var(--vibeui-scrollspy-002-border);
color:var(--vibeui-scrollspy-002-muted);text-decoration:none;
font-size:0.75rem;line-height:1;white-space:nowrap;
transition:color .16s ease,border-color .16s ease;
}
[data-vibeui-block="scrollspy-002"] [data-part="num"]{
display:flex;align-items:center;justify-content:center;
width:1.125rem;height:1.125rem;border-radius:9999px;
background:color-mix(in oklab,var(--vibeui-scrollspy-002-muted) 14%,transparent);
font-size:0.625rem;font-weight:700;font-variant-numeric:tabular-nums;
}
/* Активный пункт — залитый номер: в ряду одинаковых чипов цвета текста мало. */
[data-vibeui-block="scrollspy-002"] [data-part="link"][aria-current="true"]{
color:var(--vibeui-scrollspy-002-fg);border-color:var(--vibeui-scrollspy-002-accent);
font-weight:600;
}
[data-vibeui-block="scrollspy-002"] [data-part="link"][aria-current="true"] [data-part="num"]{
background:var(--vibeui-scrollspy-002-accent);color:oklch(1 0 0);
}
[data-vibeui-block="scrollspy-002"] [data-part="link"]:focus-visible{outline:2px solid var(--vibeui-scrollspy-002-accent);outline-offset:2px}
[data-vibeui-block="scrollspy-002"] [data-part="body"]{
height:12rem;overflow-y:auto;overscroll-behavior:contain;scroll-behavior:smooth;
padding-right:0.375rem;border-top:1px solid var(--vibeui-scrollspy-002-border);
}
[data-vibeui-block="scrollspy-002"] [data-part="body"]:focus-visible{outline:2px solid var(--vibeui-scrollspy-002-accent);outline-offset:2px;border-radius:0.375rem}
[data-vibeui-block="scrollspy-002"] [data-part="section"]{scroll-margin-top:0.75rem;padding-top:0.75rem}
[data-vibeui-block="scrollspy-002"] [data-part="section"] h4{margin:0 0 0.25rem;font-size:0.875rem;font-weight:650}
[data-vibeui-block="scrollspy-002"] [data-part="section"] p{margin:0;font-size:0.8125rem;line-height:1.5;color:var(--vibeui-scrollspy-002-muted)}
/* Запас снизу: без него последний раздел не долистывается до верха и не подсвечивается. */
[data-vibeui-block="scrollspy-002"] [data-part="section"]:last-child{padding-bottom:8rem}
@media (prefers-reduced-motion:reduce){
[data-vibeui-block="scrollspy-002"] [data-part="body"]{scroll-behavior:auto}
[data-vibeui-block="scrollspy-002"] *{animation:none!important;transition:none!important}
}
`

const DEFAULT_SECTIONS: Scrollspy002Section[] = [
  {
    id: "why",
    title: "Зачем",
    text: "Статья объясняет, почему оглавление на длинной странице перестаёт быть украшением: читатель приходит из поиска и попадает в середину текста.",
  },
  {
    id: "how",
    title: "Как устроено",
    text: "Разделы помечены идентификаторами, ссылки — обычные якоря, а подсветку добавляет наблюдатель пересечений поверх уже работающей навигации.",
  },
  {
    id: "mobile",
    title: "На телефоне",
    text: "Оглавление в строку прокручивается пальцем и не отнимает ширину у текста, поэтому его не приходится прятать за кнопкой.",
  },
  {
    id: "limits",
    title: "Границы",
    text: "Для оглавления из пятнадцати пунктов строка перестаёт работать: там нужен вложенный список или боковая колонка.",
  },
]

/**
 * Оглавление статьи в строку: активный пункт помечен залитым номером.
 * Один файл, ноль зависимостей, собственная палитра.
 */
export function Scrollspy002({
  sections = DEFAULT_SECTIONS,
  title = "Содержание",
  accent,
  className,
  style,
  ...props
}: Scrollspy002Props) {
  const body = useRef<HTMLDivElement>(null)
  const [active, setActive] = useState(sections[0]?.id)

  useEffect(() => {
    const root = body.current
    if (!root) return

    const watcher = new IntersectionObserver(
      (entries) => {
        const visible = entries
          .filter((entry) => entry.isIntersecting)
          .sort(
            (a, b) => a.boundingClientRect.top - b.boundingClientRect.top,
          )[0]
        if (visible) setActive(visible.target.id)
      },
      { root, rootMargin: "0px 0px -65% 0px", threshold: 0 },
    )

    root
      .querySelectorAll("[data-part='section']")
      .forEach((section) => watcher.observe(section))
    return () => watcher.disconnect()
  }, [sections])

  const position = sections.findIndex((section) => section.id === active) + 1

  const palette = {
    ...(accent ? { "--vibeui-scrollspy-002-accent": accent } : null),
    ...style,
  } as CSSProperties

  return (
    <>
      <style href="vibeui-scrollspy-002" precedence="medium">
        {STYLES}
      </style>
      <div
        {...props}
        data-vibeui-block="scrollspy-002"
        className={className}
        style={palette}
      >
        <div data-part="head">
          <h3 data-part="title">{title}</h3>
          <span data-part="counter">
            {position} / {sections.length}
          </span>
        </div>
        <nav aria-label={title}>
          <ul data-part="toc">
            {sections.map((section, index) => (
              <li key={section.id}>
                <a
                  data-part="link"
                  href={`#${section.id}`}
                  aria-current={section.id === active}
                >
                  <span data-part="num">{index + 1}</span>
                  {section.title}
                </a>
              </li>
            ))}
          </ul>
        </nav>
        <div
          data-part="body"
          ref={body}
          tabIndex={0}
          role="group"
          aria-label="Текст статьи"
        >
          {sections.map((section) => (
            <section key={section.id} id={section.id} data-part="section">
              <h4>{section.title}</h4>
              <p>{section.text}</p>
            </section>
          ))}
        </div>
      </div>
    </>
  )
}