tracky-mouse 2.6.0 → 2.8.0

package/README.md

@@ -147,7 +147,7 @@ This is the callback that you need to define to simulate pointer movement.
 This starts up the dwell clicker.
 
 Arguments:
-- `config.targets` (required): a CSS selector for the elements to click. Anything else will be ignored.
+- `config.targets` (required): a CSS selector for the elements to click. Anything else will be ignored (except as an occluder).
 - `config.shouldDrag(el)` (optional): a function that returns true if the element should be dragged rather than simply clicked.
 - `config.noCenter(el)` (optional): a function that returns true if the element should be clicked anywhere on the element, rather than always at the center.
 - `config.retarget` (optional): an array of `{ from, to, withinMargin }` objects, which define rules for dynamically changing what is hovered/clicked when the mouse is over a different element.
@@ -156,6 +156,7 @@ Arguments:
 	- `withinMargin` (optional): a number of pixels within which to consider the mouse over the `to` element. Default to infinity.
 - `config.isEquivalentTarget(el1, el2)` (optional): a function that returns true if two elements should be considered part of the same control, i.e. if clicking either should do the same thing. Elements that are equal are always considered equivalent even if you return false. This option is used for preventing the system from detecting occluding elements as separate controls, and rejecting the click. (When an occlusion is detected, it flashes a red box.)
 - `config.dwellClickEvenIfPaused(el)` (optional): a function that returns true if the element should be clicked even while dwell clicking is otherwise paused. Use this for a dwell clicking toggle button, so it's possible to resume dwell clicking. With dwell clicking it's important to let users take a break, since otherwise you have to constantly move the cursor in order to not click on things!
+- `config.shouldClickThrough(el)` (optional): a function that returns true if the element should be totally ignored, allowing clicking on content behind it. Prefer `pointer-events: none` when possible, which will work for all input methods. Use this only if you need to differentiate input methods. Default: `(el) => el.matches(".tracky-mouse-click-through, .tracky-mouse-click-through *")`
 - `config.click({x, y, target})` (required): a function to trigger a click on the given target element.
 - `config.beforeDispatch()` (optional): a function to call before a pointer event is dispatched. For detecting un-trusted user gestures, outside of an event handler.
 - `config.afterDispatch()` (optional): a function to call after a pointer event is dispatched. For detecting un-trusted user gestures, outside of an event handler.