@ fasterfixes/ 核心
核心客户端库 更快的图像 ——网络应用的视觉反馈工具.
此软件包提供快捷Fixes部件使用的 API 客户端、 类型和公用设备 。 大多数用户应安装 @fasterfixes/react 相反,它自动包括这个软件包.
安装
npm install @fasterfixes/core
使用量
import { FasterFixesClient } from "@fasterfixes/core";
const client = new FasterFixesClient({
apiKey: "your-project-api-key",
});
// Fetch widget configuration
const config = await client.getConfig();
// Submit feedback
await client.createFeedback(
{
comment: "Button is misaligned on mobile",
pageUrl: window.location.href,
selector: "main > div > button",
clickX: 150,
clickY: 320,
},
reviewerToken,
screenshotBlob, // optional
);
// Fetch feedback for a page
const { feedback } = await client.getFeedback(reviewerToken, pageUrl);
API 密码
FasterFixesClient
| 方法 | 说明 |
|---|---|
getConfig() | 获取部件配置( 启用状态) |
getFeedback(token, url?) | 获取反馈项目, 可选择通过页面 URL 过滤 |
createFeedback(data, token, screenshot?) | 用可选截图提交新反馈 |
updateFeedback(id, data, token) | 更新现有反馈注释 |
deleteFeedback(id, token) | 删除反馈项目 |
ApiError
被所有客户端的方法 扔在非OK反应。 扩展 Error。 。 。 .
| 财产 | 类型 | 说明 |
|---|---|---|
status | number | HTTP 状态代码 |
message | string | API 的错误消息 |
details | unknown | 其他错误细节 |
公用事业
| 导出 | 说明 |
|---|---|
generateSelector(element) | 生成 DOM 元素的最佳 CSS 选择器 |
generateSelectors(element) | 生成多个选择策略并返回最稳定的策略 best |
resolveElement(selector, strategies?) | 使用主选择器找到元素, 按优先级顺序通过策略返回 |
captureElementContext(element, selectors) | 获取关于 DOM 元素的丰富上下文( 描述、 React 组件路径、 相邻文本) |
getBrowserInfo() | 检测浏览器名称、版本、 OS 和视图大小 |
resolveReviewerToken() | 从 URL parm 中解析审查器令牌( E)ff_token)或本地图集 |
类型
所有类型脚本都导出,包括: WidgetConfig, (中文(简体) ), WidgetPosition, (中文(简体) ), FeedbackItem, (中文(简体) ), FeedbackStatus, (中文(简体) ), CreateFeedbackData, (中文(简体) ), UpdateFeedbackData, (中文(简体) ), SelectorStrategies, (中文(简体) ), ElementContext, (中文(简体) ), ClientOptions, (中文(简体) ), Labels还有更多.
常数
有用常数也被导出 : FEEDBACK_STATUSES, (中文(简体) ), WIDGET_POSITIONS, (中文(简体) ), STATUS_COLORS, (中文(简体) ), DEFAULT_LABELS, (中文(简体) ), DEFAULT_WIDGET_COLOR, (中文(简体) ), DEFAULT_WIDGET_POSITION。 。 。 .