@studio-freight/react-lenis - npm Package Compare versions

Comparing version 0.0.15 to 0.0.16

package.json

 {
   "name": "@studio-freight/react-lenis",
-  "version": "0.0.15",
+  "version": "0.0.16",
   "description": "",
@@ -58,5 +58,5 @@ "files": [
     "react-dom": "^18.2.0",
-    "rimraf": "^4.4.1",
+    "rimraf": "^5.0.0",
     "typescript": "^5.0.4",
-    "vite": "^4.2.1",
+    "vite": "^4.3.1",
     "zustand": "^4.3.2"
@@ -76,3 +76,3 @@ },
     "@studio-freight/hamo": "0.6.12",
-    "@studio-freight/lenis": "latest",
+    "@studio-freight/lenis": "^1.0.10",
     "prop-types": "^15.8.1",
@@ -79,0 +79,0 @@ "zustand": "^4.3.7"

README.md

@@ -28,6 +28,25 @@ [![Bibliotheca](https://assets.studiofreight.com/bibliotheca/header.png)](https://github.com/studio-freight/bibliotheca)
 
+## Installation
+
+For npm users:
+```
+npm i @studio-freight/react-lenis
+```
+
+For yarn users:
+```
+yarn add @studio-freight/react-lenis
+```
+
+
 ## Usage
 
 ```js
-const Layout = () => {
+import { Lenis as ReactLenis, useLenis } from '@studio-freight/react-lenis'
+
+function Layout() {
+  const lenis = useLenis(({scroll}) => {
+    // called every scroll
+  })
+
   return (
@@ -34,0 +53,0 @@ <ReactLenis root options={{ ...options }}>

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

111

increased by20.65%

Worsened metrics

Total package byte prevSize

39546

decreased by-2.43%

Dependency changes

• Updated@studio-freight/lenis@^1.0.10