react-scroll-control 1.0.3 → 1.0.4
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 → README.md} +32 -0
- package/package.json +1 -1
package/{readme.md → README.md}
RENAMED
|
@@ -48,3 +48,35 @@ Using npm:
|
|
|
48
48
|
|
|
49
49
|
```bash
|
|
50
50
|
npm install react-scroll-control
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
## 🚀 Usage
|
|
54
|
+
|
|
55
|
+
```jsx
|
|
56
|
+
import useSmoothScroll from "react-scroll-control";
|
|
57
|
+
|
|
58
|
+
function App() {
|
|
59
|
+
useSmoothScroll(0.5);
|
|
60
|
+
|
|
61
|
+
return (
|
|
62
|
+
<div>
|
|
63
|
+
<h1>Hello JSX</h1>
|
|
64
|
+
</div>
|
|
65
|
+
);
|
|
66
|
+
}
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
## ⚠️ Important Notes
|
|
71
|
+
|
|
72
|
+
- This hook replaces native mouse-wheel scrolling
|
|
73
|
+
|
|
74
|
+
- Uses { passive: false } to allow preventDefault()
|
|
75
|
+
|
|
76
|
+
- Best used at the root level of the application
|
|
77
|
+
|
|
78
|
+
- Avoid nested scroll containers
|
|
79
|
+
|
|
80
|
+
- Not suitable for touch-based scrolling
|
|
81
|
+
|
|
82
|
+
- Desktop browsers only
|