-
Notifications
You must be signed in to change notification settings - Fork 127
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
147 additions
and
117 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
80 changes: 80 additions & 0 deletions
80
packages/circuit-ui/hooks/useScrollLock/useScrollLock.spec.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| /** | ||
| * Copyright 2024, SumUp Ltd. | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| import { beforeEach, describe, expect, it, vi } from 'vitest'; | ||
|
|
||
| import { act, renderHook } from '../../util/test-utils.js'; | ||
|
|
||
| import { useScrollLock } from './useScrollLock.js'; | ||
|
|
||
| describe('useScrollLock', () => { | ||
| Object.defineProperty(window, 'scrollTo', { | ||
| value: vi.fn(), | ||
| writable: true, | ||
| }); | ||
|
|
||
| Object.defineProperty(window, 'scrollY', { value: 1, writable: true }); | ||
|
|
||
| beforeEach(() => { | ||
| document.body.style.position = ''; | ||
| document.body.style.top = ''; | ||
| document.documentElement.style.setProperty('--scroll-y', ''); | ||
| }); | ||
|
|
||
| it('locks the scroll when `isLocked` is true', () => { | ||
| document.documentElement.style.setProperty('--scroll-y', '100px'); | ||
|
|
||
| const { rerender } = renderHook(({ isLocked }) => useScrollLock(isLocked), { | ||
| initialProps: { isLocked: false }, | ||
| }); | ||
|
|
||
| rerender({ isLocked: true }); | ||
|
|
||
| expect(document.body.style.position).toBe('fixed'); | ||
| expect(document.body.style.top).toBe('-100px'); | ||
| }); | ||
|
|
||
| it('unlocks the scroll when `isLocked` is false', () => { | ||
| document.body.style.top = '-100px'; | ||
|
|
||
| const { rerender } = renderHook(({ isLocked }) => useScrollLock(isLocked), { | ||
| initialProps: { isLocked: true }, | ||
| }); | ||
|
|
||
| rerender({ isLocked: false }); | ||
|
|
||
| expect(document.body.style.position).toBe(''); | ||
| expect(document.body.style.top).toBe(''); | ||
| expect(window.scrollTo).toHaveBeenCalledWith(0, 100); | ||
| }); | ||
|
|
||
| it('updates `--scroll-y` on scroll', () => { | ||
| global.requestAnimationFrame = vi | ||
| .fn() | ||
| .mockImplementation((callback: () => void) => callback()); | ||
|
|
||
| renderHook(() => useScrollLock(false)); | ||
|
|
||
| act(() => { | ||
| window.scrollY = 200; | ||
| const scrollEvent = new Event('scroll'); | ||
| window.dispatchEvent(scrollEvent); | ||
| }); | ||
|
|
||
| expect(document.documentElement.style.getPropertyValue('--scroll-y')).toBe( | ||
| '200px', | ||
| ); | ||
| }); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| /** | ||
| * Copyright 2024, SumUp Ltd. | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| import { useEffect, useRef } from 'react'; | ||
|
|
||
| export const useScrollLock = (isLocked: boolean): void => { | ||
| const busy = useRef(false); | ||
|
|
||
| useEffect(() => { | ||
| function setScrollProperty() { | ||
| if (!busy.current) { | ||
| requestAnimationFrame(() => { | ||
| document.documentElement.style.setProperty( | ||
| '--scroll-y', | ||
| `${window.scrollY}px`, | ||
| ); | ||
| busy.current = false; | ||
| }); | ||
| busy.current = true; | ||
| } | ||
| } | ||
| window.addEventListener('scroll', setScrollProperty); | ||
|
|
||
| return () => { | ||
| window.removeEventListener('scroll', setScrollProperty); | ||
| }; | ||
| }, []); | ||
|
|
||
| useEffect(() => { | ||
| if (isLocked) { | ||
| const scrollY = | ||
| document.documentElement.style.getPropertyValue('--scroll-y'); | ||
| const { body } = document; | ||
| body.style.position = 'fixed'; | ||
| body.style.left = '0'; | ||
| body.style.right = '0'; | ||
| body.style.top = `-${scrollY}`; | ||
| } else { | ||
| // restore scroll to page | ||
| const { body } = document; | ||
| const scrollY = body.style.top; | ||
| body.style.position = ''; | ||
| body.style.top = ''; | ||
| body.style.left = ''; | ||
| body.style.right = ''; | ||
| window.scrollTo(0, Number.parseInt(scrollY || '0', 10) * -1); | ||
| } | ||
| }, [isLocked]); | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters