Navigation

Scrollspy Contents

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

  • scrollspy
  • toc
  • reading
  • observer

Превью

1440pxHost theme

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

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

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

Установка

Компонент ставится одной командой: файл копируется в проект, зависимостей нет.

Пропсы

Каждый проп имеет разумное значение по умолчанию, поэтому компонент рендерится и без единого атрибута.

Тема

Цвета живут в локальных переменных с префиксом компонента и не конфликтуют с темой проекта-хозяина.

Доступность

Разметка семантическая, фокус виден, состояние передаётся не только цветом.

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

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

# Установка и размещение «scrollspy-001» (Scrollspy Contents) из VibeUI

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

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

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

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

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

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

<Scrollspy001 sections={[{ id: "install", title: "Установка", text: "…" }]} />

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

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

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

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

## 6. Можно менять
- массив sections и их тексты
- title — заголовок оглавления
- высоту области текста
- акцент через проп accent

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

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

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

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

Компонент самодостаточен: один файл, без зависимостей, собственная палитра в локальных переменных --vibeui-scrollspy-001-*. Клиентский: "use client" ради IntersectionObserver. Наблюдатель ограничен областью текста через root, а rootMargin отрезает нижние 60%, иначе активным становится раздел, который только показался снизу. У последнего раздела есть запас снизу — без него он не долистывается.

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

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

"use client"

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

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

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

// Идея компонента: оглавление, которое подсвечивает раздел, видимый сейчас.
// Слежение — IntersectionObserver, а не обработчик scroll: браузер сам решает,
// когда пересчитывать, и страница не дёргается при быстрой прокрутке. Полоса
// сверху обрезана rootMargin, иначе активным становится раздел, ушедший вверх.
const STYLES = `
:where([data-vibeui-block="scrollspy-001"]){
--vibeui-scrollspy-001-bg:oklch(1 0 0);
--vibeui-scrollspy-001-fg:oklch(0.24 0.014 265);
--vibeui-scrollspy-001-muted:oklch(0.56 0.014 265);
--vibeui-scrollspy-001-border:oklch(0.91 0.006 265);
--vibeui-scrollspy-001-accent:oklch(0.55 0.2 262);
--vibeui-scrollspy-001-font:ui-sans-serif,system-ui,-apple-system,"Segoe UI",Roboto,"Helvetica Neue",Arial,sans-serif;
}
[data-vibeui-block="scrollspy-001"]{
display:grid;grid-template-columns:9rem 1fr;gap:1rem;
width:100%;max-width:30rem;box-sizing:border-box;padding:0.875rem;
background:var(--vibeui-scrollspy-001-bg);
border:1px solid var(--vibeui-scrollspy-001-border);border-radius:0.875rem;
font-family:var(--vibeui-scrollspy-001-font);color:var(--vibeui-scrollspy-001-fg);
}
[data-vibeui-block="scrollspy-001"] [data-part="toc"]{
position:sticky;top:0;align-self:start;
display:flex;flex-direction:column;gap:0.125rem;
border-left:2px solid var(--vibeui-scrollspy-001-border);
}
[data-vibeui-block="scrollspy-001"] [data-part="head"]{
margin:0 0 0.375rem 0.625rem;font-size:0.6875rem;letter-spacing:0.04em;
text-transform:uppercase;color:var(--vibeui-scrollspy-001-muted);
}
/* Активный пункт помечен полосой у края, а не только цветом текста. */
[data-vibeui-block="scrollspy-001"] [data-part="link"]{
position:relative;padding:0.25rem 0.5rem 0.25rem 0.625rem;
color:var(--vibeui-scrollspy-001-muted);text-decoration:none;
font-size:0.8125rem;line-height:1.3;
}
[data-vibeui-block="scrollspy-001"] [data-part="link"][aria-current="true"]{color:var(--vibeui-scrollspy-001-fg);font-weight:650}
[data-vibeui-block="scrollspy-001"] [data-part="link"][aria-current="true"]::before{
content:"";position:absolute;left:-2px;top:0.25rem;bottom:0.25rem;
width:2px;background:var(--vibeui-scrollspy-001-accent);
}
[data-vibeui-block="scrollspy-001"] [data-part="link"]:focus-visible{outline:2px solid var(--vibeui-scrollspy-001-accent);outline-offset:-2px;border-radius:0.25rem}
[data-vibeui-block="scrollspy-001"] [data-part="body"]{
height:13rem;overflow-y:auto;overscroll-behavior:contain;
scroll-behavior:smooth;padding-right:0.375rem;
}
[data-vibeui-block="scrollspy-001"] [data-part="section"]{scroll-margin-top:0.5rem}
[data-vibeui-block="scrollspy-001"] [data-part="section"] h3{margin:0 0 0.25rem;font-size:0.875rem;font-weight:650}
[data-vibeui-block="scrollspy-001"] [data-part="section"] p{margin:0 0 1.25rem;font-size:0.8125rem;line-height:1.5;color:var(--vibeui-scrollspy-001-muted)}
/* Запас снизу: без него последний раздел не долистывается и не подсвечивается. */
[data-vibeui-block="scrollspy-001"] [data-part="section"]:last-child p{margin-bottom:9rem}
@media (prefers-reduced-motion:reduce){
[data-vibeui-block="scrollspy-001"] [data-part="body"]{scroll-behavior:auto}
[data-vibeui-block="scrollspy-001"] *{animation:none!important;transition:none!important}
}
`

const DEFAULT_SECTIONS: Scrollspy001Section[] = [
  {
    id: "install",
    title: "Установка",
    text: "Компонент ставится одной командой: файл копируется в проект, зависимостей нет.",
  },
  {
    id: "props",
    title: "Пропсы",
    text: "Каждый проп имеет разумное значение по умолчанию, поэтому компонент рендерится и без единого атрибута.",
  },
  {
    id: "theme",
    title: "Тема",
    text: "Цвета живут в локальных переменных с префиксом компонента и не конфликтуют с темой проекта-хозяина.",
  },
  {
    id: "a11y",
    title: "Доступность",
    text: "Разметка семантическая, фокус виден, состояние передаётся не только цветом.",
  },
]

/**
 * Оглавление с подсветкой видимого раздела: IntersectionObserver вместо scroll.
 * Один файл, ноль зависимостей, собственная палитра.
 */
export function Scrollspy001({
  sections = DEFAULT_SECTIONS,
  title = "На странице",
  accent,
  className,
  style,
  ...props
}: Scrollspy001Props) {
  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 -60% 0px", threshold: 0 },
    )

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

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

  return (
    <>
      <style href="vibeui-scrollspy-001" precedence="medium">
        {STYLES}
      </style>
      <div
        {...props}
        data-vibeui-block="scrollspy-001"
        className={className}
        style={palette}
      >
        <nav data-part="toc" aria-label={title}>
          <p data-part="head">{title}</p>
          {sections.map((section) => (
            <a
              key={section.id}
              data-part="link"
              href={`#${section.id}`}
              aria-current={section.id === active}
              onClick={(event) => {
                event.preventDefault()
                body.current
                  ?.querySelector(`#${section.id}`)
                  ?.scrollIntoView({ block: "start" })
              }}
            >
              {section.title}
            </a>
          ))}
        </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">
              <h3>{section.title}</h3>
              <p>{section.text}</p>
            </section>
          ))}
        </div>
      </div>
    </>
  )
}