-
Notifications
You must be signed in to change notification settings - Fork 3
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
3 changed files
with
95 additions
and
0 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,89 @@ | ||
// This is a custom hook to fix the issue with sticky and the soft keyboard on ios. | ||
// on ios, when the soft keyboard is open, the keyboard pushes the content up. | ||
// This ends up getting the sticky element out of the screen. | ||
// As a workaround, we wrap the sticky element with a wrapper, | ||
// set a margin to the sticky element as much as the wrapper is out of the screen. | ||
import { useDebouncedCallback } from './use-debounced-callback'; | ||
import { useCallback, useEffect, useRef } from 'react'; | ||
|
||
const DEBOUNCE_TIME = 150; // ms | ||
const TRANSITION_CLASS = 'animate-slide-down'; | ||
|
||
export function useStickyIOS< | ||
StickyElementType extends HTMLElement = HTMLDivElement, | ||
WrapperElementType extends HTMLElement = HTMLDivElement, | ||
>() { | ||
const stickyRef = useRef<StickyElementType>(null); | ||
const wrapperRef = useRef<WrapperElementType>(null); | ||
const blurred = useRef(false); | ||
|
||
const stickyOffsetRef = useRef(0); | ||
|
||
const setMargin = () => { | ||
// When the keyboard gets closed, both the 'scroll' and 'blur' events are fired. | ||
// We skip the handling here. | ||
// Otherwise, wrapper.getBoundingClientRect().top might return incorrect value | ||
// due to keyboard closing animation. | ||
// This would set wrong marinTop with gap above the sticky element. | ||
if (blurred.current) { | ||
blurred.current = false; | ||
return; | ||
} | ||
|
||
const wrapper = wrapperRef.current; | ||
const sticky = stickyRef.current; | ||
|
||
if (!wrapper || !sticky) { | ||
return; | ||
} | ||
|
||
const newPosition = wrapper.getBoundingClientRect().top; | ||
// do nothing if wrapper remains in the screen | ||
if (newPosition >= -1) { | ||
return; | ||
} | ||
|
||
stickyRef.current.classList.add(TRANSITION_CLASS); | ||
// if wrapper is out of the screen, | ||
// add a margin to show the sticky element | ||
stickyOffsetRef.current = Math.abs(newPosition); | ||
|
||
// set the margin by the new fixed position | ||
sticky.style.marginTop = `${stickyOffsetRef.current}px`; | ||
}; | ||
|
||
const debouncedSetMargin = useDebouncedCallback(setMargin, DEBOUNCE_TIME); | ||
|
||
const resetPosition = useCallback(() => { | ||
if (stickyRef.current) { | ||
stickyRef.current.style.marginTop = '0px'; | ||
stickyRef.current.classList.remove(TRANSITION_CLASS); | ||
} | ||
|
||
if (stickyOffsetRef.current > 0) { | ||
stickyOffsetRef.current = 0; | ||
} | ||
}, []); | ||
|
||
const handleScroll = useCallback(() => { | ||
// put the sticky element back to default position | ||
resetPosition(); | ||
|
||
// show the sticky element with delay | ||
debouncedSetMargin(); | ||
}, [debouncedSetMargin, resetPosition]); | ||
|
||
useEffect(() => { | ||
window.addEventListener('scroll', handleScroll); | ||
return () => { | ||
window.removeEventListener('scroll', handleScroll); | ||
}; | ||
}, [handleScroll]); | ||
|
||
const handleBlur = useCallback(() => { | ||
blurred.current = true; | ||
resetPosition(); | ||
}, [resetPosition]); | ||
|
||
return { handleBlur, stickyRef, wrapperRef }; | ||
} |
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