@nightshadeui/scroller 3.1.1 → 3.2.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
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# @nightshadeui/scroller
|
|
2
|
+
|
|
3
|
+
How far an element has scrolled through the viewport, as a reactive number from 0 to 1.
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
npm i @nightshadeui/scroller
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
import { ScrollerController } from '@nightshadeui/scroller';
|
|
11
|
+
|
|
12
|
+
const scroller = new ScrollerController({
|
|
13
|
+
start: 0.2,
|
|
14
|
+
end: 1,
|
|
15
|
+
});
|
|
16
|
+
scroller.mount(el);
|
|
17
|
+
// scroller.t goes from 0 to 1 as el scrolls through
|
|
18
|
+
scroller.unmount();
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
| Param | Default | Means |
|
|
22
|
+
|-------|---------|-------|
|
|
23
|
+
| `start` | `0` | where `startAnchor` has to be for `t` to leave 0, as a viewport fraction from the bottom |
|
|
24
|
+
| `end` | `1` | where `endAnchor` has to be for `t` to reach 1, on the same scale |
|
|
25
|
+
| `startAnchor` | `top` | which edge of the element starts the count |
|
|
26
|
+
| `endAnchor` | `bottom` | which edge ends it |
|
|
27
|
+
|
|
28
|
+
Pass `t` to CSS as a variable, `:style="{ '--t': scroller.t }"`, and let `calc()` do the animation.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ScrollerController.d.ts","sourceRoot":"","sources":["../src/ScrollerController.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE5C,qBAAa,kBAAkB;IAWvB,QAAQ,CAAC,MAAM,EAAE,cAAc;IATnC,OAAO,CAAC,EAAE,CAA4B;IACtC,OAAO,CAAC,KAAK,CAAK;IAClB,OAAO,CAAC,KAAK,CAEV;IAEH,OAAO,CAAC,QAAQ,CAAuB;gBAG1B,MAAM,GAAE,cAAmB;IAGxC,IAAI,CAAC,WAEJ;IAED,KAAK,CAAC,EAAE,EAAE,WAAW;
|
|
1
|
+
{"version":3,"file":"ScrollerController.d.ts","sourceRoot":"","sources":["../src/ScrollerController.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE5C,qBAAa,kBAAkB;IAWvB,QAAQ,CAAC,MAAM,EAAE,cAAc;IATnC,OAAO,CAAC,EAAE,CAA4B;IACtC,OAAO,CAAC,KAAK,CAAK;IAClB,OAAO,CAAC,KAAK,CAEV;IAEH,OAAO,CAAC,QAAQ,CAAuB;gBAG1B,MAAM,GAAE,cAAmB;IAGxC,IAAI,CAAC,WAEJ;IAED,KAAK,CAAC,EAAE,EAAE,WAAW;IAOrB,OAAO;IAOP,MAAM;IAKN,OAAO,CAAC,SAAS;IAOjB,OAAO,CAAC,QAAQ;CAkBnB"}
|
|
@@ -15,11 +15,13 @@ export class ScrollerController {
|
|
|
15
15
|
mount(el) {
|
|
16
16
|
this.el = el;
|
|
17
17
|
window.addEventListener('scroll', this.onScroll, { passive: true });
|
|
18
|
+
window.addEventListener('resize', this.onScroll, { passive: true });
|
|
18
19
|
this.update();
|
|
19
20
|
}
|
|
20
21
|
unmount() {
|
|
21
22
|
this.el = null;
|
|
22
23
|
window.removeEventListener('scroll', this.onScroll);
|
|
24
|
+
window.removeEventListener('resize', this.onScroll);
|
|
23
25
|
cancelAnimationFrame(this.frame);
|
|
24
26
|
}
|
|
25
27
|
update() {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ScrollerController.js","sourceRoot":"","sources":["../src/ScrollerController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,KAAK,CAAC;AAI/B,MAAM,OAAO,kBAAkB;IAU3B,YACa,SAAyB,EAAE;QAA3B,WAAM,GAAN,MAAM,CAAqB;QAThC,OAAE,GAAuB,IAAI,CAAC;QAC9B,UAAK,GAAG,CAAC,CAAC;QACV,UAAK,GAAG,QAAQ,CAAC;YACrB,CAAC,EAAE,CAAC;SACP,CAAC,CAAC;QAEK,aAAQ,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;IAIpC,CAAC;IAEJ,IAAI,CAAC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IACxB,CAAC;IAED,KAAK,CAAC,EAAe;QACjB,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,MAAM,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;QACpE,IAAI,CAAC,MAAM,EAAE,CAAC;IAClB,CAAC;IAED,OAAO;QACH,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC;QACf,MAAM,CAAC,mBAAmB,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QACpD,oBAAoB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC;IAED,MAAM;QACF,oBAAoB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACjC,IAAI,CAAC,KAAK,GAAG,qBAAqB,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;IAC/D,CAAC;IAEO,SAAS;QACb,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;YACX,OAAO;QACX,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC1C,CAAC;IAEO,QAAQ,CAAC,EAAe;QAC5B,MAAM,EACF,KAAK,GAAG,CAAC,EACT,GAAG,GAAG,CAAC,EACP,WAAW,GAAG,KAAK,EACnB,SAAS,GAAG,QAAQ,GACvB,GAAG,IAAI,CAAC,MAAM,CAAC;QAChB,MAAM,CAAC,GAAG,MAAM,CAAC,WAAW,CAAC;QAC7B,MAAM,IAAI,GAAG,EAAE,CAAC,qBAAqB,EAAE,CAAC;QACxC,MAAM,YAAY,GAAG,WAAW,KAAK,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC;QAC/E,MAAM,UAAU,GAAG,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3E,MAAM,MAAM,GAAG,YAAY,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC;QAC9C,MAAM,IAAI,GAAG,UAAU,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC;QACxC,MAAM,MAAM,GAAG,IAAI,GAAG,MAAM,CAAC;QAC7B,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,GAAG,MAAM,CAAC;QAChC,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACvC,CAAC;CAEJ"}
|
|
1
|
+
{"version":3,"file":"ScrollerController.js","sourceRoot":"","sources":["../src/ScrollerController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,KAAK,CAAC;AAI/B,MAAM,OAAO,kBAAkB;IAU3B,YACa,SAAyB,EAAE;QAA3B,WAAM,GAAN,MAAM,CAAqB;QAThC,OAAE,GAAuB,IAAI,CAAC;QAC9B,UAAK,GAAG,CAAC,CAAC;QACV,UAAK,GAAG,QAAQ,CAAC;YACrB,CAAC,EAAE,CAAC;SACP,CAAC,CAAC;QAEK,aAAQ,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;IAIpC,CAAC;IAEJ,IAAI,CAAC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IACxB,CAAC;IAED,KAAK,CAAC,EAAe;QACjB,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,MAAM,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;QACpE,MAAM,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;QACpE,IAAI,CAAC,MAAM,EAAE,CAAC;IAClB,CAAC;IAED,OAAO;QACH,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC;QACf,MAAM,CAAC,mBAAmB,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QACpD,MAAM,CAAC,mBAAmB,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QACpD,oBAAoB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC;IAED,MAAM;QACF,oBAAoB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACjC,IAAI,CAAC,KAAK,GAAG,qBAAqB,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;IAC/D,CAAC;IAEO,SAAS;QACb,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;YACX,OAAO;QACX,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC1C,CAAC;IAEO,QAAQ,CAAC,EAAe;QAC5B,MAAM,EACF,KAAK,GAAG,CAAC,EACT,GAAG,GAAG,CAAC,EACP,WAAW,GAAG,KAAK,EACnB,SAAS,GAAG,QAAQ,GACvB,GAAG,IAAI,CAAC,MAAM,CAAC;QAChB,MAAM,CAAC,GAAG,MAAM,CAAC,WAAW,CAAC;QAC7B,MAAM,IAAI,GAAG,EAAE,CAAC,qBAAqB,EAAE,CAAC;QACxC,MAAM,YAAY,GAAG,WAAW,KAAK,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC;QAC/E,MAAM,UAAU,GAAG,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3E,MAAM,MAAM,GAAG,YAAY,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC;QAC9C,MAAM,IAAI,GAAG,UAAU,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC;QACxC,MAAM,MAAM,GAAG,IAAI,GAAG,MAAM,CAAC;QAC7B,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,GAAG,MAAM,CAAC;QAChC,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACvC,CAAC;CAEJ"}
|
package/package.json
CHANGED
|
@@ -23,12 +23,14 @@ export class ScrollerController {
|
|
|
23
23
|
mount(el: HTMLElement) {
|
|
24
24
|
this.el = el;
|
|
25
25
|
window.addEventListener('scroll', this.onScroll, { passive: true });
|
|
26
|
+
window.addEventListener('resize', this.onScroll, { passive: true });
|
|
26
27
|
this.update();
|
|
27
28
|
}
|
|
28
29
|
|
|
29
30
|
unmount() {
|
|
30
31
|
this.el = null;
|
|
31
32
|
window.removeEventListener('scroll', this.onScroll);
|
|
33
|
+
window.removeEventListener('resize', this.onScroll);
|
|
32
34
|
cancelAnimationFrame(this.frame);
|
|
33
35
|
}
|
|
34
36
|
|