@pixelmatters/markup 1.1.0 → 1.2.0
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 +13 -11
- package/dist/react.js +380 -276
- package/dist/widget.js +850 -746
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -89,23 +89,25 @@ export default function App() {
|
|
|
89
89
|
|
|
90
90
|
Mounts the widget. Idempotent: re-calling with the same config is a no-op; calling with a different config tears down the previous instance first. Returns the `destroy` function.
|
|
91
91
|
|
|
92
|
-
| Option | Type | Default | Description
|
|
93
|
-
| ---------- | --------------------------------- | ---------------- |
|
|
94
|
-
| `apiUrl` | `string` | required | Convex deployment site URL (`https://*.convex.site`)
|
|
95
|
-
| `apiKey` | `string` | required | Project API key — mint one in the dashboard
|
|
96
|
-
| `position` | `'bottom-right' \| 'bottom-left'` | `'bottom-right'` |
|
|
97
|
-
| `theme` | `'light' \| 'dark' \| 'auto'` | `'auto'` | Visual theme — `'light'` or `'dark'`, or `'auto'` (default) to follow the host's `prefers-color-scheme`
|
|
92
|
+
| Option | Type | Default | Description |
|
|
93
|
+
| ---------- | --------------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------ |
|
|
94
|
+
| `apiUrl` | `string` | required | Convex deployment site URL (`https://*.convex.site`) |
|
|
95
|
+
| `apiKey` | `string` | required | Project API key — mint one in the dashboard |
|
|
96
|
+
| `position` | `'bottom-right' \| 'bottom-left'` | `'bottom-right'` | Initial corner for the floating action button — users can drag it across the viewport midline to flip corners at runtime |
|
|
97
|
+
| `theme` | `'light' \| 'dark' \| 'auto'` | `'auto'` | Visual theme — `'light'` or `'dark'`, or `'auto'` (default) to follow the host's `prefers-color-scheme` |
|
|
98
98
|
|
|
99
99
|
### `destroy()`
|
|
100
100
|
|
|
101
101
|
Unmounts the widget and removes the host element. Safe to call when nothing is mounted.
|
|
102
102
|
|
|
103
|
-
### Keyboard
|
|
103
|
+
### Keyboard & mouse
|
|
104
104
|
|
|
105
|
-
| Shortcut
|
|
106
|
-
|
|
|
107
|
-
| `cmd/ctrl + .`
|
|
108
|
-
| `cmd/ctrl + click`
|
|
105
|
+
| Shortcut | Action |
|
|
106
|
+
| --------------------- | ---------------------------------------------------------------------- |
|
|
107
|
+
| `cmd/ctrl + .` | Toggle HUD visibility |
|
|
108
|
+
| `cmd/ctrl + click` | Click the FAB to hide the HUD with a hint toast |
|
|
109
|
+
| Drag the FAB | Snap it to whichever bottom corner the pointer ends in |
|
|
110
|
+
| Drag a popover header | Move the open thread / new-thread popover; resets to the pin on reopen |
|
|
109
111
|
|
|
110
112
|
## How it works
|
|
111
113
|
|