Angular API 参考

完整参考: @reelkit/angular 的组件、指令、服务与工具。

ReelComponent

选择器: rk-reel

输入

输入类型默认值说明
countnumber必填幻灯片总数
direction'vertical' | 'horizontal''vertical'滚动方向
size[number, number] | undefinedundefined以 [宽, 高] 表示的尺寸。省略时通过 ResizeObserver 自动测量
initialIndexnumber0起始幻灯片索引
loopbooleanfalse启用无限循环
transitionTransitionTransformFnslideTransition过渡效果函数。内置有 slideTransition、fadeTransition、flipTransition、cubeTransition、zoomTransition
transitionDurationnumber300动画时长(毫秒)
swipeDistanceFactornumber0.12滑动阈值(0-1)
enableGesturesbooleantrue启用触摸 / 鼠标拖拽导航
enableNavKeysbooleantrue启用键盘方向键导航
enableWheelbooleanfalse启用鼠标滚轮导航
wheelDebounceMsnumber200滚轮事件防抖时长(毫秒)
rangeExtractor(index: number, count: number) => number[]defaultRangeExtractor自定义函数,决定渲染哪些索引
keyExtractor(index: number, indexInRange: number) => string | numberindex => index@for track 表达式的自定义 key 函数(配合 loop 时很有用)
classNamestring''施加在根容器元素上的 CSS 类名
ariaLabelstring'Carousel'轮播区域的无障碍标签

输出

输出类型说明
afterChangeEventEmitter<{ index: number; indexInRange: number }>幻灯片过渡完成后发出
beforeChangeEventEmitter<{ index: number; nextIndex: number; indexInRange: number }>幻灯片过渡开始前发出
slideDragStartEventEmitter<number>拖拽手势开始时发出
slideDragEndEventEmitter<number>拖拽手势结束(松手)时发出
slideDragCanceledEventEmitter<number>拖拽手势被取消(回弹)时发出
apiReadyEventEmitter<ReelApi>视图初始化后发出一次,暴露命令式 API

ReelApi 接口

通过 (apiReady) 输出获取:

typescript
import { type ReelApi } from '@reelkit/angular';

@Component({ ... })
export class AppComponent {
  api: ReelApi | undefined;

  // In template: (apiReady)="api = $event"

  prev()  { this.api?.prev(); }
  next()  { this.api?.next(); }
  jump(i: number) { this.api?.goTo(i, true); }  // animated
}
方法类型说明
next()() => void切到下一张幻灯片
prev()() => void切到上一张幻灯片
goTo(index, animate?)(number, boolean?) => Promise<void>跳到指定的幻灯片索引
adjust()() => void重新计算幻灯片位置(布局变化后很有用)
observe()() => void开始监听键盘事件
unobserve()() => void停止监听键盘事件

RkReelItemDirective

选择器: [rkReelItem] —— 用在 ng-template 内部的 rk-reel.

模板上下文

html
<ng-template rkReelItem let-i let-indexInRange="indexInRange" let-size="size">
  <!-- $implicit (let-i)  : number         — absolute slide index -->
  <!-- indexInRange        : number         — position in the visible window (0, 1, or 2) -->
  <!-- size                : [number,number] — [width, height] of the container -->
</ng-template>
变量类型说明
$implicit (let-i)number绝对幻灯片索引(0 到 count-1)
indexInRangenumber在可见窗口中的位置(0、1 或 2)
size[number, number]滑动器当前尺寸,形如 [宽, 高](像素)

ReelIndicatorComponent

选择器: rk-reel-indicator

输入

输入类型默认值说明
countnumber | undefinedauto条目总数。嵌套在 rk-reel 内部时会自动从父级上下文连接;单独使用时请显式传入
activenumber | undefinedauto当前活动索引。嵌套在 rk-reel 内部时会自动从父级上下文连接;单独使用时请显式传入
direction'vertical' | 'horizontal''vertical'指示器方向
radiusnumber3圆点半径(像素)
visiblenumber5同时可见的正常尺寸圆点上限
gapnumber4圆点之间的间距(像素)
activeColorstring'#fff'活动圆点颜色
inactiveColorstring'rgba(255,255,255,0.5)'非活动圆点颜色
edgeScalenumber0.5边缘溢出圆点的缩放系数
classNamestring''施加在指示器容器上的自定义 CSS 类名
tablistLabelstring'Slide navigation'tablist 地标的无障碍标签

输出

输出类型说明
dotClickEventEmitter<number>点击圆点时发出,带上圆点索引

RK_REEL_CONTEXT

