# Reelkit

> Headless, virtualized, TikTok-style vertical slider component library for React, Vue, and Angular. Zero dependencies in core; renders only 3 slides to the DOM at any time via virtualization.

This file indexes the Reelkit documentation so LLM agents can consume it without scraping the React-rendered site. Each link points at the public docs URL; fetch `llms-full.txt` for the same index with embedded per-page summaries.

## Getting started

- [Getting Started](https://reelkit.dev/docs/getting-started): reelkit is a single-item slider — one item visible at a time, like TikTok, Instagram Reels, or Stories. Perfect for vertical video feeds, fullscreen galleries, and swipeable content.
- [Installation](https://reelkit.dev/docs/installation): Install reelkit packages and configure your project. Independent versioning per package; install only what you need.
- [Server-Side Rendering](https://reelkit.dev/docs/ssr): All reelkit packages work on the server. Import and render with Next.js, Remix, Angular Universal, Nuxt 3, or any SSR setup.

## Core

- [Core Guide](https://reelkit.dev/docs/core/guide): The @reelkit/core package provides framework-agnostic slider logic. Use it to build custom integrations or understand the underlying architecture.
- [Core API Reference](https://reelkit.dev/docs/core/api): Complete reference for @reelkit/core configuration, callbacks, methods, state, signals, transitions, content loading, sound, timeline, fullscreen, DOM utilities, focus management, and video utilities.
- [Stories Core](https://reelkit.dev/docs/stories-core): Engine behind @reelkit/react-stories-player. Pure TypeScript, no framework deps. Use to build stories players for Angular, Vue, or vanilla JS.

## React

- [React Guide](https://reelkit.dev/docs/react/guide): Build sliders with @reelkit/react. Reel component, itemBuilder pattern, navigation, ReelIndicator, virtualization with 10000+ items, and performance tips.
- [React API Reference](https://reelkit.dev/docs/react/api): Complete reference for @reelkit/react components, props, methods, callbacks, ReelIndicator, Observe, AnimatedObserve, hooks, accessibility, and utilities.
- [Reel Player](https://reelkit.dev/docs/reel-player): Full-screen TikTok/Reels-style video reel player overlay for React. ContentItem schema, props, callbacks, slot renderers, keyboard shortcuts, theming tokens, and CSS classes.
- [Lightbox](https://reelkit.dev/docs/lightbox): Full-screen image gallery lightbox overlay for React. LightboxItem schema, props, tree-shakable transitions (slideTransition, lightboxFadeTransition, flipTransition, lightboxZoomTransition), keyboard shortcuts, theming tokens, CSS classes, slot renderers.
- [Stories Player](https://reelkit.dev/docs/stories-player): Instagram-style stories player overlay for React. StoriesGroup schema, two-level navigation (groups + stories), auto-advance timer, canvas progress bar, tap zones, slot renderers, theming.

## Vue

- [Vue Guide](https://reelkit.dev/docs/vue/guide): Build sliders with @reelkit/vue. Reel component, #item slot, ReelIndicator, imperative API via template ref, transitions, virtualization, and event handlers.
- [Vue API Reference](https://reelkit.dev/docs/vue/api): Complete reference for @reelkit/vue components, props, emits, exposed methods, ReelIndicator, useSwipeToClose, and provide/inject context shape.
- [Vue Reel Player](https://reelkit.dev/docs/vue-reel-player): Full-screen TikTok/Reels-style video reel player overlay for Vue 3. ContentItem schema, props, emits, scoped slots, theming tokens, CSS classes shared with React reel-player.
- [Vue Lightbox](https://reelkit.dev/docs/vue-lightbox): Full-screen image gallery lightbox overlay for Vue 3. LightboxItem schema, props, emits, scoped slots, tree-shakable transitionFn, swipe-to-close, theming shared with React lightbox.
- [Vue Stories Player](https://reelkit.dev/docs/vue-stories-player): Vue 3 stories player overlay (in development). React version available now; Vue version will share @reelkit/stories-core engine for two-level navigation, RAF timer, and canvas progress.

## Angular

- [Angular Guide](https://reelkit.dev/docs/angular/guide): Build sliders with @reelkit/angular. rk-reel component, rkReelItem directive, ReelIndicator, apiReady output, signal-based imperative API, virtualization.
- [Angular API Reference](https://reelkit.dev/docs/angular/api): Complete reference for @reelkit/angular components, inputs, outputs, exposed API methods, ReelIndicator, RK_REEL_CONTEXT injection token, and signal bridges.
- [Angular Reel Player](https://reelkit.dev/docs/angular-reel-player): Full-screen TikTok/Reels-style video reel player overlay for Angular. ContentItem schema, inputs, outputs, template slot directives, theming shared with React reel-player.
- [Angular Lightbox](https://reelkit.dev/docs/angular-lightbox): Full-screen image gallery lightbox overlay for Angular. LightboxItem schema, inputs, outputs, template slot directives, tree-shakable transitionFn, swipe-to-close, theming shared with React lightbox.
- [Angular Stories Player](https://reelkit.dev/docs/angular-stories-player): Angular stories player overlay (in development). React version available now; Angular version will share @reelkit/stories-core engine for two-level navigation, RAF timer, and canvas progress.

## Meta

- [Troubleshooting](https://reelkit.dev/docs/troubleshooting): Fixes for iOS Safari quirks, video playback, fullscreen, keyboard navigation, and auto-sizing issues.
- [Changelog](https://reelkit.dev/docs/changelog): Release history for all @reelkit/* packages. See repo CHANGELOG.md for full version log; this page renders that content at runtime.