@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/src/shell/annotate.ts
CHANGED
|
@@ -51,17 +51,21 @@ export const MARKER_HIT = String.raw`(count, boxAt, x, y, touch) => {
|
|
|
51
51
|
* was, its text anywhere, its words with any spacing) and drawn over it, in a layer of the
|
|
52
52
|
* shell's own (a closed shadow root), again whenever the content changes; what can't be found
|
|
53
53
|
* is reported `orphaned`;
|
|
54
|
-
* - markers (P104): a mark with a count gets a small
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
*
|
|
54
|
+
* - markers (P104): a mark with a count gets a small button with the number, a bubble: a text
|
|
55
|
+
* anchor's at its paragraph's end (P133), a draft's (P107) beside its anchor's last line (P105:
|
|
56
|
+
* in the line's gutter), an element's on its corner; a click on it, or Enter or Space with the
|
|
57
|
+
* focus on it (P133), is reported (`activated`), and the content's own handlers never see it; a
|
|
58
|
+
* draft is drawn apart, a dashed line and a hollow bubble with no number, and has a marker with
|
|
59
|
+
* or without a count;
|
|
58
60
|
* - following: while a mark has a marker, once a scroll, a resize or a change of the content
|
|
59
61
|
* settles, the marks that moved since the host was last told are reported, at most once a
|
|
60
62
|
* second, so the host's own UI beside a mark can follow;
|
|
61
63
|
* - places in the document (P132): each result's box also in the document's coordinates
|
|
62
64
|
* (`documentRect`), with how far the document was scrolled as it was read (`scroll`), and the
|
|
63
65
|
* followed mark's (`tracked`) too, so a host places marks scrolled out of the frame, and keeps
|
|
64
|
-
* them placed as the document scrolls, from one report and the followed mark's scroll
|
|
66
|
+
* them placed as the document scrolls, from one report and the followed mark's scroll;
|
|
67
|
+
* - the last line (P133): where a selection or a mark's words end, in the document's coordinates
|
|
68
|
+
* too (`lastLineDocumentRect`), so a host places its UI after them.
|
|
65
69
|
*
|
|
66
70
|
* It shares the realm with the content, which can interfere with all of it: the host takes its
|
|
67
71
|
* reports as UI hints only.
|
|
@@ -323,6 +327,19 @@ export const ANNOTATE_RUNTIME = String.raw`if (declared("annotate")) {
|
|
|
323
327
|
};
|
|
324
328
|
// A box in the viewport, in the document (P132): where it is as the document scrolls.
|
|
325
329
|
const inDocument = (rect, scroll) => ({ x: rect.x + scroll.x, y: rect.y + scroll.y, width: rect.width, height: rect.height });
|
|
330
|
+
// Where what was found ends (P133), in the document as a documentRect is: its last line with
|
|
331
|
+
// words on it, or an element's whole box (it has no lines of its own). Null with nothing drawn.
|
|
332
|
+
const lastLineOf = (found, scroll) => {
|
|
333
|
+
const rect = found.range ? lastBox(rangeRects.call(found.range)) : elementRect.call(found.element);
|
|
334
|
+
return rect === null ? null : inDocument(box(rect), scroll);
|
|
335
|
+
};
|
|
336
|
+
// What a selection's report adds to its box (P133): its last line, with the scroll it was
|
|
337
|
+
// read at; neither where nothing of it is drawn.
|
|
338
|
+
const placeOf = (found) => {
|
|
339
|
+
const scroll = scrollOf();
|
|
340
|
+
const lastLineDocumentRect = lastLineOf(found, scroll);
|
|
341
|
+
return lastLineDocumentRect === null ? {} : { lastLineDocumentRect, scroll };
|
|
342
|
+
};
|
|
326
343
|
|
|
327
344
|
// The shell's own layer, over the content: marks, the outline of what would be picked.
|
|
328
345
|
let layer = null;
|
|
@@ -337,18 +354,22 @@ export const ANNOTATE_RUNTIME = String.raw`if (declared("annotate")) {
|
|
|
337
354
|
// marker hollow, a light bubble with a dashed edge and the glyph's outline, no number.
|
|
338
355
|
// While the last pointer was a finger or a pen (P119), each marker takes the pointer in a
|
|
339
356
|
// box of at least 44 by 44 px centred on its own (an invisible ::before; 100% is its padding
|
|
340
|
-
// box, its border 1 px), so a tap a few px off still lands on the shell's layer.
|
|
341
|
-
|
|
357
|
+
// box, its border 1 px), so a tap a few px off still lands on the shell's layer. A marker is
|
|
358
|
+
// a real button (P133): what a browser gives one is taken off, a ring says it has the focus.
|
|
359
|
+
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}";
|
|
342
360
|
// Inline and important: the content's own style sheets can't hide, shrink or move it by
|
|
343
361
|
// accident. Set again at each draw, since its scripts can rewrite it (narrowing only: the
|
|
344
|
-
// content can still cover the layer, or move it with its ancestors, P104).
|
|
345
|
-
|
|
362
|
+
// content can still cover the layer, or move it with its ancestors, P104). Clipped, where an
|
|
363
|
+
// engine has it, not hidden: hidden is a box a focused marker out of view would scroll (P133).
|
|
364
|
+
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";
|
|
346
365
|
const ensureLayer = () => {
|
|
347
366
|
if (layer === null) {
|
|
348
367
|
layer = createElement.call(document, "div");
|
|
349
|
-
layer.setAttribute("aria-hidden", "true");
|
|
350
368
|
layer.setAttribute("data-porthole-annotations", "");
|
|
351
369
|
shadow = attachShadow.call(layer, { mode: "closed" });
|
|
370
|
+
// Within the shadow root: a focus moving from one marker to the next never leaves it.
|
|
371
|
+
callOf(listenOn, shadow, ["focusin", onMarkerFocus]);
|
|
372
|
+
callOf(listenOn, shadow, ["focusout", onMarkerFocus]);
|
|
352
373
|
}
|
|
353
374
|
if (layer.style.cssText !== LAYER_STYLE) {
|
|
354
375
|
layer.style.cssText = LAYER_STYLE;
|
|
@@ -380,6 +401,13 @@ export const ANNOTATE_RUNTIME = String.raw`if (declared("annotate")) {
|
|
|
380
401
|
const markerWidth = (label) => Math.max(MARKER_HEIGHT, 23 + (label === "" ? 0 : 3 + label.length * 7));
|
|
381
402
|
// Compact (P105): the number alone, or the glyph alone for none, with less padding.
|
|
382
403
|
const compactWidth = (label) => (label === "" ? 21 : Math.max(MARKER_HEIGHT, 10 + label.length * 7));
|
|
404
|
+
// What a marker is called (P133), to whoever can't see it: what it is, and the words it is
|
|
405
|
+
// on. In English, whatever the page's language: the shell has no words of the host's.
|
|
406
|
+
const nameOf = (mark) => {
|
|
407
|
+
const words = typeof mark.anchor.label === "string" ? squash(mark.anchor.label).slice(0, LIMIT.label) : "";
|
|
408
|
+
const what = mark.draft ? "Draft comment" : mark.count === 1 ? "1 comment" : mark.count > 1 ? mark.count + " comments" : "Comment";
|
|
409
|
+
return words === "" ? what : what + " on " + words;
|
|
410
|
+
};
|
|
383
411
|
// A rect's last line with words on it: its last box with a width, else any with a size.
|
|
384
412
|
const lastBox = (rects) => {
|
|
385
413
|
let any = null;
|
|
@@ -403,7 +431,9 @@ export const ANNOTATE_RUNTIME = String.raw`if (declared("annotate")) {
|
|
|
403
431
|
// in a row of them), just past the line's last word. Markers on one line of one block go
|
|
404
432
|
// together, in the order their words end. Where the bubble with its glyph fits in none of
|
|
405
433
|
// these, the number alone does (compact); where that fits in none either (a full line on a
|
|
406
|
-
// narrow screen), it goes as far right as it can, over the line's end.
|
|
434
|
+
// narrow screen), it goes as far right as it can, over the line's end. A posted comment's
|
|
435
|
+
// marker (P133) is placed the same way on its paragraph's last line instead, where nothing
|
|
436
|
+
// follows its words, and first tries just past that line's last word.
|
|
407
437
|
const computedOf = window.getComputedStyle;
|
|
408
438
|
const elementsAt = Document.prototype.elementsFromPoint;
|
|
409
439
|
const containsOf = Node.prototype.contains;
|
|
@@ -463,6 +493,52 @@ export const ANNOTATE_RUNTIME = String.raw`if (declared("annotate")) {
|
|
|
463
493
|
}
|
|
464
494
|
return end;
|
|
465
495
|
};
|
|
496
|
+
// The end of the paragraph an anchor ends in (P133): a range over the block's last words
|
|
497
|
+
// that are drawn, from the anchor's end on, as far as a block inside it (a nested list, say:
|
|
498
|
+
// its words are their own paragraph), 256 text nodes at most. Null if none follow the anchor.
|
|
499
|
+
const inBlock = (node, block) => {
|
|
500
|
+
for (let at = node.parentElement; at !== null && at !== block; at = at.parentElement) {
|
|
501
|
+
if (!INLINE.test(computedOf.call(window, at).display)) {
|
|
502
|
+
return false;
|
|
503
|
+
}
|
|
504
|
+
}
|
|
505
|
+
return true;
|
|
506
|
+
};
|
|
507
|
+
const paragraphEnd = (range, block) => {
|
|
508
|
+
const start = range.endContainer;
|
|
509
|
+
if (start.nodeType !== 3) {
|
|
510
|
+
return null;
|
|
511
|
+
}
|
|
512
|
+
const walker = createTreeWalker.call(document, block, NodeFilter.SHOW_TEXT);
|
|
513
|
+
walker.currentNode = start;
|
|
514
|
+
let end = null;
|
|
515
|
+
let node = start;
|
|
516
|
+
for (let pieces = 0; node !== null && pieces < 256; pieces += 1) {
|
|
517
|
+
if (node !== start && !inBlock(node, block)) {
|
|
518
|
+
break;
|
|
519
|
+
}
|
|
520
|
+
const words = node.nodeValue;
|
|
521
|
+
const first = node === start ? range.endOffset : 0;
|
|
522
|
+
let to = words.length;
|
|
523
|
+
while (to > first && /\s/.test(words.charAt(to - 1))) {
|
|
524
|
+
to -= 1;
|
|
525
|
+
}
|
|
526
|
+
if (to > first) {
|
|
527
|
+
const piece = createRange.call(document);
|
|
528
|
+
try {
|
|
529
|
+
piece.setStart(node, Math.max(first, to - 2));
|
|
530
|
+
piece.setEnd(node, to);
|
|
531
|
+
} catch (_) {
|
|
532
|
+
return end;
|
|
533
|
+
}
|
|
534
|
+
if (lastBox(rangeRects.call(piece)) !== null) {
|
|
535
|
+
end = piece;
|
|
536
|
+
}
|
|
537
|
+
}
|
|
538
|
+
node = walker.nextNode();
|
|
539
|
+
}
|
|
540
|
+
return end;
|
|
541
|
+
};
|
|
466
542
|
// Nothing of the content's at a point but a box that holds the block (its background); a
|
|
467
543
|
// point out of view hides nothing.
|
|
468
544
|
const clearAt = (x, y, block) => {
|
|
@@ -515,7 +591,11 @@ export const ANNOTATE_RUNTIME = String.raw`if (declared("annotate")) {
|
|
|
515
591
|
return null;
|
|
516
592
|
};
|
|
517
593
|
const gutter = right + gap;
|
|
518
|
-
|
|
594
|
+
// A paragraph's end (P133): just past its last word, where the line leaves the room.
|
|
595
|
+
let left = line.ending ? fits(line.words + gap, false) : null;
|
|
596
|
+
if (left === null) {
|
|
597
|
+
left = fits(gutter, false);
|
|
598
|
+
}
|
|
519
599
|
if (left === null && gutter > most) {
|
|
520
600
|
left = fits(most, true);
|
|
521
601
|
}
|
|
@@ -527,7 +607,8 @@ export const ANNOTATE_RUNTIME = String.raw`if (declared("annotate")) {
|
|
|
527
607
|
const placeLines = (wanted, placed, room) => {
|
|
528
608
|
// One line of one block: markers whose last lines share a middle.
|
|
529
609
|
const lines = [];
|
|
530
|
-
|
|
610
|
+
// In the order their words end, those at one paragraph's end too.
|
|
611
|
+
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);
|
|
531
612
|
for (const each of wanted) {
|
|
532
613
|
const middle = each.at.top + each.at.height / 2;
|
|
533
614
|
let line = null;
|
|
@@ -537,10 +618,11 @@ export const ANNOTATE_RUNTIME = String.raw`if (declared("annotate")) {
|
|
|
537
618
|
}
|
|
538
619
|
}
|
|
539
620
|
if (line === null) {
|
|
540
|
-
line = { block: each.block, middle, height: each.at.height, bottom: each.at.bottom, range: each.range, at: each.at, items: [] };
|
|
621
|
+
line = { block: each.block, middle, height: each.at.height, bottom: each.at.bottom, range: each.range, at: each.at, ending: false, items: [] };
|
|
541
622
|
lines.push(line);
|
|
542
623
|
}
|
|
543
624
|
line.items.push(each);
|
|
625
|
+
line.ending = line.ending || each.ending;
|
|
544
626
|
if (each.at.right > line.at.right) {
|
|
545
627
|
line.at = each.at;
|
|
546
628
|
line.range = each.range;
|
|
@@ -619,20 +701,24 @@ export const ANNOTATE_RUNTIME = String.raw`if (declared("annotate")) {
|
|
|
619
701
|
const kept = markerNodes.get(mark.id);
|
|
620
702
|
let marker = kept ? kept.element : null;
|
|
621
703
|
if (marker === null) {
|
|
622
|
-
|
|
623
|
-
//
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
704
|
+
// A real button (P133): the keyboard reaches it, Enter and Space click it, assistive
|
|
705
|
+
// technology names it, and WebKit makes a tap a click on it (P105).
|
|
706
|
+
marker = createElement.call(document, "button");
|
|
707
|
+
marker.setAttribute("type", "button");
|
|
708
|
+
}
|
|
709
|
+
// Stepped aside while elements are picked, from the keyboard too. Set, not left to the
|
|
710
|
+
// button: Safari's Tab skips a button without one, unless the person asked otherwise.
|
|
711
|
+
marker.tabIndex = mode.elements ? -1 : 0;
|
|
628
712
|
marker.className = "marker" + (mark.draft ? " draft" : "") + (each.compact ? " compact" : "") + (mark.id === active ? " active" : "") + (mode.elements ? " inert" : "");
|
|
629
713
|
marker.style.cssText = "left:" + each.left + "px;top:" + each.top + "px";
|
|
630
714
|
markers.push({ id: mark.id, element: marker });
|
|
631
|
-
const
|
|
715
|
+
const name = nameOf(mark);
|
|
716
|
+
const form = (mark.draft ? "draft:" : "") + (each.compact ? "compact:" : "full:") + label + ":" + name;
|
|
632
717
|
if (kept && kept.form === form) {
|
|
633
718
|
return marker;
|
|
634
719
|
}
|
|
635
720
|
markerNodes.set(mark.id, { element: marker, form });
|
|
721
|
+
marker.setAttribute("aria-label", name);
|
|
636
722
|
marker.replaceChildren();
|
|
637
723
|
if (!each.compact || label === "") {
|
|
638
724
|
const glyph = createElementNS.call(document, SVG, "svg");
|
|
@@ -659,10 +745,9 @@ export const ANNOTATE_RUNTIME = String.raw`if (declared("annotate")) {
|
|
|
659
745
|
}
|
|
660
746
|
return marker;
|
|
661
747
|
};
|
|
662
|
-
const tapTarget = () => {};
|
|
663
748
|
let active = null;
|
|
664
|
-
// The mark whose marker the pointer is over: its words are lit as
|
|
665
|
-
// a marker in the gutter shows which words it is for (P105).
|
|
749
|
+
// The mark whose marker the pointer is over, or the focus is on (P133): its words are lit as
|
|
750
|
+
// the active mark's are, so a marker in the gutter shows which words it is for (P105).
|
|
666
751
|
let hot = null;
|
|
667
752
|
let flashing = null;
|
|
668
753
|
let flashUntil = 0;
|
|
@@ -678,6 +763,10 @@ export const ANNOTATE_RUNTIME = String.raw`if (declared("annotate")) {
|
|
|
678
763
|
style.nonce = nonce;
|
|
679
764
|
}
|
|
680
765
|
boxes = { style, marks: createElement.call(document, "div"), markers: createElement.call(document, "div"), hover: createElement.call(document, "div") };
|
|
766
|
+
// Only the markers are for assistive technology (P133): the rest draws what the page
|
|
767
|
+
// already says.
|
|
768
|
+
boxes.marks.setAttribute("aria-hidden", "true");
|
|
769
|
+
boxes.hover.setAttribute("aria-hidden", "true");
|
|
681
770
|
root.replaceChildren(boxes.style, boxes.marks, boxes.markers, boxes.hover);
|
|
682
771
|
}
|
|
683
772
|
if (boxes.style.textContent !== STYLE) {
|
|
@@ -699,6 +788,7 @@ export const ANNOTATE_RUNTIME = String.raw`if (declared("annotate")) {
|
|
|
699
788
|
// What is measured first, then drawn: no node of the layer changes while the page is read.
|
|
700
789
|
const corners = [];
|
|
701
790
|
const wanted = [];
|
|
791
|
+
const focused = focusedMarker() !== null;
|
|
702
792
|
markers = [];
|
|
703
793
|
for (const mark of marks) {
|
|
704
794
|
if (mark.found === null) {
|
|
@@ -719,14 +809,28 @@ export const ANNOTATE_RUNTIME = String.raw`if (declared("annotate")) {
|
|
|
719
809
|
if (at !== null) {
|
|
720
810
|
// A draft's marker has no number (P107).
|
|
721
811
|
const label = mark.draft ? "" : labelOf(mark.count);
|
|
722
|
-
const each = { mark,
|
|
812
|
+
const each = { mark, label, width: markerWidth(label), small: compactWidth(label), compact: false, at, words: at, left: 0, top: 0, ending: false };
|
|
723
813
|
if (mark.found.range) {
|
|
724
814
|
// Kept while it still holds the words (P105): a change elsewhere doesn't move them.
|
|
725
815
|
if (mark.block === undefined || !mark.block.isConnected || !containsOf.call(mark.block, mark.found.range.endContainer)) {
|
|
726
816
|
mark.block = blockOf(mark.found.range);
|
|
817
|
+
mark.end = undefined;
|
|
727
818
|
}
|
|
728
819
|
each.range = mark.found.range;
|
|
729
820
|
each.block = mark.block;
|
|
821
|
+
// A posted comment's, at its paragraph's end (P133); read once for what was found,
|
|
822
|
+
// since a block's words can be long. A draft's stays by the words being written on.
|
|
823
|
+
if (!mark.draft) {
|
|
824
|
+
each.ending = true;
|
|
825
|
+
if (mark.end === undefined) {
|
|
826
|
+
mark.end = paragraphEnd(mark.found.range, mark.block);
|
|
827
|
+
}
|
|
828
|
+
const last = mark.end === null ? null : lastBox(rangeRects.call(mark.end));
|
|
829
|
+
if (last !== null) {
|
|
830
|
+
each.at = last;
|
|
831
|
+
each.range = mark.end;
|
|
832
|
+
}
|
|
833
|
+
}
|
|
730
834
|
wanted.push(each);
|
|
731
835
|
} else {
|
|
732
836
|
corners.push(each);
|
|
@@ -742,18 +846,25 @@ export const ANNOTATE_RUNTIME = String.raw`if (declared("annotate")) {
|
|
|
742
846
|
}
|
|
743
847
|
// The layer's own boxes out of the way while places are hit-tested (P105): each test
|
|
744
848
|
// otherwise walks every mark and marker the last draw left (0.13 ms each, 300 of them).
|
|
849
|
+
// A marker with the focus would lose it out of the display (P133): while the person is on
|
|
850
|
+
// one, the markers only stop taking the pointer, which the tests skip but still walk.
|
|
745
851
|
if (wanted.length > 0) {
|
|
746
852
|
into.marks.style.display = "none";
|
|
747
|
-
|
|
853
|
+
if (focused) {
|
|
854
|
+
into.markers.setAttribute("data-placing", "");
|
|
855
|
+
} else {
|
|
856
|
+
into.markers.style.display = "none";
|
|
857
|
+
}
|
|
748
858
|
try {
|
|
749
859
|
placeLines(wanted, placed, room);
|
|
750
860
|
} finally {
|
|
751
861
|
into.marks.style.display = "";
|
|
752
862
|
into.markers.style.display = "";
|
|
863
|
+
into.markers.removeAttribute("data-placing");
|
|
753
864
|
}
|
|
754
865
|
}
|
|
755
866
|
const badges = [];
|
|
756
|
-
for (const each of corners.concat(wanted).sort((a, b) => a.
|
|
867
|
+
for (const each of corners.concat(wanted).sort((a, b) => a.mark.reading - b.mark.reading)) {
|
|
757
868
|
badges.push(markerOf(each));
|
|
758
869
|
}
|
|
759
870
|
for (const id of Array.from(markerNodes.keys())) {
|
|
@@ -779,11 +890,14 @@ export const ANNOTATE_RUNTIME = String.raw`if (declared("annotate")) {
|
|
|
779
890
|
into.markers.removeChild(child);
|
|
780
891
|
}
|
|
781
892
|
}
|
|
782
|
-
|
|
783
|
-
|
|
784
|
-
|
|
893
|
+
// In reading order, the Tab key's (P133). A marker that stays in its place isn't touched
|
|
894
|
+
// (a press spans a redraw, above), and none moves while one has the focus: it would lose it.
|
|
895
|
+
badges.forEach((badge, at) => {
|
|
896
|
+
const there = into.markers.childNodes[at] || null;
|
|
897
|
+
if (badge.parentNode !== into.markers || (!focused && there !== badge)) {
|
|
898
|
+
into.markers.insertBefore(badge, focused ? null : there);
|
|
785
899
|
}
|
|
786
|
-
}
|
|
900
|
+
});
|
|
787
901
|
into.hover.replaceChildren(...outlines);
|
|
788
902
|
};
|
|
789
903
|
let drawing = false;
|
|
@@ -819,7 +933,8 @@ export const ANNOTATE_RUNTIME = String.raw`if (declared("annotate")) {
|
|
|
819
933
|
// Its box moves as the document scrolls, inside the frame or not: each one tells the
|
|
820
934
|
// host the scroll, for every mark it places by its place in the document (P132).
|
|
821
935
|
const scroll = scrollOf();
|
|
822
|
-
|
|
936
|
+
const lastLineDocumentRect = lastLineOf(mark.found, scroll);
|
|
937
|
+
tell(M.tracked, Object.assign({ id: tracking, rect, documentRect: inDocument(rect, scroll), scroll }, lastLineDocumentRect === null ? {} : { lastLineDocumentRect }));
|
|
823
938
|
}
|
|
824
939
|
}
|
|
825
940
|
trackFrame = nextFrame(trackTick);
|
|
@@ -863,15 +978,16 @@ export const ANNOTATE_RUNTIME = String.raw`if (declared("annotate")) {
|
|
|
863
978
|
placed.forEach((each, at) => orders.set(each.mark, at));
|
|
864
979
|
return orders;
|
|
865
980
|
};
|
|
866
|
-
// A mark's result: its box in the viewport, and in the document (P132)
|
|
867
|
-
// report's one reading of it.
|
|
981
|
+
// A mark's result: its box in the viewport, and in the document (P132), its last line too
|
|
982
|
+
// (P133), by scroll, the report's one reading of it.
|
|
868
983
|
const resultOf = (mark, orders, scroll) => {
|
|
869
984
|
if (mark.found === null) {
|
|
870
985
|
return { id: mark.id, state: "orphaned" };
|
|
871
986
|
}
|
|
872
987
|
const order = (orders || ordersOf()).get(mark);
|
|
873
988
|
const rect = box(rectOf(mark.found));
|
|
874
|
-
|
|
989
|
+
const lastLineDocumentRect = lastLineOf(mark.found, scroll);
|
|
990
|
+
return Object.assign({ id: mark.id, state: "attached", rect, documentRect: inDocument(rect, scroll) }, lastLineDocumentRect === null ? {} : { lastLineDocumentRect }, order === undefined ? {} : { order });
|
|
875
991
|
};
|
|
876
992
|
// Two boxes more than 0.5 px apart on any side (or one of them unknown).
|
|
877
993
|
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;
|
|
@@ -913,8 +1029,15 @@ export const ANNOTATE_RUNTIME = String.raw`if (declared("annotate")) {
|
|
|
913
1029
|
changed = true;
|
|
914
1030
|
}
|
|
915
1031
|
mark.found = found;
|
|
1032
|
+
mark.end = undefined;
|
|
916
1033
|
mark.state = state;
|
|
917
1034
|
}
|
|
1035
|
+
// Where each starts, once for each finding: the markers' reading order (P133).
|
|
1036
|
+
const orders = ordersOf();
|
|
1037
|
+
for (const mark of marks) {
|
|
1038
|
+
const reading = orders.get(mark);
|
|
1039
|
+
mark.reading = reading === undefined ? marks.length : reading;
|
|
1040
|
+
}
|
|
918
1041
|
if (all || changed) {
|
|
919
1042
|
const scroll = scrollOf();
|
|
920
1043
|
report(resultsOf(false, scroll), scroll);
|
|
@@ -1075,9 +1198,10 @@ export const ANNOTATE_RUNTIME = String.raw`if (declared("annotate")) {
|
|
|
1075
1198
|
|
|
1076
1199
|
// A marker's click (P104). The layer takes no pointer but on its markers, so a press whose
|
|
1077
1200
|
// target is the layer is on a marker: the content's handlers never see it (this listener
|
|
1078
|
-
// runs before any of theirs), nor does what lies under it, and a click is reported.
|
|
1079
|
-
//
|
|
1080
|
-
//
|
|
1201
|
+
// runs before any of theirs), nor does what lies under it, and a click is reported. A press
|
|
1202
|
+
// of the mouse or a finger moves no focus; the keyboard reaches a marker as any button
|
|
1203
|
+
// (P133, which reverses P104's no tab stop): it joins the page's focus order, which the
|
|
1204
|
+
// content controls, so the host's own list of marks stays the keyboard way it can rely on.
|
|
1081
1205
|
//
|
|
1082
1206
|
// A press is read and stopped through the platform's own functions and getters, kept now
|
|
1083
1207
|
// (P105), as the navigation guard reads its events (P099): content that later patches
|
|
@@ -1090,6 +1214,11 @@ export const ANNOTATE_RUNTIME = String.raw`if (declared("annotate")) {
|
|
|
1090
1214
|
const targetOf = getterOf(Event.prototype, "target");
|
|
1091
1215
|
const typeOf = getterOf(Event.prototype, "type");
|
|
1092
1216
|
const buttonOf = getterOf(MouseEvent.prototype, "button");
|
|
1217
|
+
const detailOf = getterOf(UIEvent.prototype, "detail");
|
|
1218
|
+
const keyOf = getterOf(KeyboardEvent.prototype, "key");
|
|
1219
|
+
const repeatOf = getterOf(KeyboardEvent.prototype, "repeat");
|
|
1220
|
+
const activeOf = getterOf(ShadowRoot.prototype, "activeElement");
|
|
1221
|
+
const scrollWindow = window.scrollBy;
|
|
1093
1222
|
const clientXOf = getterOf(MouseEvent.prototype, "clientX");
|
|
1094
1223
|
const clientYOf = getterOf(MouseEvent.prototype, "clientY");
|
|
1095
1224
|
const leftOf = getterOf(DOMRectReadOnly.prototype, "left");
|
|
@@ -1106,6 +1235,16 @@ export const ANNOTATE_RUNTIME = String.raw`if (declared("annotate")) {
|
|
|
1106
1235
|
const at = markerHit(markers.length, (i) => markerBox(markers[i].element), x, y, touch);
|
|
1107
1236
|
return at < 0 ? null : markers[at];
|
|
1108
1237
|
};
|
|
1238
|
+
const markerOfNode = (element) => {
|
|
1239
|
+
for (let i = 0; i < markers.length; i += 1) {
|
|
1240
|
+
if (markers[i].element === element) {
|
|
1241
|
+
return markers[i];
|
|
1242
|
+
}
|
|
1243
|
+
}
|
|
1244
|
+
return null;
|
|
1245
|
+
};
|
|
1246
|
+
// The marker with the focus (P133), or null.
|
|
1247
|
+
const focusedMarker = () => (shadow === null || activeOf === null ? null : markerOfNode(callOf(activeOf, shadow, [])));
|
|
1109
1248
|
const isShown = (id) => {
|
|
1110
1249
|
for (let i = 0; i < marks.length; i += 1) {
|
|
1111
1250
|
if (marks[i].id === id) {
|
|
@@ -1135,12 +1274,57 @@ export const ANNOTATE_RUNTIME = String.raw`if (declared("annotate")) {
|
|
|
1135
1274
|
}
|
|
1136
1275
|
// isTrusted is the event's own, unforgeable.
|
|
1137
1276
|
if (type === "click" && event.isTrusted && callOf(buttonOf, event, []) === 0) {
|
|
1277
|
+
// From the keyboard or assistive technology (P133) a click has no count and no place:
|
|
1278
|
+
// it is the focused marker's. Not while elements are picked: the markers step aside.
|
|
1279
|
+
const keyed = callOf(detailOf, event, []) === 0 ? focusedMarker() : null;
|
|
1280
|
+
if (keyed !== null) {
|
|
1281
|
+
if (!mode.elements && isShown(keyed.id)) {
|
|
1282
|
+
tell(M.activated, { id: keyed.id, rect: markerBox(keyed.element) });
|
|
1283
|
+
}
|
|
1284
|
+
return;
|
|
1285
|
+
}
|
|
1138
1286
|
const hit = markerAt(callOf(clientXOf, event, []), callOf(clientYOf, event, []));
|
|
1139
1287
|
if (hit !== null && isShown(hit.id)) {
|
|
1140
1288
|
tell(M.activated, { id: hit.id, rect: markerBox(hit.element) });
|
|
1141
1289
|
}
|
|
1142
1290
|
}
|
|
1143
1291
|
};
|
|
1292
|
+
// The keys that click a focused marker (P133), each stopped as a press is, so the content
|
|
1293
|
+
// neither hears them nor cancels the click they make; it keeps every other key, Tab and
|
|
1294
|
+
// Escape too, as it would on a button of its own, and the host's find shortcut stays. A key
|
|
1295
|
+
// held down clicks once: each repeat would spend the bridge's rate on one press.
|
|
1296
|
+
const onMarkerKey = (event) => {
|
|
1297
|
+
if (layer === null || callOf(targetOf, event, []) !== layer) {
|
|
1298
|
+
return;
|
|
1299
|
+
}
|
|
1300
|
+
const key = callOf(keyOf, event, []);
|
|
1301
|
+
if (key === "Enter" || key === " ") {
|
|
1302
|
+
callOf(stopPress, event, []);
|
|
1303
|
+
if (callOf(repeatOf, event, [])) {
|
|
1304
|
+
callOf(cancelPress, event, []);
|
|
1305
|
+
}
|
|
1306
|
+
}
|
|
1307
|
+
};
|
|
1308
|
+
for (const type of ["keydown", "keypress", "keyup"]) {
|
|
1309
|
+
window.addEventListener(type, onMarkerKey, true);
|
|
1310
|
+
}
|
|
1311
|
+
// The focus on a marker (P133) lights its words, as the pointer does, and brings it into view:
|
|
1312
|
+
// a marker out of view is out of the layer's box, which never scrolls, so the document must.
|
|
1313
|
+
const onMarkerFocus = (event) => {
|
|
1314
|
+
const on = callOf(typeOf, event, []) === "focusin" ? markerOfNode(callOf(targetOf, event, [])) : null;
|
|
1315
|
+
const id = on === null ? null : on.id;
|
|
1316
|
+
if (id !== hot) {
|
|
1317
|
+
hot = id;
|
|
1318
|
+
redraw();
|
|
1319
|
+
}
|
|
1320
|
+
if (on !== null) {
|
|
1321
|
+
const rect = markerBox(on.element);
|
|
1322
|
+
const seen = document.documentElement.clientHeight || window.innerHeight;
|
|
1323
|
+
if (rect.y < 0 || rect.y + rect.height > seen) {
|
|
1324
|
+
callOf(scrollWindow, window, [0, rect.y - (seen - rect.height) / 2]);
|
|
1325
|
+
}
|
|
1326
|
+
}
|
|
1327
|
+
};
|
|
1144
1328
|
// The pointer moving over a marker is stopped too. Narrowing only: the content still sees
|
|
1145
1329
|
// the pointer leave its own element for the layer (relatedTarget), the layer's :hover and
|
|
1146
1330
|
// :active, and the frame's user activation, so it can tell a marker was pressed, and
|
|
@@ -1260,7 +1444,7 @@ export const ANNOTATE_RUNTIME = String.raw`if (declared("annotate")) {
|
|
|
1260
1444
|
return;
|
|
1261
1445
|
}
|
|
1262
1446
|
swallowUntil = performance.now() + 2000;
|
|
1263
|
-
tell(M.selected, { anchor, rect: box(elementRect.call(element)) });
|
|
1447
|
+
tell(M.selected, Object.assign({ anchor, rect: box(elementRect.call(element)) }, placeOf({ element })));
|
|
1264
1448
|
}, HOLD_MS),
|
|
1265
1449
|
};
|
|
1266
1450
|
}, true);
|
|
@@ -1308,7 +1492,7 @@ export const ANNOTATE_RUNTIME = String.raw`if (declared("annotate")) {
|
|
|
1308
1492
|
hover = null;
|
|
1309
1493
|
setCursor(false);
|
|
1310
1494
|
draw();
|
|
1311
|
-
tell(M.selected, { anchor, rect: box(elementRect.call(element)) });
|
|
1495
|
+
tell(M.selected, Object.assign({ anchor, rect: box(elementRect.call(element)) }, placeOf({ element })));
|
|
1312
1496
|
}, true);
|
|
1313
1497
|
window.addEventListener("keydown", (event) => {
|
|
1314
1498
|
if (event.key !== "Escape") {
|
|
@@ -1367,7 +1551,7 @@ export const ANNOTATE_RUNTIME = String.raw`if (declared("annotate")) {
|
|
|
1367
1551
|
}
|
|
1368
1552
|
reported = key;
|
|
1369
1553
|
reportedBox = rect;
|
|
1370
|
-
tell(M.selected, { anchor, rect });
|
|
1554
|
+
tell(M.selected, Object.assign({ anchor, rect }, placeOf({ range })));
|
|
1371
1555
|
return true;
|
|
1372
1556
|
};
|
|
1373
1557
|
document.addEventListener("selectionchange", () => {
|
package/src/shell/find.ts
CHANGED
|
@@ -140,7 +140,7 @@ export const FIND_LATEST = String.raw`(later, time, quiet, run, superseded) => {
|
|
|
140
140
|
* scripts can, P104). The annotation runtime carries the same text (a test holds them equal).
|
|
141
141
|
*/
|
|
142
142
|
export const LAYER_STYLE =
|
|
143
|
-
"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";
|
|
143
|
+
"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";
|
|
144
144
|
|
|
145
145
|
/**
|
|
146
146
|
* The shell's find in page (P131), spliced into the shell's runtime (`__FIND__`) when the config
|