@ehfuse/overlay-scrollbar 1.6.23 → 1.7.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.
Files changed (15) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +160 -131
  3. package/dist/OverlayScrollbar.d.ts +2 -0
  4. package/dist/OverlayScrollbar.d.ts.map +1 -1
  5. package/dist/hooks/usePullToRefresh.d.ts +25 -0
  6. package/dist/hooks/usePullToRefresh.d.ts.map +1 -0
  7. package/dist/index.d.ts +1 -1
  8. package/dist/index.d.ts.map +1 -1
  9. package/dist/index.esm.js +7 -2
  10. package/dist/index.esm.js.map +4 -4
  11. package/dist/index.js +7 -2
  12. package/dist/index.js.map +4 -4
  13. package/dist/types.d.ts +9 -0
  14. package/dist/types.d.ts.map +1 -1
  15. package/package.json +52 -52
package/dist/types.d.ts CHANGED
@@ -42,6 +42,13 @@ export interface AutoHideConfig {
42
42
  delayOnWheel?: number;
43
43
  initialDelay?: number;
44
44
  }
45
+ export interface PullToRefreshConfig {
46
+ enabled?: boolean;
47
+ onRefresh?: () => void | Promise<void>;
48
+ threshold?: number;
49
+ maxDistance?: number;
50
+ indicatorColor?: string;
51
+ }
45
52
  export interface OverlayScrollbarProps {
46
53
  className?: string;
47
54
  style?: React.CSSProperties;
@@ -54,6 +61,7 @@ export interface OverlayScrollbarProps {
54
61
  arrows?: ArrowsConfig;
55
62
  dragScroll?: DragScrollConfig;
56
63
  autoHide?: AutoHideConfig;
64
+ pullToRefresh?: PullToRefreshConfig;
57
65
  showScrollbar?: boolean;
58
66
  showHorizontalScrollbar?: boolean;
59
67
  detectInnerScroll?: boolean;
@@ -70,4 +78,5 @@ export declare const DEFAULT_TRACK_CONFIG: TrackConfig;
70
78
  export declare const DEFAULT_ARROWS_CONFIG: ArrowsConfig;
71
79
  export declare const DEFAULT_DRAG_SCROLL_CONFIG: DragScrollConfig;
72
80
  export declare const DEFAULT_AUTO_HIDE_CONFIG: AutoHideConfig;
81
+ export declare const DEFAULT_PULL_TO_REFRESH_CONFIG: PullToRefreshConfig;
73
82
  //# sourceMappingURL=types.d.ts.map
package/dist/types.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAGlC,MAAM,WAAW,WAAW;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB;AAGD,MAAM,WAAW,WAAW;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,SAAS,CAAC,EAAE,OAAO,CAAC;CACvB;AAGD,MAAM,WAAW,YAAY;IACzB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB;AAGD,MAAM,WAAW,gBAAgB;IAC7B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC/B;AAGD,MAAM,WAAW,cAAc;IAC3B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,qBAAqB;IAClC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;IAC5B,cAAc,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;IACrC,YAAY,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;IACnC,QAAQ,EAAE,SAAS,CAAC;IACpB,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IAGlC,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAC9B,QAAQ,CAAC,EAAE,cAAc,CAAC;IAG1B,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAGD,MAAM,WAAW,mBAAmB;IAChC,kBAAkB,EAAE,MAAM,cAAc,GAAG,IAAI,CAAC;IAChD,QAAQ,EAAE,CAAC,OAAO,EAAE,eAAe,KAAK,IAAI,CAAC;IAC7C,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;CACxB;AAGD,eAAO,MAAM,oBAAoB,EAAE,WAAgB,CAAC;AACpD,eAAO,MAAM,oBAAoB,EAAE,WAAgB,CAAC;AACpD,eAAO,MAAM,qBAAqB,EAAE,YAAiB,CAAC;AACtD,eAAO,MAAM,0BAA0B,EAAE,gBAAqB,CAAC;AAC/D,eAAO,MAAM,wBAAwB,EAAE,cAAmB,CAAC"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAGlC,MAAM,WAAW,WAAW;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB;AAGD,MAAM,WAAW,WAAW;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,SAAS,CAAC,EAAE,OAAO,CAAC;CACvB;AAGD,MAAM,WAAW,YAAY;IACzB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB;AAGD,MAAM,WAAW,gBAAgB;IAC7B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC/B;AAGD,MAAM,WAAW,cAAc;IAC3B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB;AAGD,MAAM,WAAW,mBAAmB;IAChC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACvC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,qBAAqB;IAClC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;IAC5B,cAAc,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;IACrC,YAAY,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;IACnC,QAAQ,EAAE,SAAS,CAAC;IACpB,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IAGlC,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAC9B,QAAQ,CAAC,EAAE,cAAc,CAAC;IAC1B,aAAa,CAAC,EAAE,mBAAmB,CAAC;IAGpC,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAGD,MAAM,WAAW,mBAAmB;IAChC,kBAAkB,EAAE,MAAM,cAAc,GAAG,IAAI,CAAC;IAChD,QAAQ,EAAE,CAAC,OAAO,EAAE,eAAe,KAAK,IAAI,CAAC;IAC7C,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;CACxB;AAGD,eAAO,MAAM,oBAAoB,EAAE,WAAgB,CAAC;AACpD,eAAO,MAAM,oBAAoB,EAAE,WAAgB,CAAC;AACpD,eAAO,MAAM,qBAAqB,EAAE,YAAiB,CAAC;AACtD,eAAO,MAAM,0BAA0B,EAAE,gBAAqB,CAAC;AAC/D,eAAO,MAAM,wBAAwB,EAAE,cAAmB,CAAC;AAC3D,eAAO,MAAM,8BAA8B,EAAE,mBAAwB,CAAC"}
package/package.json CHANGED
@@ -1,52 +1,52 @@
1
- {
2
- "name": "@ehfuse/overlay-scrollbar",
3
- "version": "1.6.23",
4
- "description": "A React component that provides a custom overlay scrollbar with smooth animations and auto-hide functionality",
5
- "type": "module",
6
- "main": "dist/index.js",
7
- "module": "dist/index.esm.js",
8
- "types": "dist/index.d.ts",
9
- "files": [
10
- "dist",
11
- "README.md",
12
- "LICENSE"
13
- ],
14
- "scripts": {
15
- "build": "node build.js",
16
- "prepublishOnly": "npm run build",
17
- "dev": "node build.js",
18
- "test": "echo \"Error: no test specified\" && exit 1"
19
- },
20
- "keywords": [
21
- "react",
22
- "scrollbar",
23
- "overlay",
24
- "custom-scrollbar",
25
- "typescript",
26
- "ui-component",
27
- "smooth-scrolling",
28
- "auto-hide"
29
- ],
30
- "author": "KIM YOUNG JIN <ehfuse@gmail.com>",
31
- "license": "MIT",
32
- "repository": {
33
- "type": "git",
34
- "url": "https://github.com/ehfuse/overlay-scrollbar.git"
35
- },
36
- "bugs": {
37
- "url": "https://github.com/ehfuse/overlay-scrollbar/issues"
38
- },
39
- "homepage": "https://github.com/ehfuse/overlay-scrollbar#readme",
40
- "peerDependencies": {
41
- "react": ">=16.8.0",
42
- "react-dom": ">=16.8.0"
43
- },
44
- "devDependencies": {
45
- "@types/node": "^20.19.17",
46
- "@types/react": "^18.2.31",
47
- "@types/react-dom": "^18.2.14",
48
- "esbuild": "^0.27.0",
49
- "tslib": "^2.8.1",
50
- "typescript": "^5.9.3"
51
- }
52
- }
1
+ {
2
+ "name": "@ehfuse/overlay-scrollbar",
3
+ "version": "1.7.0",
4
+ "description": "A React component that provides a custom overlay scrollbar with smooth animations and auto-hide functionality",
5
+ "type": "module",
6
+ "main": "dist/index.js",
7
+ "module": "dist/index.esm.js",
8
+ "types": "dist/index.d.ts",
9
+ "files": [
10
+ "dist",
11
+ "README.md",
12
+ "LICENSE"
13
+ ],
14
+ "scripts": {
15
+ "build": "node build.js",
16
+ "prepublishOnly": "npm run build",
17
+ "dev": "node build.js",
18
+ "test": "echo \"Error: no test specified\" && exit 1"
19
+ },
20
+ "keywords": [
21
+ "react",
22
+ "scrollbar",
23
+ "overlay",
24
+ "custom-scrollbar",
25
+ "typescript",
26
+ "ui-component",
27
+ "smooth-scrolling",
28
+ "auto-hide"
29
+ ],
30
+ "author": "KIM YOUNG JIN <ehfuse@gmail.com>",
31
+ "license": "MIT",
32
+ "repository": {
33
+ "type": "git",
34
+ "url": "https://github.com/ehfuse/overlay-scrollbar.git"
35
+ },
36
+ "bugs": {
37
+ "url": "https://github.com/ehfuse/overlay-scrollbar/issues"
38
+ },
39
+ "homepage": "https://github.com/ehfuse/overlay-scrollbar#readme",
40
+ "peerDependencies": {
41
+ "react": ">=16.8.0",
42
+ "react-dom": ">=16.8.0"
43
+ },
44
+ "devDependencies": {
45
+ "@types/node": "^20.19.17",
46
+ "@types/react": "^18.2.31",
47
+ "@types/react-dom": "^18.2.14",
48
+ "esbuild": "^0.27.0",
49
+ "tslib": "^2.8.1",
50
+ "typescript": "^5.9.3"
51
+ }
52
+ }