@caravela-studio/glancy-web

中文文档
0.4.0发布于 2026/11/05MITTypeScriptES Module近 30 天下载 1942

浏览器的光滑:事件、页面浏览、会话回放和热映射——任何框架或无

中文使用文档
文档目录3 节
  1. 无
  2. 服务器
  3. 脚本标记( glancy.js)

@caravela-studio/glancy-web 页面存档备份,存于互联网档案馆

浏览器中的 Glancy, 对于任何框架( 或无): 事件、 页面视图、 会话重放和热映射 . 在下一个.j 中使用 @caravela-studio/glancy-next,它用一个提供者和一个服务器客户端来包装。 在一个没有 构建步骤(或 WordPress),使用脚本标签 glancy.js 见下文.

无

在 npm 上公开,不需要任何符号 :

npm install @caravela-studio/glancy-web
import { BrowserClient } from "@caravela-studio/glancy-web";

export const glancy = new BrowserClient({
  writeKey: "glc_prod_…",            // Glancy → Setup
  // host: "https://analytics.example.com", // only when self-hosting (default https://ingest.heyglancy.com)
  heatmaps: true,                     // optional
  sessionReplay: { sampleRate: 0.5 }, // optional; inputs are masked
});

glancy.page();                        // on every route change (your router's hook)
glancy.track("Order Completed", { revenue: 42 });
glancy.identify(user.id, { name: user.name, email: user.email });
glancy.reset();                       // on sign out
选项默认
writeKey, (中文(简体) ), host—— 说需求
heatmapsfalse点击并滚动深度
sessionReplayfalsetrue 或者说 { sampleRate, maskAllInputs, maskAllText, maskTextSelector, blockSelector }
redactParamskey, token, code, password…查询参数被替换 redacted 在 URL 中显示
flushAt 编号 : flushInterval20 编号 : 2000 分钟击打
consent—— 说{ ads: boolean }如果已经知道 访客的广告同意
debugfalse记录每次事件

方法: track, (中文(简体) ), page, (中文(简体) ), identify, (中文(简体) ), group, (中文(简体) ), alias, (中文(简体) ), reset, (中文(简体) ), flush, (中文(简体) ), getAnonymousId, (中文(简体) ), getUserId, (中文(简体) ), getSessionId, (中文(简体) ), startRecording, (中文(简体) ), stopRecording (例如在撤回同意时), consent({ ads }) (从) 您的同意横幅 : ads: false,访问者的活动从未发送到广告平台;浏览器与 全球隐私控制 ads: false) (中文(简体) ).

隐私 : data-glancy-mask 在重放中隐藏元素的文本, data-glancy-block 别管了.

服务器

@caravela-studio/glancy-web/server数字 : glancy() 编号 : ServerClient 用于 JavaScript 服务器, 加请求跟踪 与 status 财务报告和审定财务报表 duration_ms 作为 API Request 事件: withGlancyRoute(handler, { waitUntil? }) 用于获取样式 操作员和 trackRequests() 为快通/连接. 活动报告 @glancy/web-server 他们的图书馆,所以 摄入将它们视为服务器事件. 见 /docs/sdks/web。 。 。 .

脚本标记( glancy.js)

每个Glancy服务于它(~7 KB gziped). 每个特性都是自己的文件,只有在它打开时才会获取: glancy-capture.js (自动捕获、热映射、glancy-errors.js、glancy-vital.js(闲置)和glancy-replay.js(仅用于抽样会议):

<script defer src="https://ingest.heyglancy.com/glancy.js" data-key="glc_prod_…" data-heatmaps data-replay></script>
属性
data-key桶的写键( 需要)
data-hostGlancy 运行的地方( 默认: 脚本来自何处)
data-heatmaps, (中文(简体) ), data-replay, (中文(简体) ), data-replay-sample="0.25"加热图/ 会话重放
data-outbound-links其它站点链接的音轨点击
data-redact-params="order,email"更多要隐藏的查询参数
data-manual没有自动页面浏览
data-debug记录一切

礛 glancy.track(…), (中文(简体) ), glancy.identify(…), (中文(简体) ), glancy.reset()要在剧本装入前拨打,请添加 首先使用函数窗体 :

<script>window.glancy=window.glancy||function(){(glancy.q=glancy.q||[]).push([].slice.call(arguments))}</script>
<script>glancy("track", "Pricing Viewed")</script>

完全没有代码 : <button data-glancy-event="Demo Requested" data-glancy-prop-plan="pro"> (关于表格的工作也).

版本与发布记录

@caravela-studio/glancy-web 共发布 8 个版本,首次发布于 2026/10/23;过去 12 个月发布了 8 个版本。

版本发布日期距今
0.4.0latest2026/11/055 天前
0.3.12026/11/045 天前
0.2.02026/10/3011 天前
0.1.32026/10/2713 天前
0.1.22026/10/2713 天前
0.1.12026/10/2417 天前

关于 @caravela-studio/glancy-web 的常见问题

@caravela-studio/glancy-web 是什么?

浏览器的光滑:事件、页面浏览、会话回放和热映射——任何框架或无

如何安装 @caravela-studio/glancy-web?

在项目目录运行 npm install @caravela-studio/glancy-web,或使用 pnpm add / yarn add / bun add。

@caravela-studio/glancy-web 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@caravela-studio/glancy-web 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@caravela-studio/glancy-web 可以商用吗?

@caravela-studio/glancy-web 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@caravela-studio/glancy-web 的下载量有多少?

根据 npm 官方下载统计,@caravela-studio/glancy-web 在 2026/10/09 – 2026/11/07 这 30 天内被下载 1,942 次,日均约 65 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@caravela-studio/glancy-web 还在维护吗?

最新版本 0.4.0 发布于 2026/11/05(5 天前);至今共发布 8 个版本,其中过去 12 个月发布了 8 个;首次发布于 2026/10/23。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。