An InjectionToken<ReelContextValue> 由 rk-reel 提供给后代组件。内部被 rk-reel-indicator 用于自动连接。在需要滑动器上下文的自定义组件里注入它。

typescript
import { inject } from '@angular/core';
import { RK_REEL_CONTEXT } from '@reelkit/angular';

@Component({ ... })
export class MyCustomControl {
  private readonly ctx = inject(RK_REEL_CONTEXT, { optional: true });

  jump(index: number) {
    this.ctx?.goTo(index, true);
  }
}
属性类型说明
indexSignal<number>响应式的当前幻灯片索引
countSignal<number>响应式的条目总数
goTo(index: number, animate?: boolean) => Promise<void>以编程方式跳到某张幻灯片

BodyLockService

带引用计数的 body 滚动锁。多个并发调用方(例如Lightbox和弹窗同时打开)可以各自独立调用 lock/unlock —— 只有最后一个调用方释放后 body 才恢复。在 root 级提供 —— 任意位置都能注入。

typescript
import { inject } from '@angular/core';
import { BodyLockService } from '@reelkit/angular';

@Component({ ... })
export class OverlayComponent {
  private readonly bodyLock = inject(BodyLockService);

  open() { this.bodyLock.lock(); }
  close() { this.bodyLock.unlock(); }
}
成员类型说明
lockedboolean(getter)body 当前是否被锁住
lock()() => void锁住 body 滚动并补偿滚动条宽度
unlock()() => void恢复 body 原本的滚动样式

SoundStateService

覆盖层播放媒体时的静音与禁用状态,以 Angular signal 暴露。请在拥有媒体的组件上提供它,而不是在 root 级 —— 这样每个覆盖层实例各自保有状态。reelkit 的每个 Angular 覆盖层都用它 —— @reelkit/angular-reel-player 重新导出同一个类,因此原有的导入照常可用。

lightbox 是例外:请把服务提供在 <rk-lightbox-overlay> 之上,因为它的视频幻灯片由你自己的模板渲染,否则永远看不到覆盖层内部的实例。

typescript
import { inject } from '@angular/core';
import { SoundStateService } from '@reelkit/angular';

@Component({
  // Provide it on the component that owns the media, so two overlays
  // on one page never share a muted state.
  providers: [SoundStateService],
  // ...
})
export class OverlayComponent {
  readonly soundState = inject(SoundStateService);

  // Use in template:
  // [muted]="soundState.muted()"
  // [hidden]="soundState.disabled()"
  // (click)="soundState.toggle()"
}
成员类型说明
muted()Signal<boolean>当前是否静音。初始为静音
disabled()Signal<boolean>声音当前不可控制时为 true,声音按钮随之隐藏。该值由覆盖层设置 —— RkReelPlayerOverlayComponent 在幻灯片没有视频或正在切换时把它置为 true
controllerSoundController(getter)底层的 core SoundController —— 交给 syncMutedToVideo,让 <video> 跟随静音状态
toggle()() => void切换静音状态
setDisabled()(value: boolean) => void设置当前声音是否可控
reset()() => void回到初始状态:静音、未禁用

Signal 桥接工具

把核心信号系统(@reelkit/core)桥接到 Angular 原生信号 API 的工具函数。内部被 ReelComponent使用,也可用于自定义框架集成。

函数签名说明
toAngularSignal(source: Subscribable<T>, destroyRef: DestroyRef) => Signal<T>把核心的 Subscribable 桥接成只读的 Angular Signal
animatedSignalBridge(source: AnimatedValue, zone: NgZone, cdRef: ChangeDetectorRef, destroyRef: DestroyRef) => Signal<number>把核心的动画值桥接成 Angular Signal,在 zone 之外通过 requestAnimationFrame 更新
typescript
import { DestroyRef, inject } from '@angular/core';
import { toAngularSignal } from '@reelkit/angular';
import { createSliderController } from '@reelkit/core';

// Custom component using low-level signal bridge
const destroyRef = inject(DestroyRef);
const controller = createSliderController({ count: 10 }, {});
const index = toAngularSignal(controller.state.index, destroyRef);

createOverlayUrlState

OverlayUrlStateOptions

为浮层构建一个 URL 状态控制器,你再把它交给 <rk-lightbox-url-overlay> 的 [controller] 输入。请在注入上下文中调用它 —— 字段初始化器或构造函数;它会立即挂载,并通过 DestroyRef释放。完整讲解: Angular Lightbox页面的 URL 状态.

