Navigation

Reading Progress

Боковое оглавление документации отвечает на два вопроса сразу: подсветка говорит «где я», а вертикальная полоса — сколько текста осталось.

  • scrollspy
  • docs
  • progress
  • sidebar

Превью

1440pxHost theme

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

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

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

Обзор

Документация начинается с короткого объяснения: что делает библиотека и чего она принципиально не делает.

Установка

Компонент копируется в проект одной командой. Ни рантайма, ни конфигурации: файл лежит в вашем репозитории и правится как ваш собственный код.

Тема

Все цвета объявлены локальными переменными компонента. Чтобы перекрасить блок, достаточно передать одну переменную акцента — трогать глобальные стили не нужно.

Раскладка

Ширина считается от контейнера, а не от окна: компонент одинаково ведёт себя в узкой колонке и на полном экране.

Частые вопросы

Здесь собраны ответы на то, что спрашивают до установки: про размер, про совместимость и про поддержку старых браузеров.

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

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

# Установка и размещение «scrollspy-004» (Reading Progress) из VibeUI

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

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

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

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

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

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

<Scrollspy004
  title="Документация"
  sections={[
    { id: "install", title: "Установка", text: "Компонент копируется в проект одной командой" },
    { id: "theming", title: "Тема", text: "Цвета живут в локальных переменных" },
  ]}
/>

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

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

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

## 5. Сохранить как установлено
- локальную палитру --vibeui-scrollspy-004-* и не подменять её токенами вашей темы
- расчёт прогресса от прокрутки: «третий из шести» не равен половине текста
- role="progressbar" с aria-valuenow — полоса без роли скринридеру ничего не сообщает
- процент числом рядом с полосой: одна полоса не даёт точности
- обычные якоря без preventDefault: без JS оглавление обязано остаться рабочим
- aria-current на активной ссылке, а не только заливку фона

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

## 7. Правила
- Процент считается по своей области прокрутки: для всей страницы обработчик придётся повесить на window.
- Сто процентов достигаются только в самом низу — короткий текст сразу покажет 100%.
- Идентификаторы разделов должны быть уникальны на странице.
- Не выносите CSS-переменные в globals.css: компонент обязан оставаться одним файлом.

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

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

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

Компонент самодостаточен: один файл, без зависимостей, палитра в локальных переменных --vibeui-scrollspy-004-*. Клиентский ("use client") — нужны IntersectionObserver и обработчик прокрутки. Активный раздел ищет наблюдатель, а процент прочитанного считается от scrollTop и scrollHeight области чтения и уезжает в CSS переменной --vibeui-scrollspy-004-progress: доля текста и номер раздела — разные величины, потому что разделы разной длины. Полоса помечена role="progressbar" с aria-valuenow, ссылки остаются обычными якорями.

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

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

"use client"

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

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

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

