@pixelmatters/markup 1.18.3 → 1.18.4
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 +9 -15
- package/dist/widget.js +3 -3
- package/dist/widget.js.map +1 -1
- package/package.json +2 -2
- package/skills/install-markup-widget/SKILL.md +5 -5
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@pixelmatters/markup",
|
|
3
|
-
"version": "1.18.
|
|
3
|
+
"version": "1.18.4",
|
|
4
4
|
"description": "Embeddable feedback widget for collecting visual bug reports, screenshots, and comments on live web apps.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"annotation",
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
"tanstack-intent",
|
|
14
14
|
"widget"
|
|
15
15
|
],
|
|
16
|
-
"homepage": "https://
|
|
16
|
+
"homepage": "https://markup.pixelmatters.dev",
|
|
17
17
|
"bugs": {
|
|
18
18
|
"url": "https://github.com/Pixelmatters/markup/issues"
|
|
19
19
|
},
|
|
@@ -7,7 +7,7 @@ sources:
|
|
|
7
7
|
- 'Pixelmatters/markup:packages/widget/src/widget.ts'
|
|
8
8
|
metadata:
|
|
9
9
|
library: pixelmatters-markup
|
|
10
|
-
library_version: '1.18.
|
|
10
|
+
library_version: '1.18.4'
|
|
11
11
|
---
|
|
12
12
|
|
|
13
13
|
`@pixelmatters/markup` is a Preact widget that runs inside a shadow DOM and talks to a hosted Convex backend at `https://<deployment>.convex.site`. The host page calls `init({ apiUrl, apiKey })` once at the app root and gets back a `destroy()` function. Everything else — pin anchoring, threads, mentions, identity, screenshots, real-time updates — lives inside the widget bundle.
|
|
@@ -26,7 +26,7 @@ For a `<script>`-tag drop-in (no bundler / CMS / page-builder), use the inline E
|
|
|
26
26
|
|
|
27
27
|
```html
|
|
28
28
|
<script type="module">
|
|
29
|
-
import { init } from 'https://esm.sh/@pixelmatters/markup@1.18.
|
|
29
|
+
import { init } from 'https://esm.sh/@pixelmatters/markup@1.18.4'
|
|
30
30
|
init({ apiUrl: '…', apiKey: '…' })
|
|
31
31
|
</script>
|
|
32
32
|
```
|
|
@@ -36,7 +36,7 @@ If the host disallows inline JS, use the auto-init form. `data-markup-widget="tr
|
|
|
36
36
|
```html
|
|
37
37
|
<script
|
|
38
38
|
type="module"
|
|
39
|
-
src="https://esm.sh/@pixelmatters/markup@1.18.
|
|
39
|
+
src="https://esm.sh/@pixelmatters/markup@1.18.4"
|
|
40
40
|
data-markup-widget="true"
|
|
41
41
|
data-api-url="…"
|
|
42
42
|
data-api-key="…"
|
|
@@ -203,7 +203,7 @@ Walk these in order when the widget is misbehaving:
|
|
|
203
203
|
- **Don't wrap in a provider component.** `init` is the entire public surface.
|
|
204
204
|
- **Don't call `init` inside a route component.** Mount at the app root once.
|
|
205
205
|
- **Don't hardcode the API key.** Use env vars so rotations don't require a code change.
|
|
206
|
-
- **Don't ship CDN URLs without a version pin.** `@pixelmatters/markup@1.18.
|
|
206
|
+
- **Don't ship CDN URLs without a version pin.** `@pixelmatters/markup@1.18.4`, not `@pixelmatters/markup`.
|
|
207
207
|
- **Don't add `https://*.convex.site` to `connect-src` and assume that's the whole CSP story.** The deployment domain (`<your-deployment>.convex.site`) is what the widget hits over HTTP, and it must be listed explicitly. Live thread updates go to `wss://<your-deployment>.convex.cloud` — the widget derives that origin from `apiUrl` — so `connect-src` needs both. `img-src` needs `blob:`, `data:`, and the host serving profile pictures; `style-src` needs `'unsafe-inline'` because the widget appends its stylesheet as a `<style>` element inside its shadow root. Add `https://esm.sh` to `script-src` only if you took the CDN path.
|
|
208
208
|
|
|
209
209
|
## Versioning & releases
|
|
@@ -212,7 +212,7 @@ The widget follows semver. Pin to a major in `package.json` (`^1.5.0`) so patch
|
|
|
212
212
|
|
|
213
213
|
## Reference
|
|
214
214
|
|
|
215
|
-
- Install tutorial: https://
|
|
215
|
+
- Install tutorial: https://markup.pixelmatters.dev/docs/install
|
|
216
216
|
- Package on npm: https://www.npmjs.com/package/@pixelmatters/markup
|
|
217
217
|
- Source: https://github.com/Pixelmatters/markup
|
|
218
218
|
|