feat(dragging): Create (new) IDragger and IDraggable interfaces
#7953
Conversation
Rename core/interfaces/i_draggable.ts to core/interfaces/i_draggable.old.ts to make room for new IDraggable. Do not rename actual interface as it's not yet clear that it will be necessary for both to coexist as imports in the same file.
cpcallen
force-pushed
the
feat/drag-interfaces
branch
from
1e5615b to
b1f15ad
Compare
| * be supplied as an alternative to providing a PointerEvent for | ||
| * programatic drags. | ||
| */ | ||
| drag(newLoc: Coordinate, e?: PointerEvent): void; |
There was a problem hiding this comment.
If you want to structure the method signature like this, should the event be non-optional? Otherwise you basically have three function signatures:
drag(newLoc: Coordinate);
drag(newLoc: Coordinate, e: PointerEvent);
drag(newLoc: Coordinate, target: IDragTarget);
There was a problem hiding this comment.
That looks like what I intended.
If e: PointerEvent is non-optional then target would need to be nullable (or otherwise optional) to cover the case where you are doing a programmatic drag (no PointerEvent, unless maybe you synthesise one) and you don't happen to be over a drag target.
There was a problem hiding this comment.
Would it make more sense to explicitly provide the three function signatures then? Small preference from me, but not a big enough deal to block. I'm going to switch this review back to approve.
core/interfaces/i_draggable.ts
Outdated
| * @param e PointerEvent that continued the drag; could be used to | ||
| * look up any IDragTarget the pointer is over, check modifier | ||
| * keys, etc. |
There was a problem hiding this comment.
If provided, they /should/ look up the drag target and deal with it.
cpcallen
force-pushed
the
feat/drag-interfaces
branch
from
b1f15ad to
981a5e0
Compare
The basics
The details
Resolves
Fixes #7838.
Proposed Changes
core/interfaces/i_draggable.tstocore/interfaces/i_draggable.old.tsand update imports of it.IDragableinterface incore/interfaces/i_draggable.ts.IDraggerinterface incore/interfaces/i_dragger.ts.Reason for Changes
API changes to support custom dragging.
Test Coverage
Passes
npm test.Additional Information
I wasn't sure about whether to make the
targetparameter ofIDraggable'sdragmethod optional or nullable. Opinions welcome.I wasn't clear whether the
totalDeltaparameter ofIDragger'sonDragmethod was intended to be cumulative or not, but I supposed it was given that the non-cumulative drag distance is presumably available via the (non-optional)PointerEventparameter. (It's slightly unclear to me why we are making the gesture responsible for keeping track of the cumulative drag, but perhaps it has reasons to do so already.)