@loupekit/sdk 0.10.28 → 0.11.0-next.76
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -4
- package/dist/index.global.js +327 -33
- package/dist/index.global.js.map +1 -1
- package/dist/index.js +327 -33
- package/dist/index.js.map +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -60,7 +60,8 @@ the moment of the comment, so the feedback stays actionable even after the UI ch
|
|
|
60
60
|
| 💬 **Free comments** | Drop a page-level note anywhere with the **Note** mode — no element, no screenshot. |
|
|
61
61
|
| ▭ **Free-region screenshots** | Drag a free-size box, screenshot exactly that area, comment on it. The region anchors to the element under its center, so it tracks responsive reflow and scrolling. |
|
|
62
62
|
| ⏺ **Screen recording** | The **Record** tool drags the same box, then captures a screen video of it (via `getDisplayMedia` + canvas crop) as `.webm` — duration-capped with a Stop button. Recordings play back inline in the widget and the dashboard. |
|
|
63
|
-
| 🧲 **Dockable control** | A DevTools-style panel: dock it to the left / right / bottom edge (which pushes your page over so it's never covered) or float it as a movable, resizable window. Light/dark theme, collapses to a `◎`
|
|
63
|
+
| 🧲 **Dockable control** | A DevTools-style panel: dock it to the left / right / bottom edge (which pushes your page over so it's never covered) or float it as a movable, resizable window. Light/dark theme, collapses to a draggable `◎` launcher (one tap reopens the panel; a chevron expands the quick actions to pin a comment, drop a note, hide the markers or hide the launcher itself), and becomes a bottom sheet on mobile. Position, launcher position, theme and marker visibility persist. |
|
|
64
|
+
| 🕒 **Who and when** | Every thread shows its author and an absolute timestamp rendered in `init({ timeZone, locale })`, so one team reads one clock. The Home footer shows the bundle version and flags it when the host's `packageVersion` differs. |
|
|
64
65
|
| 🔁 **Redeploy-surviving re-anchoring** | A multi-signal fingerprint (stable id/testid, CSS path, XPath, text, attributes, position) re-locates the element on the current page; if it can't, the pin **detaches** instead of pointing at the wrong thing. |
|
|
65
66
|
| 📸 **Screenshot capture** | `[data-loupe-redact]` regions are painted over **before any pixels leave the browser**. |
|
|
66
67
|
| 🧩 **Shadow-DOM isolation** | The widget's CSS never leaks into your page and vice-versa. |
|
|
@@ -103,9 +104,12 @@ Pass `repo` and `branch` to `init()` to make
|
|
|
103
104
|
threads branch-aware — the board can then be filtered by repository and branch.
|
|
104
105
|
Use the header's dock controls to dock it left / right /
|
|
105
106
|
bottom (which pushes your page over) or float it, toggle light/dark, or close it to the `◎`
|
|
106
|
-
|
|
107
|
-
(pin a comment, drop a note, hide the markers,
|
|
108
|
-
|
|
107
|
+
launcher. The launcher carries the comment count; one tap reopens the panel, and the chevron
|
|
108
|
+
beside it expands the quick actions (pin a comment, drop a note, hide the markers, hide the
|
|
109
|
+
launcher). Drag the launcher to move it anywhere — the spot is remembered, and **Reset launcher
|
|
110
|
+
position** in the Settings menu puts it back. Hide it from a quick action, the Settings menu,
|
|
111
|
+
`Alt+Shift+L`, or `hideLauncher()` / `showLauncher()` when it covers something on your page.
|
|
112
|
+
Call `destroy()` to tear it down. `init()` is idempotent — safe to call more
|
|
109
113
|
than once. Pass `label` to change the brand name shown in the header.
|
|
110
114
|
|
|
111
115
|
### Adding your own tab
|
|
@@ -256,6 +260,9 @@ and reordered, yet the pin follows it:
|
|
|
256
260
|
| `captureRecording` | `(rect, opts?) => Promise<string \| undefined>` | Override screen-recording capture (returns a webm data URL). Defaults to `getDisplayMedia` + canvas crop; `opts` carries a duration cap and a `register(stop)` hook. |
|
|
257
261
|
| `headers` | `Record<string, string>` | Extra headers merged into every backend request (e.g. a CSRF token). |
|
|
258
262
|
| `credentials` | `RequestCredentials` | `credentials` mode for backend requests — set `"include"` for cross-origin cookie auth. |
|
|
263
|
+
| `timeZone` | `string` | IANA time zone every timestamp is rendered in (e.g. `"Africa/Cairo"`). Defaults to the browser's. |
|
|
264
|
+
| `locale` | `string` | BCP 47 locale for dates (e.g. `"en-GB"` for day-first). Defaults to the browser's. |
|
|
265
|
+
| `packageVersion` | `string` | Version of the host package that served this bundle (`Loupe.version` is the bundle's own). Flagged in the widget when the two differ. |
|
|
259
266
|
|
|
260
267
|
## Redaction
|
|
261
268
|
|