[Feature] Improve drag service

[titouanmathis]

🔗 Linked issue

No issue.

❓ Type of change

• 📖 Documentation (updates to the documentation, readme or JSdoc annotations)
• 🐞 Bug fix (a non-breaking change that fixes an issue)
• 👌 Enhancement (improving an existing functionality like performance)
• ✨ New feature (a non-breaking change that adds functionality)
• 🧹 Chore (updates to the build process or auxiliary tools and libraries)
• ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

Add a props.MODES object to the drag service props, referencing the different modes of the drag lifecycle.

import { useDrag } from '@studiometa/js-toolkit';

useDrag(target).add('key', (props) => {
  if (props.mode === props.MODES.START) {
    console.log('drag is starting');
  }
});

This PR removes the undocumented DragService.MODES property, this might be a breaking change if you rely on it.

📝 Checklist

• I have linked an issue or discussion.
• I have added tests (if possible).
• I have updated the documentation accordingly.
• I have updated the changelog.

[github-actions]

Export Size

@studiometa/js-toolkit

Name	Size	Diff
ALL	17.45 kB	+55 B (+0.32%) 🔺
DragService	1.85 kB	+2 B (+0.11%) 🔺
SERVICES	3.68 kB	+2 B (+0.05%) 🔺
FRAMEWORK	12.33 kB	+4 B (+0.03%) 🔺
DECORATORS	6.84 kB	-2 B (-0.03%) 🔽
withDrag	2 kB	-13 B (-0.65%) 🔽

Unchanged

@studiometa/js-toolkit

Name	Size	Diff
AbstractService	512 B	-
addClass	226 B	-
addStyle	238 B	-
animate	2.93 kB	-
Base	7.48 kB	-
BASE	7.55 kB	-
boundingRectToCircle	154 B	-
cache	179 B	-
camelCase	401 B	-
clamp	67 B	-
clamp01	87 B	-
collideCircleCircle	99 B	-
collideCircleRect	159 B	-
collidePointCircle	112 B	-
collidePointRect	103 B	-
collideRectRect	99 B	-
createApp	1.28 kB	-
createEaseInOut	116 B	-
createEaseOut	71 B	-
createElement	526 B	-
createRange	90 B	-
damp	78 B	-
dashCase	376 B	-
debounce	92 B	-
domScheduler	296 B	-
ease	435 B	-
easeInCirc	68 B	-
easeInCubic	59 B	-
easeInExpo	80 B	-
easeInOutCirc	141 B	-
easeInOutCubic	130 B	-
easeInOutExpo	134 B	-
easeInOutQuad	128 B	-
easeInOutQuart	133 B	-
easeInOutQuint	152 B	-
easeInOutSine	151 B	-
easeInQuad	63 B	-
easeInQuart	61 B	-
easeInQuint	62 B	-
easeInSine	77 B	-
easeLinear	49 B	-
easeOutCirc	115 B	-
easeOutCubic	103 B	-
easeOutExpo	112 B	-
easeOutQuad	103 B	-
easeOutQuart	100 B	-
easeOutQuint	103 B	-
easeOutSine	121 B	-
endsWith	88 B	-
getAncestorWhere	91 B	-
getAncestorWhereUntil	119 B	-
getClosestParent	173 B	-
getComponentResolver	138 B	-
getDirectChildren	194 B	-
getInstanceFromElement	90 B	-
getInstances	146 B	-
getOffsetSizes	159 B	-
hasWindow	62 B	-
HELPERS	2.43 kB	-
historyPush	499 B	-
historyReplace	503 B	-
importOnInteraction	891 B	-
importOnMediaQuery	236 B	-
importWhenIdle	223 B	-
importWhenPrefersMotion	275 B	-
importWhenVisible	911 B	-
inertiaFinalValue	142 B	-
isArray	70 B	-
isBoolean	78 B	-
isDefined	86 B	-
isDev	72 B	-
isDirectChild	206 B	-
isEmpty	207 B	-
isEmptyString	93 B	-
isFunction	72 B	-
isNull	72 B	-
isNumber	84 B	-
isObject	105 B	-
isString	86 B	-
keyCodes	97 B	-
KeyService	833 B	-
lerp	57 B	-
loadElement	169 B	-
loadIframe	189 B	-
loadImage	188 B	-
loadLink	186 B	-
loadScript	197 B	-
LoadService	577 B	-
lowerCase	60 B	-
map	71 B	-
matrix	106 B	-
mean	91 B	-
memo	100 B	-
memoize	189 B	-
MutationService	784 B	-
nextFrame	162 B	-
nextMicrotask	111 B	-
nextTick	134 B	-
noop	39 B	-
noopValue	49 B	-
objectToURLSearchParams	302 B	-
pascalCase	377 B	-
PointerService	1.05 kB	-
Queue	226 B	-
RafService	880 B	-
randomInt	80 B	-
randomItem	232 B	-
removeClass	222 B	-
removeStyle	238 B	-
ResizeService	977 B	-
round	56 B	-
saveActiveElement	56 B	-
ScrollService	1.01 kB	-
scrollTo	2.13 kB	-
SmartQueue	411 B	-
snakeCase	378 B	-
startsWith	87 B	-
throttle	101 B	-
toggleClass	225 B	-
transform	321 B	-
transition	916 B	-
trapFocus	363 B	-
tween	1.56 kB	-
untrapFocus	45 B	-
upperCase	54 B	-
useDrag	1.89 kB	-
useKey	847 B	-
useLoad	592 B	-
useMutation	819 B	-
usePointer	1.08 kB	-
useRaf	894 B	-
useResize	995 B	-
useScheduler	290 B	-
useScroll	1.03 kB	-
UTILS	7.5 kB	-
wait	79 B	-
withBreakpointManager	1.39 kB	-
withBreakpointObserver	1.58 kB	-
withExtraConfig	135 B	-
withFreezedOptions	140 B	-
withIntersectionObserver	260 B	-
withLeadingCharacters	88 B	-
withLeadingSlash	107 B	-
withMountOnMediaQuery	322 B	-
withMountWhenInView	286 B	-
withMountWhenPrefersMotion	355 B	-
withMutation	943 B	-
withName	81 B	-
withoutLeadingCharacters	86 B	-
withoutLeadingCharactersRecursive	124 B	-
withoutLeadingSlash	93 B	-
withoutTrailingCharacters	98 B	-
withoutTrailingCharactersRecursive	129 B	-
withoutTrailingSlash	103 B	-
withRelativePointer	1.21 kB	-
withResponsiveOptions	2.24 kB	-
withScrolledInView	1.87 kB	-
withTrailingCharacters	96 B	-
withTrailingSlash	120 B	-

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.01%. Comparing base (dbc8e1a) to head (a5d7a44).
Report is 8 commits behind head on develop.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop     #618   +/-   ##
========================================
  Coverage    99.01%   99.01%           
========================================
  Files          122      122           
  Lines         4183     4183           
  Branches      1137     1137           
========================================
  Hits          4142     4142           
  Misses          41       41           

Flag	Coverage Δ
unittests	99.01% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.