@reelkit/angular-reel-player

@reelkit/angular-reel-player

Instagram Reels / TikTok-style video player for Angular. Opens as a full-screen overlay with vertical swipe navigation. Handles video autoplay, sound continuity on iOS, and multi-media posts. ~15.8 kB gzip.

Installation

npm install @reelkit/angular-reel-player @reelkit/angular

Quick Start

import { Component, signal } from '@angular/core';
import {
  RkReelPlayerOverlayComponent,
  type ContentItem,
} from '@reelkit/angular-reel-player';

@Component({
  standalone: true,
  imports: [RkReelPlayerOverlayComponent],
  template: `
    <button (click)="isOpen.set(true)">Open Player</button>
    <rk-reel-player-overlay
      [isOpen]="isOpen()"
      [content]="content"
      (closed)="isOpen.set(false)"
    />
  `,
})
export class AppComponent {
  isOpen = signal(false);
  content: ContentItem[] = [
    {
      id: '1',
      media: [
        {
          id: 'v1',
          type: 'video',
          src: 'https://example.com/video.mp4',
          poster: 'https://example.com/poster.jpg',
          aspectRatio: 9 / 16,
        },
      ],
      author: { name: 'John Doe', avatar: 'https://example.com/avatar.jpg' },
      likes: 1234,
      description: 'Amazing video!',
    },
  ];
}

Features

• Vertical swipe navigation (touch, mouse, keyboard, wheel)
• Video autoplay with sound toggle
• Multi-media posts with horizontal nested slider
• Instagram-style indicator dots
• Keyboard navigation (Arrow keys, Escape)
• Desktop navigation arrows
• iOS sound continuity via shared <video> element
• Video position memory across slide changes

Template Slots

Customization via @ContentChild template directives:

Directive	Description
rkPlayerSlideOverlay	Custom per-slide overlay (author, likes, etc.)
rkPlayerSlide	Fully custom slide content
rkPlayerControls	Custom player controls (close, sound)
rkPlayerNavigation	Custom prev/next navigation arrows
rkPlayerNestedSlide	Custom nested horizontal slide content
rkPlayerNestedNavigation	Custom arrows for the inner slider

API Reference

rk-reel-player-overlay Inputs

Input	Type	Default	Description
isOpen	boolean	required	Controls overlay visibility
content	ContentItem[]	required	Content items to display
initialIndex	number	0	Starting slide index
loop	boolean	false	Enable infinite loop
useNavKeys	boolean	true	Enable keyboard navigation
enableWheel	boolean	true	Enable mouse wheel navigation
wheelDebounceMs	number	200	Wheel debounce duration (ms)
transitionDuration	number	300	Transition duration (ms)
swipeDistanceFactor	number	0.12	Swipe threshold (0-1)

rk-reel-player-overlay Outputs

Output	Type	Description
closed	void	Emitted when player closes
slideChange	number	Emitted after slide change

Types

interface ContentItem {
  id: string;
  media: MediaItem[];
  author: {
    name: string;
    avatar: string;
  };
  likes: number;
  description: string;
}

interface MediaItem {
  id: string;
  type: 'image' | 'video';
  src: string;
  poster?: string;
  aspectRatio: number;
}

Keyboard Shortcuts

Key	Action
ArrowUp	Previous slide
ArrowDown	Next slide
ArrowLeft	Previous media (nested)
ArrowRight	Next media (nested)
Escape	Close player

CSS Classes

Class	Description
.rk-reel-overlay	Overlay background
.rk-reel-container	Player container
.rk-reel-slide-wrapper	Slide wrapper
.rk-player-nav-arrows	Desktop nav arrows container
.rk-player-nav-btn	Individual nav arrow button
.rk-player-close-btn	Close button
.rk-player-sound-btn	Sound toggle
.rk-reel-slide-overlay	Per-slide overlay (author, likes)
.rk-reel-slide-overlay-author	Author row
.rk-reel-slide-overlay-avatar	Author avatar
.rk-reel-slide-overlay-name	Author name
.rk-reel-slide-overlay-description	Slide description
.rk-reel-slide-overlay-likes	Like count
.rk-nested-slider-inner	Nested horizontal slider
.rk-nested-nav	Nested nav arrows
.rk-nested-indicator	Nested slider dot indicator
.rk-video-slide-container	Video slide wrapper
.rk-video-slide-element	Video element
.rk-video-slide-poster	Video poster image
.rk-video-slide-loader	Video loading indicator

Documentation

Docs and interactive demos at reelkit.dev/docs/angular-reel-player.

Support

If ReelKit saved you some time, a star on GitHub would mean a lot — it's a small thing, but it really helps the project get noticed.

License

MIT