Installation
Installiere die Pakete von reelkit und richte dein Projekt ein.
Paketauswahl
Installiere nur, was du auch nutzt:
| Paket | Beschreibung | Einsatzzweck |
|---|---|---|
@reelkit/core | Core, unabhängig vom Framework | Eigene Integrationen |
@reelkit/stories-core | Engine für Stories, unabhängig vom Framework | Eigene Integrationen für Stories |
@reelkit/react | React-Komponenten | Apps mit React 18+ |
@reelkit/react-reel-player | Vertikaler Reel Player im Vollbild | Player im Stil von Instagram/TikTok |
@reelkit/react-lightbox | Lightbox für Bildergalerien | Bildvorschau im Vollbild |
@reelkit/react-stories-player | Stories Player im Stil von Instagram | Stories mit automatischem Weiterschalten und Gesten |
@reelkit/angular | Standalone-Komponenten für Angular | Apps mit Angular 19+ |
@reelkit/angular-reel-player | Vertikaler Reel Player im Vollbild | Player im Stil von Instagram/TikTok |
@reelkit/angular-lightbox | Lightbox für Bildergalerien | Bildvorschau im Vollbild |
@reelkit/angular-stories-player | Stories Player im Stil von Instagram | Stories mit automatischem Weiterschalten und Gesten |
@reelkit/vue | Komponenten und Composables für Vue 3 | Apps mit Vue 3 |
@reelkit/vue-reel-player | Vertikaler Reel Player im Vollbild | Player im Stil von Instagram/TikTok |
@reelkit/vue-lightbox | Lightbox für Bildergalerien | Bildvorschau im Vollbild |
@reelkit/vue-stories-player | Stories Player im Stil von Instagram | Stories mit automatischem Weiterschalten und Gesten |
Bundle-Größen
Alle Pakete sind darauf ausgelegt, das Bundle so wenig wie möglich zu vergrößern:
| Paket | JS | JS (gzip) | CSS | CSS (gzip) |
|---|---|---|---|---|
@reelkit/core | 29.8 kB | 11.2 kB | - | - |
@reelkit/react | 13.8 kB | 4.9 kB | - | - |
@reelkit/react-reel-player | 17.1 kB | 5.4 kB | 9.7 kB | 2.1 kB |
@reelkit/react-lightbox | 12.7 kB | 4.1 kB | 7.9 kB | 1.6 kB |
@reelkit/react-stories-player | 25.3 kB | 7.5 kB | 9.9 kB | 2.1 kB |
@reelkit/angular | 70.2 kB | 15.8 kB | - | - |
@reelkit/angular-reel-player | 148.1 kB | 24.4 kB | 15.0 kB | 3.5 kB |
@reelkit/angular-lightbox | 113.6 kB | 19.1 kB | 10.2 kB | 2.2 kB |
@reelkit/vue | 15.3 kB | 5.2 kB | - | - |
@reelkit/vue-reel-player | 21.0 kB | 6.2 kB | 9.7 kB | 2.1 kB |
@reelkit/vue-lightbox | 18.2 kB | 4.9 kB | 7.0 kB | 1.4 kB |
@reelkit/vue-stories-player | 25.4 kB | 7.9 kB | 9.9 kB | 2.1 kB |
Vergleich mit anderen Bibliotheken
ReelKit rendert zu jedem Zeitpunkt 3 Slides ins DOM und kommt mit mehr als 10.000 Elementen zurecht. Andere Karussell-Bibliotheken rendern alle Slides und geraten bei großen Listen ins Stocken.
| Bibliothek | JS (gzip) | Virtualisierung | Hinweise |
|---|---|---|---|
| ReelKit (core + react) | 16.1 kB | Keine Abhängigkeiten | |
| ReelKit (core + angular) | 27.0 kB | Keine Abhängigkeiten | |
| ReelKit (core + vue) | 16.4 kB | Keine Abhängigkeiten | |
| Swiper | ~25 kB | Plugin | Vollständiges Bundle; Tree-Shaking möglich |
| Embla Carousel | ~7 kB | ✗ | Leichtgewichtig, auf Plugins aufgebaut |
| keen-slider | ~6 kB | ✗ | Keine Abhängigkeiten |
npm
npm install @reelkit/angularyarn
yarn add @reelkit/angularpnpm
pnpm add @reelkit/angularPeer-Abhängigkeiten
Die Framework-Pakete haben Peer-Abhängigkeiten, die in deinem Projekt schon vorhanden sein sollten:
@reelkit/react
react>= 18.0.0react-dom>= 18.0.0
@reelkit/react-reel-player
@reelkit/reactreact>= 18.0.0react-dom>= 18.0.0lucide-react>= 0.400.0
@reelkit/react-lightbox
@reelkit/reactreact>= 18.0.0react-dom>= 18.0.0lucide-react>= 0.400.0
@reelkit/react-stories-player
@reelkit/reactreact>= 18.0.0react-dom>= 18.0.0lucide-react>= 0.400.0
@reelkit/angular
@angular/core>= 19.0.0@angular/common>= 19.0.0
@reelkit/angular-reel-player
@reelkit/angular@angular/core>= 19.0.0@angular/common>= 19.0.0lucide-angular>= 0.460.0
@reelkit/angular-lightbox
@reelkit/angular@angular/core>= 19.0.0@angular/common>= 19.0.0lucide-angular>= 0.460.0
@reelkit/angular-stories-player
@reelkit/angular@angular/core>= 19.0.0@angular/common>= 19.0.0lucide-angular>= 0.460.0
@reelkit/vue
vue>= 3.0.0
@reelkit/vue-reel-player
@reelkit/vuevue>= 3.3.0lucide-vue-next>= 0.400.0
@reelkit/vue-lightbox
@reelkit/vuevue>= 3.0.0lucide-vue-next>= 0.400.0
@reelkit/vue-stories-player
@reelkit/vuevue>= 3.3.0lucide-vue-next>= 0.400.0
lucide-react brauchst du nur für die Standard-Icons. Wenn du über renderControls und renderNavigation eigene Bedienelemente und eine eigene Navigation mitbringst (beim Stories Player über renderHeader und renderNavigation), kannst du die Installation weglassen.
lucide-angular brauchst du nur für die Standard-Icons. Wenn du über die Template-Slots eigene Bedienelemente und eine eigene Navigation mitbringst (rkPlayerControls und rkPlayerNavigation, rkLightboxControls und rkLightboxNavigation, rkStoriesHeader und rkStoriesNavigation), kannst du die Installation weglassen.
lucide-vue-next brauchst du nur für die Standard-Icons. Wenn du über die Scoped Slots #controls und #navigation eigene Bedienelemente und eine eigene Navigation mitbringst (beim Stories Player über #header und #navigation), kannst du die Installation weglassen.
TypeScript
Alle Pakete liefern ihre TypeScript-Typdefinitionen mit. Zusätzliche @types-Pakete brauchst du nicht.
Browser-Unterstützung
reelkit unterstützt alle modernen Browser:
- Chrome/Edge 88+
- Firefox 78+
- Safari 14+
- iOS Safari 14+
- Android Chrome 88+
Nächste Schritte
- Core-Leitfaden - die Engine, unabhängig vom Framework
- Framework-Leitfaden - Komponenten, Demos und IntegrationFramework-Leitfaden - Komponenten, Demos und IntegrationFramework-Leitfaden - Komponenten, Demos und Integration
- Reel Player - Videoplayer im Stil von TikTok/ReelsReel Player - Videoplayer im Stil von TikTok/ReelsReel Player - Videoplayer im Stil von TikTok/Reels
- Lightbox - Galerie für Bilder und VideosLightbox - Galerie für Bilder und VideosLightbox - Galerie für Bilder und Videos
- Stories Player - Stories-Ansicht im Stil von InstagramStories Player - Stories-Ansicht im Stil von InstagramStories Player - Stories-Ansicht im Stil von Instagram