Kindly EditDocumentationTry the editor

help-capture.js

The help capture interaction and its preview workflow. Captures user-selected context without changing the page’s published content.

Responsibility#

The help capture interaction and its preview workflow. Captures user-selected context without changing the page’s published content.

File characteristics#

  • Source: assets/help-capture.js
  • Lines in this release: 949
  • Type: browser JavaScript

Named browser helpers#

boot, buildModal, buildSelection, cancelSelection, closeModal, drawSelRect, encodeShot, finishSelection, frameFromStream, grabTabPixels, h, hideError, loadH2C, lockScroll, mountShot, normRect, onAnnoDown, onAnnoMove, onAnnoUp, onModalKey, onSelDown, onSelKey, onSelMove, onSelUp, openModal, pixelStreamLive, redraw, releasePixelStream, retake, runDomCapture, setColor, setSending, setTool, showError, showForm, startSelection, strokeOp, submit, toCanvasPoint, toolBtn, unlockScroll.

These functions are internal to the module unless an explicit public contract says otherwise. The list includes nested helpers and is not a global browser API.

Literal event listeners#

click, ended, keydown, mousedown, pagehide, pointercancel, pointerdown, pointermove, pointerup. Dynamic event names may be assembled elsewhere. Event listeners must follow the owner document when the live device canvas moves page nodes.

Markup attributes used here#

data-ke-shot-anchor. These names can represent authored state, generated output, or temporary editor markers. Use the feature’s save contract before persisting them.

Integration and verification#

Load this file through the plugin’s normal enqueue path so its dependencies and configuration are present. Check the relevant feature after a saved reload, in the live device canvas where applicable, and on the published page. Editor-only UI should not become authored page content. See architecture for the lifecycle and responsive design for document movement.

About this page

Documents Kindly Edit 0.9.16. Source: assets/help-capture.js. Theme choices and account permissions can change which controls appear.

Type a word or phrase to search the full documentation.