Skip to content

Commit

Permalink
v0.2.8
Browse files Browse the repository at this point in the history
  • Loading branch information
clementroche committed Sep 28, 2022
2 parents eb56df2 + f5aa992 commit df3cf7b
Show file tree
Hide file tree
Showing 12 changed files with 43 additions and 17 deletions.
34 changes: 30 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,23 +11,46 @@ This is our take on smooth scroll, lightweight, hard working, smooth as butter s
## Features

- Performant
- Lightweight [(~2Kb gzipped)](https://bundle.js.org/?q=@studio-freight/lenis)
- Lightweight [(~2Kb gzipped)](https://bundlejs.com/?q=%40studio-freight%2Flenis)
- Run scroll in main thread
- Accessibility (CMD+F page search, Tab and arrow navigation, keep scroll position on page refresh, etc.)
- External RAF
- SSR proof
- Not opinionated
- Tree-shakable
- Custom scroll easing/duration

<br>

## Installing
| Feature | [Locomotive-scroll](https://github.com/locomotivemtl/locomotive-scroll) | [GSAP ScrollSmoother](https://greensock.com/scrollsmoother/) | [Lenis](https://github.com/studio-freight/lenis) |
|-----------------------------|-------------------|---------------------|--------|
| Native scrollbar ||||
| Native scroll inputs ||||
| Normalize scroll experience ||||
| Accessibility ||||
| CSS Sticky ||||
| IntsersectionObserver ||||
| Open source ||||
| Built-in animation system ||||
| Size (gzip) | [12.33KB](https://bundlejs.com/?q=locomotive-scroll) | [26.08KB](https://bundlejs.com/?q=gsap%2FScrollSmoother&treeshake=%5B%7BScrollSmoother%7D%5D) | [2.13kb](https://bundlejs.com/?q=%40studio-freight%2Flenis) |

just the usual:
<br>

## Installing

using package manager:
```bash
$ npm i @studio-freight/lenis
```

or replace `npm` with your package manager of choice :)
<br/>

using scripts:
```html
<script src="https://cdn.jsdelivr.net/gh/studio-freight/lenis@latest/bundled/lenis.js"></script>
```



<br>

Expand Down Expand Up @@ -141,6 +164,9 @@ body {
- [Repeat](https://getrepeat.io/) by [Studio Freight](https://www.studiofreight.com/)
- [Dragonfly](https://dragonfly.xyz/) by [Studio Freight](https://www.studiofreight.com/)
- [Yuga Labs](https://yuga.com/) by [Antinomy Studio](https://antinomy.studio/)
- [Quentin Hocde's Portfolio](https://quentinhocde.com) by [Quentin Hocde](https://twitter.com/QuentinHocde)
- [Houses Of](https://housesof.world) by [Félix P.](https://flayks.com/) & [Shelby Kay](https://shelbykay.dev/)
- [Shelby Kay's Portfolio](https://shelbykay.dev) by [Shelby Kay](https://shelbykay.dev/)

<br/>

Expand Down
4 changes: 2 additions & 2 deletions bundled/lenis.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dist/lenis.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion dist/lenis.js.map

Large diffs are not rendered by default.

Loading

2 comments on commit df3cf7b

@vercel
Copy link

@vercel vercel bot commented on df3cf7b Sep 28, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"⚡️ Lighthouse report for the changes in this commit:

🔴 Performance: 42
🟢 Accessibility: 98
🟢 Best practices: 92
🟢 SEO: 92
🟢 PWA: 100

Lighthouse ran on https://lenis-7qft5gq2u-studio-freight.vercel.app/"

Please sign in to comment.