Session replay options inconsistency across docs and exported types for JS Web SDK
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 58/100
- Issue 类型
- 缺陷
- 描述清晰度
- 基本清楚
- 活跃度
- 活跃
- 技术栈
- typescript
- 领域
- documentation, web-dev
调研方向
Compare the session replay documentation at /docs/sdks/web and /docs/session-replay with packages/sdks/web/src/index.ts and packages/sdks/web/src/replay/recorder.ts. First determine whether maskTextSelector is intended to be supported; done means the chosen behavior, exported type, recorder handling, and documentation consistently agree.
由索引模型根据 Issue 内容生成。
描述
In https://openpanel.dev/docs/sdks/web, a maskTextSelector option is mentioned. This option is neither present in https://openpanel.dev/docs/session-replay or in the declared SessionReplayOptions type.
A value which seems it could come from this configuration is hard-coded in https://github.com/Openpanel-dev/openpanel/blob/6ae4a60d9035acc70923d70c34fdc6358d70cea7/packages/sdks/web/src/replay/recorder.ts#L113. The hard-coded [data-openpanel-replay-mask] matches the default described in https://openpanel.dev/docs/sdks/web.
This creates a documentation inconsistency, and I'm unsure whether I should rely on the documented default as a workaround, or if this is not intended to be a feature at all.
Given a direction, I'm happy to open a PR to either remove the mention from the docs or to fix the config and wire it to the point where it should be consumed.
- 主要语言
- TypeScript
- 星标
- 7.1k
- 派生
- 510
- 平均合并
- 7 天 2 小时
- 30 天内合并 PR
- 7
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 没有贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
Openpanel-dev/openpanel 的其他 Issue
-
难度 1/5 1 小时以内 新手友好度 88/100
Openpanel-dev/openpanel#532 ·
维护者通常 1 天内回复
-
Period comparison badge shows wrong percentage for decreases (100 → 50 shows ↓100%)可能已有人在做 @sarmah-rup 于 9 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 85/100
Openpanel-dev/openpanel#526 ·
维护者通常 1 天内回复
-
Self-hosted missing op1-replay.js可能已有人在做 @houstona 于 10 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 84/100
Openpanel-dev/openpanel#512 · 1 条评论 ·
维护者通常 1 天内回复
-
login page needs refinement可能已有人在做 @anandghegde 于 24 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 68/100
Openpanel-dev/openpanel#495 ·
维护者通常 1 天内回复
-
难度 3/5 1-2 天 新手友好度 68/100
Openpanel-dev/openpanel#528 ·
维护者通常 1 天内回复
查看 Openpanel-dev/openpanel 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 76/100
维护者通常 1 天内回复
-
难度 1/5 1-3 小时 新手友好度 84/100
answerLoops/answerLoops#345 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 82/100
siyuan-note/siyuan#20313 ·
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 78/100
LanternOps/breeze#8254 ·
维护者通常 1 天内回复
-
难度 1/5 1-3 小时 新手友好度 82/100
gofish-graphics/gofish-graphics#1084 ·
维护者通常 1 天内回复