@pixelmatters/markup 1.3.5 → 1.3.6
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 +8 -8
- package/dist/widget.js +942 -830
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
[](./LICENSE)
|
|
5
5
|
[](https://bundlephobia.com/package/@pixelmatters/markup)
|
|
6
6
|
|
|
7
|
-
Pin-anchored feedback for live web apps. Drop in a script tag
|
|
7
|
+
Pin-anchored feedback for live web apps. Drop in a script tag and your stakeholders can leave threaded comments, reactions, and annotated screenshots on top of any page — without touching the host's CSS, build, or routing.
|
|
8
8
|
|
|
9
9
|
## Highlights
|
|
10
10
|
|
|
@@ -35,9 +35,9 @@ CDN drop-in (no build step) — paste this just before `</body>`:
|
|
|
35
35
|
```html
|
|
36
36
|
<script type="module">
|
|
37
37
|
// Pin the exact version — esm.sh resolves it from npm
|
|
38
|
-
import { init } from 'https://esm.sh/@pixelmatters/markup@1.3.
|
|
38
|
+
import { init } from 'https://esm.sh/@pixelmatters/markup@1.3.6'
|
|
39
39
|
// or
|
|
40
|
-
// import { init } from 'https://esm.run/@pixelmatters/markup@1.3.
|
|
40
|
+
// import { init } from 'https://esm.run/@pixelmatters/markup@1.3.6'
|
|
41
41
|
|
|
42
42
|
init({
|
|
43
43
|
apiUrl: 'https://your-deployment.convex.site',
|
|
@@ -48,14 +48,14 @@ CDN drop-in (no build step) — paste this just before `</body>`:
|
|
|
48
48
|
</script>
|
|
49
49
|
```
|
|
50
50
|
|
|
51
|
-
> **Why pin the version?** CDN URLs without a version (`@pixelmatters/markup`) resolve to whatever's `latest` on npm — a future major release will break your page silently. Always pin (`@pixelmatters/markup@1.3.
|
|
51
|
+
> **Why pin the version?** CDN URLs without a version (`@pixelmatters/markup`) resolve to whatever's `latest` on npm — a future major release will break your page silently. Always pin (`@pixelmatters/markup@1.3.6`).
|
|
52
52
|
|
|
53
53
|
If your platform doesn't allow inline JS (some CMS / page-builder editors), use the auto-init form instead — point a `<script src=…>` at the bundle and pass config via `data-*` attributes:
|
|
54
54
|
|
|
55
55
|
```html
|
|
56
56
|
<script
|
|
57
57
|
type="module"
|
|
58
|
-
src="https://esm.sh/@pixelmatters/markup@1.3.
|
|
58
|
+
src="https://esm.sh/@pixelmatters/markup@1.3.6"
|
|
59
59
|
data-markup-widget="true"
|
|
60
60
|
data-api-url="https://your-deployment.convex.site"
|
|
61
61
|
data-api-key="markup_..."
|
|
@@ -144,7 +144,7 @@ export default function App() {
|
|
|
144
144
|
|
|
145
145
|
### `init(config) → destroy`
|
|
146
146
|
|
|
147
|
-
Mounts the widget.
|
|
147
|
+
Mounts the widget. Always tears down any existing instance before mounting, so calling `init` again (with the same or a different config) is safe. Returns the `destroy` function.
|
|
148
148
|
|
|
149
149
|
| Option | Type | Default | Description |
|
|
150
150
|
| ---------- | --------------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------ |
|
|
@@ -231,7 +231,7 @@ For a `<script>` tag drop-in (no bundler), use the inline ESM form and **pin the
|
|
|
231
231
|
|
|
232
232
|
```html
|
|
233
233
|
<script type="module">
|
|
234
|
-
import { init } from 'https://esm.sh/@pixelmatters/markup@1.3.
|
|
234
|
+
import { init } from 'https://esm.sh/@pixelmatters/markup@1.3.6'
|
|
235
235
|
|
|
236
236
|
init({
|
|
237
237
|
apiUrl: '...',
|
|
@@ -247,7 +247,7 @@ If inline JS is disallowed (some CMS / page-builder editors), use the auto-init
|
|
|
247
247
|
```html
|
|
248
248
|
<script
|
|
249
249
|
type="module"
|
|
250
|
-
src="https://esm.sh/@pixelmatters/markup@1.3.
|
|
250
|
+
src="https://esm.sh/@pixelmatters/markup@1.3.6"
|
|
251
251
|
data-markup-widget="true"
|
|
252
252
|
data-api-url="..."
|
|
253
253
|
data-api-key="..."
|