@sharadox/scroll-web-library 0.3.0 → 0.4.0

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/README.md CHANGED
@@ -15,12 +15,13 @@ pnpm add @sharadox/scroll-web-library
15
15
 
16
16
  ## API
17
17
 
18
- | Import | Export |
19
- | ------------------ | ------------------------------------------------------------------------------------------------------- |
20
- | `…/smooth-scroll` | `<SmoothScroll duration? anchorOffset?>` (renders nothing; default 1.15 s and -60 px) |
21
- | `…/active-section` | `useActiveSection(ids)` → `{ active, within, page }` (keep `ids` stable, for example a module constant) |
22
- | `…/glide` | `glideTo(top, { duration? })` |
23
- | `…/scroll-steps` | `useScrollSteps(sectionRef, count, { duration? })` (0.9 s by default) |
18
+ | Import | Export |
19
+ | ------------------ | ------------------------------------------------------------------------------------------------------------------------------- |
20
+ | `…/smooth-scroll` | `<SmoothScroll duration? anchorOffset?>` (renders nothing; default 1.15 s and -60 px; `#top` glides to the top of any page) |
21
+ | `…/section-link` | `<SectionLink href>`: Next.js `Link` for a section (`#id`, `/en#id`) that leaves scrolling to `SmoothScroll` (`scroll={false}`) |
22
+ | `…/active-section` | `useActiveSection(ids)` → `{ active, within, page }` (keep `ids` stable, for example a module constant) |
23
+ | `…/glide` | `glideTo(top, { duration? })` |
24
+ | `…/scroll-steps` | `useScrollSteps(sectionRef, count, { duration? })` (0.9 s by default) |
24
25
 
25
26
  ## Develop
26
27
 
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../source/scroll-steps/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAa,KAAK,SAAS,EAAE,MAAM,OAAO,CAAC;AAElD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gDAAgD,CAAC;AAOzF;;;;;;;;;GASG;AACH,wBAAgB,cAAc,CAAC,OAAO,SAAS,WAAW,EACxD,OAAO,EAAE,SAAS,CAAC,OAAO,GAAG,IAAI,CAAC,EAClC,KAAK,EAAE,MAAM,EACb,EAAE,QAAc,EAAE,GAAE,kBAAuB,QA0E5C"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../source/scroll-steps/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAa,KAAK,SAAS,EAAE,MAAM,OAAO,CAAC;AAElD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gDAAgD,CAAC;AAOzF;;;;;;;;;GASG;AACH,wBAAgB,cAAc,CAAC,OAAO,SAAS,WAAW,EACxD,OAAO,EAAE,SAAS,CAAC,OAAO,GAAG,IAAI,CAAC,EAClC,KAAK,EAAE,MAAM,EACb,EAAE,QAAc,EAAE,GAAE,kBAAuB,QA4E5C"}
@@ -36,19 +36,23 @@ export function useScrollSteps(section, count, { duration = 0.9 } = {}) {
36
36
  at: (index) => top + ((index + 0.5) / count) * travel,
37
37
  };
38
38
  };
