{
 "slug": "lenis",
 "name": "Lenis",
 "author": "darkroom.engineering",
 "density": "full",
 "status": "active",
 "status_note": null,
 "alternatives_page": null,
 "one_liner": "Lightweight smooth-scroll library often paired with GSAP ScrollTrigger and WebGL scroll effects.",
 "category": {
  "slug": "motion-examples",
  "name": "Web animation examples and effects"
 },
 "tags": [
  "Code library",
  "Open source"
 ],
 "styles": [
  "minimal"
 ],
 "logo_url": "https://agentgid.com/media/avatars/darkroomengineering.png",
 "logo_letter": "L",
 "links": {
  "repo": "https://github.com/darkroomengineering/lenis",
  "website": "https://lenis.dev",
  "api_docs": null
 },
 "preview": {
  "kind": "image_grid",
  "src": "https://agentgid.com/assets/lenis/demo.jpg",
  "alt": "Scroll position over two seconds after one jump of 3000 pixels, as an instant step without smoothing, and with Lenis at duration 1.2 s, lerp 0.1 and lerp 0.03.",
  "caption": "Made by AgentGid with lenis 1.3.27 (npm, dist/lenis.min.js). MIT license; the chart is drawn by our own code from values Lenis returned."
 },
 "verdicts": [
  {
   "key": "price",
   "label": "Price",
   "value": "Free",
   "status": "yes",
   "sub": "No paid plan",
   "quote": null,
   "note": "Fully free.",
   "source": {
    "label": "lenis.dev",
    "url": "https://lenis.dev"
   },
   "n": 1
  },
  {
   "key": "commercial",
   "label": "Commercial use",
   "value": "Yes",
   "status": "yes",
   "sub": "MIT",
   "quote": "to use, copy, modify, merge, publish, distribute, sublicense, and/or sell",
   "note": "MIT allows use, change and sale in paid products.",
   "source": {
    "label": "raw.githubusercontent.com",
    "url": "https://raw.githubusercontent.com/darkroomengineering/lenis/main/LICENSE"
   },
   "n": 2
  },
  {
   "key": "credit",
   "label": "Credit the author",
   "value": "Not needed",
   "status": "yes",
   "sub": "Keep the notice in code copies",
   "quote": "The above copyright notice and this permission notice shall be included in all",
   "note": "No credit on screen. Keep the license notice inside the code you ship.",
   "source": {
    "label": "raw.githubusercontent.com",
    "url": "https://raw.githubusercontent.com/darkroomengineering/lenis/main/LICENSE"
   },
   "n": 3
  },
  {
   "key": "agent_access",
   "label": "Agent access",
   "value": "npm package",
   "status": "info",
   "sub": "Installs without a key",
   "quote": null,
   "note": "An agent can install it by itself with npm install lenis. No key or account is needed.",
   "source": {
    "label": "github.com/darkroomengineering/lenis",
    "url": "https://github.com/darkroomengineering/lenis"
   },
   "n": 4
  }
 ],
 "license": {
  "name": "MIT",
  "url": "https://raw.githubusercontent.com/darkroomengineering/lenis/main/LICENSE",
  "summary": "Free to use in personal and paid sites, with no visible credit. Keep the copyright and license notice with copies of the code.",
  "pages_read": 1,
  "rules": [
   "Keep the MIT notice if you redistribute the code.",
   "Respect prefers-reduced-motion."
  ],
  "rows": [
   {
    "label": "Commercial use",
    "value": "Yes",
    "status": "yes",
    "quote": "to use, copy, modify, merge, publish, distribute, sublicense, and/or sell",
    "source": {
     "label": "raw.githubusercontent.com",
     "url": "https://raw.githubusercontent.com/darkroomengineering/lenis/main/LICENSE"
    },
    "note": null
   },
   {
    "label": "Credit",
    "value": "Not needed",
    "status": "yes",
    "quote": "The above copyright notice and this permission notice shall be included in all",
    "source": {
     "label": "raw.githubusercontent.com",
     "url": "https://raw.githubusercontent.com/darkroomengineering/lenis/main/LICENSE"
    },
    "note": null
   },
   {
    "label": "Inside your app or game",
    "value": "Can ship inside your app",
    "status": "yes",
    "quote": "to use, copy, modify, merge, publish, distribute, sublicense, and/or sell",
    "source": {
     "label": "raw.githubusercontent.com",
     "url": "https://raw.githubusercontent.com/darkroomengineering/lenis/main/LICENSE"
    },
    "note": null
   },
   {
    "label": "Pass the files on to your users",
    "value": "Allowed",
    "status": "yes",
    "quote": "to use, copy, modify, merge, publish, distribute, sublicense, and/or sell",
    "source": {
     "label": "raw.githubusercontent.com",
     "url": "https://raw.githubusercontent.com/darkroomengineering/lenis/main/LICENSE"
    },
    "note": null
   },
   {
    "label": "AI training",
    "value": "Not stated",
    "status": "unknown",
    "quote": null,
    "source": null,
    "note": null
   },
   {
    "label": "Bots and bulk downloads",
    "value": "Not stated",
    "status": "unknown",
    "quote": null,
    "source": null,
    "note": null
   }
  ],
  "checked_at": "2026-11-05",
  "commercial_use_page": "https://agentgid.com/assets/lenis/commercial-use/"
 },
 "overview": {
  "heading": "Lenis: smooth page scrolling for websites",
  "body": "Lenis is a small free script that makes a web page glide when people scroll, instead of jumping in steps. It keeps the browser's own scrolling underneath, so sticky headers, links to page sections and screen readers keep working. Design studios use it with scroll animations and 3D scenes."
 },
 "uses": [
  {
   "title": "A smoother feel on a landing page",
   "text": "Make wheel and trackpad scrolling glide on a portfolio or product page, added with a few lines and no build step.",
   "idea": false,
   "image": null
  },
  {
   "title": "Scroll animations that stay in sync",
   "text": "When pictures and text animate as you scroll, Lenis and the animation library move together on one clock, so effects do not lag behind the page.",
   "idea": false,
   "image": null
  },
  {
   "title": "Smooth jumps to page sections",
   "text": "Clicking Pricing or Contact in the menu glides to that part of the page, with room left for a fixed header.",
   "idea": false,
   "image": null
  },
  {
   "title": "3D and WebGL scenes tied to scroll",
   "text": "Keep a 3D scene or a moving background in step with the page as people scroll through a story site.",
   "idea": false,
   "image": null
  },
  {
   "title": "Smooth scrolling on a Framer site",
   "text": "Add the same smooth feel to a site made in Framer with the official plugin, without writing code.",
   "idea": false,
   "image": null
  },
  {
   "title": "Horizontal gallery sections",
   "text": "Let a row of project images or a timeline glide sideways, for a gallery or a case study page.",
   "idea": true,
   "image": null
  }
 ],
 "start": {
  "prompt": "Add lenis 1.3.27 with its recommended CSS, start it with autoRaf true and anchors true, mark the modal and the dropdown with data-lenis-prevent, and keep the default respect for reduced motion.",
  "install": "npm i lenis",
  "install_note": null,
  "code": [
   {
    "tab": "Step 1",
    "intro": "Start Lenis with its own animation loop turned on.",
    "source": "import Lenis from 'lenis'\nimport 'lenis/dist/lenis.css'\n\nconst lenis = new Lenis({\n  autoRaf: true,\n});"
   },
   {
    "tab": "Step 2",
    "intro": "Mark boxes that must scroll on their own, such as a modal or a long dropdown, so Lenis leaves them alone.",
    "source": "<div data-lenis-prevent>scrollable content</div>"
   }
  ]
 },
 "mistakes": [
  {
   "dont": "new Lenis() with no autoRaf and no animation loop",
   "fix": "new Lenis({ autoRaf: true }), or call lenis.raf(time) in your own requestAnimationFrame or GSAP ticker loop",
   "why": "Lenis only moves the page when raf runs every frame; otherwise scrolling looks dead.",
   "dont_code": false,
   "fix_code": false
  },
  {
   "dont": "Leaving out lenis.css",
   "fix": "import 'lenis/dist/lenis.css' or link dist/lenis.css from the same version",
   "why": "The CSS handles stopped state, nested scroll areas and iframes; the troubleshooting list asks for it.",
   "dont_code": false,
   "fix_code": true
  },
  {
   "dont": "smoothTouch: true (from older guides and the site llms.txt)",
   "fix": "syncTouch: true, only when you need touch scroll synced",
   "why": "The current settings list has syncTouch, not smoothTouch, and the limits list warns about it on older iOS.",
   "dont_code": false,
   "fix_code": false
  },
  {
   "dont": "CSS scroll-snap-type on sections together with Lenis",
   "fix": "Use the lenis/snap add-on for snapping",
   "why": "Lenis does not support CSS scroll-snap.",
   "dont_code": false,
   "fix_code": false
  },
  {
   "dont": "<script src=\"https://unpkg.com/lenis\"></script> (no version, as in the site llms.txt)",
   "fix": "Pin the version, e.g. https://unpkg.com/lenis@1.3.27/dist/lenis.min.js, or install from npm",
   "why": "An unversioned link loads whatever is newest and can change behavior without warning.",
   "dont_code": true,
   "fix_code": false
  }
 ],
 "agent": {
  "self_serve": true,
  "self_serve_text": "Agent installs a package or loads it from a CDN",
  "install": "npm install lenis",
  "repo": "https://github.com/darkroomengineering/lenis",
  "api_docs": null,
  "api_account": "Not needed. Everything runs on your side.",
  "get_files": "npm install lenis, create new Lenis() and drive it with requestAnimationFrame or GSAP's ticker.",
  "formats": [
   "js",
   "css"
  ],
  "limits": null,
  "mcp": null,
  "mcp_url": null,
  "credit_line": "Smooth scroll: Lenis by darkroom.engineering (MIT)",
  "rules_text": "- Lenis (Web animation examples and effects, UI animation (Lottie, Rive)). Lightweight smooth-scroll library often paired with GSAP ScrollTrigger and WebGL scroll effects. Price: free; commercial use OK; no credit needed. Style: minimal.\n  Connect: npm lenis.\n  Get files: npm install lenis, create new Lenis() and drive it with requestAnimationFrame or GSAP's ticker (js, css).\n  Rule: Keep the MIT notice if you redistribute the code.\n  Rule: Respect prefers-reduced-motion.\n  License: https://raw.githubusercontent.com/darkroomengineering/lenis/main/LICENSE (checked 2026-11-05; details: https://agentgid.com/assets/lenis/)",
  "agent_md": "https://agentgid.com/assets/lenis/agent.md",
  "card_json": "https://agentgid.com/assets/lenis/card.json"
 },
 "popularity": {
  "gid_score": 59,
  "stars": 17316,
  "downloads_7d": 2747298,
  "downloads_7d_label": "2.7M",
  "downloads_change_4w_pct": 30.4,
  "eco": "npm",
  "package": "lenis",
  "repo": "darkroomengineering/lenis",
  "agent_projects": 38,
  "agent_projects_total": 4817,
  "downloads_unconfirmed": false,
  "series": {
   "downloads_weekly": [
    [
     "2025-11-17",
     111754
    ],
    [
     "2025-11-24",
     114766
    ],
    [
     "2025-12-01",
     135071
    ],
    [
     "2025-12-08",
     154639
    ],
    [
     "2025-12-15",
     145162
    ],
    [
     "2025-12-22",
     112203
    ],
    [
     "2025-12-29",
     114883
    ],
    [
     "2026-01-05",
     166548
    ],
    [
     "2026-01-12",
     183368
    ],
    [
     "2026-01-19",
     197019
    ],
    [
     "2026-01-26",
     213574
    ],
    [
     "2026-02-02",
     306041
    ],
    [
     "2026-02-09",
     256206
    ],
    [
     "2026-02-16",
     307491
    ],
    [
     "2026-02-23",
     326137
    ],
    [
     "2026-03-02",
     362315
    ],
    [
     "2026-03-09",
     359229
    ],
    [
     "2026-03-16",
     482250
    ],
    [
     "2026-03-23",
     412059
    ],
    [
     "2026-03-30",
     428362
    ],
    [
     "2026-04-06",
     374047
    ],
    [
     "2026-04-13",
     433593
    ],
    [
     "2026-04-20",
     461696
    ],
    [
     "2026-04-27",
     505887
    ],
    [
     "2026-05-04",
     562908
    ],
    [
     "2026-05-11",
     625887
    ],
    [
     "2026-05-18",
     674141
    ],
    [
     "2026-05-25",
     703147
    ],
    [
     "2026-06-01",
     777601
    ],
    [
     "2026-06-08",
     848202
    ],
    [
     "2026-06-15",
     1012991
    ],
    [
     "2026-06-22",
     911062
    ],
    [
     "2026-06-29",
     876774
    ],
    [
     "2026-07-06",
     1030592
    ],
    [
     "2026-07-13",
     1151952
    ],
    [
     "2026-07-20",
     1193323
    ],
    [
     "2026-07-27",
     1270782
    ],
    [
     "2026-08-03",
     1349285
    ],
    [
     "2026-08-10",
     1337965
    ],
    [
     "2026-08-17",
     1306182
    ],
    [
     "2026-08-24",
     1357339
    ],
    [
     "2026-08-31",
     1580647
    ],
    [
     "2026-09-07",
     1089604
    ],
    [
     "2026-09-14",
     1313296
    ],
    [
     "2026-09-21",
     1747876
    ],
    [
     "2026-09-28",
     2055723
    ],
    [
     "2026-10-05",
     1889167
    ],
    [
     "2026-10-12",
     1565593
    ],
    [
     "2026-10-19",
     1646400
    ],
    [
     "2026-10-26",
     2399728
    ],
    [
     "2026-11-02",
     2672296
    ],
    [
     "2026-11-09",
     2747298
    ]
   ],
   "stars": [
    [
     "2026-11-07",
     17137
    ],
    [
     "2026-11-08",
     17140
    ],
    [
     "2026-11-09",
     17154
    ],
    [
     "2026-11-10",
     17175
    ],
    [
     "2026-11-11",
     17186
    ],
    [
     "2026-11-12",
     17207
    ],
    [
     "2026-11-13",
     17231
    ],
    [
     "2026-11-14",
     17250
    ],
    [
     "2026-11-15",
     17269
    ],
    [
     "2026-11-16",
     17289
    ],
    [
     "2026-11-17",
     17316
    ]
   ]
  },
  "stars_flat_since": null,
  "updated_at": "2026-11-17"
 },
 "alternatives": [
  {
   "slug": "lenis",
   "name": "Lenis",
   "why": null,
   "current": true,
   "price": "Free",
   "commercial": {
    "value": "Commercial OK",
    "status": "yes"
   },
   "access": "npm"
  },
  {
   "slug": "gsap",
   "name": "GSAP (GreenSock)",
   "why": "Pick GSAP when you need the scroll animations themselves (pinning, scrubbing, text effects); it pairs with Lenis rather than replacing it.",
   "current": false,
   "price": "Free",
   "commercial": {
    "value": "Commercial OK",
    "status": "yes"
   },
   "access": "npm"
  },
  {
   "slug": "aos",
   "name": "AOS (Animate On Scroll)",
   "why": "Pick AOS when you only want elements to fade or slide in as they appear, set with data attributes, without changing how the page scrolls.",
   "current": false,
   "price": "Free",
   "commercial": {
    "value": "Commercial OK",
    "status": "yes"
   },
   "access": "npm"
  },
  {
   "slug": "animate-css",
   "name": "Animate.css",
   "why": "Pick Animate.css for ready entrance and attention animations added with one class name.",
   "current": false,
   "price": "Free",
   "commercial": {
    "value": "With conditions",
    "status": "cond"
   },
   "access": "npm"
  },
  {
   "slug": "threejs-examples",
   "name": "three.js examples",
   "why": "Hundreds of official three.js WebGL/WebGPU examples (shaders, particles, post-processing, loaders) with full source in the repo's examples folder.",
   "current": false,
   "price": "Free",
   "commercial": {
    "value": "Commercial OK",
    "status": "yes"
   },
   "access": "npm"
  },
  {
   "slug": "react-three-fiber-examples",
   "name": "React Three Fiber examples",
   "why": "Gallery of React Three Fiber scenes (shaders, portals, caustics, scroll, physics, glass) linked to runnable sandboxes with source.",
   "current": false,
   "price": "Free",
   "commercial": {
    "value": "Commercial OK",
    "status": "yes"
   },
   "access": "npm"
  }
 ],
 "faq": [
  {
   "q": "Does smooth scrolling break sticky headers or links to sections?",
   "a": "No. Lenis wraps the browser's own scroll, so sticky elements and anchor links keep working; turn on anchors for smooth jumps."
  },
  {
   "q": "Does it work with React or Vue?",
   "a": "Yes. There are packages lenis/react and lenis/vue, plus a Framer plugin."
  },
  {
   "q": "Can I change how heavy the scroll feels?",
   "a": "Yes. Lower lerp values (default 0.1) make it heavier and slower; or set a duration and an easing."
  },
  {
   "q": "Can I use it on a paid client site?",
   "a": "Yes. It is MIT licensed; keep the license notice with the code."
  }
 ],
 "at_a_glance": {
  "latest_version": "1.3.27",
  "last_release": "2026-10-15",
  "last_commit": "2026-11-13",
  "runtime": "Modern browsers; no dependencies. lenis/react needs React 17+, lenis/vue needs Vue 3+ (optional peers).",
  "key_needed": false,
  "formats": "js, css"
 },
 "good_to_know": [
  "People who turned on reduced motion in their system get normal, unsmoothed scrolling by default. Keep it that way.",
  "The browser's built-in snap to sections does not work with it; a separate snap add-on does that job.",
  "Smoothing stops over embedded frames such as video or map embeds, and Safari limits it to 60 frames per second.",
  "Boxes that scroll on their own inside the page, like a modal, need a setting or a marker, or they stop scrolling smoothly."
 ],
 "stack_snippets": [],
 "claims": [
  "The whole library is a few KB with zero runtime dependencies",
  "Under 5kb"
 ],
 "checked": {
  "license_read": "2026-11-05",
  "overview_checked": "2026-11-09",
  "numbers_updated": "2026-11-17",
  "sources": [
   {
    "label": "lenis.dev",
    "url": "https://lenis.dev/"
   },
   {
    "label": "lenis.dev/llms.txt",
    "url": "https://lenis.dev/llms.txt"
   },
   {
    "label": "github.com/darkroomengineering/lenis",
    "url": "https://github.com/darkroomengineering/lenis"
   },
   {
    "label": "README on GitHub",
    "url": "https://github.com/darkroomengineering/lenis/blob/main/README.md"
   },
   {
    "label": "LICENSE on GitHub",
    "url": "https://github.com/darkroomengineering/lenis/blob/main/LICENSE"
   },
   {
    "label": "npm: lenis/latest",
    "url": "https://registry.npmjs.org/lenis/latest"
   },
   {
    "label": "npm: lenis/1.3.27",
    "url": "https://registry.npmjs.org/lenis/1.3.27"
   },
   {
    "label": "raw.githubusercontent.com",
    "url": "https://raw.githubusercontent.com/darkroomengineering/lenis/main/LICENSE"
   }
  ],
  "unverified": null
 },
 "user_reports": null,
 "url": "https://agentgid.com/assets/lenis/",
 "note": "Written by AgentGid from the official pages in checked.sources; quotes are copied from those pages. status: yes | cond | no | unknown | info. Prices and vendor claims are as reported on the checked date. Not legal advice."
}
