@meltemi/diagrams-canvas 1.9.0 → 1.10.17

package/README.md

@@ -47,13 +47,39 @@ A host that shares the diagram can show who else is in it with `presence` messag
 in `@meltemi/diagrams-editor`): the other people, each with a name, a colour and the ids they have
 selected. The canvas draws an outline in the person's colour around each of those and a tag with
 the name (always text, never markup) on a layer above the scene that is never selected, copied or
-exported and that nothing of is sent back. Each message replaces the last; a message with nobody,
-an empty canvas or another diagram clears it, and ids the diagram does not have are ignored.
+exported and that nothing of is sent back. A person may also have a `pointer` (`{ x, y }` in
+diagram units): the canvas draws a cursor in their colour with the name at its tail, which glides
+to the next point in 200 ms and keeps its size at every zoom. Each message replaces the last; a
+message with nobody, an empty canvas or another diagram clears it, and ids the diagram does not
+have, and pointers that are not two finite numbers, are ignored. Once a host has sent `presence`,
+the canvas tells it where the person's own pointer is with `presencePointer` messages (diagram
+units and the diagram's id, `null` when it leaves), at most every 50 ms.
+
+The Pointer tool (K, or its toggle before the grid's) draws a trail that fades in 800 ms and edits
+nothing, on every canvas, read-only ones included; the trail is no part of the document or of any
+export. In the colour of the person: the `me: { colour }` of the last `presence` message, else the
+render's `colors.accent`. A person's `laser` (`{ batch, points }`, at most 64 points `{ x, y, t }`,
+`t` in milliseconds since the batch's first point) is drawn once per `batch` as that person's trail,
+and the canvas posts the points of the person's own strokes with `presenceLaser` messages to a host
+that has sent `presence`, at most every 50 ms.
 
 Popovers, menus, side panels, tooltips and target outlines open and close with short transitions
 on the motion tokens of `canvas.css` (`--mdg-motion-fast`, `--mdg-motion`, `--mdg-motion-slow`,
 `--mdg-ease`). When the system asks for reduced motion they are zero and nothing moves.
 
+The properties panel folds to a rail from the button in its head and unfolds from the rail's
+button or the toolbar's toggle, one choice kept with the canvas's state (`PersistedState.inspector`,
+read as a boolean only). A host folds it too with `app.setInspectorCollapsed(collapsed)` and reads
+`app.inspectorCollapsed`; a host that binds a key of its own for it names the key in
+`host.keys.inspector` (the playground passes "Ctrl+Alt+B"), and the canvas's tooltips show it.
+
+Every toolbar button's name says what it does, without its key; its `title` adds the key in
+parentheses and `aria-keyshortcuts` says it. The package exports the bubble that shows those titles,
+`Tooltips` (`new Tooltips(root, { except })`, 400 ms after the pointer rests, `TOOLTIP_DELAY`), so a
+host draws its own controls' tooltips the same way (the playground uses `{ except: "#app" }`, and
+the canvas keeps its own), and `ariaKeyshortcuts(shown)`, which writes a shown key ("Ctrl+Alt+B",
+"Mayús+1") as `aria-keyshortcuts` wants it ("Control+Alt+B", "Shift+1").
+
 ## Documentation
 
 - [Editor guide](https://github.com/askenaz-dev/meltemi-diagrams/blob/main/docs/editor.md)