39
- // Moves one step in `direction` if there is one; true when the gesture was taken.
40
- const step = (direction, now) => {
39
+ /*
40
+ * Moves one step in `direction` if there is one. A touch's glide starts once the touch event is over: smooth
41
+ * scrolling handles the same lifted finger after us, and would otherwise stop the glide it doesn't know about.
42
+ */
43
+ const step = (direction, now, afterEvent = false) => {
41
44
  const where = place();
42
45
  if (!where)
43
- return false;
46
+ return;
44
47
  const next = where.current + direction;
45
- if (next < 0 || next >= count)
46
- return false;
47
- if (now >= lockedUntil) {
48
- lockedUntil = now + duration * 1000;
49
- glideTo(where.at(next), { duration });
50
- }
51
- return true;
48
+ if (next < 0 || next >= count || now < lockedUntil)
49
+ return;
50
+ lockedUntil = now + duration * 1000;
51
+ const glide = () => glideTo(where.at(next), { duration });
52
+ if (afterEvent)
53
+ setTimeout(glide);
54
+ else
55
+ glide();
52
56
  };
53
57
  const wheel = (event) => {
54
58
  if (Math.abs(event.deltaY) < Math.abs(event.deltaX))
@@ -86,7 +90,7 @@ export function useScrollSteps(section, count, { duration = 0.9 } = {}) {
86
90
  const travel = touchY - event.changedTouches[0].clientY;
87
91
  touchY = null;
88
92
  if (Math.abs(travel) >= SWIPE)
89
- step(travel > 0 ? 1 : -1, event.timeStamp);
93
+ step(travel > 0 ? 1 : -1, event.timeStamp, true);
90
94
  };
91
95
  const options = { capture: true, passive: false };
92
96
  addEventListener("wheel", wheel, options);
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../source/scroll-steps/index.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AACb,OAAO,EAAE,SAAS,EAAkB,MAAM,OAAO,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,MAAM,oCAAoC,CAAC;AAG7D,mEAAmE;AACnE,MAAM,WAAW,GAAG,GAAG,CAAC;AACxB,wDAAwD;AACxD,MAAM,KAAK,GAAG,EAAE,CAAC;AAEjB;;;;;;;;;GASG;AACH,MAAM,UAAU,cAAc,CAC5B,OAAkC,EAClC,KAAa,EACb,EAAE,QAAQ,GAAG,GAAG,KAAyB,EAAE;IAE3C,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,SAAS,GAAG,CAAC,CAAC;QAClB,IAAI,WAAW,GAAG,CAAC,CAAC;QACpB,IAAI,MAAM,GAAkB,IAAI,CAAC;QACjC,uGAAuG;QACvG,MAAM,KAAK,GAAG,GAAG,EAAE;YACjB,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;YAChC,IAAI,CAAC,OAAO;gBAAE,OAAO,IAAI,CAAC;YAC1B,MAAM,MAAM,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC;YAC/C,MAAM,MAAM,GAAG,OAAO,CAAC,YAAY,GAAG,WAAW,CAAC;YAClD,IAAI,MAAM,IAAI,CAAC,IAAI,MAAM,CAAC,GAAG,GAAG,CAAC,IAAI,MAAM,CAAC,MAAM,GAAG,WAAW,GAAG,CAAC;gBAAE,OAAO,IAAI,CAAC;YAClF,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,GAAG,OAAO,CAAC;YACjC,MAAM,QAAQ,GAAG,CAAC,OAAO,GAAG,GAAG,CAAC,GAAG,MAAM,CAAC;YAC1C,OAAO;gBACL,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,KAAK,CAAC,CAAC,CAAC;gBACvE,EAAE,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,GAAG,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,MAAM;aAC9D,CAAC;QACJ,CAAC,CAAC;QACF,kFAAkF;QAClF,MAAM,IAAI,GAAG,CAAC,SAAiB,EAAE,GAAW,EAAE,EAAE;YAC9C,MAAM,KAAK,GAAG,KAAK,EAAE,CAAC;YACtB,IAAI,CAAC,KAAK;gBAAE,OAAO,KAAK,CAAC;YACzB,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,GAAG,SAAS,CAAC;YACvC,IAAI,IAAI,GAAG,CAAC,IAAI,IAAI,IAAI,KAAK;gBAAE,OAAO,KAAK,CAAC;YAC5C,IAAI,GAAG,IAAI,WAAW,EAAE,CAAC;gBACvB,WAAW,GAAG,GAAG,GAAG,QAAQ,GAAG,IAAI,CAAC;gBACpC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;YACxC,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC;QACF,MAAM,KAAK,GAAG,CAAC,KAAiB,EAAE,EAAE;YAClC,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC;gBAAE,OAAO;YAC5D,MAAM,GAAG,GAAG,KAAK,CAAC,SAAS,CAAC;YAC5B,MAAM,KAAK,GAAG,GAAG,GAAG,SAAS,GAAG,WAAW,CAAC;YAC5C,SAAS,GAAG,GAAG,CAAC;YAChB,MAAM,KAAK,GAAG,KAAK,EAAE,CAAC;YACtB,IAAI,CAAC,KAAK;gBAAE,OAAO;YACnB,MAAM,SAAS,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC5C,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,GAAG,SAAS,CAAC;YACvC,IAAI,IAAI,GAAG,CAAC,IAAI,IAAI,IAAI,KAAK;gBAAE,OAAO;YACtC,2GAA2G;YAC3G,KAAK,CAAC,cAAc,EAAE,CAAC;YACvB,KAAK,CAAC,eAAe,EAAE,CAAC;YACxB,IAAI,KAAK;gBAAE,IAAI,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;QAClC,CAAC,CAAC;QACF,MAAM,UAAU,GAAG,CAAC,KAAiB,EAAE,EAAE;YACvC,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAE,CAAC,OAAO,CAAC;QACrC,CAAC,CAAC;QACF,MAAM,SAAS,GAAG,CAAC,KAAiB,EAAE,EAAE;YACtC,IAAI,MAAM,KAAK,IAAI;gBAAE,OAAO;YAC5B,MAAM,KAAK,GAAG,KAAK,EAAE,CAAC;YACtB,MAAM,SAAS,GAAG,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAE,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAClE,IAAI,KAAK,IAAI,KAAK,CAAC,OAAO,GAAG,SAAS,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,GAAG,SAAS,GAAG,KAAK;gBAAE,KAAK,CAAC,cAAc,EAAE,CAAC;QAC3G,CAAC,CAAC;QACF,MAAM,QAAQ,GAAG,CAAC,KAAiB,EAAE,EAAE;YACrC,IAAI,MAAM,KAAK,IAAI;gBAAE,OAAO;YAC5B,MAAM,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC,CAAE,CAAC,OAAO,CAAC;YACzD,MAAM,GAAG,IAAI,CAAC;YACd,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,KAAK;gBAAE,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;QAC5E,CAAC,CAAC;QACF,MAAM,OAAO,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;QAClD,gBAAgB,CAAC,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;QAC1C,gBAAgB,CAAC,YAAY,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;QACpD,gBAAgB,CAAC,WAAW,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QAClD,gBAAgB,CAAC,UAAU,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QAChD,OAAO,GAAG,EAAE;YACV,mBAAmB,CAAC,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;YAC7C,mBAAmB,CAAC,YAAY,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;YACvD,mBAAmB,CAAC,WAAW,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;YACrD,mBAAmB,CAAC,UAAU,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QACrD,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC;AACjC,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../source/scroll-steps/index.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AACb,OAAO,EAAE,SAAS,EAAkB,MAAM,OAAO,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,MAAM,oCAAoC,CAAC;AAG7D,mEAAmE;AACnE,MAAM,WAAW,GAAG,GAAG,CAAC;AACxB,wDAAwD;AACxD,MAAM,KAAK,GAAG,EAAE,CAAC;AAEjB;;;;;;;;;GASG;AACH,MAAM,UAAU,cAAc,CAC5B,OAAkC,EAClC,KAAa,EACb,EAAE,QAAQ,GAAG,GAAG,KAAyB,EAAE;IAE3C,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,SAAS,GAAG,CAAC,CAAC;QAClB,IAAI,WAAW,GAAG,CAAC,CAAC;QACpB,IAAI,MAAM,GAAkB,IAAI,CAAC;QACjC,uGAAuG;QACvG,MAAM,KAAK,GAAG,GAAG,EAAE;YACjB,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;YAChC,IAAI,CAAC,OAAO;gBAAE,OAAO,IAAI,CAAC;YAC1B,MAAM,MAAM,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC;YAC/C,MAAM,MAAM,GAAG,OAAO,CAAC,YAAY,GAAG,WAAW,CAAC;YAClD,IAAI,MAAM,IAAI,CAAC,IAAI,MAAM,CAAC,GAAG,GAAG,CAAC,IAAI,MAAM,CAAC,MAAM,GAAG,WAAW,GAAG,CAAC;gBAAE,OAAO,IAAI,CAAC;YAClF,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,GAAG,OAAO,CAAC;YACjC,MAAM,QAAQ,GAAG,CAAC,OAAO,GAAG,GAAG,CAAC,GAAG,MAAM,CAAC;YAC1C,OAAO;gBACL,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,KAAK,CAAC,CAAC,CAAC;gBACvE,EAAE,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,GAAG,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,MAAM;aAC9D,CAAC;QACJ,CAAC,CAAC;QACF;;;WAGG;QACH,MAAM,IAAI,GAAG,CAAC,SAAiB,EAAE,GAAW,EAAE,UAAU,GAAG,KAAK,EAAE,EAAE;YAClE,MAAM,KAAK,GAAG,KAAK,EAAE,CAAC;YACtB,IAAI,CAAC,KAAK;gBAAE,OAAO;YACnB,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,GAAG,SAAS,CAAC;YACvC,IAAI,IAAI,GAAG,CAAC,IAAI,IAAI,IAAI,KAAK,IAAI,GAAG,GAAG,WAAW;gBAAE,OAAO;YAC3D,WAAW,GAAG,GAAG,GAAG,QAAQ,GAAG,IAAI,CAAC;YACpC,MAAM,KAAK,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;YAC1D,IAAI,UAAU;gBAAE,UAAU,CAAC,KAAK,CAAC,CAAC;;gBAC7B,KAAK,EAAE,CAAC;QACf,CAAC,CAAC;QACF,MAAM,KAAK,GAAG,CAAC,KAAiB,EAAE,EAAE;YAClC,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC;gBAAE,OAAO;YAC5D,MAAM,GAAG,GAAG,KAAK,CAAC,SAAS,CAAC;YAC5B,MAAM,KAAK,GAAG,GAAG,GAAG,SAAS,GAAG,WAAW,CAAC;YAC5C,SAAS,GAAG,GAAG,CAAC;YAChB,MAAM,KAAK,GAAG,KAAK,EAAE,CAAC;YACtB,IAAI,CAAC,KAAK;gBAAE,OAAO;YACnB,MAAM,SAAS,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC5C,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,GAAG,SAAS,CAAC;YACvC,IAAI,IAAI,GAAG,CAAC,IAAI,IAAI,IAAI,KAAK;gBAAE,OAAO;YACtC,2GAA2G;YAC3G,KAAK,CAAC,cAAc,EAAE,CAAC;YACvB,KAAK,CAAC,eAAe,EAAE,CAAC;YACxB,IAAI,KAAK;gBAAE,IAAI,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;QAClC,CAAC,CAAC;QACF,MAAM,UAAU,GAAG,CAAC,KAAiB,EAAE,EAAE;YACvC,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAE,CAAC,OAAO,CAAC;QACrC,CAAC,CAAC;QACF,MAAM,SAAS,GAAG,CAAC,KAAiB,EAAE,EAAE;YACtC,IAAI,MAAM,KAAK,IAAI;gBAAE,OAAO;YAC5B,MAAM,KAAK,GAAG,KAAK,EAAE,CAAC;YACtB,MAAM,SAAS,GAAG,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAE,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAClE,IAAI,KAAK,IAAI,KAAK,CAAC,OAAO,GAAG,SAAS,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,GAAG,SAAS,GAAG,KAAK;gBAAE,KAAK,CAAC,cAAc,EAAE,CAAC;QAC3G,CAAC,CAAC;QACF,MAAM,QAAQ,GAAG,CAAC,KAAiB,EAAE,EAAE;YACrC,IAAI,MAAM,KAAK,IAAI;gBAAE,OAAO;YAC5B,MAAM,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC,CAAE,CAAC,OAAO,CAAC;YACzD,MAAM,GAAG,IAAI,CAAC;YACd,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,KAAK;gBAAE,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QAClF,CAAC,CAAC;QACF,MAAM,OAAO,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;QAClD,gBAAgB,CAAC,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;QAC1C,gBAAgB,CAAC,YAAY,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;QACpD,gBAAgB,CAAC,WAAW,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QAClD,gBAAgB,CAAC,UAAU,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QAChD,OAAO,GAAG,EAAE;YACV,mBAAmB,CAAC,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;YAC7C,mBAAmB,CAAC,YAAY,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;YACvD,mBAAmB,CAAC,WAAW,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;YACrD,mBAAmB,CAAC,UAAU,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QACrD,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC;AACjC,CAAC"}
@@ -0,0 +1,11 @@
1
+ import Link from "next/link";
2
+ import type { ComponentProps } from "react";
3
+ /**
4
+ * Next.js `Link` for a section of the page (`#contact`, or `/en#contact` from another page). Next.js updates the address
5
+ * and `SmoothScroll` does the scrolling (`scroll={false}`), so the page glides there instead of two scrolls fighting.
6
+ *
7
+ * @example
8
+ * <SectionLink href="#contact">Contact</SectionLink>
9
+ */
10
+ export declare function SectionLink(properties: ComponentProps<typeof Link>): import("react").JSX.Element;
11
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../source/section-link/index.tsx"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AAE5C;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,UAAU,EAAE,cAAc,CAAC,OAAO,IAAI,CAAC,+BAElE"}
@@ -0,0 +1,13 @@
1
+ import { jsx as _jsx } from "react/jsx-runtime";
2
+ import Link from "next/link";
3
+ /**
4
+ * Next.js `Link` for a section of the page (`#contact`, or `/en#contact` from another page). Next.js updates the address
5
+ * and `SmoothScroll` does the scrolling (`scroll={false}`), so the page glides there instead of two scrolls fighting.
6
+ *
7
+ * @example
8
+ * <SectionLink href="#contact">Contact</SectionLink>
9
+ */
10
+ export function SectionLink(properties) {
11
+ return _jsx(Link, { scroll: false, ...properties });
12
+ }
13
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../source/section-link/index.tsx"],"names":[],"mappings":";AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAG7B;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CAAC,UAAuC;IACjE,OAAO,KAAC,IAAI,IAAC,MAAM,EAAE,KAAK,KAAM,UAAU,GAAI,CAAC;AACjD,CAAC"}
@@ -1,8 +1,9 @@
1
1
  import type { SmoothScrollProperties } from "@sharadox/scroll-web-library/smooth-scroll/type";
2
2
  /**
3
- * Smooth, inertial page scrolling, including in-page anchor links. A link to the page already open (the logo on the
4
- * home page, for one) glides back to the top instead of reloading. Smoothing is off when the visitor prefers reduced
5
- * motion: anchors then jump, and the same-page link still goes to the top without reloading.
3
+ * Smooth, inertial page scrolling, including in-page anchor links (plain ones and `SectionLink`s) and `#top`, which
4
+ * glides to the top of whatever page is open. A link to the page already open (the logo on the home page, for one)
5
+ * glides back to the top instead of reloading. Smoothing is off when the visitor prefers reduced motion: anchors then
6
+ * jump, and the same-page link still goes to the top without reloading.
6
7
  */
7
8
  export declare function SmoothScroll({ duration, anchorOffset }: SmoothScrollProperties): null;
8
9
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../source/smooth-scroll/index.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,iDAAiD,CAAC;AAK9F;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,EAAE,QAAe,EAAE,YAAkB,EAAE,EAAE,sBAAsB,QA+C3F"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../source/smooth-scroll/index.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,iDAAiD,CAAC;AAK9F;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,EAAE,QAAe,EAAE,YAAkB,EAAE,EAAE,sBAAsB,QAqD3F"}
@@ -5,9 +5,10 @@ import { registerGlider } from "@sharadox/scroll-web-library/glide";
5
5
  /** A path without its trailing slash, so "/en/" and "/en" count as the same page. */