选项类型默认值说明
paramstring必填承载当前幻灯片的查询参数,例如 photo。
adapterUrlAdapterHistory API读写导航状态所走的系统。带路由的应用请传入基于 Router 的适配器,避免 Router 的 location 过期。
codecUrlCodec<Id>必填传输格式:参数文本 ↔ 稳定身份。它与 locator 成对出现 —— 默认的 ?photo=3 画廊展开 ...urlIndexKey(() => images().length) 即可;也可以提供你自己的实现,让重新排序后书签依然有效。
locatorUrlLocator<Id>必填把身份映射成位置,并自己判断有效性:locate(同步)、locateAsync(分页画廊的异步兜底)、identify(写回)。

createRouterUrlAdapter

@reelkit/angular/ng-router-url-adapter

A UrlAdapter ,底层用 Angular Router。在带路由的应用里把它作为 adapter 的 createOverlayUrlState 选项传入,让 Router 始终是导航的唯一真相来源 —— 绕过 Router 直接写 history.pushState 会让它的 location 过期,下一次导航就会把参数丢掉。写入只触及查询部分,路径、fragment 以及 ?tag=a&tag=b 这样的重复键都原样保留。每次变化都会报告 Router 是在同一页面内压栈、替换,还是在历史中前进后退,因此从 routerLink 打开的画廊按一次返回就能关闭。请在注入上下文中调用它;路由订阅会通过 DestroyRef 释放。

它从独立的子路径导出,因此没有路由的应用永远不会把 @angular/router 打进产物。 @angular/router 是可选的同级依赖。

typescript
import { createRouterUrlAdapter } from '@reelkit/angular/ng-router-url-adapter';

protected readonly photo = createOverlayUrlState({
  param: 'photo',
  adapter: createRouterUrlAdapter(),
  ...urlIndexKey(() => this.images().length),
});

无障碍

<rk-reel> 渲染为 role="region" ,并带 aria-roledescription="carousel"。把 ariaLabel 输入即可给这个区域一个屏幕阅读器能读的名字。一个 polite 的实时区域会在每次切换时播报“第 N 张,共 M 张”。非活动幻灯片会带上 inert 属性,于是焦点和辅助技术导航会跳过它们。

<rk-reel-indicator> 渲染为 role="tablist" ,圆点上使用漫游 tabindex;方向键移动焦点,Enter 或空格激活对应幻灯片。

如果你要围绕 <rk-reel>? captureFocusForReturn, createFocusTrap、 getFocusableElements 都从 @reelkit/angular 重新导出,用于焦点归还和焦点陷阱。

包导出

全部公开导出自 @reelkit/angular:

typescript
// Components & directives
import {
  ReelComponent,
  ReelIndicatorComponent,
  RkReelItemDirective,
  RkSwipeToCloseDirective,
} from '@reelkit/angular';

// Types
import type {
  ReelApi,
  ReelContextValue,
  RkReelItemContext,
  CoreSignal,
  Subscribable,
  AnimatedValue,
  RangeExtractor,
  SliderDirection,
  Disposer,
  DisposableList,
  GestureController,
  SliderController,
  ContentLoadingController,
  ContentPreloader,
  ContentPreloaderConfig,
  SoundController,
  BodyLock,
  TransitionTransformFn,
  SlideTransformStyle,
  SwipeToCloseDirection,
} from '@reelkit/angular';

// Context
import { RK_REEL_CONTEXT } from '@reelkit/angular';

// Services
import { BodyLockService, SoundStateService } from '@reelkit/angular';

// Signal bridges
import { toAngularSignal, animatedSignalBridge } from '@reelkit/angular';

// Core re-exports
import {
  // Signals & reactivity
  createSignal, createComputed, reaction, batch,

  // Transitions
  slideTransition, fadeTransition, flipTransition,
  cubeTransition, zoomTransition, getSlideProgress,

  // Content loading & preloading
  createContentLoadingController, createContentPreloader,

  // Sound
  createSoundController, syncMutedToVideo,

  // Fullscreen
  fullscreenSignal, requestFullscreen, exitFullscreen,

  // DOM & cleanup
  observeDomEvent, createDisposableList, createBodyLock, sharedBodyLock,

  // Size detection
  observeElementSize, getViewportSize, observeViewportSize,
  isMobileWidth, fitAspectRatio, isTouchDevice,

  // Autoplay & download
  createTimerController, createSlideshowController, downloadFile,

  // Focus management
  captureFocusForReturn, createFocusTrap, getFocusableElements,

  // Slider & gestures
  createSliderController, createGestureController,
  defaultRangeExtractor, createDefaultKeyExtractorForLoop,

  // Video
  captureFrame, createSharedVideo,

  // Utilities
  animate, noop, clamp, abs, first, last, extractRange,
} from '@reelkit/angular';