Diamond Diamond

ui · 6 variants · 1 categories

Scrollspy

Scroll-tied navigation previews for side rails, highlight pills, right-edge dots, mono editorial, badge markers, and sliding indicators.

npx "@rueda.dev/gems-diamond" add scrollspy
§01

Scrollspy

6 variants

Install

npm i @diamond/ui
rail

Install

npm i @diamond/ui
pills

Install

npm i @diamond/ui
dots

02 body

npm i @diamond/ui
mono

FAQ

Common questions and answers.
badge

Install

npm i @diamond/ui
sliding

Usage Guide

How to wire up this component in your app — props, callbacks, customization, and the conventions Diamond shares across the library.

Universal patterns

Every Diamond component shares the same prop conventions, so once you learn one you can predict the others.

  • variant — discriminated union of every visual option. Categories shown above are docs-only metadata; the prop is a flat string union.
  • accent — any CSS color string. Overrides --diamond-accent just for that instance via inline style. Cascades into hover, ring, and selection states.
  • asChild (when present) — renders the underlying primitive via @radix-ui/react-slot, letting you compose with <Link>, motion.button, etc.
  • className — merged with internal Tailwind classes via cn(). Use it to override layout, spacing, or colors.
  • Native HTML attributes (onClick, aria-*, data-*, ref, etc.) flow through to the root element without any whitelist.
  • Diamond is the skin: zero domain state, zero fetch, zero providers. You wire data and reactions in your app code; the components just render and emit events.