@botiverse/porthole 0.14.10 → 0.14.11
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/CHANGELOG.md +20 -0
- package/dist/annotate/types.d.ts +32 -14
- package/dist/annotate/types.js +1 -1
- package/dist/annotate/validate.js +28 -3
- package/dist/check/page-source.js +1 -1
- package/dist/conformance/harness-source.js +1 -1
- package/dist/shell/annotate.d.ts +9 -5
- package/dist/shell/annotate.js +225 -41
- package/dist/shell/find.d.ts +1 -1
- package/dist/shell/find.js +1 -1
- package/docs/ADOPTING.md +31 -3
- package/docs/ARCHITECTURE.md +4 -3
- package/docs/DECISIONS.md +139 -2
- package/docs/DESIGN.md +49 -18
- package/docs/THREAT_MODEL.md +27 -5
- package/package.json +1 -1
- package/src/annotate/types.ts +32 -14
- package/src/annotate/validate.ts +33 -3
- package/src/shell/annotate.ts +225 -41
- package/src/shell/find.ts +1 -1
package/dist/shell/annotate.d.ts
CHANGED
|
@@ -24,17 +24,21 @@ export declare const MARKER_HIT: string;
|
|
|
24
24
|
* was, its text anywhere, its words with any spacing) and drawn over it, in a layer of the
|
|
25
25
|
* shell's own (a closed shadow root), again whenever the content changes; what can't be found
|
|
26
26
|
* is reported `orphaned`;
|
|
27
|
-
* - markers (P104): a mark with a count gets a small
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
27
|
+
* - markers (P104): a mark with a count gets a small button with the number, a bubble: a text
|
|
28
|
+
* anchor's at its paragraph's end (P133), a draft's (P107) beside its anchor's last line (P105:
|
|
29
|
+
* in the line's gutter), an element's on its corner; a click on it, or Enter or Space with the
|
|
30
|
+
* focus on it (P133), is reported (`activated`), and the content's own handlers never see it; a
|
|
31
|
+
* draft is drawn apart, a dashed line and a hollow bubble with no number, and has a marker with
|
|
32
|
+
* or without a count;
|
|
31
33
|
* - following: while a mark has a marker, once a scroll, a resize or a change of the content
|
|
32
34
|
* settles, the marks that moved since the host was last told are reported, at most once a
|
|
33
35
|
* second, so the host's own UI beside a mark can follow;
|
|
34
36
|
* - places in the document (P132): each result's box also in the document's coordinates
|
|
35
37
|
* (`documentRect`), with how far the document was scrolled as it was read (`scroll`), and the
|
|
36
38
|
* followed mark's (`tracked`) too, so a host places marks scrolled out of the frame, and keeps
|
|
37
|
-
* them placed as the document scrolls, from one report and the followed mark's scroll
|
|
39
|
+
* them placed as the document scrolls, from one report and the followed mark's scroll;
|
|
40
|
+
* - the last line (P133): where a selection or a mark's words end, in the document's coordinates
|
|
41
|
+
* too (`lastLineDocumentRect`), so a host places its UI after them.
|
|
38
42
|
*
|
|
39
43
|
* It shares the realm with the content, which can interfere with all of it: the host takes its
|
|
40
44
|
* reports as UI hints only.
|
package/dist/shell/annotate.js
CHANGED
|
@@ -49,17 +49,21 @@ export const MARKER_HIT = String.raw `(count, boxAt, x, y, touch) => {
|
|
|
49
49
|
* was, its text anywhere, its words with any spacing) and drawn over it, in a layer of the
|
|
50
50
|
* shell's own (a closed shadow root), again whenever the content changes; what can't be found
|
|
51
51
|
* is reported `orphaned`;
|
|
52
|
-
* - markers (P104): a mark with a count gets a small
|
|
53
|
-
*
|
|
54
|
-
*
|
|
55
|
-
*
|
|
52
|
+
* - markers (P104): a mark with a count gets a small button with the number, a bubble: a text
|
|
53
|
+
* anchor's at its paragraph's end (P133), a draft's (P107) beside its anchor's last line (P105:
|
|
54
|
+
* in the line's gutter), an element's on its corner; a click on it, or Enter or Space with the
|
|
55
|
+
* focus on it (P133), is reported (`activated`), and the content's own handlers never see it; a
|
|
56
|
+
* draft is drawn apart, a dashed line and a hollow bubble with no number, and has a marker with
|
|
57
|
+
* or without a count;
|
|
56
58
|
* - following: while a mark has a marker, once a scroll, a resize or a change of the content
|
|
57
59
|
* settles, the marks that moved since the host was last told are reported, at most once a
|
|
58
60
|
* second, so the host's own UI beside a mark can follow;
|
|
59
61
|
* - places in the document (P132): each result's box also in the document's coordinates
|
|
60
62
|
* (`documentRect`), with how far the document was scrolled as it was read (`scroll`), and the
|
|
61
63
|
* followed mark's (`tracked`) too, so a host places marks scrolled out of the frame, and keeps
|
|
62
|
-
* them placed as the document scrolls, from one report and the followed mark's scroll
|
|
64
|
+
* them placed as the document scrolls, from one report and the followed mark's scroll;
|
|
65
|
+
* - the last line (P133): where a selection or a mark's words end, in the document's coordinates
|
|
66
|
+
* too (`lastLineDocumentRect`), so a host places its UI after them.
|
|
63
67
|
*
|
|
64
68
|
* It shares the realm with the content, which can interfere with all of it: the host takes its
|
|
65
69
|
* reports as UI hints only.
|
|
@@ -321,6 +325,19 @@ export const ANNOTATE_RUNTIME = String.raw `if (declared("annotate")) {
|
|
|
321
325
|
};
|
|
322
326
|
// A box in the viewport, in the document (P132): where it is as the document scrolls.
|
|
323
327
|
const inDocument = (rect, scroll) => ({ x: rect.x + scroll.x, y: rect.y + scroll.y, width: rect.width, height: rect.height });
|
|
328
|
+
// Where what was found ends (P133), in the document as a documentRect is: its last line with
|
|
329
|
+
// words on it, or an element's whole box (it has no lines of its own). Null with nothing drawn.
|
|
330
|
+
const lastLineOf = (found, scroll) => {
|
|
331
|
+
const rect = found.range ? lastBox(rangeRects.call(found.range)) : elementRect.call(found.element);
|
|
332
|
+
return rect === null ? null : inDocument(box(rect), scroll);
|
|
333
|
+
};
|
|
334
|
+
// What a selection's report adds to its box (P133): its last line, with the scroll it was
|
|
335
|
+
// read at; neither where nothing of it is drawn.
|
|
336
|
+
const placeOf = (found) => {
|
|
337
|
+
const scroll = scrollOf();
|
|
338
|
+
const lastLineDocumentRect = lastLineOf(found, scroll);
|
|
339
|
+
return lastLineDocumentRect === null ? {} : { lastLineDocumentRect, scroll };
|
|
340
|
+
};
|
|
324
341
|
|
|
325
342
|
// The shell's own layer, over the content: marks, the outline of what would be picked.
|
|
326
343
|
let layer = null;
|
|
@@ -335,18 +352,22 @@ export const ANNOTATE_RUNTIME = String.raw `if (declared("annotate")) {
|
|
|
335
352
|
// marker hollow, a light bubble with a dashed edge and the glyph's outline, no number.
|
|
336
353
|
// While the last pointer was a finger or a pen (P119), each marker takes the pointer in a
|
|
337
354
|
// box of at least 44 by 44 px centred on its own (an invisible ::before; 100% is its padding
|
|
338
|
-
// box, its border 1 px), so a tap a few px off still lands on the shell's layer.
|
|
339
|
-
|
|
355
|
+
// box, its border 1 px), so a tap a few px off still lands on the shell's layer. A marker is
|
|
356
|
+
// a real button (P133): what a browser gives one is taken off, a ring says it has the focus.
|
|
357
|
+
const STYLE = ".mark{position:absolute;border-radius:2px;background:rgba(250,204,21,.18);box-shadow:inset 0 -2px 0 rgba(234,179,8,.95)}.mark.element{background:rgba(250,204,21,.07);box-shadow:none;outline:2px solid rgba(234,179,8,.9);outline-offset:1px}.mark.active{background:rgba(250,204,21,.26);box-shadow:inset 0 -3px 0 rgb(234,179,8),0 0 0 2px rgba(234,179,8,.45)}.mark.element.active{background:rgba(250,204,21,.12);box-shadow:none;outline-width:3px}.mark.element.quiet{background:rgba(250,204,21,.05);outline:1px solid rgba(234,179,8,.6);outline-offset:2px}.mark.element.quiet.active{background:rgba(250,204,21,.1);outline:2px solid rgba(234,179,8,.9)}.mark.draft{box-sizing:border-box;background:rgba(250,204,21,.08);box-shadow:none;border-bottom:2px dashed rgba(202,138,4,.95)}.mark.draft.active{background:rgba(250,204,21,.16);box-shadow:0 0 0 2px rgba(234,179,8,.45);border-bottom-width:3px}.mark.element.draft{background:rgba(250,204,21,.04);border-bottom:0;outline-style:dashed}.mark.element.draft.active{background:rgba(250,204,21,.08);box-shadow:none;outline-style:dashed}.marker{position:absolute;box-sizing:border-box;height:18px;min-width:18px;display:flex;align-items:center;justify-content:center;gap:3px;margin:0;padding:0 5px;border:1px solid rgba(161,98,7,.6);border-radius:9px 9px 9px 2px;background:#fde68a;color:#422006;box-shadow:0 1px 2px rgba(0,0,0,.3);font:600 11px/16px system-ui,-apple-system,Segoe UI,Roboto,sans-serif;font-style:normal;letter-spacing:0;word-spacing:0;text-transform:none;text-indent:0;text-shadow:none;direction:ltr;writing-mode:horizontal-tb;white-space:nowrap;user-select:none;-webkit-user-select:none;cursor:pointer;pointer-events:auto;appearance:none;-webkit-appearance:none}.marker:focus-visible{outline:2px solid #2563eb;outline-offset:1px}.marker:hover{background:#fcd34d}.marker.active{background:#facc15;box-shadow:0 0 0 2px rgba(234,179,8,.55),0 1px 2px rgba(0,0,0,.3)}.marker.compact{padding:0 4px}.marker.draft{border:1px dashed rgb(202,138,4);background:#fffdf5;color:#a16207;box-shadow:0 1px 2px rgba(0,0,0,.2)}.marker.draft:hover{background:#fef9e7}.marker.draft.active{background:#fef3c7;box-shadow:0 0 0 2px rgba(234,179,8,.55),0 1px 2px rgba(0,0,0,.2)}.marker.inert,[data-placing]>.marker{pointer-events:none}.touch>.marker::before{content:'';position:absolute;left:50%;top:50%;width:max(100% + 2px,44px);height:max(100% + 2px,44px);transform:translate(-50%,-50%)}.marker svg{display:block;width:11px;height:11px;flex:none}.mark.flash{animation:flash 1.8s ease-out}@keyframes flash{from{box-shadow:inset 0 -3px 0 rgb(234,179,8),0 0 0 6px rgba(250,204,21,.6)}}.hover{position:absolute;outline:2px solid #2563eb;outline-offset:1px;background:rgba(37,99,235,.12)}.tag{position:absolute;max-width:70vw;overflow:hidden;text-overflow:ellipsis;white-space:nowrap;font:12px/18px ui-monospace,SFMono-Regular,Menlo,monospace;padding:0 6px;border-radius:4px;background:#1e293b;color:#fff}";
|
|
340
358
|
// Inline and important: the content's own style sheets can't hide, shrink or move it by
|
|
341
359
|
// accident. Set again at each draw, since its scripts can rewrite it (narrowing only: the
|
|
342
|
-
// content can still cover the layer, or move it with its ancestors, P104).
|
|
343
|
-
|
|
360
|
+
// content can still cover the layer, or move it with its ancestors, P104). Clipped, where an
|
|
361
|
+
// engine has it, not hidden: hidden is a box a focused marker out of view would scroll (P133).
|
|
362
|
+
const LAYER_STYLE = "position:fixed!important;inset:0!important;width:auto!important;height:auto!important;min-width:0!important;min-height:0!important;max-width:none!important;max-height:none!important;display:block!important;visibility:visible!important;opacity:1!important;pointer-events:none!important;z-index:2147483647!important;overflow:hidden!important;overflow:clip!important;margin:0!important;padding:0!important;border:0!important;background:none!important;transform:none!important;scale:none!important;translate:none!important;rotate:none!important;zoom:1!important;clip-path:none!important;mask:none!important;filter:none!important;content-visibility:visible!important;contain:none!important";
|
|
344
363
|
const ensureLayer = () => {
|
|
345
364
|
if (layer === null) {
|
|
346
365
|
layer = createElement.call(document, "div");
|
|
347
|
-
layer.setAttribute("aria-hidden", "true");
|
|
348
366
|
layer.setAttribute("data-porthole-annotations", "");
|
|
349
367
|
shadow = attachShadow.call(layer, { mode: "closed" });
|
|
368
|
+
// Within the shadow root: a focus moving from one marker to the next never leaves it.
|
|
369
|
+
callOf(listenOn, shadow, ["focusin", onMarkerFocus]);
|
|
370
|
+
callOf(listenOn, shadow, ["focusout", onMarkerFocus]);
|
|
350
371
|
}
|
|
351
372
|
if (layer.style.cssText !== LAYER_STYLE) {
|
|
352
373
|
layer.style.cssText = LAYER_STYLE;
|
|
@@ -378,6 +399,13 @@ export const ANNOTATE_RUNTIME = String.raw `if (declared("annotate")) {
|
|
|
378
399
|
const markerWidth = (label) => Math.max(MARKER_HEIGHT, 23 + (label === "" ? 0 : 3 + label.length * 7));
|
|
379
400
|
// Compact (P105): the number alone, or the glyph alone for none, with less padding.
|
|
380
401
|
const compactWidth = (label) => (label === "" ? 21 : Math.max(MARKER_HEIGHT, 10 + label.length * 7));
|
|
402
|
+
// What a marker is called (P133), to whoever can't see it: what it is, and the words it is
|
|
403
|
+
// on. In English, whatever the page's language: the shell has no words of the host's.
|
|
404
|
+
const nameOf = (mark) => {
|
|
405
|
+
const words = typeof mark.anchor.label === "string" ? squash(mark.anchor.label).slice(0, LIMIT.label) : "";
|
|
406
|
+
const what = mark.draft ? "Draft comment" : mark.count === 1 ? "1 comment" : mark.count > 1 ? mark.count + " comments" : "Comment";
|
|
407
|
+
return words === "" ? what : what + " on " + words;
|
|
408
|
+
};
|
|
381
409
|
// A rect's last line with words on it: its last box with a width, else any with a size.
|
|
382
410
|
const lastBox = (rects) => {
|
|
383
411
|
let any = null;
|
|
@@ -401,7 +429,9 @@ export const ANNOTATE_RUNTIME = String.raw `if (declared("annotate")) {
|
|
|
401
429
|
// in a row of them), just past the line's last word. Markers on one line of one block go
|
|
402
430
|
// together, in the order their words end. Where the bubble with its glyph fits in none of
|
|
403
431
|
// these, the number alone does (compact); where that fits in none either (a full line on a
|
|
404
|
-
// narrow screen), it goes as far right as it can, over the line's end.
|
|
432
|
+
// narrow screen), it goes as far right as it can, over the line's end. A posted comment's
|
|
433
|
+
// marker (P133) is placed the same way on its paragraph's last line instead, where nothing
|
|
434
|
+
// follows its words, and first tries just past that line's last word.
|
|
405
435
|
const computedOf = window.getComputedStyle;
|
|
406
436
|
const elementsAt = Document.prototype.elementsFromPoint;
|
|
407
437
|
const containsOf = Node.prototype.contains;
|
|
@@ -461,6 +491,52 @@ export const ANNOTATE_RUNTIME = String.raw `if (declared("annotate")) {
|
|
|
461
491
|
}
|
|
462
492
|
return end;
|
|
463
493
|
};
|
|
494
|
+
// The end of the paragraph an anchor ends in (P133): a range over the block's last words
|
|
495
|
+
// that are drawn, from the anchor's end on, as far as a block inside it (a nested list, say:
|
|
496
|
+
// its words are their own paragraph), 256 text nodes at most. Null if none follow the anchor.
|
|
497
|
+
const inBlock = (node, block) => {
|
|
498
|
+
for (let at = node.parentElement; at !== null && at !== block; at = at.parentElement) {
|
|
499
|
+
if (!INLINE.test(computedOf.call(window, at).display)) {
|
|
500
|
+
return false;
|
|
501
|
+
}
|
|
502
|
+
}
|
|
503
|
+
return true;
|
|
504
|
+
};
|
|
505
|
+
const paragraphEnd = (range, block) => {
|
|
506
|
+
const start = range.endContainer;
|
|
507
|
+
if (start.nodeType !== 3) {
|
|
508
|
+
return null;
|
|
509
|
+
}
|
|
510
|
+
const walker = createTreeWalker.call(document, block, NodeFilter.SHOW_TEXT);
|
|
511
|
+
walker.currentNode = start;
|
|
512
|
+
let end = null;
|
|
513
|
+
let node = start;
|
|
514
|
+
for (let pieces = 0; node !== null && pieces < 256; pieces += 1) {
|
|
515
|
+
if (node !== start && !inBlock(node, block)) {
|
|
516
|
+
break;
|
|
517
|
+
}
|
|
518
|
+
const words = node.nodeValue;
|
|
519
|
+
const first = node === start ? range.endOffset : 0;
|
|
520
|
+
let to = words.length;
|
|
521
|
+
while (to > first && /\s/.test(words.charAt(to - 1))) {
|
|
522
|
+
to -= 1;
|
|
523
|
+
}
|
|
524
|
+
if (to > first) {
|
|
525
|
+
const piece = createRange.call(document);
|
|
526
|
+
try {
|
|
527
|
+
piece.setStart(node, Math.max(first, to - 2));
|
|
528
|
+
piece.setEnd(node, to);
|
|
529
|
+
} catch (_) {
|
|
530
|
+
return end;
|
|
531
|
+
}
|
|
532
|
+
if (lastBox(rangeRects.call(piece)) !== null) {
|
|
533
|
+
end = piece;
|
|
534
|
+
}
|
|
535
|
+
}
|
|
536
|
+
node = walker.nextNode();
|
|
537
|
+
}
|
|
538
|
+
return end;
|
|
539
|
+
};
|
|
464
540
|
// Nothing of the content's at a point but a box that holds the block (its background); a
|
|
465
541
|
// point out of view hides nothing.
|
|
466
542
|
const clearAt = (x, y, block) => {
|
|
@@ -513,7 +589,11 @@ export const ANNOTATE_RUNTIME = String.raw `if (declared("annotate")) {
|
|
|
513
589
|
return null;
|
|
514
590
|
};
|
|
515
591
|
const gutter = right + gap;
|
|
516
|
-
|
|
592
|
+
// A paragraph's end (P133): just past its last word, where the line leaves the room.
|
|
593
|
+
let left = line.ending ? fits(line.words + gap, false) : null;
|
|
594
|
+
if (left === null) {
|
|
595
|
+
left = fits(gutter, false);
|
|
596
|
+
}
|
|
517
597
|
if (left === null && gutter > most) {
|
|
518
598
|
left = fits(most, true);
|
|
519
599
|
}
|
|
@@ -525,7 +605,8 @@ export const ANNOTATE_RUNTIME = String.raw `if (declared("annotate")) {
|
|
|
525
605
|
const placeLines = (wanted, placed, room) => {
|
|
526
606
|
// One line of one block: markers whose last lines share a middle.
|
|
527
607
|
const lines = [];
|
|
528
|
-
|
|
608
|
+
// In the order their words end, those at one paragraph's end too.
|
|
609
|
+
wanted.sort((a, b) => a.at.top - b.at.top || a.at.right - b.at.right || a.words.top - b.words.top || a.words.right - b.words.right);
|
|
529
610
|
for (const each of wanted) {
|
|
530
611
|
const middle = each.at.top + each.at.height / 2;
|
|
531
612
|
let line = null;
|
|
@@ -535,10 +616,11 @@ export const ANNOTATE_RUNTIME = String.raw `if (declared("annotate")) {
|
|
|
535
616
|
}
|
|
536
617
|
}
|
|
537
618
|
if (line === null) {
|
|
538
|
-
line = { block: each.block, middle, height: each.at.height, bottom: each.at.bottom, range: each.range, at: each.at, items: [] };
|
|
619
|
+
line = { block: each.block, middle, height: each.at.height, bottom: each.at.bottom, range: each.range, at: each.at, ending: false, items: [] };
|
|
539
620
|
lines.push(line);
|
|
540
621
|
}
|
|
541
622
|
line.items.push(each);
|
|
623
|
+
line.ending = line.ending || each.ending;
|
|
542
624
|
if (each.at.right > line.at.right) {
|
|
543
625
|
line.at = each.at;
|
|
544
626
|
line.range = each.range;
|
|
@@ -617,20 +699,24 @@ export const ANNOTATE_RUNTIME = String.raw `if (declared("annotate")) {
|
|
|
617
699
|
const kept = markerNodes.get(mark.id);
|
|
618
700
|
let marker = kept ? kept.element : null;
|
|
619
701
|
if (marker === null) {
|
|
620
|
-
|
|
621
|
-
//
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
702
|
+
// A real button (P133): the keyboard reaches it, Enter and Space click it, assistive
|
|
703
|
+
// technology names it, and WebKit makes a tap a click on it (P105).
|
|
704
|
+
marker = createElement.call(document, "button");
|
|
705
|
+
marker.setAttribute("type", "button");
|
|
706
|
+
}
|
|
707
|
+
// Stepped aside while elements are picked, from the keyboard too. Set, not left to the
|
|
708
|
+
// button: Safari's Tab skips a button without one, unless the person asked otherwise.
|
|
709
|
+
marker.tabIndex = mode.elements ? -1 : 0;
|
|
626
710
|
marker.className = "marker" + (mark.draft ? " draft" : "") + (each.compact ? " compact" : "") + (mark.id === active ? " active" : "") + (mode.elements ? " inert" : "");
|
|
627
711
|
marker.style.cssText = "left:" + each.left + "px;top:" + each.top + "px";
|
|
628
712
|
markers.push({ id: mark.id, element: marker });
|
|
629
|
-
const
|
|
713
|
+
const name = nameOf(mark);
|
|
714
|
+
const form = (mark.draft ? "draft:" : "") + (each.compact ? "compact:" : "full:") + label + ":" + name;
|
|
630
715
|
if (kept && kept.form === form) {
|
|
631
716
|
return marker;
|
|
632
717
|
}
|
|
633
718
|
markerNodes.set(mark.id, { element: marker, form });
|
|
719
|
+
marker.setAttribute("aria-label", name);
|
|
634
720
|
marker.replaceChildren();
|
|
635
721
|
if (!each.compact || label === "") {
|
|
636
722
|
const glyph = createElementNS.call(document, SVG, "svg");
|
|
@@ -657,10 +743,9 @@ export const ANNOTATE_RUNTIME = String.raw `if (declared("annotate")) {
|
|
|
657
743
|
}
|
|
658
744
|
return marker;
|
|
659
745
|
};
|
|
660
|
-
const tapTarget = () => {};
|
|
661
746
|
let active = null;
|
|
662
|
-
// The mark whose marker the pointer is over: its words are lit as
|
|
663
|
-
// a marker in the gutter shows which words it is for (P105).
|
|
747
|
+
// The mark whose marker the pointer is over, or the focus is on (P133): its words are lit as
|
|
748
|
+
// the active mark's are, so a marker in the gutter shows which words it is for (P105).
|
|
664
749
|
let hot = null;
|
|
665
750
|
let flashing = null;
|
|
666
751
|
let flashUntil = 0;
|
|
@@ -676,6 +761,10 @@ export const ANNOTATE_RUNTIME = String.raw `if (declared("annotate")) {
|
|
|
676
761
|
style.nonce = nonce;
|
|
677
762
|
}
|
|
678
763
|
boxes = { style, marks: createElement.call(document, "div"), markers: createElement.call(document, "div"), hover: createElement.call(document, "div") };
|
|
764
|
+
// Only the markers are for assistive technology (P133): the rest draws what the page
|
|
765
|
+
// already says.
|
|
766
|
+
boxes.marks.setAttribute("aria-hidden", "true");
|
|
767
|
+
boxes.hover.setAttribute("aria-hidden", "true");
|
|
679
768
|
root.replaceChildren(boxes.style, boxes.marks, boxes.markers, boxes.hover);
|
|
680
769
|
}
|
|
681
770
|
if (boxes.style.textContent !== STYLE) {
|
|
@@ -697,6 +786,7 @@ export const ANNOTATE_RUNTIME = String.raw `if (declared("annotate")) {
|
|
|
697
786
|
// What is measured first, then drawn: no node of the layer changes while the page is read.
|
|
698
787
|
const corners = [];
|
|
699
788
|
const wanted = [];
|
|
789
|
+
const focused = focusedMarker() !== null;
|
|
700
790
|
markers = [];
|
|
701
791
|
for (const mark of marks) {
|
|
702
792
|
if (mark.found === null) {
|
|
@@ -717,14 +807,28 @@ export const ANNOTATE_RUNTIME = String.raw `if (declared("annotate")) {
|
|
|
717
807
|
if (at !== null) {
|
|
718
808
|
// A draft's marker has no number (P107).
|
|
719
809
|
const label = mark.draft ? "" : labelOf(mark.count);
|
|
720
|
-
const each = { mark,
|
|
810
|
+
const each = { mark, label, width: markerWidth(label), small: compactWidth(label), compact: false, at, words: at, left: 0, top: 0, ending: false };
|
|
721
811
|
if (mark.found.range) {
|
|
722
812
|
// Kept while it still holds the words (P105): a change elsewhere doesn't move them.
|
|
723
813
|
if (mark.block === undefined || !mark.block.isConnected || !containsOf.call(mark.block, mark.found.range.endContainer)) {
|
|
724
814
|
mark.block = blockOf(mark.found.range);
|
|
815
|
+
mark.end = undefined;
|
|
725
816
|
}
|
|
726
817
|
each.range = mark.found.range;
|
|
727
818
|
each.block = mark.block;
|
|
819
|
+
// A posted comment's, at its paragraph's end (P133); read once for what was found,
|
|
820
|
+
// since a block's words can be long. A draft's stays by the words being written on.
|
|
821
|
+
if (!mark.draft) {
|
|
822
|
+
each.ending = true;
|
|
823
|
+
if (mark.end === undefined) {
|
|
824
|
+
mark.end = paragraphEnd(mark.found.range, mark.block);
|
|
825
|
+
}
|
|
826
|
+
const last = mark.end === null ? null : lastBox(rangeRects.call(mark.end));
|
|
827
|
+
if (last !== null) {
|
|
828
|
+
each.at = last;
|
|
829
|
+
each.range = mark.end;
|
|
830
|
+
}
|
|
831
|
+
}
|
|
728
832
|
wanted.push(each);
|
|
729
833
|
} else {
|
|
730
834
|
corners.push(each);
|
|
@@ -740,18 +844,25 @@ export const ANNOTATE_RUNTIME = String.raw `if (declared("annotate")) {
|
|
|
740
844
|
}
|
|
741
845
|
// The layer's own boxes out of the way while places are hit-tested (P105): each test
|
|
742
846
|
// otherwise walks every mark and marker the last draw left (0.13 ms each, 300 of them).
|
|
847
|
+
// A marker with the focus would lose it out of the display (P133): while the person is on
|
|
848
|
+
// one, the markers only stop taking the pointer, which the tests skip but still walk.
|
|
743
849
|
if (wanted.length > 0) {
|
|
744
850
|
into.marks.style.display = "none";
|
|
745
|
-
|
|
851
|
+
if (focused) {
|
|
852
|
+
into.markers.setAttribute("data-placing", "");
|
|
853
|
+
} else {
|
|
854
|
+
into.markers.style.display = "none";
|
|
855
|
+
}
|
|
746
856
|
try {
|
|
747
857
|
placeLines(wanted, placed, room);
|
|
748
858
|
} finally {
|
|
749
859
|
into.marks.style.display = "";
|
|
750
860
|
into.markers.style.display = "";
|
|
861
|
+
into.markers.removeAttribute("data-placing");
|
|
751
862
|
}
|
|
752
863
|
}
|
|
753
864
|
const badges = [];
|
|
754
|
-
for (const each of corners.concat(wanted).sort((a, b) => a.
|
|
865
|
+
for (const each of corners.concat(wanted).sort((a, b) => a.mark.reading - b.mark.reading)) {
|
|
755
866
|
badges.push(markerOf(each));
|
|
756
867
|
}
|
|
757
868
|
for (const id of Array.from(markerNodes.keys())) {
|
|
@@ -777,11 +888,14 @@ export const ANNOTATE_RUNTIME = String.raw `if (declared("annotate")) {
|
|
|
777
888
|
into.markers.removeChild(child);
|
|
778
889
|
}
|
|
779
890
|
}
|
|
780
|
-
|
|
781
|
-
|
|
782
|
-
|
|
891
|
+
// In reading order, the Tab key's (P133). A marker that stays in its place isn't touched
|
|
892
|
+
// (a press spans a redraw, above), and none moves while one has the focus: it would lose it.
|
|
893
|
+
badges.forEach((badge, at) => {
|
|
894
|
+
const there = into.markers.childNodes[at] || null;
|
|
895
|
+
if (badge.parentNode !== into.markers || (!focused && there !== badge)) {
|
|
896
|
+
into.markers.insertBefore(badge, focused ? null : there);
|
|
783
897
|
}
|
|
784
|
-
}
|
|
898
|
+
});
|
|
785
899
|
into.hover.replaceChildren(...outlines);
|
|
786
900
|
};
|
|
787
901
|
let drawing = false;
|
|
@@ -817,7 +931,8 @@ export const ANNOTATE_RUNTIME = String.raw `if (declared("annotate")) {
|
|
|
817
931
|
// Its box moves as the document scrolls, inside the frame or not: each one tells the
|
|
818
932
|
// host the scroll, for every mark it places by its place in the document (P132).
|
|
819
933
|
const scroll = scrollOf();
|
|
820
|
-
|
|
934
|
+
const lastLineDocumentRect = lastLineOf(mark.found, scroll);
|
|
935
|
+
tell(M.tracked, Object.assign({ id: tracking, rect, documentRect: inDocument(rect, scroll), scroll }, lastLineDocumentRect === null ? {} : { lastLineDocumentRect }));
|
|
821
936
|
}
|
|
822
937
|
}
|
|
823
938
|
trackFrame = nextFrame(trackTick);
|
|
@@ -861,15 +976,16 @@ export const ANNOTATE_RUNTIME = String.raw `if (declared("annotate")) {
|
|
|
861
976
|
placed.forEach((each, at) => orders.set(each.mark, at));
|
|
862
977
|
return orders;
|
|
863
978
|
};
|
|
864
|
-
// A mark's result: its box in the viewport, and in the document (P132)
|
|
865
|
-
// report's one reading of it.
|
|
979
|
+
// A mark's result: its box in the viewport, and in the document (P132), its last line too
|
|
980
|
+
// (P133), by scroll, the report's one reading of it.
|
|
866
981
|
const resultOf = (mark, orders, scroll) => {
|
|
867
982
|
if (mark.found === null) {
|
|
868
983
|
return { id: mark.id, state: "orphaned" };
|
|
869
984
|
}
|
|
870
985
|
const order = (orders || ordersOf()).get(mark);
|
|
871
986
|
const rect = box(rectOf(mark.found));
|
|
872
|
-
|
|
987
|
+
const lastLineDocumentRect = lastLineOf(mark.found, scroll);
|
|
988
|
+
return Object.assign({ id: mark.id, state: "attached", rect, documentRect: inDocument(rect, scroll) }, lastLineDocumentRect === null ? {} : { lastLineDocumentRect }, order === undefined ? {} : { order });
|
|
873
989
|
};
|
|
874
990
|
// Two boxes more than 0.5 px apart on any side (or one of them unknown).
|
|
875
991
|
const apart = (a, b) => !a || !b || Math.abs(a.x - b.x) > 0.5 || Math.abs(a.y - b.y) > 0.5 || Math.abs(a.width - b.width) > 0.5 || Math.abs(a.height - b.height) > 0.5;
|
|
@@ -911,8 +1027,15 @@ export const ANNOTATE_RUNTIME = String.raw `if (declared("annotate")) {
|
|
|
911
1027
|
changed = true;
|
|
912
1028
|
}
|
|
913
1029
|
mark.found = found;
|
|
1030
|
+
mark.end = undefined;
|
|
914
1031
|
mark.state = state;
|
|
915
1032
|
}
|
|
1033
|
+
// Where each starts, once for each finding: the markers' reading order (P133).
|
|
1034
|
+
const orders = ordersOf();
|
|
1035
|
+
for (const mark of marks) {
|
|
1036
|
+
const reading = orders.get(mark);
|
|
1037
|
+
mark.reading = reading === undefined ? marks.length : reading;
|
|
1038
|
+
}
|
|
916
1039
|
if (all || changed) {
|
|
917
1040
|
const scroll = scrollOf();
|
|
918
1041
|
report(resultsOf(false, scroll), scroll);
|
|
@@ -1073,9 +1196,10 @@ export const ANNOTATE_RUNTIME = String.raw `if (declared("annotate")) {
|
|
|
1073
1196
|
|
|
1074
1197
|
// A marker's click (P104). The layer takes no pointer but on its markers, so a press whose
|
|
1075
1198
|
// target is the layer is on a marker: the content's handlers never see it (this listener
|
|
1076
|
-
// runs before any of theirs), nor does what lies under it, and a click is reported.
|
|
1077
|
-
//
|
|
1078
|
-
//
|
|
1199
|
+
// runs before any of theirs), nor does what lies under it, and a click is reported. A press
|
|
1200
|
+
// of the mouse or a finger moves no focus; the keyboard reaches a marker as any button
|
|
1201
|
+
// (P133, which reverses P104's no tab stop): it joins the page's focus order, which the
|
|
1202
|
+
// content controls, so the host's own list of marks stays the keyboard way it can rely on.
|
|
1079
1203
|
//
|
|
1080
1204
|
// A press is read and stopped through the platform's own functions and getters, kept now
|
|
1081
1205
|
// (P105), as the navigation guard reads its events (P099): content that later patches
|
|
@@ -1088,6 +1212,11 @@ export const ANNOTATE_RUNTIME = String.raw `if (declared("annotate")) {
|
|
|
1088
1212
|
const targetOf = getterOf(Event.prototype, "target");
|
|
1089
1213
|
const typeOf = getterOf(Event.prototype, "type");
|
|
1090
1214
|
const buttonOf = getterOf(MouseEvent.prototype, "button");
|
|
1215
|
+
const detailOf = getterOf(UIEvent.prototype, "detail");
|
|
1216
|
+
const keyOf = getterOf(KeyboardEvent.prototype, "key");
|
|
1217
|
+
const repeatOf = getterOf(KeyboardEvent.prototype, "repeat");
|
|
1218
|
+
const activeOf = getterOf(ShadowRoot.prototype, "activeElement");
|
|
1219
|
+
const scrollWindow = window.scrollBy;
|
|
1091
1220
|
const clientXOf = getterOf(MouseEvent.prototype, "clientX");
|
|
1092
1221
|
const clientYOf = getterOf(MouseEvent.prototype, "clientY");
|
|
1093
1222
|
const leftOf = getterOf(DOMRectReadOnly.prototype, "left");
|
|
@@ -1104,6 +1233,16 @@ export const ANNOTATE_RUNTIME = String.raw `if (declared("annotate")) {
|
|
|
1104
1233
|
const at = markerHit(markers.length, (i) => markerBox(markers[i].element), x, y, touch);
|
|
1105
1234
|
return at < 0 ? null : markers[at];
|
|
1106
1235
|
};
|
|
1236
|
+
const markerOfNode = (element) => {
|
|
1237
|
+
for (let i = 0; i < markers.length; i += 1) {
|
|
1238
|
+
if (markers[i].element === element) {
|
|
1239
|
+
return markers[i];
|
|
1240
|
+
}
|
|
1241
|
+
}
|
|
1242
|
+
return null;
|
|
1243
|
+
};
|
|
1244
|
+
// The marker with the focus (P133), or null.
|
|
1245
|
+
const focusedMarker = () => (shadow === null || activeOf === null ? null : markerOfNode(callOf(activeOf, shadow, [])));
|
|
1107
1246
|
const isShown = (id) => {
|
|
1108
1247
|
for (let i = 0; i < marks.length; i += 1) {
|
|
1109
1248
|
if (marks[i].id === id) {
|
|
@@ -1133,12 +1272,57 @@ export const ANNOTATE_RUNTIME = String.raw `if (declared("annotate")) {
|
|
|
1133
1272
|
}
|
|
1134
1273
|
// isTrusted is the event's own, unforgeable.
|
|
1135
1274
|
if (type === "click" && event.isTrusted && callOf(buttonOf, event, []) === 0) {
|
|
1275
|
+
// From the keyboard or assistive technology (P133) a click has no count and no place:
|
|
1276
|
+
// it is the focused marker's. Not while elements are picked: the markers step aside.
|
|
1277
|
+
const keyed = callOf(detailOf, event, []) === 0 ? focusedMarker() : null;
|
|
1278
|
+
if (keyed !== null) {
|
|
1279
|
+
if (!mode.elements && isShown(keyed.id)) {
|
|
1280
|
+
tell(M.activated, { id: keyed.id, rect: markerBox(keyed.element) });
|
|
1281
|
+
}
|
|
1282
|
+
return;
|
|
1283
|
+
}
|
|
1136
1284
|
const hit = markerAt(callOf(clientXOf, event, []), callOf(clientYOf, event, []));
|
|
1137
1285
|
if (hit !== null && isShown(hit.id)) {
|
|
1138
1286
|
tell(M.activated, { id: hit.id, rect: markerBox(hit.element) });
|
|
1139
1287
|
}
|
|
1140
1288
|
}
|
|
1141
1289
|
};
|
|
1290
|
+
// The keys that click a focused marker (P133), each stopped as a press is, so the content
|
|
1291
|
+
// neither hears them nor cancels the click they make; it keeps every other key, Tab and
|
|
1292
|
+
// Escape too, as it would on a button of its own, and the host's find shortcut stays. A key
|
|
1293
|
+
// held down clicks once: each repeat would spend the bridge's rate on one press.
|
|
1294
|
+
const onMarkerKey = (event) => {
|
|
1295
|
+
if (layer === null || callOf(targetOf, event, []) !== layer) {
|
|
1296
|
+
return;
|
|
1297
|
+
}
|
|
1298
|
+
const key = callOf(keyOf, event, []);
|
|
1299
|
+
if (key === "Enter" || key === " ") {
|
|
1300
|
+
callOf(stopPress, event, []);
|
|
1301
|
+
if (callOf(repeatOf, event, [])) {
|
|
1302
|
+
callOf(cancelPress, event, []);
|
|
1303
|
+
}
|
|
1304
|
+
}
|
|
1305
|
+
};
|
|
1306
|
+
for (const type of ["keydown", "keypress", "keyup"]) {
|
|
1307
|
+
window.addEventListener(type, onMarkerKey, true);
|
|
1308
|
+
}
|
|
1309
|
+
// The focus on a marker (P133) lights its words, as the pointer does, and brings it into view:
|
|
1310
|
+
// a marker out of view is out of the layer's box, which never scrolls, so the document must.
|
|
1311
|
+
const onMarkerFocus = (event) => {
|
|
1312
|
+
const on = callOf(typeOf, event, []) === "focusin" ? markerOfNode(callOf(targetOf, event, [])) : null;
|
|
1313
|
+
const id = on === null ? null : on.id;
|
|
1314
|
+
if (id !== hot) {
|
|
1315
|
+
hot = id;
|
|
1316
|
+
redraw();
|
|
1317
|
+
}
|
|
1318
|
+
if (on !== null) {
|
|
1319
|
+
const rect = markerBox(on.element);
|
|
1320
|
+
const seen = document.documentElement.clientHeight || window.innerHeight;
|
|
1321
|
+
if (rect.y < 0 || rect.y + rect.height > seen) {
|
|
1322
|
+
callOf(scrollWindow, window, [0, rect.y - (seen - rect.height) / 2]);
|
|
1323
|
+
}
|
|
1324
|
+
}
|
|
1325
|
+
};
|
|
1142
1326
|
// The pointer moving over a marker is stopped too. Narrowing only: the content still sees
|
|
1143
1327
|
// the pointer leave its own element for the layer (relatedTarget), the layer's :hover and
|
|
1144
1328
|
// :active, and the frame's user activation, so it can tell a marker was pressed, and
|
|
@@ -1258,7 +1442,7 @@ export const ANNOTATE_RUNTIME = String.raw `if (declared("annotate")) {
|
|
|
1258
1442
|
return;
|
|
1259
1443
|
}
|
|
1260
1444
|
swallowUntil = performance.now() + 2000;
|
|
1261
|
-
tell(M.selected, { anchor, rect: box(elementRect.call(element)) });
|
|
1445
|
+
tell(M.selected, Object.assign({ anchor, rect: box(elementRect.call(element)) }, placeOf({ element })));
|
|
1262
1446
|
}, HOLD_MS),
|
|
1263
1447
|
};
|
|
1264
1448
|
}, true);
|
|
@@ -1306,7 +1490,7 @@ export const ANNOTATE_RUNTIME = String.raw `if (declared("annotate")) {
|
|
|
1306
1490
|
hover = null;
|
|
1307
1491
|
setCursor(false);
|
|
1308
1492
|
draw();
|
|
1309
|
-
tell(M.selected, { anchor, rect: box(elementRect.call(element)) });
|
|
1493
|
+
tell(M.selected, Object.assign({ anchor, rect: box(elementRect.call(element)) }, placeOf({ element })));
|
|
1310
1494
|
}, true);
|
|
1311
1495
|
window.addEventListener("keydown", (event) => {
|
|
1312
1496
|
if (event.key !== "Escape") {
|
|
@@ -1365,7 +1549,7 @@ export const ANNOTATE_RUNTIME = String.raw `if (declared("annotate")) {
|
|
|
1365
1549
|
}
|
|
1366
1550
|
reported = key;
|
|
1367
1551
|
reportedBox = rect;
|
|
1368
|
-
tell(M.selected, { anchor, rect });
|
|
1552
|
+
tell(M.selected, Object.assign({ anchor, rect }, placeOf({ range })));
|
|
1369
1553
|
return true;
|
|
1370
1554
|
};
|
|
1371
1555
|
document.addEventListener("selectionchange", () => {
|
package/dist/shell/find.d.ts
CHANGED
|
@@ -42,7 +42,7 @@ export declare const FIND_LATEST: string;
|
|
|
42
42
|
* important, so the content's own style sheets can't hide, shrink or move it by accident (its
|
|
43
43
|
* scripts can, P104). The annotation runtime carries the same text (a test holds them equal).
|
|
44
44
|
*/
|
|
45
|
-
export declare const LAYER_STYLE = "position:fixed!important;inset:0!important;width:auto!important;height:auto!important;min-width:0!important;min-height:0!important;max-width:none!important;max-height:none!important;display:block!important;visibility:visible!important;opacity:1!important;pointer-events:none!important;z-index:2147483647!important;overflow:hidden!important;margin:0!important;padding:0!important;border:0!important;background:none!important;transform:none!important;scale:none!important;translate:none!important;rotate:none!important;zoom:1!important;clip-path:none!important;mask:none!important;filter:none!important;content-visibility:visible!important;contain:none!important";
|
|
45
|
+
export declare const LAYER_STYLE = "position:fixed!important;inset:0!important;width:auto!important;height:auto!important;min-width:0!important;min-height:0!important;max-width:none!important;max-height:none!important;display:block!important;visibility:visible!important;opacity:1!important;pointer-events:none!important;z-index:2147483647!important;overflow:hidden!important;overflow:clip!important;margin:0!important;padding:0!important;border:0!important;background:none!important;transform:none!important;scale:none!important;translate:none!important;rotate:none!important;zoom:1!important;clip-path:none!important;mask:none!important;filter:none!important;content-visibility:visible!important;contain:none!important";
|
|
46
46
|
/**
|
|
47
47
|
* The shell's find in page (P131), spliced into the shell's runtime (`__FIND__`) when the config
|
|
48
48
|
* declares `find`, so it runs before any content does, with the DOM's own functions as they were.
|
package/dist/shell/find.js
CHANGED
|
@@ -135,7 +135,7 @@ export const FIND_LATEST = String.raw `(later, time, quiet, run, superseded) =>
|
|
|
135
135
|
* important, so the content's own style sheets can't hide, shrink or move it by accident (its
|
|
136
136
|
* scripts can, P104). The annotation runtime carries the same text (a test holds them equal).
|
|
137
137
|
*/
|
|
138
|
-
export const LAYER_STYLE = "position:fixed!important;inset:0!important;width:auto!important;height:auto!important;min-width:0!important;min-height:0!important;max-width:none!important;max-height:none!important;display:block!important;visibility:visible!important;opacity:1!important;pointer-events:none!important;z-index:2147483647!important;overflow:hidden!important;margin:0!important;padding:0!important;border:0!important;background:none!important;transform:none!important;scale:none!important;translate:none!important;rotate:none!important;zoom:1!important;clip-path:none!important;mask:none!important;filter:none!important;content-visibility:visible!important;contain:none!important";
|
|
138
|
+
export const LAYER_STYLE = "position:fixed!important;inset:0!important;width:auto!important;height:auto!important;min-width:0!important;min-height:0!important;max-width:none!important;max-height:none!important;display:block!important;visibility:visible!important;opacity:1!important;pointer-events:none!important;z-index:2147483647!important;overflow:hidden!important;overflow:clip!important;margin:0!important;padding:0!important;border:0!important;background:none!important;transform:none!important;scale:none!important;translate:none!important;rotate:none!important;zoom:1!important;clip-path:none!important;mask:none!important;filter:none!important;content-visibility:visible!important;contain:none!important";
|
|
139
139
|
/**
|
|
140
140
|
* The shell's find in page (P131), spliced into the shell's runtime (`__FIND__`) when the config
|
|
141
141
|
* declares `find`, so it runs before any content does, with the DOM's own functions as they were.
|
package/docs/ADOPTING.md
CHANGED
|
@@ -251,9 +251,10 @@ createHost(config, {
|
|
|
251
251
|
With `annotate` declared (`capabilities: { annotate: {} }`), a host lets people point at a
|
|
252
252
|
display and keeps its comments beside it ([P053](DECISIONS.md), P104). Everything the frame
|
|
253
253
|
reports is the page's word: a hint where to draw, never a permission. A mark's `count` puts a
|
|
254
|
-
numbered marker
|
|
255
|
-
|
|
256
|
-
|
|
254
|
+
numbered marker, a button, at the end of its words' paragraph (P133); a click on one, or Enter or
|
|
255
|
+
Space with the keyboard on it, is `activated`. A draft, a comment its author hasn't posted yet
|
|
256
|
+
(`kind: "draft"`, P107), is drawn apart, beside its own words: a dashed line and a hollow marker
|
|
257
|
+
with no number, which is clicked and followed as a posted one is.
|
|
257
258
|
|
|
258
259
|
```js
|
|
259
260
|
display.annotations.show([
|
|
@@ -414,6 +415,33 @@ composer.onClose(() => display.annotations.clearSelection());
|
|
|
414
415
|
|
|
415
416
|
A page that scrolls a box of its own rather than its document moves the places of the marks in
|
|
416
417
|
it as it scrolls; show again (or follow such a mark) to hear them again.
|
|
418
|
+
- **After the last line** (P133): for UI after a selection's or a mark's words rather than beside
|
|
419
|
+
their whole box (a composer's button, a card), a newer shell gives `selected`, each attached
|
|
420
|
+
result and `tracked` a `lastLineDocumentRect`: the last line with words on it, in the document's
|
|
421
|
+
coordinates (an element's whole box: it has no lines), unclamped as `documentRect` is. `selected`
|
|
422
|
+
carries the `scroll` it was read at too; an `anchored` report and `tracked` already do. A line's
|
|
423
|
+
end in the frame's viewport is `x + width - scroll.x`, its bottom `y + height - scroll.y`. Clip
|
|
424
|
+
what you draw from it, as above, and keep `rect` where it is absent (an older shell):
|
|
425
|
+
|
|
426
|
+
```js
|
|
427
|
+
display.on("annotation", (report) => {
|
|
428
|
+
if (report.type !== "selected") return;
|
|
429
|
+
const line = report.lastLineDocumentRect;
|
|
430
|
+
const at = line
|
|
431
|
+
? { x: line.x + line.width - report.scroll.x, y: line.y + line.height - report.scroll.y }
|
|
432
|
+
: { x: report.rect.x + report.rect.width, y: report.rect.y + report.rect.height };
|
|
433
|
+
composer.openAt(frame, clipToFrame(at), report.anchor); // the frame's px: clip them, then add its position
|
|
434
|
+
});
|
|
435
|
+
```
|
|
436
|
+
- **The keyboard** (P133): each marker is a button in the frame's Tab order, after the page's own
|
|
437
|
+
stops, in reading order, named for what it is ("3 comments on …", from the `count` and the
|
|
438
|
+
anchor's `label`; in English, whatever your UI's language). Enter or Space on it is `activated`,
|
|
439
|
+
through the same path and the same gesture check as a click: nothing to handle apart. It is the
|
|
440
|
+
page's focus order, which a page can steal from or hide a marker from, and it is one more
|
|
441
|
+
`activated` the content can time: keep your own list of marks as the way a keyboard can rely on,
|
|
442
|
+
with `annotations.focus(id)` to bring one into view, and leave your view's guard as it is (it
|
|
443
|
+
takes no key for 500 ms either, and takes no focus: Enter again on the marker is one more
|
|
444
|
+
`activated`).
|
|
417
445
|
- **Labels and quotes are the page's text**: shown only as text. Porthole takes out of a label what
|
|
418
446
|
the person can't see; a quote (`exact`) keeps it, to be found again. Hand either to a model only
|
|
419
447
|
as the page's words.
|
package/docs/ARCHITECTURE.md
CHANGED
|
@@ -326,9 +326,10 @@ several displays on one page are in [THREAT_MODEL.md](THREAT_MODEL.md).
|
|
|
326
326
|
`/server` from the host's store at `/_blob/<id>` on the artifact's origin.
|
|
327
327
|
- **Annotations** (`annotate`): the host drives a select mode and marks anchors in
|
|
328
328
|
the shell; anchors are W3C Web Annotation selectors a host stores with its own
|
|
329
|
-
comments (P053). A mark may carry a count, drawn as a
|
|
330
|
-
the host hears and answers with its own UI outside
|
|
331
|
-
draft, its author's unposted comment, drawn apart with a
|
|
329
|
+
comments (P053). A mark may carry a count, drawn as a marker, a button at its
|
|
330
|
+
paragraph's end (P133), whose click the host hears and answers with its own UI outside
|
|
331
|
+
the frame (P104), and may be a draft, its author's unposted comment, drawn apart with a
|
|
332
|
+
hollow marker (P107).
|
|
332
333
|
- **Find in page** (`find`): the host draws its own find bar and asks the shell for
|
|
333
334
|
a query (`porthole/find.query`, a request: how many matches, which is current);
|
|
334
335
|
the shell finds it in the same text index annotations read, highlights it in a layer
|