Skip to content

Commit

Permalink
update docs url
Browse files Browse the repository at this point in the history
  • Loading branch information
clementroche committed Feb 20, 2024
1 parent c3f82d8 commit 0a48aab
Show file tree
Hide file tree
Showing 9 changed files with 2,673 additions and 19 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[![LENIS](https://assets.studiofreight.com/lenis/header.png)](https://github.com/studio-freight/lenis)
[![LENIS](https://assets.studiofreight.com/lenis/header.png)](https://github.com/darkroomengineering/lenis)

[![npm](https://img.shields.io/npm/v/%40studio-freight%2Flenis?colorA=000000&colorB=ff98a2
)](https://www.npmjs.com/package/@studio-freight/lenis)
Expand Down Expand Up @@ -73,7 +73,7 @@ gsap.ticker.lagSmoothing(0)
```

### React:
See documentation for [react-lenis](https://github.com/studio-freight/lenis/tree/main/packages/react-lenis).
See documentation for [react-lenis](https://github.com/darkroomengineering/lenis/tree/main/packages/react-lenis).



Expand Down Expand Up @@ -217,7 +217,7 @@ html.lenis {
- no support for CSS scroll-snap
- capped to 60fps on Safari ([source](https://bugs.webkit.org/show_bug.cgi?id=173434)) and 30fps on low power mode
- smooth scroll will stop working over iframe since they don't forward wheel events
- position fixed seems to lag on MacOS Safari pre-M1 ([source](https://github.com/studio-freight/lenis/issues/103))
- position fixed seems to lag on MacOS Safari pre-M1 ([source](https://github.com/darkroomengineering/lenis/issues/103))

<br>

Expand All @@ -233,7 +233,7 @@ html.lenis {
## Plugins

- [Loconative-scroll](https://github.com/quentinhocde/loconative-scroll#how-to-switch-from-locomotive-scroll-to-loconative-scroll) by [Quentin Hocde](https://twitter.com/QuentinHocde)
- [react-lenis](https://github.com/studio-freight/lenis/tree/main/packages/react-lenis) by [Studio Freight](https://www.studiofreight.com/)
- [react-lenis](https://github.com/darkroomengineering/lenis/tree/main/packages/react-lenis) by [Studio Freight](https://www.studiofreight.com/)
- [r3f-scroll-rig](https://github.com/14islands/r3f-scroll-rig) by [14islands](https://14islands.com/)
- [Lenis Scroll Snap Plugin](https://github.com/funkhaus/lenis-scroll-snap) by [Funkhaus](https://github.com/funkhaus)
- [locomotive-scroll](https://github.com/locomotivemtl/locomotive-scroll) by [Locomotive](https://locomotive.ca/)
Expand Down
8 changes: 4 additions & 4 deletions packages/lenis/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[![LENIS](https://assets.studiofreight.com/lenis/header.png)](https://github.com/studio-freight/lenis)
[![LENIS](https://assets.studiofreight.com/lenis/header.png)](https://github.com/darkroomengineering/lenis)

[![npm](https://img.shields.io/npm/v/%40studio-freight%2Flenis?colorA=000000&colorB=ff98a2
)](https://www.npmjs.com/package/@studio-freight/lenis)
Expand Down Expand Up @@ -73,7 +73,7 @@ gsap.ticker.lagSmoothing(0)
```

### React:
See documentation for [react-lenis](https://github.com/studio-freight/lenis/tree/main/packages/react-lenis).
See documentation for [react-lenis](https://github.com/darkroomengineering/lenis/tree/main/packages/react-lenis).



Expand Down Expand Up @@ -217,7 +217,7 @@ html.lenis {
- no support for CSS scroll-snap
- capped to 60fps on Safari ([source](https://bugs.webkit.org/show_bug.cgi?id=173434)) and 30fps on low power mode
- smooth scroll will stop working over iframe since they don't forward wheel events
- position fixed seems to lag on MacOS Safari pre-M1 ([source](https://github.com/studio-freight/lenis/issues/103))
- position fixed seems to lag on MacOS Safari pre-M1 ([source](https://github.com/darkroomengineering/lenis/issues/103))

<br>

Expand All @@ -233,7 +233,7 @@ html.lenis {
## Plugins

- [Loconative-scroll](https://github.com/quentinhocde/loconative-scroll#how-to-switch-from-locomotive-scroll-to-loconative-scroll) by [Quentin Hocde](https://twitter.com/QuentinHocde)
- [react-lenis](https://github.com/studio-freight/lenis/tree/main/packages/react-lenis) by [Studio Freight](https://www.studiofreight.com/)
- [react-lenis](https://github.com/darkroomengineering/lenis/tree/main/packages/react-lenis) by [Studio Freight](https://www.studiofreight.com/)
- [r3f-scroll-rig](https://github.com/14islands/r3f-scroll-rig) by [14islands](https://14islands.com/)
- [Lenis Scroll Snap Plugin](https://github.com/funkhaus/lenis-scroll-snap) by [Funkhaus](https://github.com/funkhaus)
- [locomotive-scroll](https://github.com/locomotivemtl/locomotive-scroll) by [Locomotive](https://locomotive.ca/)
Expand Down
4 changes: 2 additions & 2 deletions packages/lenis/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
"description": "Lenis is a smooth scroll library to normalize and smooth the scrolling experience across devices",
"repository": {
"type": "git",
"url": "git+https://github.com/studio-freight/lenis.git"
"url": "git+https://github.com/darkroomengineering/lenis.git"
},
"bugs": {
"url": "https://github.com/studio-freight/lenis/issues"
"url": "https://github.com/darkroomengineering/lenis/issues"
},
"files": [
"dist"
Expand Down
4 changes: 2 additions & 2 deletions packages/react-lenis/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@


## Introduction
react-lenis provides a `<ReactLenis>` component that creates a [Lenis](https://github.com/studio-freight/lenis) instance and provides it to its children via context. This allows you to use Lenis in your React app without worrying about passing the instance down through props. It also provides a `useLenis` hook that allows you to access the Lenis instance from any component in your app.
react-lenis provides a `<ReactLenis>` component that creates a [Lenis](https://github.com/darkroomengineering/lenis) instance and provides it to its children via context. This allows you to use Lenis in your React app without worrying about passing the instance down through props. It also provides a `useLenis` hook that allows you to access the Lenis instance from any component in your app.


<br/>
Expand Down Expand Up @@ -41,7 +41,7 @@ function Layout() {
<br/>

## Props
- `options`: [Lenis options](https://github.com/studio-freight/lenis#instance-settings).
- `options`: [Lenis options](https://github.com/darkroomengineering/lenis#instance-settings).
- `root`: Lenis will be instanciate using `<html>` scroll. Default: `false`.
- `autoRaf`: if `false`, `lenis.raf` needs to be called manually. Default: `true`.
- `rAFpriority`: [Tempus](https://github.com/studio-freight/tempus#readme) execution priority. Default: `0`.
Expand Down
4 changes: 2 additions & 2 deletions packages/react-lenis/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
"version": "0.0.44",
"repository": {
"type": "git",
"url": "git+https://github.com/studio-freight/lenis.git"
"url": "git+https://github.com/darkroomengineering/lenis.git"
},
"bugs": {
"url": "https://github.com/studio-freight/lenis/issues"
"url": "https://github.com/darkroomengineering/lenis/issues"
},
"files": [
"dist"
Expand Down
Loading

1 comment on commit 0a48aab

@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: 32
🟠 Accessibility: 88
🟢 Best practices: 100
🟠 SEO: 67
🔴 PWA: 0

Lighthouse ran on https://gsap.com/requires-membership/?plugin=SplitText&source=trial"

Please sign in to comment.