// Идея компонента: боковое оглавление документации, которое отвечает на два
// разных вопроса. «Где я» — подсветка активного пункта наблюдателем
// пересечений. «Сколько осталось» — вертикальная полоса прогресса вдоль
// списка, считается от прокрутки, а не от номера раздела: разделы разной
// длины, и «третий из шести» не равен половине текста.
const STYLES = `
:where([data-vibeui-block="scrollspy-004"]){
--vibeui-scrollspy-004-bg:oklch(1 0 0);
--vibeui-scrollspy-004-fg:oklch(0.23 0.014 265);
--vibeui-scrollspy-004-muted:oklch(0.56 0.014 265);
--vibeui-scrollspy-004-border:oklch(0.91 0.006 265);
--vibeui-scrollspy-004-accent:oklch(0.55 0.19 300);
--vibeui-scrollspy-004-progress:0%;
--vibeui-scrollspy-004-font:ui-sans-serif,system-ui,-apple-system,"Segoe UI",Roboto,"Helvetica Neue",Arial,sans-serif;
}
[data-vibeui-block="scrollspy-004"]{
display:grid;grid-template-columns:10.5rem 1fr;gap:1rem;
width:100%;max-width:32rem;box-sizing:border-box;padding:0.9375rem;
background:var(--vibeui-scrollspy-004-bg);
border:1px solid var(--vibeui-scrollspy-004-border);border-radius:0.875rem;
font-family:var(--vibeui-scrollspy-004-font);color:var(--vibeui-scrollspy-004-fg);
}
[data-vibeui-block="scrollspy-004"] [data-part="side"]{
position:sticky;top:0;align-self:start;
display:flex;flex-direction:column;gap:0.5rem;
}
[data-vibeui-block="scrollspy-004"] [data-part="head"]{
display:flex;align-items:baseline;justify-content:space-between;gap:0.5rem;margin:0;
font-size:0.6875rem;font-weight:700;letter-spacing:0.06em;text-transform:uppercase;
color:var(--vibeui-scrollspy-004-muted);
}
[data-vibeui-block="scrollspy-004"] [data-part="percent"]{
font-size:0.6875rem;font-weight:700;letter-spacing:0;text-transform:none;
color:var(--vibeui-scrollspy-004-accent);font-variant-numeric:tabular-nums;
}
[data-vibeui-block="scrollspy-004"] [data-part="rail"]{display:grid;grid-template-columns:2px 1fr;gap:0.5rem}
/* Полоса прочитанного — фон трека, залитый на процент прокрутки. */
[data-vibeui-block="scrollspy-004"] [data-part="track"]{
position:relative;border-radius:2px;background:var(--vibeui-scrollspy-004-border);
}
[data-vibeui-block="scrollspy-004"] [data-part="fill"]{
position:absolute;inset:0 0 auto 0;height:var(--vibeui-scrollspy-004-progress);
border-radius:2px;background:var(--vibeui-scrollspy-004-accent);
transition:height .12s linear;
}
[data-vibeui-block="scrollspy-004"] ul{margin:0;padding:0;list-style:none;display:flex;flex-direction:column;gap:0.0625rem}
[data-vibeui-block="scrollspy-004"] [data-part="link"]{
display:block;padding:0.25rem 0.375rem;border-radius:0.375rem;
color:var(--vibeui-scrollspy-004-muted);text-decoration:none;font-size:0.8125rem;line-height:1.3;
}
[data-vibeui-block="scrollspy-004"] [data-part="link"]:hover{color:var(--vibeui-scrollspy-004-fg)}
[data-vibeui-block="scrollspy-004"] [data-part="link"][aria-current="true"]{
color:var(--vibeui-scrollspy-004-fg);font-weight:650;
background:color-mix(in oklab,var(--vibeui-scrollspy-004-accent) 10%,transparent);
}
[data-vibeui-block="scrollspy-004"] [data-part="link"]:focus-visible{outline:2px solid var(--vibeui-scrollspy-004-accent);outline-offset:-2px}
[data-vibeui-block="scrollspy-004"] [data-part="body"]{
height:13rem;overflow-y:auto;overscroll-behavior:contain;scroll-behavior:smooth;padding-right:0.375rem;
}
[data-vibeui-block="scrollspy-004"] [data-part="body"]:focus-visible{outline:2px solid var(--vibeui-scrollspy-004-accent);outline-offset:2px;border-radius:0.375rem}
[data-vibeui-block="scrollspy-004"] [data-part="section"]{scroll-margin-top:0.5rem}
[data-vibeui-block="scrollspy-004"] [data-part="section"] h4{margin:0 0 0.25rem;font-size:0.875rem;font-weight:650}
[data-vibeui-block="scrollspy-004"] [data-part="section"] p{margin:0 0 1rem;font-size:0.8125rem;line-height:1.5;color:var(--vibeui-scrollspy-004-muted)}
@media (prefers-reduced-motion:reduce){
[data-vibeui-block="scrollspy-004"] [data-part="body"]{scroll-behavior:auto}
[data-vibeui-block="scrollspy-004"] *{animation:none!important;transition:none!important}
}
`

const DEFAULT_SECTIONS: Scrollspy004Section[] = [
  {
    id: "overview",
    title: "Обзор",
    text: "Документация начинается с короткого объяснения: что делает библиотека и чего она принципиально не делает.",
  },
  {
    id: "install",
    title: "Установка",
    text: "Компонент копируется в проект одной командой. Ни рантайма, ни конфигурации: файл лежит в вашем репозитории и правится как ваш собственный код.",
  },
  {
    id: "theming",
    title: "Тема",
    text: "Все цвета объявлены локальными переменными компонента. Чтобы перекрасить блок, достаточно передать одну переменную акцента — трогать глобальные стили не нужно.",
  },
  {
    id: "layout",
    title: "Раскладка",
    text: "Ширина считается от контейнера, а не от окна: компонент одинаково ведёт себя в узкой колонке и на полном экране.",
  },
  {
    id: "faq",
    title: "Частые вопросы",
    text: "Здесь собраны ответы на то, что спрашивают до установки: про размер, про совместимость и про поддержку старых браузеров.",
  },
]

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

  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 -70% 0px", threshold: 0 },
    )

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

  function onScroll(event: UIEvent<HTMLDivElement>) {
    const node = event.currentTarget
    const scrollable = node.scrollHeight - node.clientHeight
    setProgress(
      scrollable <= 0 ? 100 : Math.round((node.scrollTop / scrollable) * 100),
    )
  }

  const palette = {
    "--vibeui-scrollspy-004-progress": `${progress}%`,
    ...(accent ? { "--vibeui-scrollspy-004-accent": accent } : null),
    ...style,
  } as CSSProperties

  return (
    <>
      <style href="vibeui-scrollspy-004" precedence="medium">
        {STYLES}
      </style>
      <div
        {...props}
        data-vibeui-block="scrollspy-004"
        className={className}
        style={palette}
      >
        <nav data-part="side" aria-label={title}>
          <p data-part="head">
            {title}
            <span data-part="percent">{progress}%</span>
          </p>
          <div data-part="rail">
            <div
              data-part="track"
              role="progressbar"
              aria-label="Прочитано"
              aria-valuenow={progress}
              aria-valuemin={0}
              aria-valuemax={100}
            >
              <span data-part="fill" />
            </div>
            <ul>
              {sections.map((section) => (
                <li key={section.id}>
                  <a
                    data-part="link"
                    href={`#${section.id}`}
                    aria-current={section.id === active}
                  >
                    {section.title}
                  </a>
                </li>
              ))}
            </ul>
          </div>
        </nav>
        <div
          data-part="body"
          ref={body}
          onScroll={onScroll}
          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>
    </>
  )
}