6
6
  const page = (path) => path.replace(/(.)\/$/, "$1");
7
7
  /**
8
- * Smooth, inertial page scrolling, including in-page anchor links. A link to the page already open (the logo on the
9
- * home page, for one) glides back to the top instead of reloading. Smoothing is off when the visitor prefers reduced
10
- * motion: anchors then jump, and the same-page link still goes to the top without reloading.
8
+ * Smooth, inertial page scrolling, including in-page anchor links (plain ones and `SectionLink`s) and `#top`, which
9
+ * glides to the top of whatever page is open. A link to the page already open (the logo on the home page, for one)
10
+ * glides back to the top instead of reloading. Smoothing is off when the visitor prefers reduced motion: anchors then
11
+ * jump, and the same-page link still goes to the top without reloading.
11
12
  */
12
13
  export function SmoothScroll({ duration = 1.15, anchorOffset = -60 }) {
13
14
  useEffect(() => {
@@ -27,14 +28,26 @@ export function SmoothScroll({ duration = 1.15, anchorOffset = -60 }) {
27
28
  const link = event.target.closest("a[href]");
28
29
  if (!link)
29
30
  return;
30
- const anchor = link.getAttribute("href").startsWith("#")
31
- ? document.querySelector(link.getAttribute("href"))
32
- : null;
33
- if (anchor) {
34
- if (!lenis)
31
+ const href = link.getAttribute("href");
32
+ if (href.startsWith("#")) {
33
+ // "#top" is the top of any page, as in browsers; other anchors are the element with that id.
34
+ const anchor = href === "#top" ? document.documentElement : document.querySelector(href);
35
+ if (!anchor)
36
+ return;
37
+ // A `SectionLink` (Next.js Link that leaves scrolling to us) has already taken the click: scroll even then.
38
+ if (!lenis && !event.defaultPrevented)
35
39
  return;
36
40
  event.preventDefault();
37
- lenis.scrollTo(anchor, { offset: anchorOffset });
41
+ if (anchor === document.documentElement) {
42
+ if (lenis)
43
+ lenis.scrollTo(0);
44
+ else
45
+ window.scrollTo({ top: 0, behavior: "auto" });
46
+ }
47
+ else if (lenis)
48
+ lenis.scrollTo(anchor, { offset: anchorOffset });
49
+ else
50
+ anchor.scrollIntoView();
38
51
  return;
39
52
  }
40
53
  // A plain click on a link to this very page: back to the top, no reload.
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../source/smooth-scroll/index.tsx"],"names":[],"mappings":"AAAA,YAAY,CAAC;AACb,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAClC,OAAO,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AAGpE,qFAAqF;AACrF,MAAM,IAAI,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;AAE5D;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,EAAE,QAAQ,GAAG,IAAI,EAAE,YAAY,GAAG,CAAC,EAAE,EAA0B;IAC1F,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,KAAK,GAAG,MAAM,CAAC,UAAU,CAAC,kCAAkC,CAAC,CAAC,OAAO;YACzE,CAAC,CAAC,IAAI;YACN,CAAC,CAAC,IAAI,KAAK,CAAC,EAAE,QAAQ,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;QAC/C,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,MAAM,OAAO,GAAG,CAAC,IAAY,EAAE,EAAE;YAC/B,KAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACjB,KAAK,GAAG,qBAAqB,CAAC,OAAO,CAAC,CAAC;QACzC,CAAC,CAAC;QACF,IAAI,KAAK;YAAE,KAAK,GAAG,qBAAqB,CAAC,OAAO,CAAC,CAAC;QAClD,wFAAwF;QACxF,cAAc,CAAC,KAAK,IAAI,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC;QACtF,MAAM,OAAO,GAAG,CAAC,KAAiB,EAAE,EAAE;YACpC,MAAM,IAAI,GAAI,KAAK,CAAC,MAAsB,CAAC,OAAO,CAAoB,SAAS,CAAC,CAAC;YACjF,IAAI,CAAC,IAAI;gBAAE,OAAO;YAClB,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAE,CAAC,UAAU,CAAC,GAAG,CAAC;gBACvD,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAc,IAAI,CAAC,YAAY,CAAC,MAAM,CAAE,CAAC;gBACjE,CAAC,CAAC,IAAI,CAAC;YACT,IAAI,MAAM,EAAE,CAAC;gBACX,IAAI,CAAC,KAAK;oBAAE,OAAO;gBACnB,KAAK,CAAC,cAAc,EAAE,CAAC;gBACvB,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,CAAC;gBACjD,OAAO;YACT,CAAC;YACD,yEAAyE;YACzE,MAAM,QAAQ,GACZ,IAAI,CAAC,MAAM,KAAK,QAAQ,CAAC,MAAM;gBAC/B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;gBAC/C,CAAC,IAAI,CAAC,IAAI;gBACV,CAAC,IAAI,CAAC,MAAM,CAAC;YACf,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;YAC9G,IAAI,QAAQ,IAAI,UAAU,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;gBAC3C,KAAK,CAAC,cAAc,EAAE,CAAC;gBACvB,IAAI,KAAK;oBAAE,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;;oBACxB,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;YACrD,CAAC;QACH,CAAC,CAAC;QACF,QAAQ,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC5C,OAAO,GAAG,EAAE;YACV,oBAAoB,CAAC,KAAK,CAAC,CAAC;YAC5B,QAAQ,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAC/C,KAAK,EAAE,OAAO,EAAE,CAAC;YACjB,cAAc,CAAC,IAAI,CAAC,CAAC;QACvB,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC;IAC7B,OAAO,IAAI,CAAC;AACd,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../source/smooth-scroll/index.tsx"],"names":[],"mappings":"AAAA,YAAY,CAAC;AACb,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAClC,OAAO,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AAGpE,qFAAqF;AACrF,MAAM,IAAI,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;AAE5D;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAC,EAAE,QAAQ,GAAG,IAAI,EAAE,YAAY,GAAG,CAAC,EAAE,EAA0B;IAC1F,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,KAAK,GAAG,MAAM,CAAC,UAAU,CAAC,kCAAkC,CAAC,CAAC,OAAO;YACzE,CAAC,CAAC,IAAI;YACN,CAAC,CAAC,IAAI,KAAK,CAAC,EAAE,QAAQ,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;QAC/C,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,MAAM,OAAO,GAAG,CAAC,IAAY,EAAE,EAAE;YAC/B,KAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACjB,KAAK,GAAG,qBAAqB,CAAC,OAAO,CAAC,CAAC;QACzC,CAAC,CAAC;QACF,IAAI,KAAK;YAAE,KAAK,GAAG,qBAAqB,CAAC,OAAO,CAAC,CAAC;QAClD,wFAAwF;QACxF,cAAc,CAAC,KAAK,IAAI,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC;QACtF,MAAM,OAAO,GAAG,CAAC,KAAiB,EAAE,EAAE;YACpC,MAAM,IAAI,GAAI,KAAK,CAAC,MAAsB,CAAC,OAAO,CAAoB,SAAS,CAAC,CAAC;YACjF,IAAI,CAAC,IAAI;gBAAE,OAAO;YAClB,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAE,CAAC;YACxC,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBACzB,6FAA6F;gBAC7F,MAAM,MAAM,GAAG,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAc,IAAI,CAAC,CAAC;gBACtG,IAAI,CAAC,MAAM;oBAAE,OAAO;gBACpB,4GAA4G;gBAC5G,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,gBAAgB;oBAAE,OAAO;gBAC9C,KAAK,CAAC,cAAc,EAAE,CAAC;gBACvB,IAAI,MAAM,KAAK,QAAQ,CAAC,eAAe,EAAE,CAAC;oBACxC,IAAI,KAAK;wBAAE,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;;wBACxB,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;gBACrD,CAAC;qBAAM,IAAI,KAAK;oBAAE,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,CAAC;;oBAC9D,MAAM,CAAC,cAAc,EAAE,CAAC;gBAC7B,OAAO;YACT,CAAC;YACD,yEAAyE;YACzE,MAAM,QAAQ,GACZ,IAAI,CAAC,MAAM,KAAK,QAAQ,CAAC,MAAM;gBAC/B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;gBAC/C,CAAC,IAAI,CAAC,IAAI;gBACV,CAAC,IAAI,CAAC,MAAM,CAAC;YACf,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;YAC9G,IAAI,QAAQ,IAAI,UAAU,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;gBAC3C,KAAK,CAAC,cAAc,EAAE,CAAC;gBACvB,IAAI,KAAK;oBAAE,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;;oBACxB,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;YACrD,CAAC;QACH,CAAC,CAAC;QACF,QAAQ,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC5C,OAAO,GAAG,EAAE;YACV,oBAAoB,CAAC,KAAK,CAAC,CAAC;YAC5B,QAAQ,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAC/C,KAAK,EAAE,OAAO,EAAE,CAAC;YACjB,cAAc,CAAC,IAAI,CAAC,CAAC;QACvB,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC;IAC7B,OAAO,IAAI,CAAC;AACd,CAAC"}
package/llms.txt CHANGED
@@ -9,3 +9,6 @@
9
9
  - /glide: glideTo(top, { duration? }) — through the running SmoothScroll (Lenis) or window.scrollTo (smooth, or auto with reduced motion); registerGlider is internal to SmoothScroll
10
10
  - /scroll-steps: useScrollSteps(sectionRef, count, { duration? = 0.9 }) — while the section is pinned, each wheel gesture (a pause of 180 ms starts a new one) or finger swipe (30 px+) glides exactly one step; step i sits at top + (i + 0.5) / count × (height − innerHeight); past the ends the page scrolls on
11
11
  - 0.3.0: glide, scroll-steps
12
+ - 0.3.1: a finger swipe's step glide starts after the touch event, so smooth scrolling (Lenis) no longer stops it on phones
13
+ - /section-link: <SectionLink href …LinkProps> — next/link with scroll={false} for in-page sections; SmoothScroll glides (or, with reduced motion, jumps) to the anchor even though Link took the click
14
+ - 0.4.0: SectionLink; SmoothScroll handles "#top" (top of the open page) and anchors whose click a Next.js Link already took; next is a peer dependency
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sharadox/scroll-web-library",
3
- "version": "0.3.0",
3
+ "version": "0.4.0",
4
4
  "description": "Scrolling for React websites: smooth inertial scrolling with anchor jumps (Lenis) and the active section with page progress.",
5
5
  "private": false,
6
6
  "license": "SEE LICENSE IN LICENCA.md",
@@ -70,14 +70,16 @@
70
70
  "turbo": "^2.11.10",
71
71
  "typedoc": "^0.28.20",
72
72
  "typescript": "6.0.3",
73
- "vitest": "^5.1.0"
73
+ "vitest": "^5.1.0",
74
+ "next": "16.4.5"
74
75
  },
75
76
  "dependencies": {
76
77
  "@sharadox/web-library": "^0.5.0",
77
78
  "lenis": "^1.3.27"
78
79
  },
79
80
  "peerDependencies": {
80
- "react": ">=19"
81
+ "react": ">=19",
82
+ "next": ">=16"
81
83
  },
82
84
  "scripts": {
83
85
  "build": "rm -rf distribution && tsc -p tsconfig.build.json",