reelkitReelKit

Instalação

Instale os pacotes do reelkit e configure seu projeto.

Escolha do pacote

Instale somente o que você usa:

PacoteDescriçãoQuando usar
@reelkit/coreCore independente de frameworkIntegrações personalizadas
@reelkit/stories-coreEngine de stories independente de frameworkIntegrações personalizadas de stories
@reelkit/reactComponentes ReactAplicações React 18+
@reelkit/react-reel-playerPlayer vertical em tela cheiaPlayer no estilo Instagram/TikTok
@reelkit/react-lightboxGaleria de imagens em lightboxVisualização de imagens em tela cheia
@reelkit/react-stories-playerPlayer de stories no estilo InstagramStories com avanço automático e gestos
@reelkit/angularComponentes standalone do AngularAplicações Angular 19+
@reelkit/angular-reel-playerPlayer vertical em tela cheiaPlayer no estilo Instagram/TikTok
@reelkit/angular-lightboxGaleria de imagens em lightboxVisualização de imagens em tela cheia
@reelkit/angular-stories-playerPlayer de stories no estilo InstagramStories com avanço automático e gestos
@reelkit/vueComponentes e composables do Vue 3Aplicações Vue 3
@reelkit/vue-reel-playerPlayer vertical em tela cheiaPlayer no estilo Instagram/TikTok
@reelkit/vue-lightboxGaleria de imagens em lightboxVisualização de imagens em tela cheia
@reelkit/vue-stories-playerPlayer de stories no estilo InstagramStories com avanço automático e gestos

Tamanho dos pacotes

Todos os pacotes são otimizados para pesar o mínimo possível no bundle:

PacoteJSJS (gzip)CSSCSS (gzip)
@reelkit/core29.8 kB11.2 kB--
@reelkit/react13.8 kB4.9 kB--
@reelkit/react-reel-player17.1 kB5.4 kB9.7 kB2.1 kB
@reelkit/react-lightbox12.7 kB4.1 kB7.9 kB1.6 kB
@reelkit/react-stories-player25.3 kB7.5 kB9.9 kB2.1 kB
@reelkit/angular70.2 kB15.8 kB--
@reelkit/angular-reel-player148.1 kB24.4 kB15.0 kB3.5 kB
@reelkit/angular-lightbox113.6 kB19.1 kB10.2 kB2.2 kB
@reelkit/vue15.3 kB5.2 kB--
@reelkit/vue-reel-player21.0 kB6.2 kB9.7 kB2.1 kB
@reelkit/vue-lightbox18.2 kB4.9 kB7.0 kB1.4 kB
@reelkit/vue-stories-player25.4 kB7.9 kB9.9 kB2.1 kB

Comparação com outras bibliotecas

O ReelKit mantém 3 slides no DOM a qualquer momento e dá conta de mais de 10.000 itens. Outras bibliotecas de carrossel renderizam todos os slides, o que trava em listas grandes.

BibliotecaJS (gzip)VirtualizaçãoObservações
ReelKit (core + react)16.1 kBSem dependências
ReelKit (core + angular)27.0 kBSem dependências
ReelKit (core + vue)16.4 kBSem dependências
Swiper~25 kBPluginBundle completo; permite tree-shaking
Embla Carousel~7 kB✗Leve, baseada em plugins
keen-slider~6 kB✗Sem dependências

npm

bash
npm install @reelkit/react

yarn

bash
yarn add @reelkit/react

pnpm

bash
pnpm add @reelkit/react

npm

bash
npm install @reelkit/angular

yarn

bash
yarn add @reelkit/angular

pnpm

bash
pnpm add @reelkit/angular

npm

bash
npm install @reelkit/vue

yarn

bash
yarn add @reelkit/vue

pnpm

bash
pnpm add @reelkit/vue

Peer dependencies

Os pacotes de framework declaram peer dependencies que provavelmente já estão no seu projeto:

@reelkit/react

  • react >= 18.0.0
  • react-dom >= 18.0.0

@reelkit/react-reel-player

  • @reelkit/react
  • react >= 18.0.0
  • react-dom >= 18.0.0
  • lucide-react >= 0.400.0

@reelkit/react-lightbox

  • @reelkit/react
  • react >= 18.0.0
  • react-dom >= 18.0.0
  • lucide-react >= 0.400.0

@reelkit/react-stories-player

  • @reelkit/react
  • react >= 18.0.0
  • react-dom >= 18.0.0
  • lucide-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.0
  • lucide-angular >= 0.460.0

@reelkit/angular-lightbox

  • @reelkit/angular
  • @angular/core >= 19.0.0
  • @angular/common >= 19.0.0
  • lucide-angular >= 0.460.0

@reelkit/angular-stories-player

  • @reelkit/angular
  • @angular/core >= 19.0.0
  • @angular/common >= 19.0.0
  • lucide-angular >= 0.460.0

@reelkit/vue

  • vue >= 3.0.0

@reelkit/vue-reel-player

  • @reelkit/vue
  • vue >= 3.3.0
  • lucide-vue-next >= 0.400.0

@reelkit/vue-lightbox

  • @reelkit/vue
  • vue >= 3.0.0
  • lucide-vue-next >= 0.400.0

@reelkit/vue-stories-player

  • @reelkit/vue
  • vue >= 3.3.0
  • lucide-vue-next >= 0.400.0

lucide-react só é necessário para os ícones padrão. Se você fornecer seus próprios controles e navegação por renderControls e renderNavigation (renderHeader e renderNavigation no player de stories), pode dispensar a instalação.

lucide-angular só é necessário para os ícones padrão. Se você fornecer seus próprios controles e navegação pelos slots de template (rkPlayerControls e rkPlayerNavigation, rkLightboxControls e rkLightboxNavigation, rkStoriesHeader e rkStoriesNavigation), pode dispensar a instalação.

lucide-vue-next só é necessário para os ícones padrão. Se você fornecer seus próprios controles e navegação pelos scoped slots #controls e #navigation (#header e #navigation no player de stories), pode dispensar a instalação.

TypeScript

Todos os pacotes já vêm com definições de tipo TypeScript. Nenhum pacote @types adicional é necessário.

Suporte dos navegadores

O reelkit funciona em todos os navegadores modernos:

  • Chrome/Edge 88+
  • Firefox 78+
  • Safari 14+
  • iOS Safari 14+
  • Android Chrome 88+

Próximos passos