核心指南
@reelkit/core 包提供与框架无关的滑动逻辑。用它来做自定义集成,或者理解底层架构。
架构概览
核心采用工厂函数式的控制器模式。没有类 —— 全是闭包返回的普通对象,零依赖。核心负责协调这几个部分:
- SliderController —— 中央状态管理与导航
- GestureController —— 触摸 / 指针拖拽处理
- KeyboardController —— 方向键与 Escape
- WheelController —— 带防抖的鼠标滚轮
createSliderController
创建一个新的滑动控制器实例,管理滑动器的全部状态和行为。
控制器方法
导航
生命周期
状态更新
虚拟化
核心在任何时刻只往 DOM 里渲染 3 张幻灯片(当前、上一张、下一张)。由范围提取器决定渲染窗口里包含哪些索引:
Signals
核心使用一套轻量的信号系统来做响应式:
控制器状态
通过 controller.state 访问响应式状态:
时间轴控制器
为任意 <video> 元素做一个自定义拖动条。控制器把时长、当前时间、缓冲区间和拖动状态 都暴露成响应式信号,并且一次调用就能把指针和键盘交互接到任意 DOM 元素上。
URL 状态
把浮层的打开状态放进地址栏:当前这张幻灯片就有了可分享、可直达的链接, 按返回键即可关闭。模型由核心持有;各框架绑定把它包成一个钩子(React / Vue 的 useOverlayUrlState,Angular 的 createOverlayUrlState)以及一个由 URL 驱动的浮层组件。
工作原理
createUrlStateController 把一个查询参数映射成信号,并把变化写回去。打开时压入一条历史记录,之后每次导航都是替换 —— 滑一百次也不会多出一条,所以退一步永远就是关闭。 UrlAdapter 是可插拔的读写接缝:默认实现走 history.pushState;带路由的应用则传入一个基于路由器的适配器,这样路由器自己的 location 永远不会过期。
编解码器与定位器 —— 两件事
一个 key 是配套的 { codec, locator } 组合。把身份写进 URL 和在当前集合里找到它的位置,是两件不同的事, 所以它们是两个对象:
- codec —— 传输格式。
encode把身份写成参数文本;decode再解析回来,遇到非法值直接拒绝,参数就会自动从 URL 里消失。 - locator —— 查找。
locate在当前集合里找到解码后的身份所在的位置(找不到就返回null);identify则把位置反查回身份,用于写入;可选的locateAsync会在未命中时继续翻页加载窗口式或无限式的信息流。
把两者分开,你就能任意搭配 —— 比如稳定 id 的编解码器配上一个会翻页的定位器。
索引 key 与稳定 id key
有两个内置 key 会帮你搭好这一对,区别只在于 URL 里写的是什么:
urlIndexKey(() => count)按位置寻址(?photo=3)。最简单,但列表一旦重新排序,书签打开的就是另一条了。urlStableIdKey({ items })按每个条目稳定的id寻址(?photo=post_42),扫描当前列表 —— 重新排序后书签指向的仍是那条内容,条目没了就干净地失效。hashCodec: base64UrlCodec会把 id 做 base64url 混淆(可逆,不是加密哈希)。
要给窗口式信息流翻页?两个内置 key 都接受可选的 locateAsync—— urlIndexKey(() => count, locateAsync) 和 urlStableIdKey({ items, locateAsync })。同步查找负责已加载的部分;未命中时继续把剩下的翻进来, 于是指向窗口之外的分享链接照样能打开 —— 不需要你自己手写编解码器或定位器。
需要两个维度? urlIndexTwoAxisKey 会携带 ?p=<outer>.<inner>,同时表示一条帖子和它内部的媒体索引。完整选项见 核心 API 参考。
下一步
- 核心 API 参考 - 全部可用配置项
- 框架指南 - 组件、演示与集成方式框架指南 - 组件、演示与集成方式框架指南 - 组件、演示与集成方式
- Reel Player - TikTok / Reels 风格的视频播放器Reel Player - TikTok / Reels 风格的视频播放器Reel Player - TikTok / Reels 风格的视频播放器
- Lightbox - 图片与视频画廊Lightbox - 图片与视频画廊Lightbox - 图片与视频画廊
- Stories Player - Instagram 风格的 Stories 浏览器Stories Player - Instagram 风格的 Stories 浏览器Stories Player - Instagram 风格的 Stories 浏览器